Class: Annotation

Annotation(position, attributes)

Represents an Annotation shape. An annotation displays a callout, a text and a leader pointing the annotation's geographic position to the ground.

Constructor

new Annotation(position, attributes)

Constructs an annotation.
Parameters:
Name Type Description
position Position The annotations's geographic position.
attributes AnnotationAttributes The attributes to associate with this annotation.
Source:
Throws:
If the specified position is null or undefined.
Type
ArgumentError

Extends

Members

altitudeMode

This annotation's altitude mode. May be one of
  • WorldWind.ABSOLUTE
  • WorldWind.RELATIVE_TO_GROUND
  • WorldWind.CLAMP_TO_GROUND
Default Value:
  • WorldWind.ABSOLUTE
Source:

attributes :AnnotationAttributes

The annotation's attributes.
Type:
Default Value:
Source:

displayName :String

The display name of the renderable.
Type:
  • String
Inherited From:
Default Value:
  • "Renderable"
Source:

enabled :Boolean

Indicates whether to display this renderable.
Type:
  • Boolean
Overrides:
Default Value:
  • true
Source:

pickDelegate :Object

Indicates the object to return as the userObject of this shape when picked. If null, then this shape is returned as the userObject.
Type:
  • Object
Overrides:
Default Value:
  • null
Source:
See:

position :Position

This annotation's geographic position.
Type:
Source:

text :String

The text for this annotation.
Type:
  • String
Source:

userProperties :Object

An application defined object associated with this renderable. A typical use case is to associate application defined data with a picked renderable.
Type:
  • Object
Inherited From:
Default Value:
  • An empty object
Source:

Methods

clone() → {Annotation}

Creates a new annotation that is a copy of this annotation.
Source:
Returns:
The new annotation.
Type
Annotation

copy(that)

Copies the contents of a specified annotation to this annotation.
Parameters:
Name Type Description
that Annotation The Annotation to copy.
Source:

render(dc)

Renders this annotation. This method is typically not called by applications but is called by RenderableLayer during rendering. For this shape this method creates and enques an ordered renderable with the draw context and does not actually draw the annotation.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Overrides:
Source:

renderOrdered(dc)

Draws this shape as an ordered renderable. Applications do not call this function. It is called by WorldWindow during rendering.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Source: