Skip To Content ArcGIS for Developers Sign In Dashboard

AnnotationSublayer Class


The properties of the sublayer within an AnnotationLayer. More...

Header: #include <AnnotationSublayer>
Since: Esri::ArcGISRuntime 100.6
Inherits: LayerContent

Public Functions

QString definitionExpression() const
double maxScale() const
double minScale() const
float opacity() const
bool scaleSymbols() const
qint64 subLayerId() const

Reimplemented Public Functions

virtual bool canChangeVisibility() const
virtual bool isAutoFetchLegendInfos() const
virtual bool isShowInLegend() const
virtual bool isVisible() const
virtual bool isVisibleAtScale(double scale) const
virtual LegendInfoListModel *legendInfos() const
virtual QString name() const
virtual void setAutoFetchLegendInfos(bool autoFetchLegendInfos)
virtual void setShowInLegend(bool showInLegend)
virtual void setVisible(bool visible)
virtual QList<LayerContent *> subLayerContents() const

Additional Inherited Members

Detailed Description

The properties of the sublayer within an AnnotationLayer.

Member Function Documentation



[virtual] bool AnnotationSublayer::canChangeVisibility() const

Reimplemented from LayerContent::canChangeVisibility().

Returns whether the sublayer's visibility can be changed.

See LayerContent.

QString AnnotationSublayer::definitionExpression() const

Returns the where clause of the SQL expression that defines which annotation features from the feature table are selected into this sublayer.

The definition expression string uses the SQL-92 WHERE clause syntax. Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. See the ArcGIS Blog article Querying Feature Services Date-Time Queries for more information.

[virtual] bool AnnotationSublayer::isAutoFetchLegendInfos() const

Reimplemented from LayerContent::isAutoFetchLegendInfos().

Returns whether legend infos are automatically fetched by the sublayer.

See LayerContent.

[virtual] bool AnnotationSublayer::isShowInLegend() const

Reimplemented from LayerContent::isShowInLegend().

Returns whether the sublayer will be shown in the legend.

See LayerContent.

[virtual] bool AnnotationSublayer::isVisible() const

Reimplemented from LayerContent::isVisible().

Returns whether the sublayer is enabled to be visible.

See LayerContent.

[virtual] bool AnnotationSublayer::isVisibleAtScale(double scale) const

Reimplemented from LayerContent::isVisibleAtScale().

Returns whether the sublayer is visible at a given scale.

See LayerContent.

[virtual] LegendInfoListModel *AnnotationSublayer::legendInfos() const

Reimplemented from LayerContent::legendInfos().

Returns a list model of LegendInfo objects.

See LayerContent.

double AnnotationSublayer::maxScale() const

Returns the maximum scale at which to display the sublayer.

double AnnotationSublayer::minScale() const

Returns the minimum scale at which to display the sublayer.

[virtual] QString AnnotationSublayer::name() const

Reimplemented from LayerContent::name().

Returns the sublayer's name.

See LayerContent.

float AnnotationSublayer::opacity() const

Returns the opacity with which to display the annotation text associated with this sublayer.

bool AnnotationSublayer::scaleSymbols() const

Returns whether the annotation text scales with the MapView.

[virtual] void AnnotationSublayer::setAutoFetchLegendInfos(bool autoFetchLegendInfos)

Reimplemented from LayerContent::setAutoFetchLegendInfos().

Sets whether legend infos are automatically fetched by the sublayer's legend info list model to autoFetchLegendInfos.

See LayerContent.

See also isAutoFetchLegendInfos().

[virtual] void AnnotationSublayer::setShowInLegend(bool showInLegend)

Reimplemented from LayerContent::setShowInLegend().

Sets whether the sublayer will be shown in the legend to showInLegend.

See LayerContent.

See also isShowInLegend().

[virtual] void AnnotationSublayer::setVisible(bool visible)

Reimplemented from LayerContent::setVisible().

Sets whether the sublayer is visible to visible.

See LayerContent.

See also isVisible().

[virtual] QList<LayerContent *> AnnotationSublayer::subLayerContents() const

Reimplemented from LayerContent::subLayerContents().

Returns a list of layer contents for any sublayer.

See LayerContent.

qint64 AnnotationSublayer::subLayerId() const

Returns non-negative integer id number of the AnnotationSublayer within its AnnotationLayer.

Feedback on this topic?