Class GraphShapeBuilder<Builder>

Type Parameters

Builder extends GraphBuilder<any, any>

Index

Constructors

Properties

graph graphBuilder previousNodes shapes

Methods

buffer chunk clone convertFromSpace convertToSpace debounce delay filter filterObjects flatten merge store to via viaGraph registerShape

Constructors

constructor

new GraphShapeBuilder<Builder extends GraphBuilder<any, any>>(
    graphBuilder: Builder,
    graph: GraphShape<any, any>,
    nodes: GraphNode<any, any>[],
): GraphShapeBuilder<Builder>
Type Parameters
- Builder extends GraphBuilder<any, any>
Parameters
- graphBuilder: Builder
- graph: GraphShape<any, any>
- nodes: GraphNode<any, any>[]
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:176

Properties

`Protected`graph

graph: GraphShape<any, any>

`Protected`graphBuilder

graphBuilder: Builder

`Protected`previousNodes

previousNodes: GraphNode<any, any>[]

`Protected` `Static`shapes

shapes: Map<string, (...args: any[]) => GraphNode<any, any>> = ...

Methods

buffer

buffer(): this
Buffer pushed objects

Returns this
Current graph shape builder
- Defined in src/graph/builders/GraphBuilder.ts:319

chunk

chunk(size: number, timeout?: number, timeoutUnit?: TimeUnit): this
Parameters
- size: number
- Optionaltimeout: number
- OptionaltimeoutUnit: TimeUnit
Returns this
- Defined in src/graph/builders/GraphBuilder.ts:239

clone

clone(): this
Clone frames

Returns this
Current graph shape builder
- Defined in src/graph/builders/GraphBuilder.ts:293

convertFromSpace

convertFromSpace(referenceSpace: string | ReferenceSpace): this
Convert positions of all objects from a certain reference space
Parameters
- referenceSpace: string | ReferenceSpace
  Reference space to convert from
Returns this
Current graph shape builder
- Defined in src/graph/builders/GraphBuilder.ts:311

convertToSpace

convertToSpace(referenceSpace: string | ReferenceSpace): this
Convert positions of all objects to a certain reference space
Parameters
- referenceSpace: string | ReferenceSpace
  Reference space to convert to
Returns this
Current graph shape builder
- Defined in src/graph/builders/GraphBuilder.ts:302

debounce

debounce(timeout?: number, timeoutUnit?: TimeUnit): this
Parameters
- timeout: number = 100
- timeoutUnit: TimeUnit = TimeUnit.MILLISECOND
Returns this
- Defined in src/graph/builders/GraphBuilder.ts:281

delay

delay(timeout?: number, timeoutUnit?: TimeUnit): this
Parameters
- timeout: number = 100
- timeoutUnit: TimeUnit = TimeUnit.MILLISECOND
Returns this
- Defined in src/graph/builders/GraphBuilder.ts:285

filter

filter(filterFn: (frame: DataFrame) => boolean): this
Filter frames based on function
Parameters
- filterFn: (frame: DataFrame) => boolean
  Filter function (true to keep, false to remove)
Returns this
Current graph builder instance
- Defined in src/graph/builders/GraphBuilder.ts:252

filterObjects

filterObjects(
filterFn: (object: DataObject, frame?: DataFrame) => boolean,
): this
Filter objects inside frames
Parameters
- filterFn: (object: DataObject, frame?: DataFrame) => boolean
  Filter function (true to keep, false to remove)
Returns this
Current graph builder instance
- Defined in src/graph/builders/GraphBuilder.ts:262

flatten

flatten(): this
Returns this
- Defined in src/graph/builders/GraphBuilder.ts:243

merge

merge(
    by?: (frame: DataFrame) => boolean,
    timeout?: number,
    timeoutUnit?: TimeUnit,
): this
Merge objects
Parameters
- by: (frame: DataFrame) => boolean = ...
  Merge key
- timeout: number = 100
  Timeout
- timeoutUnit: TimeUnit = TimeUnit.MILLISECOND
  Timeout unit
Returns this
Current graph shape builder
- Defined in src/graph/builders/GraphBuilder.ts:273

store

store(): Builder
Storage as sink node

Returns Builder
Graph builder
- Defined in src/graph/builders/GraphBuilder.ts:327

to

to(...nodes: (string | SinkNode<any>)[]): Builder
Parameters
- ...nodes: (string | SinkNode<any>)[]
Returns Builder
- Defined in src/graph/builders/GraphBuilder.ts:331

via

via(
    ...nodes: (
        | string
        | GraphNode<any, any>
        | GraphShape<any, any>
        | GraphBuilder<any, any>
    )[],
): this
Parameters
- ...nodes: (string | GraphNode<any, any> | GraphShape<any, any> | GraphBuilder<any, any>)[]
Returns this
- Defined in src/graph/builders/GraphBuilder.ts:195

`Protected`viaGraph

viaGraph(graph: GraphShape<any, any>): GraphNode<any, any>
Parameters
- graph: GraphShape<any, any>
Returns GraphNode<any, any>
- Defined in src/graph/builders/GraphBuilder.ts:182

`Static`registerShape

registerShape(key: string, fn: (...args: any[]) => GraphNode<any, any>): void
Parameters
- key: string
- fn: (...args: any[]) => GraphNode<any, any>
Returns void
- Defined in src/graph/builders/GraphBuilder.ts:235