Interface KMLScreenOverlayFeatureProperties

Provides type-hinting to consumers of the KML Feature.

Since

2021.0

interface KMLScreenOverlayFeatureProperties {
    address: null | string;
    color: null | string;
    description: null | string;
    drawOrder: null | number;
    errorMessages: null | string[];
    icon: KMLLink;
    name: null | string;
    open: boolean;
    overlayXY: KMLXYVector;
    phoneNumber: null | string;
    rotation: number;
    rotationXY: KMLXYVector;
    screenXY: KMLXYVector;
    size: KMLXYVector;
    snippet: null | KMLSnippet;
    timeSpan: null | KMLTimeSpan;
    timeStamp: null | string;
    visibility: boolean;
}

Hierarchy (view full)

Properties

address color description drawOrder errorMessages icon name open overlayXY phoneNumber rotation rotationXY screenXY size snippet timeSpan timeStamp visibility

Properties

address

address: null | string

A plain-text address that corresponds to the feature.

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.

overlayXY

overlayXY: KMLXYVector

Specifies a point on (or outside of) the overlay image that is mapped to the screen coordinate ().

phoneNumber

phoneNumber: null | string

A phone number that corresponds to the feature.

rotation

rotation: number

Specifies an angle in degrees counterclockwise from north for the rotation of the overlay.

rotationXY

rotationXY: KMLXYVector

Specifies a point relative to the screen about which the screen overlay is rotated.

screenXY

screenXY: KMLXYVector

Specifies a point relative to the screen origin that the overlay image is mapped to.

size

size: KMLXYVector

Specifies the size of the image for the screen overlay per the KML spec.

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

addresscolordescriptiondrawOrdererrorMessagesiconnameopenoverlayXYphoneNumberrotationrotationXYscreenXYsizesnippettimeSpantimeStampvisibility