TopologyAPI

• webVis API Reference
• TopologyAPI

Interface TopologyAPI

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

interface TopologyAPI {
    addTopologyToSelection(
        handle: TopologyHandle | TopologyHandle[],
    ): Promise<void>;
    clearTopologySelection(): Promise<void>;
    createCircularArcDescriptor(
        point0: [number, number, number],
        point1: [number, number, number],
        point2: [number, number, number],
    ): { descriptor: TopologyCircularArcDescriptor; type: CIRCULAR_ARC };
    createPointDescriptor(
        point: [number, number, number],
    ): { descriptor: TopologyPointDescriptor; type: POINT };
    getSelectedTopologyHandles(): TopologyHandle[];
    getShapeHandle(handle: TopologyHandle): TopologyHandle;
    getTopologyType(handle: TopologyHandle): TopologyType;
    isTopologySelected(handle: TopologyHandle): boolean;
    mapInternalToOriginalTopologyHandles(
        handles: TopologyHandle[],
    ): Promise<OriginalTopologyHandle[]>;
    mapOriginalToInternalTopologyHandles(
        nodeID: number,
        handles: OriginalTopologyHandle[],
    ): Promise<TopologyHandle[]>;
    removeTopologyFromSelection(
        handle: TopologyHandle | TopologyHandle[],
    ): Promise<void>;
    requestBoxDescriptor(
        nodeIds: number[],
    ): Promise<{ descriptor: TopologyBoxDescriptor; type: BOX }>;
    requestTopologyDescriptor(
        handle: TopologyHandle,
    ): Promise<TopologyDescriptor>;
    setTopologyProperty<T extends keyof TopologyPropertyTypeMap>(
        handle: TopologyHandle | TopologyHandle[],
        property: T,
        value: TopologyPropertyTypeMap[T],
    ): Promise<PromiseSettledResult<void>[]>;
    setTopologySelection(
        handle: TopologyHandle | TopologyHandle[],
    ): Promise<void>;
}

Hierarchy (View Summary)

• TopologyAPI
  • ContextAPI

Index

Methods

addTopologyToSelection clearTopologySelection createCircularArcDescriptor createPointDescriptor getSelectedTopologyHandles getShapeHandle getTopologyType isTopologySelected mapInternalToOriginalTopologyHandles mapOriginalToInternalTopologyHandles removeTopologyFromSelection requestBoxDescriptor requestTopologyDescriptor 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>

createCircularArcDescriptor

• createCircularArcDescriptor(
      point0: [number, number, number],
      point1: [number, number, number],
      point2: [number, number, number],
  ): { 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: [number, number, number],
  ): { 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): 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: 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>

requestBoxDescriptor

• requestBoxDescriptor(
      nodeIds: number[],
  ): 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: TopologyHandle): 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 extends keyof TopologyPropertyTypeMap>(
      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>

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)