API | @kineviz/graphxr-api

Hierarchy

Index

Properties

Methods

Properties

DIMENSIONS

DIMENSIONS: Record<"x" | "y" | "z", "x" | "y" | "z">

ExpandNodesEdgeDirection

ExpandNodesEdgeDirection: Record<"INCOMING" | "OUTGOING" | "BOTH" | "ANY", string>

ExpandNodesStatusCode

ExpandNodesStatusCode: Record<"MAYBE_MORE_RESULTS_AVAILABLE" | "NO_MORE_RESULTS_AVAILABLE", string>

_minimumGraphxrVersion

_minimumGraphxrVersion: string

_version

_version: string

aggregateFormula

aggregateFormula: { average: AggregateFormula; concatenate: AggregateFormula; count: AggregateFormula; max: AggregateFormula; min: AggregateFormula; range: AggregateFormula; sum: AggregateFormula; takeFirst: AggregateFormula }

Type declaration

average: AggregateFormula
concatenate: AggregateFormula
count: AggregateFormula
max: AggregateFormula
min: AggregateFormula
range: AggregateFormula
sum: AggregateFormula
takeFirst: AggregateFormula

mapFormula

mapFormula: { toDate: MapFormula; toNumber: MapFormula; toString: MapFormula; toWeek: MapFormula }

Type declaration

toDate: MapFormula
toNumber: MapFormula
toString: MapFormula
toWeek: MapFormula

Methods

aggregate

aggregate(options: AggregateOptions): TransformFunction

- Defined in index.ts:321
Parameters
- options: AggregateOptions
Returns TransformFunction

alignBy

alignBy(options: AlignByOptions): LayoutFunction

- Defined in index.ts:261
Parameters
- options: AlignByOptions
Returns LayoutFunction

applyLayout

applyLayout(view: LayoutGraph, computeLayout: LayoutFunction, tweenOverrides?: Partial<TweenLayoutOptions>): Promise<NodeIdToPosition>

- Defined in index.ts:262
Parameters
- view: LayoutGraph
- computeLayout: LayoutFunction
- Optional tweenOverrides: Partial<TweenLayoutOptions>
Returns Promise<NodeIdToPosition>

areGraphSnapshotsEqual

areGraphSnapshotsEqual(left: GraphSnapshot, right: GraphSnapshot, options?: Partial<AreGraphSnapshotsEqualOptions>): boolean

- Defined in index.ts:242
Parameters
- left: GraphSnapshot
- right: GraphSnapshot
- Optional options: Partial<AreGraphSnapshotsEqualOptions>
Returns boolean

betweenness

betweenness(graph: LayoutGraph): BetweennessResult

- Defined in index.ts:217
Parameters
- graph: LayoutGraph
Returns BetweennessResult

circle

circle(options?: NodeFilterOptions): LayoutFunction

- Defined in index.ts:267
Parameters
- Optional options: NodeFilterOptions
Returns LayoutFunction

closeness

closeness(graph: LayoutGraph): ClosenessResult

- Defined in index.ts:218
Parameters
- graph: LayoutGraph
Returns ClosenessResult

collectNodes

collectNodes(options?: CollectNodesOptions): TransformFunction

- Defined in index.ts:222
Parameters
- Optional options: CollectNodesOptions
Returns TransformFunction

colorNodesByProperty

colorNodesByProperty(options: ColorNodesByPropertyOptions): void

- Defined in index.ts:284
Parameters
- options: ColorNodesByPropertyOptions
Returns void

comparePropertyValues

comparePropertyValues(left: any, right: any, ascending?: boolean): number

- Defined in index.ts:311
Parameters
- left: any
- right: any
- Optional ascending: boolean
Returns number

connectedComponent

connectedComponent(graph: LayoutGraph): ConnectedComponentResult

- Defined in index.ts:228
Parameters
- graph: LayoutGraph
Returns ConnectedComponentResult

convertToScreenCoordinates

convertToScreenCoordinates(position: Vector3): Vector3

- Defined in index.ts:199
Parameters
- position: Vector3
Returns Vector3

createNodes

createNodes(options?: CreateNodesOptions): TransformFunction

- Defined in index.ts:253
Parameters
- Optional options: CreateNodesOptions
Returns TransformFunction

cube

cube(options?: NodeFilterOptions): LayoutFunction

- Defined in index.ts:268
Parameters
- Optional options: NodeFilterOptions
Returns LayoutFunction

dijkstra

dijkstra(graph: LayoutGraph, options: DijkstraOptions): Parent[][]

- Defined in index.ts:287
Parameters
- graph: LayoutGraph
- options: DijkstraOptions
Returns Parent[][]

dispatchGraphDataUpdate

dispatchGraphDataUpdate(): void

- Defined in index.ts:305
Returns void

distributionBy

distributionBy(options: DistributionOptions): LayoutFunction

- Defined in index.ts:269
Parameters
- options: DistributionOptions
Returns LayoutFunction

edgesByRelationship

edgesByRelationship(relationship: RelationshipId): EdgeFilter

- Defined in index.ts:239
Parameters
- relationship: RelationshipId
Returns EdgeFilter

ego

ego(options: EgoOptions): LayoutFunction

- Defined in index.ts:270
Parameters
- options: EgoOptions
Returns LayoutFunction

expandNodes

expandNodes(options?: Omit<ExpandNodesOptions, "excludedEdgeIds">): Promise<ExpandNodesStatusCode>

- Defined in index.ts:297
Parameters
- Optional options: Omit<ExpandNodesOptions, "excludedEdgeIds">
Returns Promise<ExpandNodesStatusCode>

explodeCollections

explodeCollections(options?: ExplodeCollectionsOptions): TransformFunction

- Defined in index.ts:223
Parameters
- Optional options: ExplodeCollectionsOptions
Returns TransformFunction

extract

extract(options: ExtractOptions): TransformFunction

- Defined in index.ts:332
Parameters
- options: ExtractOptions
Returns TransformFunction

flyToCenter

flyToCenter(view?: LayoutGraph, nodeIds?: NodeId[], offset?: number, options?: TweenPositionOptions): Promise<Vector3>

- Defined in index.ts:200
Parameters
- Optional view: LayoutGraph
- Optional nodeIds: NodeId[]
- Optional offset: number
- Optional options: TweenPositionOptions
Returns Promise<Vector3>

flyToPosition

flyToPosition(position: Vector3, offset?: number, options?: TweenPositionOptions): Promise<Vector3>

- Defined in index.ts:206
Parameters
- position: Vector3
- Optional offset: number
- Optional options: TweenPositionOptions
Returns Promise<Vector3>

getCategoryColor

getCategoryColor(categoryId: CategoryId): Color

- Defined in index.ts:211
Parameters
- categoryId: CategoryId
Returns Color

getCategoryConfig

getCategoryConfig(categoryId: CategoryId): CategoryConfig

- Defined in index.ts:212
Parameters
- categoryId: CategoryId
Returns CategoryConfig

getGraphView

getGraphView(): void

- Defined in index.ts:247
Returns void

getLayoutGraph

getLayoutGraph(): LegacyLayoutGraph

- Defined in index.ts:248
Returns LegacyLayoutGraph

getObservableLayoutGraph

getObservableLayoutGraph(): ObservableLayoutGraph

- Defined in index.ts:258
Returns ObservableLayoutGraph

getRuntime

getRuntime(): Runtime

- Defined in index.ts:193
Returns Runtime

getScene

getScene(): Group

- Defined in index.ts:308
Returns Group

grid

grid(options?: NodeFilterOptions): LayoutFunction

- Defined in index.ts:272
Parameters
- Optional options: NodeFilterOptions
Returns LayoutFunction

layout

layout(computeLayout: LayoutNodesFunction, options?: NodeFilterOptions): LayoutFunction

- Defined in index.ts:271
Parameters
- computeLayout: LayoutNodesFunction
- Optional options: NodeFilterOptions
Returns LayoutFunction

line

line(options?: NodeFilterOptions): LayoutFunction

- Defined in index.ts:273
Parameters
- Optional options: NodeFilterOptions
Returns LayoutFunction

link

link(options: LinkOptions): TransformFunction

- Defined in index.ts:333
Parameters
- options: LinkOptions
Returns TransformFunction

louvain

louvain(graph: LayoutGraph): LouvainResult

- Defined in index.ts:229
Parameters
- graph: LayoutGraph
Returns LouvainResult

makeCollectionNode

makeCollectionNode(category: CategoryId, collection: NodeCollection): ApiNode

- Defined in index.ts:225
Parameters
- category: CategoryId
- collection: NodeCollection
Returns ApiNode

makeColor

makeColor(hexOrR: number, g?: number, b?: number): Color

- Defined in index.ts:315
Parameters
- hexOrR: number
- Optional g: number
- Optional b: number
Returns Color

makeEdge

makeEdge(edge: Partial<ApiEdge>): ApiEdge

- Defined in index.ts:250
Parameters
- edge: Partial<ApiEdge>
Returns ApiEdge

makeGraph

makeGraph(): LayoutGraph

- Defined in index.ts:249
Returns LayoutGraph

makeNode

makeNode(options?: Partial<ApiNode>): ApiNode

- Defined in index.ts:252
Parameters
- Optional options: Partial<ApiNode>
Returns ApiNode

makeNodeId

makeNodeId(): NodeId

- Defined in index.ts:251
Returns NodeId

makePosition

makePosition(xyz: Partial<Vector3>): Vector3

- Defined in index.ts:316
Parameters
- xyz: Partial<Vector3>
Returns Vector3

makeRandomPosition

makeRandomPosition(): Vector3

- Defined in index.ts:317
Returns Vector3

map

map(options: MapOptions): TransformFunction

- Defined in index.ts:334
Parameters
- options: MapOptions
Returns TransformFunction

merge

merge(options: MergeOptions): TransformFunction

- Defined in index.ts:341
Parameters
- options: MergeOptions
Returns TransformFunction

mergeNodes

mergeNodes(options?: MergeNodesOptions): TransformFunction

- Defined in index.ts:254
Parameters
- Optional options: MergeNodesOptions
Returns TransformFunction

mergeRelationships

mergeRelationships(options?: MergeRelationshipsOptions): TransformFunction

- Defined in index.ts:255
Parameters
- Optional options: MergeRelationshipsOptions
Returns TransformFunction

neo4j

neo4j(query: Neo4jQuery, options?: Neo4jOptions): void

- Defined in index.ts:298
Parameters
- query: Neo4jQuery
- Optional options: Neo4jOptions
Returns void

nodesByCategory

nodesByCategory(category: CategoryId): NodeFilter

- Defined in index.ts:238
Parameters
- category: CategoryId
Returns NodeFilter

observe

observe<T>(event: GraphxrEvent, compute: ObserveCallback): Iterator<T, any, undefined>

- Defined in index.ts:233
Type Parameters
- T
Parameters
- event: GraphxrEvent
- compute: ObserveCallback
Returns Iterator<T, any, undefined>

on

on(event: GraphxrEvent, callback: GraphxrEventCallback): GraphxrEventCallbackId

- Defined in index.ts:235
Parameters
- event: GraphxrEvent
- callback: GraphxrEventCallback
Returns GraphxrEventCallbackId

onChange

onChange<T>(callback: ObserveCallback): Iterator<T, any, undefined>

- Defined in index.ts:234
Type Parameters
- T
Parameters
- callback: ObserveCallback
Returns Iterator<T, any, undefined>

pageRank

pageRank(graph: LayoutGraph, options?: PageRankOptions): PageRankResult

- Defined in index.ts:219
Parameters
- graph: LayoutGraph
- Optional options: PageRankOptions
Returns PageRankResult

parametric

parametric(options?: ParametricOptions): LayoutFunction

- Defined in index.ts:274
Parameters
- Optional options: ParametricOptions
Returns LayoutFunction

random

random(options?: NodeFilterOptions): LayoutFunction

- Defined in index.ts:275
Parameters
- Optional options: NodeFilterOptions
Returns LayoutFunction

rotate

rotate(options: RotateOptions): LayoutFunction

- Defined in index.ts:276
Parameters
- options: RotateOptions
Returns LayoutFunction

scale

scale(options?: ScaleOptions): LayoutFunction

- Defined in index.ts:277
Parameters
- Optional options: ScaleOptions
Returns LayoutFunction

setAutoShowImage

setAutoShowImage(value: boolean): boolean

- Defined in index.ts:301
Parameters
- value: boolean
Returns boolean

setCameraOptions

setCameraOptions(options: CameraOptions): void

- Defined in index.ts:208
Parameters
- options: CameraOptions
Returns void

setCameraRotating

setCameraRotating(isRotating: boolean): void

- Defined in index.ts:207
Parameters
- isRotating: boolean
Returns void

setCategoryCaptionProperties

setCategoryCaptionProperties(options: SetCategoryCaptionPropertiesOptions): Promise<unknown>

- Defined in index.ts:213
Parameters
- options: SetCategoryCaptionPropertiesOptions
Returns Promise<unknown>

setCategorySizeProperty

setCategorySizeProperty(options: SetCategorySizePropertyOptions): Promise<unknown>

- Defined in index.ts:214
Parameters
- options: SetCategorySizePropertyOptions
Returns Promise<unknown>

setEdgeScale

setEdgeScale(value: number): number

- Defined in index.ts:302
Parameters
- value: number
Returns number

setFullscreen

setFullscreen(value: boolean): boolean

- Defined in index.ts:348
Parameters
- value: boolean
Returns boolean

setParametricAxesOptions

setParametricAxesOptions(options: Partial<AxesOptions>): void

- Defined in index.ts:278
Parameters
- options: Partial<AxesOptions>
Returns void

setRuntime

setRuntime(runtime: Runtime): void

- Defined in index.ts:194
Parameters
- runtime: Runtime
Returns void

shift

shift(options: ShiftOptions): LayoutFunction

- Defined in index.ts:279
Parameters
- options: ShiftOptions
Returns LayoutFunction

shortcut

shortcut(options: ShortcutOptions): TransformFunction

- Defined in index.ts:342
Parameters
- options: ShortcutOptions
Returns TransformFunction

sleep

sleep(ms: number): Promise<number>

- Defined in index.ts:345
Parameters
- ms: number
Returns Promise<number>

sortByProperty

sortByProperty(property: SortByPropertyOptions): Sort<ApiNode>

- Defined in index.ts:312
Parameters
- property: SortByPropertyOptions
Returns Sort<ApiNode>

spiral

spiral(options?: NodeFilterOptions): LayoutFunction

- Defined in index.ts:280
Parameters
- Optional options: NodeFilterOptions
Returns LayoutFunction

stronglyConnectedComponent

stronglyConnectedComponent(graph: LayoutGraph): ConnectedComponentResult

- Defined in index.ts:230
Parameters
- graph: LayoutGraph
Returns ConnectedComponentResult

traceNeighbors

traceNeighbors(view: LegacyLayoutGraph, rootId: NodeId, options?: TraceNeighborsOptions): MapPolyfill<NodeId, boolean>

- Defined in index.ts:288
Parameters
- view: LegacyLayoutGraph
- rootId: NodeId
- Optional options: TraceNeighborsOptions
Returns MapPolyfill<NodeId, boolean>

triggerForceLayout

triggerForceLayout(): void

- Defined in index.ts:281
Returns void

uncollectNodes

uncollectNodes(options?: UncollectNodesOptions): TransformFunction

- Defined in index.ts:224
Parameters
- Optional options: UncollectNodesOptions
Returns TransformFunction

Hierarchy

Index

Properties

Methods

Properties

DIMENSIONS

ExpandNodesEdgeDirection

ExpandNodesStatusCode

_minimumGraphxrVersion

_version

aggregateFormula

Type declaration

average: AggregateFormula

concatenate: AggregateFormula

count: AggregateFormula

max: AggregateFormula

min: AggregateFormula

range: AggregateFormula

sum: AggregateFormula

takeFirst: AggregateFormula

mapFormula

Type declaration

toDate: MapFormula

toNumber: MapFormula

toString: MapFormula

toWeek: MapFormula

Methods

aggregate

Parameters

options: AggregateOptions

Returns TransformFunction

alignBy

Parameters

options: AlignByOptions

Returns LayoutFunction

applyLayout

Parameters

view: LayoutGraph

computeLayout: LayoutFunction

Optional tweenOverrides: Partial<TweenLayoutOptions>

Returns Promise<NodeIdToPosition>

areGraphSnapshotsEqual

Parameters

left: GraphSnapshot

right: GraphSnapshot

Optional options: Partial<AreGraphSnapshotsEqualOptions>

Returns boolean

betweenness

Parameters

graph: LayoutGraph

Returns BetweennessResult

circle

Parameters

Optional options: NodeFilterOptions

Returns LayoutFunction

closeness

Parameters

graph: LayoutGraph

Returns ClosenessResult

collectNodes

Parameters

Optional options: CollectNodesOptions

Returns TransformFunction

colorNodesByProperty

Parameters

options: ColorNodesByPropertyOptions

Returns void

comparePropertyValues

Parameters

left: any

right: any

Optional ascending: boolean

Returns number

connectedComponent

Parameters

graph: LayoutGraph

Returns ConnectedComponentResult

convertToScreenCoordinates

Parameters

position: Vector3