Skip To Content ArcGIS for Developers Sign In Dashboard

KmlLayer Class


A layer that can visualize KML data. More...

Header: #include <KmlLayer>
Since: Esri::ArcGISRuntime 100.4
Inherits: Layer and TimeAware

Public Functions

KmlLayer(Item *item, QObject *parent = nullptr)
KmlLayer(KmlDataset *dataset, QObject *parent = nullptr)
KmlDataset *dataset() const

Reimplemented Public Functions

virtual TimeExtent fullTimeExtent() const
virtual bool isSupportsTimeFiltering() const
virtual bool isTimeFilteringEnabled() const
virtual void setTimeFilteringEnabled(bool timeFilteringEnabled)
virtual void setTimeOffset(const TimeValue &timeOffset)
virtual TimeValue timeInterval() const
virtual TimeValue timeOffset() const


Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

A layer that can visualize KML data.

Member Function Documentation

KmlLayer::KmlLayer(Item *item, QObject *parent = nullptr)

Constructor that takes a Portal Item item and an optional parent.

KmlLayer::KmlLayer(KmlDataset *dataset, QObject *parent = nullptr)

Constructor that takes a dataset and an optional parent.



KmlDataset *KmlLayer::dataset() const

Returns the KML dataset for this layer.

The KML dataset is the authoritative source for the layer's KML data. The KML dataset should be used when access to the tree of KML nodes is needed (for example to build a legend or toggle node visibility).

[virtual] TimeExtent KmlLayer::fullTimeExtent() const

Reimplemented from TimeAware::fullTimeExtent().

Returns the full time extent of the layer.

[signal] void KmlLayer::fullTimeExtentChanged()

Signal emitted when the fullTimeExtent changes for this layer.

See also TimeAware.

[virtual] bool KmlLayer::isSupportsTimeFiltering() const

Reimplemented from TimeAware::isSupportsTimeFiltering().

Returns whether the layer supports filtering its contents by time values.

[virtual] bool KmlLayer::isTimeFilteringEnabled() const

Reimplemented from TimeAware::isTimeFilteringEnabled().

Returns whether the layer participates in filtering based on the time extent of its geoview.

[virtual] void KmlLayer::setTimeFilteringEnabled(bool timeFilteringEnabled)

Reimplemented from TimeAware::setTimeFilteringEnabled().

Sets whether the layer uses the time range defined on the geoview to timeFilteringEnabled.

See also isTimeFilteringEnabled().

[virtual] void KmlLayer::setTimeOffset(const TimeValue &timeOffset)

Reimplemented from TimeAware::setTimeOffset().

Sets the time offset of the layer to timeOffset.

The time offset is subtracted from the time extent set on the layer's geoview. This can be used to overlay data from different periods of time for comparison.

See also timeOffset().

[virtual] TimeValue KmlLayer::timeInterval() const

Reimplemented from TimeAware::timeInterval().

Returns a time interval that represents the suggested step size for use when manipulating the time extent.

This information can be used to set the step size for a time slider control.

[virtual] TimeValue KmlLayer::timeOffset() const

Reimplemented from TimeAware::timeOffset().

Returns the applied time offset.

See also setTimeOffset().

Feedback on this topic?