ViewerHighlightAPI

• ViewerHighlightAPI

Interface ViewerHighlightAPI

interface ViewerHighlightAPI {
    dehighlightEntity(highlightHandle?: number): void;
    highlightArc(
        pickedPt1: Vector3 | Float32Array<ArrayBufferLike>,
        pickedPt3: Vector3 | Float32Array<ArrayBufferLike>,
        center: Vector3 | Float32Array<ArrayBufferLike>,
        axis: Vector3 | Float32Array<ArrayBufferLike>,
        angle: number,
        measurementID: number,
    ): number;
    highlightBBox(
        center: Vector3 | Float32Array<ArrayBufferLike>,
        size: Vector3 | Float32Array<ArrayBufferLike>,
    ): number;
    highlightCircularArc(
        circularArcDescriptor: TopologyCircularArcDescriptor,
    ): number;
    highlightEntity(
        handle: TopologyHandle,
        highlightParameters?: ViewerHighlightParameters,
    ): Promise<number>;
    highlightLine(values: number[], scale: number, markerIndex: number): void;
    highlightPoint(
        position: Vector3 | Float32Array<ArrayBufferLike>,
        markerIndex: number,
    ): void;
}

Hierarchy (View Summary)

• ViewerHighlightAPI
  • ViewerAPI

Index

Methods

dehighlightEntity highlightArc highlightBBox highlightCircularArc highlightEntity highlightLine highlightPoint

Methods

dehighlightEntity

• dehighlightEntity(highlightHandle?: number): void

  Disable highlighting for the handle

  Parameters

  • OptionalhighlightHandle: number

    : number

  Returns void

highlightArc

• highlightArc(
      pickedPt1: Vector3 | Float32Array<ArrayBufferLike>,
      pickedPt3: Vector3 | Float32Array<ArrayBufferLike>,
      center: Vector3 | Float32Array<ArrayBufferLike>,
      axis: Vector3 | Float32Array<ArrayBufferLike>,
      angle: number,
      measurementID: number,
  ): number

  Parameters

  • pickedPt1: Vector3 | Float32Array<ArrayBufferLike>
  • pickedPt3: Vector3 | Float32Array<ArrayBufferLike>
  • center: Vector3 | Float32Array<ArrayBufferLike>
  • axis: Vector3 | Float32Array<ArrayBufferLike>
  • angle: number
  • measurementID: number

  Returns number

highlightBBox

• highlightBBox(
      center: Vector3 | Float32Array<ArrayBufferLike>,
      size: Vector3 | Float32Array<ArrayBufferLike>,
  ): number

  Parameters

  • center: Vector3 | Float32Array<ArrayBufferLike>
  • size: Vector3 | Float32Array<ArrayBufferLike>

  Returns number

highlightCircularArc

• highlightCircularArc(
      circularArcDescriptor: TopologyCircularArcDescriptor,
  ): number

  Parameters

  • circularArcDescriptor: TopologyCircularArcDescriptor

  Returns number

highlightEntity

• highlightEntity(
      handle: TopologyHandle,
      highlightParameters?: ViewerHighlightParameters,
  ): Promise<number>

  Enable highlighting of the entity , which matches the attributes informed in the viewerDataSelector

  Parameters

  • handle: TopologyHandle

    : IViewerHighlightSelector

  • OptionalhighlightParameters: ViewerHighlightParameters

  Returns Promise<number>

  the highlightHandle, which it reqed to remove the highlighting

highlightLine

• highlightLine(values: number[], scale: number, markerIndex: number): void

  Parameters

  • values: number[]
  • scale: number
  • markerIndex: number

  Returns void

highlightPoint

• highlightPoint(
      position: Vector3 | Float32Array<ArrayBufferLike>,
      markerIndex: number,
  ): void

  Parameters

  • position: Vector3 | Float32Array<ArrayBufferLike>
  • markerIndex: number

  Returns void

---

Was this page helpful? Please leave a thumbs up or down.

👍 Yes 👎 No