Class GraphEngine<NodeData, EdgeData>

constructor

• new GraphEngine<NodeData = unknown, EdgeData = unknown>(
      options?: GraphEngineOptions<NodeData, EdgeData>,
  ): GraphEngine<NodeData, EdgeData>

  Type Parameters

  • NodeData = unknown
  • EdgeData = unknown

  Parameters

  • options: GraphEngineOptions<NodeData, EdgeData> = {}

  Returns GraphEngine<NodeData, EdgeData>

Readonlystore

applyLayoutResult

• applyLayoutResult(
      result: LayoutResult,
      options?: GraphEngineLayoutOptions,
  ): GraphEngineLayoutApplication

  Parameters

  • result: LayoutResult
  • options: GraphEngineLayoutOptions = {}

  Returns GraphEngineLayoutApplication

createLayoutGeometry

• createLayoutGeometry(
      options?: CreateLayoutGeometryOptions,
  ): LayoutGeometrySnapshot

  Build stable base measurements from theme, rules and item attributes.

  Parameters

  • options: CreateLayoutGeometryOptions = {}

  Returns LayoutGeometrySnapshot

destroy

• destroy(): void

  Returns void

getDisplayDetail

• getDisplayDetail(): Readonly<Required<DisplayDetailOptions>>

  Returns Readonly<Required<DisplayDetailOptions>>

getInteractionState

• getInteractionState(): InteractionRenderState

  Returns InteractionRenderState

getLayoutArtifacts

• getLayoutArtifacts(): GraphLayoutArtifacts

  Returns GraphLayoutArtifacts

getLayoutGeometry

• getLayoutGeometry(): LayoutGeometrySnapshot | null

  Returns LayoutGeometrySnapshot | null

getStyleRules

• getStyleRules(): ResolvedGraphStyleRules<NodeData, EdgeData>

  Returns ResolvedGraphStyleRules<NodeData, EdgeData>

getViewport

• getViewport(): ViewportState

  Returns ViewportState

getViewState

• getViewState(): GraphViewState<NodeData, EdgeData>

  Returns GraphViewState<NodeData, EdgeData>

invalidateRender

• invalidateRender(): void

  Returns void

loadGraph

• loadGraph(graph: RawGraph<NodeData, EdgeData>): GraphMutationResult

  Parameters

  • graph: RawGraph<NodeData, EdgeData>

  Returns GraphMutationResult

mount

• mount(container: HTMLElement): void

  Parameters

  • container: HTMLElement

  Returns void

on

• on<
      TType extends
          | "graph:loaded"
          | "graph:cleared"
          | "node:removed"
          | "edge:removed"
          | "node:position-updated"
          | "node:positions-updated"
          | "graph:batch-applied"
          | "graph:changed"
          | "node:added"
          | "node:updated"
          | "edge:added"
          | "edge:updated",
  >(
      type: TType,
      handler: (
          event:
              | Extract<GraphLoadedEvent, { type: TType }>
              | Extract<GraphClearedEvent, { type: TType }>
              | Extract<NodeRemovedEvent, { type: TType }>
              | Extract<EdgeRemovedEvent, { type: TType }>
              | Extract<NodePositionUpdatedEvent, { type: TType }>
              | Extract<NodePositionsUpdatedEvent, { type: TType }>
              | Extract<GraphBatchAppliedEvent, { type: TType }>
              | Extract<GraphChangedEvent, { type: TType }>
              | Extract<NodeAddedEvent<NodeData>, { type: TType }>
              | Extract<NodeUpdatedEvent<NodeData>, { type: TType }>
              | Extract<EdgeAddedEvent<EdgeData>, { type: TType }>
              | Extract<EdgeUpdatedEvent<EdgeData>, { type: TType }>,
      ) => void,
  ): Unsubscribe

  Type Parameters

  • TType extends
        | "graph:loaded"
        | "graph:cleared"
        | "node:removed"
        | "edge:removed"
        | "node:position-updated"
        | "node:positions-updated"
        | "graph:batch-applied"
        | "graph:changed"
        | "node:added"
        | "node:updated"
        | "edge:added"
        | "edge:updated"

  Parameters

  • type: TType
  • handler: (
        event:
            | Extract<GraphLoadedEvent, { type: TType }>
            | Extract<GraphClearedEvent, { type: TType }>
            | Extract<NodeRemovedEvent, { type: TType }>
            | Extract<EdgeRemovedEvent, { type: TType }>
            | Extract<NodePositionUpdatedEvent, { type: TType }>
            | Extract<NodePositionsUpdatedEvent, { type: TType }>
            | Extract<GraphBatchAppliedEvent, { type: TType }>
            | Extract<GraphChangedEvent, { type: TType }>
            | Extract<NodeAddedEvent<NodeData>, { type: TType }>
            | Extract<NodeUpdatedEvent<NodeData>, { type: TType }>
            | Extract<EdgeAddedEvent<EdgeData>, { type: TType }>
            | Extract<EdgeUpdatedEvent<EdgeData>, { type: TType }>,
    ) => void

  Returns Unsubscribe

onAny

• onAny(handler: (event: GraphEvent<NodeData, EdgeData>) => void): Unsubscribe

  Parameters

  • handler: (event: GraphEvent<NodeData, EdgeData>) => void

  Returns Unsubscribe

onAnyLifecycle

• onAnyLifecycle(handler: GraphEngineLifecycleListener): Unsubscribe

  Parameters

  • handler: GraphEngineLifecycleListener

  Returns Unsubscribe

onLifecycle

• onLifecycle<
      TType extends
          | "render:scheduled"
          | "render:before"
          | "render:after"
          | "render:error"
          | "layout:started"
          | "layout:completed"
          | "layout:stale"
          | "layout:cancelled"
          | "layout:error"
          | "engine:destroyed"
          | "view:changed"
          | "view:error",
  >(
      type: TType,
      handler: (
          event:
              | Extract<GraphEngineRenderScheduledEvent, { type: TType }>
              | Extract<GraphEngineRenderBeforeEvent, { type: TType }>
              | Extract<GraphEngineRenderAfterEvent, { type: TType }>
              | Extract<GraphEngineRenderErrorEvent, { type: TType }>
              | Extract<GraphEngineLayoutStartedEvent, { type: TType }>
              | Extract<GraphEngineLayoutCompletedEvent, { type: TType }>
              | Extract<GraphEngineLayoutStaleEvent, { type: TType }>
              | Extract<GraphEngineLayoutCancelledEvent, { type: TType }>
              | Extract<GraphEngineLayoutErrorEvent, { type: TType }>
              | Extract<GraphEngineDestroyedEvent, { type: TType }>
              | Extract<GraphEngineViewChangedEvent, { type: TType }>
              | Extract<GraphEngineViewErrorEvent, { type: TType }>,
      ) => void,
  ): Unsubscribe

  Type Parameters

  • TType extends
        | "render:scheduled"
        | "render:before"
        | "render:after"
        | "render:error"
        | "layout:started"
        | "layout:completed"
        | "layout:stale"
        | "layout:cancelled"
        | "layout:error"
        | "engine:destroyed"
        | "view:changed"
        | "view:error"

  Parameters

  • type: TType
  • handler: (
        event:
            | Extract<GraphEngineRenderScheduledEvent, { type: TType }>
            | Extract<GraphEngineRenderBeforeEvent, { type: TType }>
            | Extract<GraphEngineRenderAfterEvent, { type: TType }>
            | Extract<GraphEngineRenderErrorEvent, { type: TType }>
            | Extract<GraphEngineLayoutStartedEvent, { type: TType }>
            | Extract<GraphEngineLayoutCompletedEvent, { type: TType }>
            | Extract<GraphEngineLayoutStaleEvent, { type: TType }>
            | Extract<GraphEngineLayoutCancelledEvent, { type: TType }>
            | Extract<GraphEngineLayoutErrorEvent, { type: TType }>
            | Extract<GraphEngineDestroyedEvent, { type: TType }>
            | Extract<GraphEngineViewChangedEvent, { type: TType }>
            | Extract<GraphEngineViewErrorEvent, { type: TType }>,
    ) => void

  Returns Unsubscribe

pick

• pick(point: ScreenPoint): GraphViewPickResult<NodeData, EdgeData> | null

  Parameters

  • point: ScreenPoint

  Returns GraphViewPickResult<NodeData, EdgeData> | null

refreshStyles

• refreshStyles(): void

  Reevaluate pure rules after application-owned captured state changes.

  Returns void

refreshView

• refreshView(): GraphViewRefreshResult<NodeData, EdgeData>

  Returns GraphViewRefreshResult<NodeData, EdgeData>

render

• render(): void

  Returns void

resize

• resize(size: ViewportSize): ViewportState

  Parameters

  • size: ViewportSize

  Returns ViewportState

runLayout

• runLayout(
      options?: GraphEngineLayoutOptions,
  ): Promise<GraphEngineLayoutRun | null>

  Parameters

  • options: GraphEngineLayoutOptions = {}

  Returns Promise<GraphEngineLayoutRun | null>

setDisplayDetail

• setDisplayDetail(options: DisplayDetailOptions): void

  Parameters

  • options: DisplayDetailOptions

  Returns void

setInteractionState

• setInteractionState(
      interaction: InteractionRenderStateInput,
  ): InteractionRenderState

  Parameters

  • interaction: InteractionRenderStateInput

  Returns InteractionRenderState

setLayoutGeometry

• setLayoutGeometry(geometry: LayoutGeometrySnapshot | null): void

  Install caller-owned layout measurements for the current graph version.

  Parameters

  • geometry: LayoutGeometrySnapshot | null

  Returns void

setStyleRules

• setStyleRules(rules: GraphStyleRules<NodeData, EdgeData>): void

  Preflight a complete ordered rule configuration before publishing it.

  Parameters

  • rules: GraphStyleRules<NodeData, EdgeData>

  Returns void

setViewFilterEnabled

• setViewFilterEnabled(
      id: string,
      enabled: boolean,
  ): GraphViewRefreshResult<NodeData, EdgeData>

  Parameters

  • id: string
  • enabled: boolean

  Returns GraphViewRefreshResult<NodeData, EdgeData>

setViewFilters

• setViewFilters(
      filters: readonly GraphViewFilter<NodeData, EdgeData>[],
  ): GraphViewRefreshResult<NodeData, EdgeData>

  Parameters

  • filters: readonly GraphViewFilter<NodeData, EdgeData>[]

  Returns GraphViewRefreshResult<NodeData, EdgeData>

setViewport

• setViewport(viewport: ViewportPartial): ViewportState

  Parameters

  • viewport: ViewportPartial

  Returns ViewportState

snapshot

• snapshot(): GraphSnapshot<NodeData, EdgeData>

  Returns GraphSnapshot<NodeData, EdgeData>

unmount

• unmount(): void

  Returns void

updateViewFilter

• updateViewFilter(
      id: string,
      replacement: GraphViewFilter<NodeData, EdgeData>,
  ): GraphViewRefreshResult<NodeData, EdgeData>

  Parameters

  • id: string
  • replacement: GraphViewFilter<NodeData, EdgeData>

  Returns GraphViewRefreshResult<NodeData, EdgeData>

viewSnapshot

• viewSnapshot(): GraphViewSnapshot<NodeData, EdgeData>

  Returns GraphViewSnapshot<NodeData, EdgeData>