Skip To Content ArcGIS for Developers Sign In Dashboard

ArcGISFeatureLayerInfo Class

(Esri::ArcGISRuntime::ArcGISFeatureLayerInfo)

Information about an individual layer in an ArcGIS feature service. More...

Header: #include <ArcGISFeatureLayerInfo>
Since: Esri::ArcGISRuntime 100.0

Public Functions

ArcGISFeatureLayerInfo()
ArcGISFeatureLayerInfo(const ArcGISFeatureLayerInfo &other)
ArcGISFeatureLayerInfo(ArcGISFeatureLayerInfo &&other)
~ArcGISFeatureLayerInfo()
QString attribution() const
FeatureServiceCapabilities capabilities() const
QString cimVersion() const
QVariant defaultSubtypeCode() const
QString description() const
QString displayFieldName() const
DrawingInfo drawingInfo() const
EditFieldsInfo editFieldsInfo() const
double effectiveMaxScale() const
double effectiveMinScale() const
Envelope extent() const
QList<FeatureSubtype> featureSubtypes() const
QList<FeatureTemplate> featureTemplates() const
FeatureType featureType(const QString &name) const
QList<FeatureType> featureTypes() const
Field field(const QString &fieldName) const
QList<Field> fields() const
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
OwnershipBasedAccessControlInfo ownershipBasedAccessControl() const
QList<RelationshipInfo> relationshipInfos() const
qint64 serviceLayerId() const
QString serviceLayerName() const
ServiceType serviceSourceType() const
ArcGISFeatureLayerInfoServiceType serviceType() const
QString subtypeField() const
LayerTimeInfo timeInfo() const
QString typeIdFieldName() const
QUrl url() const
QString version() const
double zDefault() const
ArcGISFeatureLayerInfo &operator=(const ArcGISFeatureLayerInfo &other)
ArcGISFeatureLayerInfo &operator=(ArcGISFeatureLayerInfo &&other)

Detailed Description

Information about an individual layer in an ArcGIS feature service.

Member Function Documentation

ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo()

Default constructor.

ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo(const ArcGISFeatureLayerInfo &other)

Copy constructor from other ArcGISFeatureLayerInfo.

ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo(ArcGISFeatureLayerInfo &&other)

Move constructor from other ArcGISFeatureLayerInfo.

ArcGISFeatureLayerInfo::~ArcGISFeatureLayerInfo()

Destructor.

QString ArcGISFeatureLayerInfo::attribution() const

Returns the attribution information.

FeatureServiceCapabilities ArcGISFeatureLayerInfo::capabilities() const

Returns the capabilities supported by the layer.

QString ArcGISFeatureLayerInfo::cimVersion() const

Returns the service's CIM version.

This function was introduced in Esri::ArcGISRuntime 100.4.

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.

DrawingInfo ArcGISFeatureLayerInfo::drawingInfo() const

Returns information about how features in the service should be displayed on a map.

EditFieldsInfo ArcGISFeatureLayerInfo::editFieldsInfo() const

Returns metadata specifying which fields or attributes of a feature contain information about who created/edited the feature and when was it created/edited

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.

Envelope ArcGISFeatureLayerInfo::extent() const

Returns the geographic extent this layer covers.

QList<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<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.

FeatureType ArcGISFeatureLayerInfo::featureType(const QString &name) const

A convenience method to find a feature type in a layer with a given name.

QList<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.

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<Field> ArcGISFeatureLayerInfo::fields() const

Returns the attribute fields (columns) available in the data.

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 whether features in the layer may have attachments.

bool ArcGISFeatureLayerInfo::hasM() const

Returns whether features in the layer may contain m-values.

bool ArcGISFeatureLayerInfo::hasZ() const

Returns whether features in the layer may contain z-values.

bool ArcGISFeatureLayerInfo::isAllowGeometryUpdates() const

Returns true if geometry of existing features can be updated.

bool ArcGISFeatureLayerInfo::isDataVersioned() const

Returns whether data in the service is versioned.

bool ArcGISFeatureLayerInfo::isDefaultVisible() const

Returns true if the layer is visible by default.

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 whether the service supports advanced query operations such as ordering results or returning distinct results.

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.

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.

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 a default z-value will be applied for features created without a z-value.

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.

OwnershipBasedAccessControlInfo ArcGISFeatureLayerInfo::ownershipBasedAccessControl() const

Returns information about ownership-based access policies governing who can edit, delete, and query features.

QList<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.

ServiceType ArcGISFeatureLayerInfo::serviceSourceType() const

Returns the type of service, such as Map Service or Feature Service.

ArcGISFeatureLayerInfoServiceType ArcGISFeatureLayerInfo::serviceType() const

Returns the type of layer or table in the service.

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.

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.

ArcGISFeatureLayerInfo &ArcGISFeatureLayerInfo::operator=(const ArcGISFeatureLayerInfo &other)

Assignment operator from other ArcGISFeatureLayerInfo.

ArcGISFeatureLayerInfo &ArcGISFeatureLayerInfo::operator=(ArcGISFeatureLayerInfo &&other)

Move operator from other ArcGISFeatureLayerInfo.


Feedback on this topic?