TopologyAPI

Interface TopologyAPI

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

Hierarchy

Methods

  • 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>

  • Clears the current Topology Selection.

    Returns Promise<void>

  • Returns a list of all selected topology elements.

    Returns TopologyHandle[]

    A List of all selected Topology elements.

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

    Parameters

    Returns TopologyHandle

    • The corresponding Shape of the specified Topology Element.
  • Returns the type of the given topology element

    Parameters

    Returns TopologyType

    The type of the given topology element

  • 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.

  • 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.

  • 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.

  • 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>

  • Returns a detailed description of the Topology Element.

    Parameters

    Returns Promise<TopologyDescriptor>

    The detailed description of the Topological Element.

  • Sets a Property of one or multiple Topology Elements.

    Type Parameters

    Parameters

    Returns Promise<PromiseSettledResult<void>[]>

  • Selects the specified Topology Elements.

    Parameters

    Returns Promise<void>