import Annotation from 'ngl/src/component/annotation.js'

public class | source

Annotation

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

Constructor Summary

Public Constructor
public	constructor(component: Component, position: Vector3, content: String \| Element, params: Object)

Member Summary

Public Members
public	component
public	element
public	offsetX
public	offsetY
public	position
public	stage
public	viewer
public	visible

Private Members
private	_cameraPosition
private	_canvasPosition
private	_clientRect
private	_viewerPosition

Method Summary

Public Methods
public	dispose(): undefined Safely remove the annotation
public	getVisibility()
public	setContent(value: String \| Element): undefined Set HTML content of the annotation
public	setVisibility(value: Boolean): undefined Set visibility of the annotation
public	updateVisibility()

Private Methods
private	_update()
private	_updateViewerPosition()

Public Constructors

public constructor(component: Component, position: Vector3, content: String | Element, params: Object) source

Params:

Name	Type	Attribute	Description
component	Component		the associated component
position	Vector3		position in 3d
content	String \| Element		HTML content
params	Object	optional	parameters
params.offsetX	Integer		2d offset in x direction
params.offsetY	Integer		2d offset in y direction
params.visible	Boolean		visibility flag

Public Members

public component source

public element source

public offsetX source

public offsetY source

public position source

public stage source

public viewer source

public visible source

Private Members

private _cameraPosition source

private _canvasPosition source

private _clientRect source

private _viewerPosition source

Public Methods

public dispose(): undefined source

Safely remove the annotation

Return:

undefined

public getVisibility() source

public setContent(value: String | Element): undefined source

Set HTML content of the annotation

Params:

Name	Type	Attribute	Description
value	String \| Element		HTML content

Return:

undefined

public setVisibility(value: Boolean): undefined source

Set visibility of the annotation

Params:

Name	Type	Attribute	Description
value	Boolean		visibility flag

Annotation

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor(component: Component, position: Vector3, content: String | Element, params: Object) source

Params:

Public Members

public component source

public element source

public offsetX source

public offsetY source

public position source

public stage source

public viewer source

public visible source

Private Members

private _cameraPosition source

private _canvasPosition source

private _clientRect source

private _viewerPosition source

Public Methods

public dispose(): undefined source

Return:

public getVisibility() source

public setContent(value: String | Element): undefined source

Params:

Return:

public setVisibility(value: Boolean): undefined source

Params:

Return:

public updateVisibility() source

Private Methods

private _update() source

private _updateViewerPosition() source