Class Graph

constructor

• new Graph(id?, attributes?): Graph

• Parameters

  • Optional id: string
  • Optional attributes: GraphAttributesObject

  Returns Graph

• new Graph(id?, strict?, attributes?): Graph

• Parameters

  • Optional id: string
  • Optional strict: boolean
  • Optional attributes: GraphAttributesObject

  Returns Graph

• new Graph(strict?, attributes?): Graph

• Parameters

  • Optional strict: boolean
  • Optional attributes: GraphAttributesObject

  Returns Graph

• new Graph(attributes?): Graph

• Parameters

  • Optional attributes: GraphAttributesObject

  Returns Graph

Readonly attributes

Optional comment

Optional Readonly id

strict

$$type

• get $$type(): "Graph"

• Returns "Graph"

edges

• get edges(): readonly EdgeModel[]

• Returns readonly EdgeModel[]

nodes

• get nodes(): readonly NodeModel[]

• Returns readonly NodeModel[]

size

• get size(): number

• Returns number

subgraphs

• get subgraphs(): readonly SubgraphModel[]

• Returns readonly SubgraphModel[]

values

• get values(): readonly [T, Attribute<T>][]

• Returns readonly [T, Attribute<T>][]

addEdge

• addEdge(edge): void

• Parameters

  • edge: EdgeModel

  Returns void

addNode

• addNode(node): void

• Parameters

  • node: NodeModel

  Returns void

addSubgraph

• addSubgraph(subgraph): void

• Parameters

  • subgraph: SubgraphModel

  Returns void

apply

• apply(attributes): void

• Parameters

  • attributes: AttributesObject<values> | AttributesEntities<values>

  Returns void

clear

• clear(): void

• Returns void

createEdge

• createEdge(targets, attributes?): EdgeModel

• Parameters

  • targets: EdgeTargetLikeTuple
  • Optional attributes: EdgeAttributesObject

  Returns EdgeModel

createNode

• createNode(id, attributes?): NodeModel

• Parameters

  • id: string
  • Optional attributes: NodeAttributesObject

  Returns NodeModel

createSubgraph

• createSubgraph(id?, attributes?): SubgraphModel

• Parameters

  • Optional id: string
  • Optional attributes: SubgraphAttributesObject

  Returns SubgraphModel

• createSubgraph(attributes?): SubgraphModel

• Parameters

  • Optional attributes: SubgraphAttributesObject

  Returns SubgraphModel

delete

• delete(key): void

• Parameters

  • key: values

  Returns void

edge

• edge(targets, callback?): EdgeModel

• Parameters

  • targets: EdgeTargetLikeTuple
  • Optional callback: ((edge) => void)
    • • (edge): void

      • Parameters

        • edge: EdgeModel

        Returns void

  Returns EdgeModel

• edge(targets, attributes, callback?): EdgeModel

• Parameters

  • targets: EdgeTargetLikeTuple
  • attributes: EdgeAttributesObject
  • Optional callback: ((edge) => void)
    • • (edge): void

      • Parameters

        • edge: EdgeModel

        Returns void

  Returns EdgeModel

• edge(attributes): void

• Parameters

  • attributes: EdgeAttributesObject

  Returns void

existEdge

• existEdge(edge): boolean

• Parameters

  • edge: EdgeModel

  Returns boolean

existNode

• existNode(nodeId): boolean

• Parameters

  • nodeId: string

  Returns boolean

existSubgraph

• existSubgraph(subgraph): boolean

• Parameters

  • subgraph: SubgraphModel

  Returns boolean

get

• get<K>(key): undefined | Attribute<K>

• Type Parameters

  • K extends values

  Parameters

  • key: K

  Returns undefined | Attribute<K>

getNode

• getNode(id): undefined | NodeModel

• Parameters

  • id: string

  Returns undefined | NodeModel

getSubgraph

• getSubgraph(id): undefined | SubgraphModel

• Parameters

  • id: string

  Returns undefined | SubgraphModel

graph

• graph(attributes): void

• Parameters

  • attributes: SubgraphAttributesObject

  Returns void

node

• node(id, callback?): NodeModel

• Parameters

  • id: string
  • Optional callback: ((node) => void)
    • • (node): void

      • Parameters

        • node: NodeModel

        Returns void

  Returns NodeModel

• node(id, attributes, callback?): NodeModel

• Parameters

  • id: string
  • attributes: NodeAttributesObject
  • Optional callback: ((node) => void)
    • • (node): void

      • Parameters

        • node: NodeModel

        Returns void

  Returns NodeModel

• node(attributes): void

• Parameters

  • attributes: NodeAttributesObject

  Returns void

removeEdge

• removeEdge(edge): void

• Parameters

  • edge: EdgeModel

  Returns void

removeNode

• removeNode(node): void

• Parameters

  • node: string | NodeModel

  Returns void

removeSubgraph

• removeSubgraph(subgraph): void

• Parameters

  • subgraph: SubgraphModel

  Returns void

set

• set<K>(key, value): void

• Type Parameters

  • K extends values

  Parameters

  • key: K
  • value: Attribute<K>

  Returns void

subgraph

• subgraph(id, callback?): SubgraphModel

• Parameters

  • id: string
  • Optional callback: ((subgraph) => void)
    • • (subgraph): void

      • Parameters

        • subgraph: SubgraphModel

        Returns void

  Returns SubgraphModel

• subgraph(id, attributes, callback?): SubgraphModel

• Parameters

  • id: string
  • attributes: SubgraphAttributesObject
  • Optional callback: ((subgraph) => void)
    • • (subgraph): void

      • Parameters

        • subgraph: SubgraphModel

        Returns void

  Returns SubgraphModel

• subgraph(attributes, callback?): SubgraphModel

• Parameters

  • attributes: SubgraphAttributesObject
  • Optional callback: ((subgraph) => void)
    • • (subgraph): void

      • Parameters

        • subgraph: SubgraphModel

        Returns void

  Returns SubgraphModel

• subgraph(callback?): SubgraphModel

• Parameters

  • Optional callback: ((subgraph) => void)
    • • (subgraph): void

      • Parameters

        • subgraph: SubgraphModel

        Returns void

  Returns SubgraphModel

with

• with(models): void

• Parameters

  • models: Partial<ModelsContext>

  Returns void