Class Pipeline

Hierarchy

Pipeline

Index

Constructors

Properties

_geom _oc _shapes name

Methods

annotate layout process shapes

Constructors

constructor

new Pipeline(name: string): Pipeline
Create a Pipeline
Parameters
- name: string
Returns Pipeline
- Defined in Pipeline.ts:45

Properties

_geom

_geom: Geom

_oc

_oc: any

_shapes

_shapes: ShapeCollection

name

name: string

Methods

annotate

annotate(options: PipelineAnnotate): Pipeline
Annotate shapes
Parameters
- options: PipelineAnnotate
Returns Pipeline
- Defined in Pipeline.ts:66

layout

layout(layout: Layout): Pipeline
Disassemble and layout in a given order
Parameters
- layout: Layout
Returns Pipeline
- Defined in Pipeline.ts:59

process

process(fn: ((shape: AnyShape, index: number, all: ShapeCollection) => any)): Pipeline
Process Shapes or pipeline
Parameters
- fn: ((shape: AnyShape, index: number, all: ShapeCollection) => any)
  - - (shape: AnyShape, index: number, all: ShapeCollection): any
    - Parameters
      
      shape: AnyShape
      
      index: number
      
      all: ShapeCollection
      
      Returns any
Returns Pipeline
- Defined in Pipeline.ts:73

shapes

shapes(shapes: AnyShapeOrCollection): Pipeline
Select shapes that go into the Pipeline
Parameters
- shapes: AnyShapeOrCollection
Returns Pipeline
- Defined in Pipeline.ts:51

Generated using TypeDoc