TopologyAPI

• webVis API Reference
• TopologyAPI

Interface TopologyAPI

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

Hierarchy

• TopologyAPI
  • ContextAPI

Index

Methods

addTopologyToSelection clearTopologySelection getSelectedTopologyHandles getTopologyType isTopologySelected mapInternalToOriginalTopologyHandles mapOriginalToInternalTopologyHandles removeTopologyFromSelection setTopologyProperty setTopologySelection

Methods

addTopologyToSelection

• addTopologyToSelection(handle: TopologyHandle | TopologyHandle[]): 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>

getSelectedTopologyHandles

• getSelectedTopologyHandles(): TopologyHandle[]

• Returns a list of all selected topology elements.

  Returns TopologyHandle[]

  A List of all selected Topology elements.

getTopologyType

• getTopologyType(handle: TopologyHandle): 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: TopologyHandle): 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: TopologyHandle[]): 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: number, handles: OriginalTopologyHandle[]): 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: TopologyHandle | TopologyHandle[]): 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>

setTopologyProperty

• setTopologyProperty<T>(handle: TopologyHandle | TopologyHandle[], property: T, value: TopologyPropertyTypeMap[T]): 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: TopologyHandle | TopologyHandle[]): 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>