Class: KmlIconStyle

KmlIconStyle(options) → {KmlIconStyle}

Contains the data associated with IconStyle node

Constructor

new KmlIconStyle(options) → {KmlIconStyle}

Constructs an KmlIconStyle. Applications usually don't 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 IconStyle in the document.
Source:
See:
Throws:
If the node is null or undefined
Type
ArgumentError
Returns:
Type
KmlIconStyle

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) kmlHeading :Number

Direction in degrees of the icon.
Type:
  • Number
Source:

(readonly) kmlHotSpotX :String

Either the number of pixels, a fractional component of the icon, or a pixel inset indicating the x component of a point on the icon.
Type:
  • String
Source:

(readonly) kmlHotSpotXUnits :String

Units in which the x value is specified. A value of fraction indicates the x value is a fraction of the icon. A value of pixels indicates the x value in pixels. A value of insetPixels indicates the indent from the right edge of the icon.
Type:
  • String
Source:

(readonly) kmlHotSpotY :String

Either the number of pixels, a fractional component of the icon, or a pixel inset indicating the y component of a point on the icon.
Type:
  • String
Source:

(readonly) kmlHotSpotYUnits :String

Units in which the y value is specified. A value of fraction indicates the y value is a fraction of the icon. A value of pixels indicates the y value in pixels. A value of insetPixels indicates the indent from the top edge of the icon.
Type:
  • String
Source:

(readonly) kmlIcon :KmlIcon

Custom Icon. If the icon is part of the IconStyle, only href is allowed for the icon.
Type:
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: