TopologyAPI

• webVis API Reference
• TopologyAPI

Interface TopologyAPI

The TopologyAPI provides multiple functionalities to operate on the Topology level of a Shape.

Hierarchy

• TopologyAPI
  • ContextAPI

Index

Methods

addTopologyToSelection clearTopologySelection createCircularArcDescriptor createPointDescriptor getSelectedTopologyHandles getShapeHandle getTopologyType isTopologySelected mapInternalToOriginalTopologyHandles mapOriginalToInternalTopologyHandles removeTopologyFromSelection requestBoxDescriptor requestTopologyDescriptor setTopologyProperty setTopologySelection

Methods

addTopologyToSelection

• addTopologyToSelection(handle): Promise<void>

• Adds one or multiple Topology elements to the current selection.

  Parameters

  • handle: TopologyHandle | TopologyHandle[]

    A Topology Element or the list of Topology Elements which should be added to the current selection.

  Returns Promise<void>

clearTopologySelection

• clearTopologySelection(): Promise<void>

• Clears the current Topology Selection.

  Returns Promise<void>

createCircularArcDescriptor

• createCircularArcDescriptor(point0, point1, point2): {
      descriptor: TopologyCircularArcDescriptor;
      type: CIRCULAR_ARC;
  }

• Create Circular arc descriptor by the three specified points.

  Parameters

  • point0: [number, number, number]

    The first point.

  • point1: [number, number, number]

    The second point.

  • point2: [number, number, number]

    The third point.

  Returns {
      descriptor: TopologyCircularArcDescriptor;
      type: CIRCULAR_ARC;
  }

  • descriptor: TopologyCircularArcDescriptor

    The attributes of the Topological Element.

  • type: CIRCULAR_ARC

    The syb type of the Topological Element.

createPointDescriptor

• createPointDescriptor(point): {
      descriptor: TopologyPointDescriptor;
      type: POINT;
  }

• Create Point descriptor by the specified point.

  Parameters

  • point: [number, number, number]

    The point.

  Returns {
      descriptor: TopologyPointDescriptor;
      type: POINT;
  }

  • descriptor: TopologyPointDescriptor

    The attributes of the Topological Element.

  • type: POINT

    The syb type of the Topological Element.

getSelectedTopologyHandles

• getSelectedTopologyHandles(): TopologyHandle[]

• Returns a list of all selected topology elements.

  Returns TopologyHandle[]

  A List of all selected Topology elements.

getShapeHandle

• getShapeHandle(handle): TopologyHandle

• Returns a handle to the corresponding Shape of the specified Topology Element.

  Parameters

  • handle: TopologyHandle

    The Topology Handle.

  Returns TopologyHandle

  • The corresponding Shape of the specified Topology Element.

getTopologyType

• getTopologyType(handle): TopologyType

• Returns the type of the given topology element

  Parameters

  • handle: TopologyHandle

    The TopologyHandle.

  Returns TopologyType

  The type of the given topology element

isTopologySelected

• isTopologySelected(handle): boolean

• Checks if the specified Topology Element is part of the current selection.

  Parameters

  • handle: TopologyHandle

    The topology element which should be checked if it selected.

  Returns boolean

  A boolean value which indicates if the specified Topology Element is part of the current selection or not.

mapInternalToOriginalTopologyHandles

• mapInternalToOriginalTopologyHandles(handles): Promise<OriginalTopologyHandle[]>

• Maps the given webvis internal topology handles to original topology handles.

  Parameters

  • handles: TopologyHandle[]

    A list of webvis internal topology handles.

  Returns Promise<OriginalTopologyHandle[]>

  Promise<Array<OriginalTopologyHandle|undefined>> - A list of the corresponding original topology handles.

mapOriginalToInternalTopologyHandles

• mapOriginalToInternalTopologyHandles(nodeID, handles): Promise<TopologyHandle[]>

• Maps the given original topology handles to webvis internal topology handles.

  Parameters

  • nodeID: number

    The Node which specifies the Part the topology relates to.

  • handles: OriginalTopologyHandle[]

    A list of original topology handles.

  Returns Promise<TopologyHandle[]>

  Promise<Array<TopologyHandle|undefined>> - A list of the corresponding webvis internal topology handles.

removeTopologyFromSelection

• removeTopologyFromSelection(handle): Promise<void>

• Removes one or multiple Topology elements to the current selection.

  Parameters

  • handle: TopologyHandle | TopologyHandle[]

    A Topology Element or a list of Topology Elements which should be removed from the current selection.

  Returns Promise<void>

requestBoxDescriptor

• requestBoxDescriptor(nodeIds): Promise<{
      descriptor: TopologyBoxDescriptor;
      type: BOX;
  }>

• Returns a Box descriptor by the specified list of Node Ids.

  Parameters

  • nodeIds: number[]

    List of Node Ids.

  Returns Promise<{
      descriptor: TopologyBoxDescriptor;
      type: BOX;
  }>

  The Box descriptor for the given Node Ids.

requestTopologyDescriptor

• requestTopologyDescriptor(handle): Promise<TopologyDescriptor>

• Returns a detailed description of the Topology Element.

  Parameters

  • handle: TopologyHandle

    The Topology Element.

  Returns Promise<TopologyDescriptor>

  The detailed description of the Topological Element.

setTopologyProperty

• setTopologyProperty<T>(handle, property, value): Promise<PromiseSettledResult<void>[]>

• Sets a Property of one or multiple Topology Elements.

  Type Parameters

  • T extends keyof TopologyPropertyTypeMap

  Parameters

  • handle: TopologyHandle | TopologyHandle[]

  • property: T

    The property which should be set.

  • value: TopologyPropertyTypeMap[T]

  Returns Promise<PromiseSettledResult<void>[]>

setTopologySelection

• setTopologySelection(handle): Promise<void>

• Selects the specified Topology Elements.

  Parameters

  • handle: TopologyHandle | TopologyHandle[]

    A Topology Element or a list of Topology Elements to select.

  Returns Promise<void>