Class CX2Network

constructor

• new CX2Network(data?: Partial<CX2Network>): CX2Network

  Parameters

  • Optionaldata: Partial<CX2Network>

  Returns CX2Network

CXVersion

hasFragments

metaData

OptionalattributeDeclarations

OptionalnetworkAttributes

Optionalnodes

Optionaledges

OptionalnodeBypass

OptionaledgeBypass

OptionalvisualProperties

Optionalstatus

StaticcreateEmpty

• createEmpty(): CX2Network

  Create a new empty CX2Network

  Returns CX2Network

StaticfromJSON

• fromJSON(json: string | object): CX2Network

  Create CX2Network from raw JSON data

  Parameters

  • json: string | object

  Returns CX2Network

StaticfromNetworkSummary

• fromNetworkSummary(summary: NetworkSummaryV3): CX2Network

  Create CX2Network from NetworkSummary (for compatibility)

  Parameters

  • summary: NetworkSummaryV3

  Returns CX2Network

addNode

• addNode(id: number, attributes?: Record<string, any>): CX2Node

  Add a node to the network

  Parameters

  • id: number
  • Optionalattributes: Record<string, any>

  Returns CX2Node

addEdge

• addEdge(
      id: number,
      sourceId: number,
      targetId: number,
      attributes?: Record<string, any>,
  ): CX2Edge

  Add an edge to the network

  Parameters

  • id: number
  • sourceId: number
  • targetId: number
  • Optionalattributes: Record<string, any>

  Returns CX2Edge

addNodeAttribute

• addNodeAttribute(nodeId: number, attributeName: string, value: any): void

  Add an individual node attribute

  Parameters

  • nodeId: number
  • attributeName: string
  • value: any

  Returns void

addEdgeAttribute

• addEdgeAttribute(edgeId: number, attributeName: string, value: any): void

  Add edge attributes (bulk)

  Parameters

  • edgeId: number
  • attributeName: string
  • value: any

  Returns void

setNodeCoordinates

• setNodeCoordinates(nodeId: number, x: number, y: number, z?: number): void

  Set node coordinates

  Parameters

  • nodeId: number
  • x: number
  • y: number
  • Optionalz: number

  Returns void

getNode

• getNode(id: number): undefined | CX2Node

  Get node by ID

  Parameters

  • id: number

  Returns undefined | CX2Node

getEdge

• getEdge(id: number): undefined | CX2Edge

  Get edge by ID

  Parameters

  • id: number

  Returns undefined | CX2Edge

getNodes

• getNodes(): CX2Node[]

  Get all nodes

  Returns CX2Node[]

getEdges

• getEdges(): CX2Edge[]

  Get all edges

  Returns CX2Edge[]

getNodeCount

• getNodeCount(): number

  Get node count

  Returns number

getEdgeCount

• getEdgeCount(): number

  Get edge count

  Returns number

getNetworkName

• getNetworkName(): undefined | string

  Get network name from attributes

  Returns undefined | string

setNetworkName

• setNetworkName(name: string): void

  Set network name

  Parameters

  • name: string

  Returns void

getNetworkAttribute

• getNetworkAttribute(key: string): any

  Get network attribute by key

  Parameters

  • key: string

  Returns any

setNetworkAttribute

• setNetworkAttribute(key: string, value: any): void

  Set network attribute

  Parameters

  • key: string
  • value: any

  Returns void

validate

• validate(): { isValid: boolean; errors: string[] }

  Validate the CX2 network structure

  Returns { isValid: boolean; errors: string[] }

toJSON

• toJSON(): string

  Convert to JSON string

  Returns string

clone

• clone(): CX2Network

  Create a deep copy of the network

  Returns CX2Network

getStatistics

• getStatistics(): {
      nodeCount: number;
      edgeCount: number;
      hasCoordinates: boolean;
      hasVisualProperties: boolean;
  }

  Get basic statistics about the network

  Returns {
      nodeCount: number;
      edgeCount: number;
      hasCoordinates: boolean;
      hasVisualProperties: boolean;
  }