Class: KmlLabelStyle

KmlLabelStyle(options)

Contains the data associated with LabelStyle

Constructor

new KmlLabelStyle(options)

Constructs an KmlLabelStyle. Applications don't usually call this constructor. It is called by KmlFile as objects from KmlFile are read. This object is already concrete implementation.
Parameters:
Name Type Description
options Object
Properties
Name Type Description
objectNode Node Node representing the LabelStyle in the document.
Source:
See:
Throws:
If node is null or undefined.
Type
ArgumentError

Extends

Members

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
Inherited From:
Default Value:
  • true
Source:

(readonly) id :String

Every object, which is part of the KML document has its identity. We will use it for changes in the document for binding.
Type:
  • String
Inherited From:
Source:

(readonly) kmlColor :String

Color, which should be used. Shapes supporting colored styles must correctly apply the color.
Type:
  • String
Inherited From:
Source:

(readonly) kmlColorMode :String

Either normal or random. Normal means applying of the color as stated. Random applies linear scale based on the color. More on https://developers.google.com/kml/documentation/kmlreference#colorstyle
Type:
  • String
Inherited From:
Source:

(readonly) kmlScale :Number

Scale in which to resize the icon.
Type:
  • Number
Source:

(readonly) node :Node

Node of this object. It may be overridden by other users of some functions like parse.
Type:
  • Node
Inherited From:
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
Inherited From:
Default Value:
  • null
Source:
See:

timeRange :Array.<Date>

An array with two elements: start time and end time of the visible range.
Type:
  • Array.<Date>
Inherited From:
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

getTagNames() → {Array.<String>}

Returns tag name of all descendants of abstract node or the tag name for current node.
Overrides:
Source:
Returns:
Type
Array.<String>

hook(controls, options)

It calls all controls associated with current KmlFile with the link to this.
Parameters:
Name Type Description
controls Array.<KmlControls> Controls associated with current tree.
options Object Options to pass into the controls.
Inherited From:
Source:

render(dc)

Render this renderable. Some shapes actually draw themselves during this call, others only add themselves to the draw context's ordered rendering list for subsequent drawing when their renderOrdered method is called. This method is intended to be called by layers such as RenderableLayer and not by applications.
Parameters:
Name Type Description
dc DrawContext The current draw context.
Inherited From:
Source: