Interface KMLGroundOverlayFeatureProperties

Provides type-hinting to consumers of the KML Feature.

Since

2020.1

interface KMLGroundOverlayFeatureProperties {
    address: null | string;
    altitude: number;
    altitudeMode: KMLAltitudeMode;
    bounds: Bounds;
    color: null | string;
    description: null | string;
    drawOrder: null | number;
    errorMessages: null | string[];
    icon: KMLLink;
    name: null | string;
    open: boolean;
    phoneNumber: null | string;
    rotation: number;
    snippet: null | KMLSnippet;
    timeSpan: null | KMLTimeSpan;
    timeStamp: null | string;
    visibility: boolean;
}

Hierarchy (view full)

Properties

address altitude altitudeMode bounds color description drawOrder errorMessages icon name open phoneNumber rotation snippet timeSpan timeStamp visibility

Properties

address

address: null | string

A plain-text address that corresponds to the feature.

altitude

altitude: number

Specifies the distance above the earth's surface, in meters, and is interpreted according to the altitude mode.

Since

2021.0

altitudeMode

altitudeMode: KMLAltitudeMode

Specifies how the KMLAltitudeMode.CLAMP_TO_GROUND (default) or KMLAltitudeMode.ABSOLUTE.

Since

2021.0

bounds

bounds: Bounds

The bounds of the GroundOverlay's LatLonBox, without rotation.

Since

2021.0

color

color: null | string

Specifies the color of this overlay

Since

2021.0

description

description: null | string

The long-form description that should appear in a balloon or information panel.

drawOrder

drawOrder: null | number

Specifies the stacking order for the images in overlapping overlays

Since

2021.0

errorMessages

errorMessages: null | string[]

Any error messages generated while parsing the feature.

Since

2021.0

icon

icon: KMLLink

Specifies the location of the resource fetched by this overlay.

Since

2021.0

name

name: null | string

User-defined label for the entity.

open

open: boolean

Specifies whether the feature should be expanded or collapsed in the UI panel.

phoneNumber

phoneNumber: null | string

A phone number that corresponds to the feature.

rotation

rotation: number

Specifies a rotation of the overlay about its center, in degrees. Values can be ±180. The default is 0 (north). Rotations are specified in a counterclockwise direction.

Since

2021.0

snippet

snippet: null | KMLSnippet

The snippet that is often displayed in a tree or other UI panel.

timeSpan

timeSpan: null | KMLTimeSpan

A span of time corresponding to the feature.

Since

2021.0

timeStamp

timeStamp: null | string

A moment in time corresponding to the feature. The value may be formatted as any of the following XML types: dateTime, date, gYearMonth, gYear. See ISO 8601 formats for details.

Since

2021.0

visibility

visibility: boolean

Whether the element should be visible on the Map. This is often represented in a list using a checkbox. If visibility is set to false, the KMLPainter will not draw the KML feature on the map.

Settings

Member Visibility

Theme

On This Page

addressaltitudealtitudeModeboundscolordescriptiondrawOrdererrorMessagesiconnameopenphoneNumberrotationsnippettimeSpantimeStampvisibility