ViewerHighlightAPI#

Interface ViewerHighlightAPI

Hierarchy

ViewerHighlightAPI
- ViewerAPI

Index

Methods

dehighlightEntity highlightArc highlightBBox highlightCircularArc highlightEntity highlightLine highlightPoint

Methods

dehighlightEntity

dehighlightEntity(highlightHandle?): void
Disable highlighting for the handle
Parameters
- Optional highlightHandle: number
  
  : number
Returns void

highlightArc

highlightArc(pickedPt1, pickedPt3, center, axis, angle, measurementID): number
Parameters
- pickedPt1: Float32Array | [number, number, number]
- pickedPt3: Float32Array | [number, number, number]
- center: Float32Array | [number, number, number]
- axis: Float32Array | [number, number, number]
- angle: number
- measurementID: number
Returns number

highlightBBox

highlightBBox(center, size): number
Parameters
- center: Float32Array | [number, number, number]
- size: Float32Array | [number, number, number]
Returns number

highlightCircularArc

highlightCircularArc(circularArcDescriptor): number
Parameters
- circularArcDescriptor: TopologyCircularArcDescriptor
Returns number

highlightEntity

highlightEntity(handle, highlightParameters?): Promise<number>
Enable highlighting of the entity , which matches the attributes informed in the viewerDataSelector
Parameters
- handle: TopologyHandle
  
  : IViewerHighlightSelector
- Optional highlightParameters: ViewerHighlightParameters
Returns Promise<number>
the highlightHandle, which it reqed to remove the highlighting

highlightLine

highlightLine(values, scale, markerIndex): void
Parameters
- values: number[]
- scale: number
- markerIndex: number
Returns void

highlightPoint

highlightPoint(position, markerIndex): void
Parameters
- position: Float32Array | [number, number, number]
- markerIndex: number
Returns void