The metadata for an individual layer or table in an ArcGIS feature service. More...
Header: | #include <ArcGISFeatureLayerInfo.h> |
Since: | Esri::ArcGISRuntime 100.0 |
Public Functions
ArcGISFeatureLayerInfo() | |
ArcGISFeatureLayerInfo(const Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &other) | |
ArcGISFeatureLayerInfo(Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &&other) | |
~ArcGISFeatureLayerInfo() | |
QString | attribution() const |
Esri::ArcGISRuntime::FeatureServiceCapabilities | capabilities() const |
QString | cimVersion() const |
QVariant | defaultSubtypeCode() const |
QString | description() const |
QString | displayFieldName() const |
Esri::ArcGISRuntime::DrawingInfo | drawingInfo() const |
Esri::ArcGISRuntime::EditFieldsInfo | editFieldsInfo() const |
double | effectiveMaxScale() const |
double | effectiveMinScale() const |
Esri::ArcGISRuntime::Envelope | extent() const |
QList<Esri::ArcGISRuntime::FeatureSubtype> | featureSubtypes() const |
QList<Esri::ArcGISRuntime::FeatureTemplate> | featureTemplates() const |
Esri::ArcGISRuntime::FeatureType | featureType(const QString &name) 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 |
QString | globalIdFieldName() const |
bool | hasAttachments() const |
bool | hasM() const |
bool | hasZ() const |
bool | isAllowGeometryUpdates() const |
bool | isDataVersioned() const |
bool | isDefaultVisible() const |
bool | isEmpty() const |
bool | isSupportsAdvancedQueries() const |
bool | isSupportsOBACForAnonymousUsers() const |
bool | isSupportsPagination() const |
bool | isSupportsQueryExtent() const |
bool | isSupportsRollbackOnFailureParameter() const |
bool | isSupportsStatistics() const |
bool | isZDefaultsEnabled() const |
qint64 | maxRecordCount() const |
double | maxScale() const |
double | minScale() const |
QString | objectIdFieldName() const |
Esri::ArcGISRuntime::OwnershipBasedAccessControlInfo | ownershipBasedAccessControl() const |
QList<Esri::ArcGISRuntime::RelationshipInfo> | relationshipInfos() const |
qint64 | serviceLayerId() const |
QString | serviceLayerName() const |
Esri::ArcGISRuntime::ServiceType | serviceSourceType() const |
Esri::ArcGISRuntime::ArcGISFeatureLayerInfoServiceType | serviceType() const |
QString | subtypeField() const |
Esri::ArcGISRuntime::LayerTimeInfo | timeInfo() const |
QString | typeIdFieldName() const |
QUrl | url() const |
QString | version() const |
double | zDefault() const |
Esri::ArcGISRuntime::ArcGISFeatureLayerInfo & | operator=(const Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &other) |
Esri::ArcGISRuntime::ArcGISFeatureLayerInfo & | operator=(Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &&other) |
Detailed Description
An ArcGIS feature service is a data service that provides access to spatial features stored in layers and non-spatial features stored in tables. ArcGISFeatureLayerInfo provides basic information about an individual layer or table in this service, such as the description, geometry type, fields, drawing information, extent, feature templates, editor tracking fields, and whether it has attachments, z-values or m-values.
You can obtain the ArcGISFeatureLayerInfo from a loaded ArcGISFeatureTable or from a loaded FeatureCollectionTable.
Member Function Documentation
ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo ()
Default constructor.
ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo (const Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &other)
Copy constructor from other ArcGISFeatureLayerInfo.
ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo (Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &&other)
Move constructor from other ArcGISFeatureLayerInfo.
ArcGISFeatureLayerInfo::~ArcGISFeatureLayerInfo ()
Destructor.
QString ArcGISFeatureLayerInfo::attribution() const
Returns the layer's attribution.
Esri::ArcGISRuntime::FeatureServiceCapabilities ArcGISFeatureLayerInfo::capabilities() const
Returns the capabilities of the layer or table's ArcGIS feature service.
[since Esri::ArcGISRuntime 100.4]
QString ArcGISFeatureLayerInfo::cimVersion () const
Returns the service's CIM version.
This function was introduced in Esri::ArcGISRuntime 100.4.
[since Esri::ArcGISRuntime 100.3]
QVariant ArcGISFeatureLayerInfo::defaultSubtypeCode () const
Returns the layer's default subtype code.
This function was introduced in Esri::ArcGISRuntime 100.3.
QString ArcGISFeatureLayerInfo::description() const
Returns the description of the layer or table in the service.
QString ArcGISFeatureLayerInfo::displayFieldName () const
Returns the name of the field that is used to display a title for features in the layer.
Esri::ArcGISRuntime::DrawingInfo ArcGISFeatureLayerInfo::drawingInfo () const
Returns information about how features in the service should be displayed on a map.
Esri::ArcGISRuntime::EditFieldsInfo ArcGISFeatureLayerInfo::editFieldsInfo () const
Returns the layer's edit fields record who adds or edits the features and when the edits are made.
If editor tracking has not been enabled, then these fields will be empty. For more information, see Editor tracking for feature services.
double ArcGISFeatureLayerInfo::effectiveMaxScale () const
Returns the maximum scale at which this layer or any of its parents is visible.
If the map is zoomed in beyond this scale, the layer will not be visible.
The maximum or minimum scale of a layer 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 ArcGISFeatureLayerInfo::effectiveMinScale () const
Returns the minimum scale at which this layer or any of its parents is visible.
If the map is zoomed out beyond this scale, the layer will not be visible.
The maximum or minimum scale of a layer 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 ArcGISFeatureLayerInfo::extent() const
Returns the geographic extent this layer covers.
[since Esri::ArcGISRuntime 100.3]
QList<Esri::ArcGISRuntime::FeatureSubtype > ArcGISFeatureLayerInfo::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::FeatureTemplate > ArcGISFeatureLayerInfo::featureTemplates () const
Returns a list of feature templates for the layer.
Only present if the layer is based on an ArcGIS feature service and does not contain feature subtypes.
Esri::ArcGISRuntime::FeatureType ArcGISFeatureLayerInfo::featureType (const QString &name) const
A convenience method to find a feature type in a layer with a given name.
QList<Esri::ArcGISRuntime::FeatureType > ArcGISFeatureLayerInfo::featureTypes () const
Returns a list of feature types representing feature subtypes in the layer.
For example, a roads layer may contain 2 feature subtypes: highways and streets.
Esri::ArcGISRuntime::Field ArcGISFeatureLayerInfo::field(const QString &fieldName ) const
A convenience method to find a field in a layer with a given fieldName.
Since Esri::ArcGISRuntime 100.1, the fieldName parameter only accepts a field name.
QList<Esri::ArcGISRuntime::Field > ArcGISFeatureLayerInfo::fields() const
Returns the attribute fields (columns) available in the data.
Esri::ArcGISRuntime::GeometryType ArcGISFeatureLayerInfo::geometryType () const
Returns the type of geometry contained by features in the layer.
QString ArcGISFeatureLayerInfo::globalIdFieldName () const
Returns the name of the field that contains the global ID.
bool ArcGISFeatureLayerInfo::hasAttachments () const
Returns true
if the layer supports attachments, false
otherwise.
bool ArcGISFeatureLayerInfo::hasM () const
Returns true
if the layer has m-values, false
otherwise.
bool ArcGISFeatureLayerInfo::hasZ () const
Returns true
if the layer has z-values, false
otherwise.
bool ArcGISFeatureLayerInfo::isAllowGeometryUpdates () const
Returns true
if the layer allows geometry updates, false
otherwise.
bool ArcGISFeatureLayerInfo::isDataVersioned () const
Returns true
if the layer has versioned data, false
otherwise.
bool ArcGISFeatureLayerInfo::isDefaultVisible () const
Returns true
if the layer default visibility value, false
otherwise.
bool ArcGISFeatureLayerInfo::isEmpty () const
Gets whether this ArcGISFeatureLayerInfo is empty.
A default constructed ArcGISFeatureLayerInfo is empty.
Returns true
if empty.
bool ArcGISFeatureLayerInfo::isSupportsAdvancedQueries () const
Returns true
if the layer supports advanced queries, false
otherwise.
[since Esri::ArcGISRuntime 100.3]
bool ArcGISFeatureLayerInfo::isSupportsOBACForAnonymousUsers () const
Returns whether the service supports Ownership Based Access Controls (OBAC) for anonymous users.
This function was introduced in Esri::ArcGISRuntime 100.3.
[since Esri::ArcGISRuntime 100.3]
bool ArcGISFeatureLayerInfo::isSupportsPagination () const
Returns whether the service supports paginated queries (with a max features count and result offset).
This function was introduced in Esri::ArcGISRuntime 100.3.
[since Esri::ArcGISRuntime 100.4]
bool ArcGISFeatureLayerInfo::isSupportsQueryExtent () const
Returns whether the service supports queries for the extent of features meeting a specified criteria.
This function was introduced in Esri::ArcGISRuntime 100.4.
bool ArcGISFeatureLayerInfo::isSupportsRollbackOnFailureParameter () const
Returns whether the service is capable of rolling back all edit operations in a batch if any one of the operations in the batch fails.
bool ArcGISFeatureLayerInfo::isSupportsStatistics () const
Returns whether the service is capable of returning statistics for query results.
bool ArcGISFeatureLayerInfo::isZDefaultsEnabled () const
Returns true
if the layer provides default z values, false
otherwise.
qint64 ArcGISFeatureLayerInfo::maxRecordCount () const
Returns the maximum number of results returned by the service for any query operation.
double ArcGISFeatureLayerInfo::maxScale () const
Returns the maximum scale at which this layer is visible.
If the map is zoomed in beyond this scale, the layer will not be visible.
double ArcGISFeatureLayerInfo::minScale () const
Returns the minimum scale at which this layer is visible.
If the map is zoomed out beyond this scale, the layer will not be visible.
QString ArcGISFeatureLayerInfo::objectIdFieldName () const
Returns the name of the field that contains the object ID.
Esri::ArcGISRuntime::OwnershipBasedAccessControlInfo ArcGISFeatureLayerInfo::ownershipBasedAccessControl () const
Returns information about ownership-based access policies governing who can edit, delete, and query features.
[since Esri::ArcGISRuntime 100.1]
QList<Esri::ArcGISRuntime::RelationshipInfo > ArcGISFeatureLayerInfo::relationshipInfos () const
Returns a list of RelationshipInfo objects that describe this layer or table's relationship with another layer or table in the service.
This function was introduced in Esri::ArcGISRuntime 100.1.
qint64 ArcGISFeatureLayerInfo::serviceLayerId () const
Returns the ID of the layer or table in the service.
QString ArcGISFeatureLayerInfo::serviceLayerName () const
Returns the name of the layer or table in the service.
Esri::ArcGISRuntime::ServiceType ArcGISFeatureLayerInfo::serviceSourceType () const
Returns the type of service, such as Map Service or Feature Service.
Esri::ArcGISRuntime::ArcGISFeatureLayerInfoServiceType ArcGISFeatureLayerInfo::serviceType () const
Returns the type of layer or table in the service.
[since Esri::ArcGISRuntime 100.3]
QString ArcGISFeatureLayerInfo::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 ArcGISFeatureLayerInfo::timeInfo () const
Returns temporal information for the layer such as start time field and end time field.
QString ArcGISFeatureLayerInfo::typeIdFieldName () const
Returns the name of the field that contains the subtype information for each feature.
QUrl ArcGISFeatureLayerInfo::url() const
Returns the URL of the layer.
QString ArcGISFeatureLayerInfo::version() const
Returns the version of the service.
double ArcGISFeatureLayerInfo::zDefault () const
Returns default z-values for features created without a valid z-value.
Only applicable if isZDefaultsEnabled is true
.
Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &ArcGISFeatureLayerInfo::operator=(const Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &other)
Assignment operator from other ArcGISFeatureLayerInfo.
Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &ArcGISFeatureLayerInfo::operator=(Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &&other)
Move operator from other ArcGISFeatureLayerInfo.