Interface KMLFeatureProperties

Provides type-hinting to consumers of the KML Feature.

Since

2020.1

interface KMLFeatureProperties {
    address: null | string;
    description: null | string;
    errorMessages: null | string[];
    name: null | string;
    open: boolean;
    phoneNumber: null | string;
    snippet: null | KMLSnippet;
    timeSpan: null | KMLTimeSpan;
    timeStamp: null | string;
    visibility: boolean;
}

Hierarchy (view full)

Properties

address description errorMessages name open phoneNumber snippet timeSpan timeStamp visibility

Properties

address

address: null | string

A plain-text address that corresponds to the feature.

description

description: null | string

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

errorMessages

errorMessages: null | string[]

Any error messages generated while parsing the feature.

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.

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

addressdescriptionerrorMessagesnameopenphoneNumbersnippettimeSpantimeStampvisibility