Class Annotation

Annotation HTML element floating on top of a position rendered in 3d

Hierarchy

Annotation

Index

Constructors

constructor

Properties

Accessors

position

Methods

Constructors

constructor

new Annotation(component: Component, position: Vector3, content: string | HTMLElement, params?: AnnotationParams): Annotation

- Defined in backend/src/component/annotation.ts:40
Parameters
- component: Component
  
  the associated component
- position: Vector3
  
  position in 3d
- content: string | HTMLElement
  
  HTML content
- Default value params: AnnotationParams = {}
Returns Annotation

Properties

Private _cameraPosition

_cameraPosition: Vector3

Private _canvasPosition

_canvasPosition: Vector2

Private _clientRect

_clientRect: ClientRect

Private _position

_position: Vector3

Private _viewerPosition

_viewerPosition: Vector3

applyFog

applyFog: boolean

Readonly component

component: Component

the associated component

element

element: HTMLElement

offsetX

offsetX: number

offsetY

offsetY: number

stage

stage: Stage

viewer

viewer: Viewer

visible

visible: boolean

Accessors

position

get position(): Vector3

- Defined in backend/src/component/annotation.ts:83
Returns Vector3

Methods

_update

_update(): void

- Defined in backend/src/component/annotation.ts:156
Returns void

_updateViewerPosition

_updateViewerPosition(): void

- Defined in backend/src/component/annotation.ts:150
Returns void

clearContent

clearContent(): void

- Defined in backend/src/component/annotation.ts:126
Returns void

dispose

dispose(): void

- Defined in backend/src/component/annotation.ts:194
Safely remove the annotation

Returns void

getVisibility

getVisibility(): boolean

- Defined in backend/src/component/annotation.ts:142
Returns boolean

setContent

setContent(value: string | HTMLElement): void

- Defined in backend/src/component/annotation.ts:92
Set HTML content of the annotation

Parameters
- value: string | HTMLElement
  
  HTML content
Returns void

setPosition

setPosition(newPos: Vector3): void

- Defined in backend/src/component/annotation.ts:120
Parameters
- newPos: Vector3
Returns void

setVisibility

setVisibility(value: boolean): void

- Defined in backend/src/component/annotation.ts:137
Set visibility of the annotation

Parameters
- value: boolean
  
  visibility flag
Returns void

updateVisibility

updateVisibility(): void

- Defined in backend/src/component/annotation.ts:146
Returns void

Generated using TypeDoc