Marker interface inherited by all types of layers. More...
| Header: | #include <LayerContent.h> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Esri::ArcGISRuntime::Object |
| Inherited By: | Esri::ArcGISRuntime::AnnotationSublayer, Esri::ArcGISRuntime::ArcGISSublayer, Esri::ArcGISRuntime::Layer, and Esri::ArcGISRuntime::WmsSublayer |
Public Functions
| virtual | ~LayerContent() override |
| virtual bool | canChangeVisibility() const = 0 |
| virtual bool | isAutoFetchLegendInfos() const = 0 |
| virtual bool | isShowInLegend() const = 0 |
| virtual bool | isVisible() const = 0 |
| virtual bool | isVisibleAtScale(double scale) const = 0 |
| virtual Esri::ArcGISRuntime::LegendInfoListModel * | legendInfos() const = 0 |
| virtual QString | name() const = 0 |
| virtual void | setAutoFetchLegendInfos(bool autoFetchLegendInfos) = 0 |
| virtual void | setShowInLegend(bool showInLegend) = 0 |
| virtual void | setVisible(bool visible) = 0 |
| virtual QList<Esri::ArcGISRuntime::LayerContent *> | subLayerContents() const = 0 |
Signals
| void | subLayerContentChanged() |
Detailed Description
A pure virtual interface implemented by all layers and sublayers.
Relevant samples:
- Build a legend: Build a legend for all the operational layers in the map.
- Control annotation sublayer visibility: Use annotation sublayers to gain finer control of annotation layer subtypes.
Member Function Documentation
[override virtual] LayerContent::~LayerContent ()
Destructor.
[pure virtual] bool LayerContent::canChangeVisibility () const
Gets whether the layer can change visibility.
Returns true if the layer can change visibility.
[pure virtual] bool LayerContent::isAutoFetchLegendInfos () const
Gets whether legend infos are automatically fetched by the layer's legend info list model.
Returns true if legend infos will be fetched automatically when the LegendInfoListModel is instantiated.
[pure virtual] bool LayerContent::isShowInLegend () const
Gets whether the layer participates in the legend.
Returns true if layer participates in the legend.
[pure virtual] bool LayerContent::isVisible () const
Gets the visibility.
Returns true if the layer is visible.
[pure virtual] bool LayerContent::isVisibleAtScale (double scale) const
Gets whether the layer is visible at the specified scale.
Returns true if the layer is visible at the specified scale.
[pure virtual] Esri::ArcGISRuntime::LegendInfoListModel *LayerContent::legendInfos () const
Gets a list model containing legend infos for the layer and any sublayers.
Returns a LegendInfoListModel representing the legend information for the layer and its sublayers.
Note: Layers that use a DictionaryRenderer will not have any legend infos.
[pure virtual] QString LayerContent::name() const
Gets the name of the layer.
[pure virtual] void LayerContent::setAutoFetchLegendInfos (bool autoFetchLegendInfos )
Sets whether legend infos are automatically fetched by the layer's legend info list model.
Set autoFetchLegendInfos to true (default is false) to have legend infos fetched automatically when the LegendInfoListModel is instantiated.
See also isAutoFetchLegendInfos().
[pure virtual] void LayerContent::setShowInLegend (bool showInLegend )
Sets whether the layer participates in the legend.
Set showInLegend to true to show the layer in the legend.
See also isShowInLegend().
[pure virtual] void LayerContent::setVisible (bool visible)
Set the visibility.
Set visible to true to enable layer to be visible.
See also isVisible().
[signal] void LayerContent::subLayerContentChanged ()
Signal emitted when the subLayerContents changes for this object.
[pure virtual] QList<Esri::ArcGISRuntime::LayerContent *> LayerContent::subLayerContents () const
Gets a list of LayerContent for any sublayers.
Returns a list of LayerContent types of all sublayers.