The metadata of an ArcGIS map service sublayer. More...
| Header: | #include <ArcGISMapServiceSublayerInfo.h> |
| Since: | Esri::ArcGISRuntime 100.1 |
Public Functions
| ArcGISMapServiceSublayerInfo() | |
| ArcGISMapServiceSublayerInfo(const Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &other) | |
| ArcGISMapServiceSublayerInfo(Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &&other) | |
| ~ArcGISMapServiceSublayerInfo() | |
| QString | attribution() const |
| bool | canModifyLayer() const |
| bool | canScaleSymbols() const |
| Esri::ArcGISRuntime::MapServiceCapabilities | capabilities() const |
| QVariant | defaultSubtypeCode() const |
| QString | definitionExpression() const |
| QString | description() const |
| QString | displayFieldName() const |
| Esri::ArcGISRuntime::DrawingInfo | drawingInfo() const |
| double | effectiveMaxScale() const |
| double | effectiveMinScale() const |
| Esri::ArcGISRuntime::Envelope | extent() const |
| QList<Esri::ArcGISRuntime::FeatureSubtype> | featureSubtypes() const |
| QList<Esri::ArcGISRuntime::FeatureType> | featureTypes() const |
| Esri::ArcGISRuntime::Field | field(const QString &fieldName) const |
| QList<Esri::ArcGISRuntime::Field> | fields() const |
| Esri::ArcGISRuntime::GeometryType | geometryType() const |
| bool | hasAttachments() const |
| bool | hasLabels() const |
| bool | hasM() const |
| bool | hasZ() const |
| bool | isDataVersioned() const |
| bool | isDefaultVisible() const |
| bool | isEmpty() const |
| bool | isSupportsAdvancedQueries() const |
| bool | isSupportsStatistics() const |
| bool | isUseStandardizedQueries() const |
| qint64 | maxRecordCount() const |
| double | maxScale() const |
| double | minScale() const |
| Esri::ArcGISRuntime::OwnershipBasedAccessControlInfo | ownershipBasedAccessControl() const |
| Esri::ArcGISRuntime::IdInfo | parentLayerInfo() const |
| QList<Esri::ArcGISRuntime::RelationshipInfo> | relationshipInfos() const |
| qint64 | serviceLayerId() const |
| QString | serviceLayerName() const |
| QList<Esri::ArcGISRuntime::IdInfo> | sublayerInfos() const |
| Esri::ArcGISRuntime::ArcGISMapServiceSublayerType | sublayerType() const |
| QString | subtypeField() const |
| Esri::ArcGISRuntime::LayerTimeInfo | timeInfo() const |
| QString | typeIdFieldName() const |
| QUrl | url() const |
| QString | version() const |
| Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo & | operator=(const Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &other) |
| Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo & | operator=(Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &&other) |
Detailed Description
ArcGISMapServiceSublayerInfo provides basic information about an individual map image sublayer (or map service sublayer), such as the description, geometry type, drawing information, fields, extent, capabilities, and layer type. You can obtain a collection of map image sublayers from ArcGISMapImageLayer::mapImageSublayers and obtain the ArcGISMapServiceSublayerInfo using the ArcGISSublayer::mapServiceSublayerInfo.
The sublayerType specifies if the map image sublayer is a feature layer, table, raster layer, or group layer. If the sublayer type is ArcGISMapServiceSublayerType::GroupLayer, it will have its own collection of sublayers that you can access using ArcGISSublayer::sublayers. If one of these sublayers is a group layer it will also contain a collection of sublayers, and so on.
Member Function Documentation
ArcGISMapServiceSublayerInfo::ArcGISMapServiceSublayerInfo ()
Default constructor.
ArcGISMapServiceSublayerInfo::ArcGISMapServiceSublayerInfo (const Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &other)
Copy constructor from other ArcGISMapServiceSublayerInfo.
ArcGISMapServiceSublayerInfo::ArcGISMapServiceSublayerInfo (Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &&other)
Move constructor from other ArcGISMapServiceSublayerInfo.
ArcGISMapServiceSublayerInfo::~ArcGISMapServiceSublayerInfo ()
Destructor.
QString ArcGISMapServiceSublayerInfo::attribution() const
Returns the attribution information.
bool ArcGISMapServiceSublayerInfo::canModifyLayer () const
Returns a flag indicating whether the sublayer supports modifying its renderer and/or its data source.
false if an error occurs.
bool ArcGISMapServiceSublayerInfo::canScaleSymbols () const
Returns a flag indicating whether the text and symbols on the sublayer will change as the map scale varies.
false if an error occurs.
Esri::ArcGISRuntime::MapServiceCapabilities ArcGISMapServiceSublayerInfo::capabilities() const
Returns the sublayer's capabilities.
[since Esri::ArcGISRuntime 100.3] QVariant ArcGISMapServiceSublayerInfo::defaultSubtypeCode () const
Returns the layer's default subtype code.
This function was introduced in Esri::ArcGISRuntime 100.3.
QString ArcGISMapServiceSublayerInfo::definitionExpression () const
Returns the sublayer's definition expression.
The definition expression string uses the SQL-92 where clause syntax (https://en.wikipedia.org/wiki/SQL-92). 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. For more information, see the ArcGIS Blog article Querying Feature Services Date-Time Queries.
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.
QString ArcGISMapServiceSublayerInfo::description() const
Returns the sublayer's description.
QString ArcGISMapServiceSublayerInfo::displayFieldName () const
Returns the sublayer's display field name.
Esri::ArcGISRuntime::DrawingInfo ArcGISMapServiceSublayerInfo::drawingInfo () const
Returns the sublayer's drawing info.
double ArcGISMapServiceSublayerInfo::effectiveMaxScale () const
Returns the maximum scale at which this sublayer or any of its parents is visible.
If the map is zoomed in beyond this scale, the sublayer will not be visible.
The maximum or minimum scale of a sublayer can be set individually, but at display time it will be overridden by the maximum or minimum scale of the parent layer if the parent layer has one.
double ArcGISMapServiceSublayerInfo::effectiveMinScale () const
Returns the minimum scale at which this sublayer or any of its parents is visible.
If the map is zoomed out beyond this scale, the sublayer will not be visible.
The maximum or minimum scale of a sublayer can be set individually, but at display time it will be overridden by the maximum or minimum scale of the parent layer if the parent layer has one.
Esri::ArcGISRuntime::Envelope ArcGISMapServiceSublayerInfo::extent() const
Returns the geographic extent this sublayer covers.
[since Esri::ArcGISRuntime 100.3] QList<Esri::ArcGISRuntime::FeatureSubtype > ArcGISMapServiceSublayerInfo::featureSubtypes () const
Returns a list of FeatureSubtype objects describing the subtypes of the layer.
This list is included for layers that have subtypes. The domains in the types list will match the domains in the subtype list for layers that have a unique value renderer based on the subtype column.
This function was introduced in Esri::ArcGISRuntime 100.3.
QList<Esri::ArcGISRuntime::FeatureType > ArcGISMapServiceSublayerInfo::featureTypes () const
Returns a list of feature types representing feature subtypes in the sublayer.
For example, a roads sublayer may contain 2 feature subtypes: highways and streets.
Esri::ArcGISRuntime::Field ArcGISMapServiceSublayerInfo::field(const QString &fieldName ) const
A convenience method to find a field in a sublayer with a given fieldName.
Since Esri::ArcGISRuntime 100.1, the fieldName parameter only accepts a field name.
QList<Esri::ArcGISRuntime::Field > ArcGISMapServiceSublayerInfo::fields() const
Returns the sublayer's field definitions.
Esri::ArcGISRuntime::GeometryType ArcGISMapServiceSublayerInfo::geometryType () const
Returns the sublayer's geometry type.
bool ArcGISMapServiceSublayerInfo::hasAttachments () const
Returns whether features in the sublayer may have attachments.
bool ArcGISMapServiceSublayerInfo::hasLabels () const
Returns whether the sublayer has labels defined on it.
bool ArcGISMapServiceSublayerInfo::hasM () const
Returns whether features in the sublayer may contain m-values.
bool ArcGISMapServiceSublayerInfo::hasZ () const
Returns whether features in the sublayer may contain z-values.
bool ArcGISMapServiceSublayerInfo::isDataVersioned () const
Returns whether data in the service is versioned.
bool ArcGISMapServiceSublayerInfo::isDefaultVisible () const
Returns true if the sublayer is visible by default.
false if an error occurs.
bool ArcGISMapServiceSublayerInfo::isEmpty () const
Gets whether this ArcGISMapServiceSublayerInfo is empty.
A default constructed ArcGISMapServiceSublayerInfo is empty.
Returns true if empty.
bool ArcGISMapServiceSublayerInfo::isSupportsAdvancedQueries () const
Returns whether the service supports advanced query operations such as ordering results or returning distinct results.
bool ArcGISMapServiceSublayerInfo::isSupportsStatistics () const
Returns whether the service is capable of returning statistics for query results.
bool ArcGISMapServiceSublayerInfo::isUseStandardizedQueries () const
Returns a flag indicating whether the sublayer requires the use of standardized queries.
Returns true indicates the sublayer requires the use of standardized queries, a value of false indicates otherwise.
qint64 ArcGISMapServiceSublayerInfo::maxRecordCount () const
Returns the maximum number of results returned by the service for any query operation.
double ArcGISMapServiceSublayerInfo::maxScale () const
Returns the maximum scale at which this sublayer is visible.
If the map is zoomed in beyond this scale, the sublayer will not be visible.
double ArcGISMapServiceSublayerInfo::minScale () const
Returns the minimum scale at which this sublayer is visible.
If the map is zoomed out beyond this scale, the sublayer will not be visible.
Esri::ArcGISRuntime::OwnershipBasedAccessControlInfo ArcGISMapServiceSublayerInfo::ownershipBasedAccessControl () const
Returns information about ownership-based access policies governing who can edit, delete, and query features.
Esri::ArcGISRuntime::IdInfo ArcGISMapServiceSublayerInfo::parentLayerInfo () const
Returns the parent layer info.
An IdInfo containing the sublayer parent id and name. Will return empty if an error occurs or if the sublayer has no parent.
[since Esri::ArcGISRuntime 100.2] QList<Esri::ArcGISRuntime::RelationshipInfo > ArcGISMapServiceSublayerInfo::relationshipInfos () const
Returns a list of RelationshipInfo objects that describe this sublayer's relationships with other sublayers in the ArcGIS Map Service.
This function was introduced in Esri::ArcGISRuntime 100.2.
qint64 ArcGISMapServiceSublayerInfo::serviceLayerId () const
Returns the ID of the sublayer or table in the service.
QString ArcGISMapServiceSublayerInfo::serviceLayerName () const
Returns the name of the sublayer or table in the service.
QList<Esri::ArcGISRuntime::IdInfo > ArcGISMapServiceSublayerInfo::sublayerInfos () const
Returns information that identifies the sublayers of this sublayer.
Esri::ArcGISRuntime::ArcGISMapServiceSublayerType ArcGISMapServiceSublayerInfo::sublayerType () const
Returns the type of sublayer in the ArcGIS map service.
ArcGISMapServiceSublayerType::Unknown if an error occurs.
[since Esri::ArcGISRuntime 100.3] QString ArcGISMapServiceSublayerInfo::subtypeField () const
Returns the layer's subtype field.
This is the field whose value determines the subtype of a feature. The value of this field corresponds to a subtype code for that feature.
This function was introduced in Esri::ArcGISRuntime 100.3.
See also FeatureSubtype::code.
Esri::ArcGISRuntime::LayerTimeInfo ArcGISMapServiceSublayerInfo::timeInfo () const
Returns temporal information for the sublayer such as start time field and end time field.
QString ArcGISMapServiceSublayerInfo::typeIdFieldName () const
Returns the name of the field that contains the subtype information for each feature.
QUrl ArcGISMapServiceSublayerInfo::url() const
Returns the URL of the sublayer.
QString ArcGISMapServiceSublayerInfo::version() const
Returns the version of the service.
Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &ArcGISMapServiceSublayerInfo::operator=(const Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &other)
Assignment operator from other ArcGISMapServiceSublayerInfo.
Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &ArcGISMapServiceSublayerInfo::operator=(Esri::ArcGISRuntime::ArcGISMapServiceSublayerInfo &&other)
Move operator from other ArcGISMapServiceSublayerInfo.