import {Annotation} from '@xeokit/xeokit-sdk/src/plugins/AnnotationsPlugin/Annotation.js'

public class | source

Annotation

Extends:

Component → Marker → Annotation

A Marker with an HTML label attached to it, managed by an AnnotationsPlugin.

See AnnotationsPlugin for more info.

Member Summary

Public Members
public	entity: *
public	eye: Number[] Optional World-space position for Camera#eye, used when this Annotation is associated with a Camera position.
public	look: Number[] Optional World-space position for Camera#look, used when this Annotation is associated with a Camera position.
public	plugin: AnnotationsPlugin The AnnotationsPlugin this Annotation was created by.
public	projection: String Optional projection type for Camera#projection, used when this Annotation is associated with a Camera position.
public	up: Number[] Optional World-space position for Camera#up, used when this Annotation is associated with a Camera position.
public	worldPos: *

Method Summary

Public Methods
public	destroy() Destroys this Annotation.
public	getField(key: String): String Gets the value of a field within the HTML templates for either the Annotation's marker or label. See AnnotationsPlugin for more info.
public	getLabelShown(): Boolean Gets whether or not to show this Annotation's label. The label is only visible when both this property and Annotation#visible are `true`. See AnnotationsPlugin for more info.
public	getMarkerShown(): Boolean Gets whether or not to show this Annotation's marker. The marker shows the Annotation's position.
public	getValues(): * Gets the values that were set for the placeholders within this Annotation's HTML marker and label templates. See AnnotationsPlugin for more info.
public	setField(key: String, value: String) Sets the value of a field within the HTML templates for either the Annotation's marker or label. See AnnotationsPlugin for more info.
public	setFromPickResult(pickResult: PickResult) Sets the Marker's worldPos and entity properties based on passed PickResult
public	setLabelPosition(position: Number) Sets the relative horizontal position of the Annotation's label HTML.
public	setLabelShown(shown: Boolean) Sets whether or not to show this Annotation's label. The label is only visible when both this property and Annotation#visible are `true`. See AnnotationsPlugin for more info.
public	setMarkerAlign(align: String) Sets the horizontal alignment of the Annotation's marker HTML.
public	setMarkerShown(shown: Boolean) Sets whether or not to show this Annotation's marker. The marker shows the Annotation's position.
public	setValues(values: {String: String\|Number}) Sets values for multiple placeholders within the Annotation's HTML templates for marker and label. See AnnotationsPlugin for more info.

Inherited Summary

From class Component
public get	owner: Component The Component that owns the lifecycle of this Component, if any.
public	destroyed: Boolean True as soon as this Component has been destroyed
public	id: String \| Number ID of this Component, unique within the Scene.
public	meta: * Arbitrary, user-defined metadata on this component.
public	scene: Scene The parent Scene that contains this Component.
public	viewer: Viewer The viewer that contains this Scene.
public	clear() Destroys all Components that are owned by this.
public	destroy() Destroys this component.
public	error(message: String) Logs an error for this component to the JavaScript console.
public	fire(event: String, value: Object, forget: Boolean) Fires an event on this component.
public	hasSubs(event: String): Boolean Returns true if there are any subscribers to the given event on this component.
public	isType(type: ): : Boolean Tests if this component is of the given type, or is a subclass of the given type.
public	log(message: String) Logs a console debugging message for this component.
public	off(subId: String) Cancels an event subscription that was previously made with Component#on or Component#once.
public	on(event: String, callback: Function, scope: Object): String Subscribes to an event on this component.
public	once(event: String, callback: Function, scope: Object) Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.
public	scheduleTask(task: *) Schedule a task to perform on the next browser interval
public	warn(message: String) Logs a warning for this component to the JavaScript console.

From class Marker
public get	canvasPos: Number[] Canvas-space 2D coordinates of this Marker.
public get	entity: Entity Gets the Entity this Marker is associated with.
public set	entity: Entity Sets the Entity this Marker is associated with.
public get	occludable: Boolean Gets whether occlusion testing is performed for this Marker.
public set	occludable: Boolean Sets whether occlusion testing is performed for this Marker.
public get	origin: Number[] Gets the RTC center of this Marker.
public get	rtcPos: Number[] Gets the RTC position of this Marker.
public get	viewPos: Number[] View-space 3D coordinates of this Marker.
public get	visible: Boolean Indicates if this Marker is currently visible.
public get	worldPos: Number[] Gets the World-space 3D position of this Marker.
public set	worldPos: Number[] Sets the World-space 3D position of this Marker.
public	destroy() Destroys this Marker.

Public Members

public entity: * source

Sets the Entity this Marker is associated with.

An Entity is optional. When the Marker has an Entity, then Marker#visible will always be false if Entity#visible is false.

Override:

Marker#entity

public eye: Number[] source

Optional World-space position for Camera#eye, used when this Annotation is associated with a Camera position.

Undefined by default.

public look: Number[] source

Optional World-space position for Camera#look, used when this Annotation is associated with a Camera position.

Undefined by default.

public plugin: AnnotationsPlugin source

The AnnotationsPlugin this Annotation was created by.

public projection: String source

Optional projection type for Camera#projection, used when this Annotation is associated with a Camera position.

Undefined by default.

public up: Number[] source

Optional World-space position for Camera#up, used when this Annotation is associated with a Camera position.

Undefined by default.

public worldPos: * source

Sets the World-space 3D position of this Marker.

Fires a "worldPos" event with new World position.

Override:

Marker#worldPos

Public Methods

public destroy() source

Destroys this Annotation.

You can also call AnnotationsPlugin#destroyAnnotation.

Override:

Marker#destroy

public getField(key: String): String source

Gets the value of a field within the HTML templates for either the Annotation's marker or label.

See AnnotationsPlugin for more info.

Params:

Name	Type	Attribute	Description
key	String		Identifies the field.

Return:

String

The field's value.

public getLabelShown(): Boolean source

Gets whether or not to show this Annotation's label.

The label is only visible when both this property and Annotation#visible are true.

See AnnotationsPlugin for more info.

Return:

Boolean

Whether to show the label.

public getMarkerShown(): Boolean source

Gets whether or not to show this Annotation's marker.

The marker shows the Annotation's position.

The marker is only visible when both this property and Annotation#visible are true.

See AnnotationsPlugin for more info.

Return:

Boolean

Whether to show the marker.

public getValues(): * source

Gets the values that were set for the placeholders within this Annotation's HTML marker and label templates.

See AnnotationsPlugin for more info.

Return:

public setField(key: String, value: String) source

Sets the value of a field within the HTML templates for either the Annotation's marker or label.

See AnnotationsPlugin for more info.

Params:

Name	Type	Attribute	Description
key	String		Identifies the field.
value	String		The field's value.

public setFromPickResult(pickResult: PickResult) source

Sets the Marker's worldPos and entity properties based on passed PickResult

Params:

Name	Type	Attribute	Description
pickResult	PickResult		A PickResult to position the Marker at.

public setLabelPosition(position: Number) source

Sets the relative horizontal position of the Annotation's label HTML.

Params:

Name	Type	Attribute	Description
position	Number		Negative - to the left, positive - to the right, otherwise ignore (default 24)

public setLabelShown(shown: Boolean) source

Sets whether or not to show this Annotation's label.

The label is only visible when both this property and Annotation#visible are true.

See AnnotationsPlugin for more info.

Params:

Name	Type	Attribute	Description
shown	Boolean		Whether to show the label.

public setMarkerAlign(align: String) source

Sets the horizontal alignment of the Annotation's marker HTML.

Params:

Name	Type	Attribute	Description
align	String		Either "left", "center", "right" (default "left")

public setMarkerShown(shown: Boolean) source

Sets whether or not to show this Annotation's marker.

The marker shows the Annotation's position.

The marker is only visible when both this property and Annotation#visible are true.

See AnnotationsPlugin for more info.

Params:

Name	Type	Attribute	Description
shown	Boolean		Whether to show the marker.

public setValues(values: {String: String|Number}) source

Sets values for multiple placeholders within the Annotation's HTML templates for marker and label.

See AnnotationsPlugin for more info.

Params:

Name	Type	Attribute	Description
values	{String: String\|Number}		Map of field values.