Reference Source
public class | source

Annotation

Extends:

ComponentMarker → Annotation

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

See AnnotationsPlugin for more info.

Member Summary

Public Members
public

eye: Number[]

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

public

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

public

The AnnotationsPlugin this Annotation was created by.

public

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.

Method Summary

Public Methods
public

Destroys this Annotation.

public

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

See AnnotationsPlugin for more info.

public

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

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

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

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

The Component that owns the lifecycle of this Component, if any.

public

True as soon as this Component has been destroyed

public

ID of this Component, unique within the Scene.

public

meta: *

Arbitrary, user-defined metadata on this component.

public

The parent Scene that contains this Component.

public

The viewer that contains this Scene.

public

clear()

Destroys all Components that are owned by this.

public

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

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

warn(message: String)

Logs a warning for this component to the JavaScript console.

From class Marker
public get

Canvas-space 2D coordinates of this Marker.

public get

Gets the Entity this Marker is associated with.

public set

Sets the Entity this Marker is associated with.

public get

Gets whether occlusion testing is performed for this Marker.

public set

Sets whether occlusion testing is performed for this Marker.

public get

View-space 3D coordinates of this Marker.

public get

Indicates if this Marker is currently visible.

public get

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

public set

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

public

Destroys this Marker.

Public Members

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 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:

NameTypeAttributeDescription
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:

NameTypeAttributeDescription
key String

Identifies the field.

value String

The field's value.

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:

NameTypeAttributeDescription
shown Boolean

Whether to show the label.

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:

NameTypeAttributeDescription
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:

NameTypeAttributeDescription
values {String: String|Number}

Map of field values.