Class GraphShapeBuilder<Builder>

Type Parameters

Builder extends GraphBuilder<any, any>

Hierarchy

GraphShapeBuilder

Index

Constructors

constructor

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

Properties

`Protected` graph

graph: GraphShape<any, any>

`Protected` graphBuilder

graphBuilder: Builder

`Protected` previousNodes

previousNodes: GraphNode<any, any>[]

`Static` `Protected` shapes

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

Methods

buffer

buffer(): GraphShapeBuilder<Builder>
Buffer pushed objects

Returns
Current graph shape builder

Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:321

chunk

chunk(size: number, timeout?: number, timeoutUnit?: TimeUnit): GraphShapeBuilder<Builder>
Parameters
- size: number
- Optional timeout: number
- Optional timeoutUnit: TimeUnit
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:233

clone

clone(): GraphShapeBuilder<Builder>
Clone frames

Returns
Current graph shape builder

Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:292

convertFromSpace

convertFromSpace(referenceSpace: string | ReferenceSpace): GraphShapeBuilder<Builder>
Convert positions of all objects from a certain reference space

Returns
Current graph shape builder
Parameters
- referenceSpace: string | ReferenceSpace
  
  Reference space to convert from
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:312

convertToSpace

convertToSpace(referenceSpace: string | ReferenceSpace): GraphShapeBuilder<Builder>
Convert positions of all objects to a certain reference space

Returns
Current graph shape builder
Parameters
- referenceSpace: string | ReferenceSpace
  
  Reference space to convert to
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:302

debounce

debounce(timeout?: number, timeoutUnit?: TimeUnit): GraphShapeBuilder<Builder>
Parameters
- timeout: number = 100
- timeoutUnit: TimeUnit = TimeUnit.MILLISECOND
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:279

delay

delay(timeout?: number, timeoutUnit?: TimeUnit): GraphShapeBuilder<Builder>
Parameters
- timeout: number = 100
- timeoutUnit: TimeUnit = TimeUnit.MILLISECOND
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:283

filter

filter(filterFn: ((object: DataObject, frame?: DataFrame) => boolean)): GraphShapeBuilder<Builder>
Filter frames based on function

Returns
Current graph builder instance
Parameters
- filterFn: ((object: DataObject, frame?: DataFrame) => boolean)
  
  Filter function (true to keep, false to remove)
  - - (object: DataObject, frame?: DataFrame): boolean
    - Parameters
      
      object: DataObject
      
      Optional frame: DataFrame
      
      Returns boolean
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:247
filter(filterFn: ((frame: DataFrame) => boolean)): GraphShapeBuilder<Builder>
Parameters
- filterFn: ((frame: DataFrame) => boolean)
  - - (frame: DataFrame): boolean
    - Parameters
      
      frame: DataFrame
      
      Returns boolean
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:248

filterObjects

filterObjects(filterFn: ((object: DataObject, frame?: DataFrame) => boolean)): GraphShapeBuilder<Builder>
Filter objects inside frames

Returns
Current graph builder instance
Parameters
- filterFn: ((object: DataObject, frame?: DataFrame) => boolean)
  
  Filter function (true to keep, false to remove)
  - - (object: DataObject, frame?: DataFrame): boolean
    - Parameters
      
      object: DataObject
      
      Optional frame: DataFrame
      
      Returns boolean
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:259

flatten

flatten(): GraphShapeBuilder<Builder>
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:237

merge

merge(by?: ((frame: DataFrame) => boolean), timeout?: number, timeoutUnit?: TimeUnit): GraphShapeBuilder<Builder>
Merge objects

Returns
Current graph shape builder
Parameters
- by: ((frame: DataFrame) => boolean) = ...
  
  Merge key
  - - (frame: DataFrame): boolean
    - Parameters
      
      frame: DataFrame
      
      Returns boolean
- timeout: number = 100
  
  Timeout
- timeoutUnit: TimeUnit = TimeUnit.MILLISECOND
  
  Timeout unit
Returns GraphShapeBuilder<Builder>
- Defined in src/graph/builders/GraphBuilder.ts:271

store

store(): Builder
Storage as sink node

Returns
Graph builder

Returns Builder
- Defined in src/graph/builders/GraphBuilder.ts:330

to

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

via

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

`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:175

`Static` registerShape

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

Class GraphShapeBuilder<Builder>

Type Parameters

Builder extends GraphBuilder<any, any>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Builder extends GraphBuilder<any, any, Builder>

Parameters

graphBuilder: Builder

graph: GraphShape<any, any>

nodes: GraphNode<any, any>[]

Returns GraphShapeBuilder<Builder>

Properties

Protected graph

Protected graphBuilder

Protected previousNodes

Static Protected shapes

Methods

buffer

Returns

Returns GraphShapeBuilder<Builder>

chunk

Parameters

size: number

Optional timeout: number

Optional timeoutUnit: TimeUnit

Returns GraphShapeBuilder<Builder>

clone

Returns

Returns GraphShapeBuilder<Builder>

convertFromSpace

Returns

Parameters

referenceSpace: string | ReferenceSpace

Returns GraphShapeBuilder<Builder>

convertToSpace

Returns

Parameters

referenceSpace: string | ReferenceSpace

Returns GraphShapeBuilder<Builder>

debounce

Parameters

timeout: number = 100

timeoutUnit: TimeUnit = TimeUnit.MILLISECOND

Returns GraphShapeBuilder<Builder>

delay

Parameters

timeout: number = 100

timeoutUnit: TimeUnit = TimeUnit.MILLISECOND

Returns GraphShapeBuilder<Builder>

filter

Returns

Parameters

filterFn: ((object: DataObject, frame?: DataFrame) => boolean)

Parameters

object: DataObject

Optional frame: DataFrame

Returns boolean

Returns GraphShapeBuilder<Builder>

Parameters

filterFn: ((frame: DataFrame) => boolean)

Parameters

frame: DataFrame

Returns boolean

Returns GraphShapeBuilder<Builder>

filterObjects

Returns

Parameters

filterFn: ((object: DataObject, frame?: DataFrame) => boolean)

Parameters

object: DataObject

Optional frame: DataFrame

Returns boolean

Returns GraphShapeBuilder<Builder>

flatten

`Protected` graph

`Protected` graphBuilder

`Protected` previousNodes

`Static` `Protected` shapes

`Optional` timeout: number

`Optional` timeoutUnit: TimeUnit

`Optional` frame: DataFrame

`Optional` frame: DataFrame

`Rest` ...nodes: (string | SinkNode<any>)[]

`Rest` ...nodes: (string | GraphNode<any, any> | GraphShape<any, any> | GraphBuilder<any, any>)[]

`Protected` viaGraph

`Static` registerShape

`Rest` ...args: any[]