Skip To Content ArcGIS for Developers Sign In Dashboard

RasterLayer Class

(Esri::ArcGISRuntime::RasterLayer)

A RasterLayer is used to render data from a Raster onto a Map. More...

Header: #include <RasterLayer>
Since: Esri::ArcGISRuntime 100.0
Inherits: ImageAdjustmentLayer, PopupSource, and TimeAware

Public Functions

RasterLayer(Raster *raster, QObject *parent = nullptr)
RasterLayer(Item *item, QObject *parent = nullptr)
~RasterLayer()
Raster *raster() const
RasterRenderer *renderer() const
void setRenderer(RasterRenderer *renderer)

Reimplemented Public Functions

virtual TimeExtent fullTimeExtent() const
virtual bool isPopupEnabled() const
virtual bool isSupportsTimeFiltering() const
virtual bool isTimeFilteringEnabled() const
virtual PopupDefinition *popupDefinition() const
virtual void setPopupDefinition(PopupDefinition *popupDefinition)
virtual void setPopupEnabled(bool popupEnabled)
virtual void setTimeFilteringEnabled(bool timeFilteringEnabled)
virtual void setTimeOffset(const TimeValue &timeOffset)
virtual TimeValue timeInterval() const
virtual TimeValue timeOffset() const

Signals

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 RasterLayer is used to render data from a Raster onto a Map.

RasterLayer adopts the loadable pattern; many of its properties are initialized asynchronously. See Loadable for more information.

Learn more about rasters from the ArcGIS Desktop documentation.

Note: The RasterLayer will automatically reproject on the fly. For example, this would mean that a RasterLayer that is in WKID 4326 could be added to a Map that is in WKID 3857, and the RasterLayer would project on-the-fly to WKID 3857.

Member Function Documentation

RasterLayer::RasterLayer(Raster *raster, QObject *parent = nullptr)

Constructs a RasterLayer with the provided raster and an optional parent.

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

Constructs a RasterLayer with the given image service raster portal item (item) and an optional parent.

RasterLayer::~RasterLayer()

Destructor.

[virtual] TimeExtent RasterLayer::fullTimeExtent() const

Reimplemented from TimeAware::fullTimeExtent().

Returns the full time extent of the layer.

This function was introduced in Esri::ArcGISRuntime 100.3.

[signal] void RasterLayer::fullTimeExtentChanged()

Signal emitted when the fullTimeExtent changes.

See also TimeAware.

[virtual] bool RasterLayer::isPopupEnabled() const

Reimplemented from PopupSource::isPopupEnabled().

See PopupSource.

[virtual] bool RasterLayer::isSupportsTimeFiltering() const

Reimplemented from TimeAware::isSupportsTimeFiltering().

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

This function was introduced in Esri::ArcGISRuntime 100.3.

[virtual] bool RasterLayer::isTimeFilteringEnabled() const

Reimplemented from TimeAware::isTimeFilteringEnabled().

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

This function was introduced in Esri::ArcGISRuntime 100.3.

[virtual] PopupDefinition *RasterLayer::popupDefinition() const

Reimplemented from PopupSource::popupDefinition().

See PopupSource.

See also setPopupDefinition().

Raster *RasterLayer::raster() const

Returns the Raster with which the layer was constructed.

RasterRenderer *RasterLayer::renderer() const

Returns the raster renderer that specifies how the Raster should be displayed.

See also setRenderer().

[virtual] void RasterLayer::setPopupDefinition(PopupDefinition *popupDefinition)

Reimplemented from PopupSource::setPopupDefinition().

Sets the popup definition to popupDefinition.

See also popupDefinition() and PopupSource.

[virtual] void RasterLayer::setPopupEnabled(bool popupEnabled)

Reimplemented from PopupSource::setPopupEnabled().

Sets whether the PopupSource is enabled to popupEnabled.

See also isPopupEnabled() and PopupSource.

void RasterLayer::setRenderer(RasterRenderer *renderer)

Sets the raster renderer specifying how the Raster should be displayed.

See also renderer().

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

Reimplemented from TimeAware::setTimeFilteringEnabled().

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

This function was introduced in Esri::ArcGISRuntime 100.3.

See also isTimeFilteringEnabled().

[virtual] void RasterLayer::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 geo view. This can be used to overlay data from different periods of time for comparison.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also timeOffset().

[virtual] TimeValue RasterLayer::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.

This function was introduced in Esri::ArcGISRuntime 100.3.

[virtual] TimeValue RasterLayer::timeOffset() const

Reimplemented from TimeAware::timeOffset().

Returns the applied time offset.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also setTimeOffset().


Feedback on this topic?