ArcGISFeatureLayerInfo Class

Member Function Documentation

ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo()

Default constructor.

ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo(const Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &other)

Copy constructor from other ArcGISFeatureLayerInfo.

[noexcept] ArcGISFeatureLayerInfo::ArcGISFeatureLayerInfo(Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &&other)

Move constructor from other ArcGISFeatureLayerInfo.

[noexcept] 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.

[since Esri::ArcGISRuntime 200.7] Esri::ArcGISRuntime::ArcadeExpression *ArcGISFeatureLayerInfo::displayFieldExpression(QObject *parent) const

Returns the layer's display field expression, or nullptr if the default display field is used.

The display field expression contains a custom un-evaluated Arcade expression, a title, an empty name, and a ArcadeExpressionReturnType::Automatic return type.

This function was introduced in Esri::ArcGISRuntime 200.7.

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 the layer's ownership-based access control information.

This information applies to 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.

[noexcept] Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &ArcGISFeatureLayerInfo::operator=(Esri::ArcGISRuntime::ArcGISFeatureLayerInfo &&other)

Move operator from other ArcGISFeatureLayerInfo.

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

Assignment operator from other ArcGISFeatureLayerInfo.