Interface KMLOverlayFeatureProperties

Provides type-hinting to consumers of the KML Feature.

2021.0

interface KMLOverlayFeatureProperties {
    address: null | string;
    color: null | string;
    description: null | string;
    drawOrder: null | number;
    errorMessages: null | string[];
    icon: KMLLink;
    name: null | string;
    open: boolean;
    phoneNumber: null | string;
    snippet: null | KMLSnippet;
    timeSpan: null | KMLTimeSpan;
    timeStamp: null | string;
    visibility: boolean;
    [key: string]: any;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: any

Properties

address color description drawOrder errorMessages icon name open phoneNumber snippet timeSpan timeStamp visibility

Properties

address: null | string

A plain-text address that corresponds to the feature.

color: null | string

Specifies the color of this overlay

2021.0

description: null | string

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

drawOrder: null | number

Specifies the stacking order for the images in overlapping overlays

2021.0

errorMessages: null | string[]

Any error messages generated while parsing the feature.

2021.0

icon: KMLLink

Specifies the location of the resource fetched by this overlay.

2021.0

name: null | string

User-defined label for the entity.

open: boolean

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

phoneNumber: null | string

A phone number that corresponds to the feature.

snippet: null | KMLSnippet

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

timeSpan: null | KMLTimeSpan

A span of time corresponding to the feature.

2021.0

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.

2021.0

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

On This Page

Properties