DimensionLayer QML Type

A layer that can visualize dimension features data. More...

Import Statement:	import Esri.ArcGISRuntime 100.15
Since:	Esri.ArcGISRuntime 100.13
Inherits:	Layer

List of all members, including inherited members

Properties

barrierWeight : Enums.LabelBarrierWeight
credential : Credential
definitionExpression : string
featureTable : ArcGISFeatureTable
item : ArcGISItem
referenceScale : double
requestConfiguration : RequestConfiguration
selectFeaturesResult : FeatureQueryResult
selectFeaturesStatus : Enums.TaskStatus
selectedFeaturesResult : FeatureQueryResult
selectedFeaturesStatus : Enums.TaskStatus
serviceLayerId : string
serviceLayerIdAsInt : int
url : url

Methods

void clearSelection()
void resetFeaturesVisible()
void selectFeature(Feature feature)
string selectFeatures(QueryParameters parameters, Enums.SelectionMode mode)
void selectFeatures(list<Feature> features)
string selectedFeatures()
void setFeatureVisible(Feature feature, bool visible)
void setFeaturesVisible(list<Feature> features, bool visible)
void unselectFeature(Feature feature)
void unselectFeatures(list<Feature> features)

Detailed Description

Dimension features are a special kind of annotation feature for showing specific lengths or distances on a map. A dimension may indicate the length of a side of a building or land parcel, or the distance between two features, such as a fire hydrant and the corner of a building. They are described in detail in "Dimension".

Each Dimension feature has specific text and specific locations for its schematic lines and arrows.

Dimension features are not linked to other point, line, or polygon features, even if the dimension measurement was created to refer to one or more features.

You can construct a dimension layer using a feature table containing dimension features: - An online ServiceFeatureTable that has a feature layer service type of Enums.ArcGISFeatureLayerInfoServiceTypeDimensionLayer - An offline GeodatabaseFeatureTable returned by the Geodatabase::geodatabaseDimensionTables collection when a GenerateGeodatabaseJob has completed

Dimension layers can be taken offline from a feature service hosted on ArcGIS Enterprise 10.9 or later, using the GeodatabaseSyncTask. Dimension layers are also supported in mobile map packages or mobile geodatabases created in ArcGIS Pro 2.9 or later.

Dimension respects the reference scale defined by the map, so dimension will always be presented to the user at the correct size and position, as defined by the dimension author.

Dimension features cannot be added, changed, or deleted by Runtime users. (Attempts will produce a "Geodatabase table not editable" (3016) error)

The fields of a Dimension feature can be queried by Runtime users or used in the definition expression, but not have their values changed. The automatic fields are described in detail in "Dimension fields". Authors may have added additional fields relevant to their data description.

The Runtime user does not have access to, and cannot change, the Renderer or the Styles used for rendering dimensions.

See also RemoteResource and Layer.

Property Documentation

barrierWeight : Enums.LabelBarrierWeight

The weight of dimension features when considered as barriers to labeling. The default is Enums.LabelBarrierWeightHigh.

This property was introduced in Esri.ArcGISRuntime 100.14.

credential : Credential

The credential used to authenticate the user requesting this DimensionLayer.

definitionExpression : string

An expression which is a SQL statement where clause to specify the subset of features to be displayed.

The definition expression string uses the SQL-92 where clause syntax (https://en.wikipedia.org/wiki/SQL-92). The default value is an empty string, which will allow all dimension features in the data source to be used by the DimensionLayer.

featureTable : ArcGISFeatureTable

The feature table associated with this layer.

item : ArcGISItem

The item used to initialize the dimension layer.

The Item represents a dimension layer on ArcGIS Online or an ArcGIS Enterprise portal.

This property must be set along with the serviceLayerId property. Failure to set both properties will result in the layer failing to load.

The item cannot be changed after the layer is loaded.

This property was introduced in Esri.ArcGISRuntime 100.14.

referenceScale : double

The reference scale for the layer (read-only).

The reference scale of the layer is the scale at which a client should view the layer for the schematic lines and text to appear at its authored size.

If the client changes the viewing scale, then schematic lines and text will grow or shrink to keep a consistent size on the map (not the screen).

For a valid layer, the reference scale will always be a finite value, greater than zero. Until the layer is loaded, the reference scale will be zero.

requestConfiguration : RequestConfiguration

Returns the RequestConfiguration in use by this dimension layer.

selectFeaturesResult : FeatureQueryResult

The result returned when the asynchronous selectFeatures(QueryParameters, Enums.SelectionMode) operation completes (read-only).

selectFeaturesStatus : Enums.TaskStatus

The current status of the asynchronous selectFeatures(QueryParameters, Enums.SelectionMode) operation (read-only).

selectedFeaturesResult : FeatureQueryResult

The result returned when the asynchronous selectedFeatures operation completes (read-only).

selectedFeaturesStatus : Enums.TaskStatus

The current status of the asynchronous selectedFeatures operation (read-only).

serviceLayerId : string

The service layer ID that defines the layer within the feature service portal item.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

This property must be set along with the item property. Failure to set both properties will result in the layer failing to load.

The service layer ID cannot be changed after the layer is loaded.

See also Layer::item and serviceLayerIdAsInt.

serviceLayerIdAsInt : int

The service layer ID that defines the layer within the feature service portal item represented as an integer type.

Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

See also Layer::item and serviceLayerId.

url : url

The URL of a feature service to define the layer.

See also url.

Signal Documentation

barrierWeightChanged()

Emitted when the barrierWeight property changes.

Note: The corresponding handler is onBarrierWeightChanged.

This signal was introduced in Esri.ArcGISRuntime 100.14.

credentialChanged()

Emitted when the credential property changes.

Note: The corresponding handler is onCredentialChanged.

definitionExpressionChanged()

Emitted when the definitionExpression property changes.

Note: The corresponding handler is onDefinitionExpressionChanged.

featureTableChanged()

Emitted when the featureTable property changes.

Note: The corresponding handler is onFeatureTableChanged.

requestConfigurationChanged()

Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.

selectFeaturesStatusChanged()

Emitted when the selectFeaturesStatus property changes.

Note: The corresponding handler is onSelectFeaturesStatusChanged.

selectedFeaturesStatusChanged()

Emitted when the selectedFeaturesStatus property changes.

Note: The corresponding handler is onSelectedFeaturesStatusChanged.

serviceLayerIdAsIntChanged()

Emitted when the serviceLayerIdAsInt property changes.

Note: The corresponding handler is onServiceLayerIdAsIntChanged.

serviceLayerIdChanged()

Emitted when the serviceLayerId property changes.

Note: The corresponding handler is onServiceLayerIdChanged.

urlChanged()

Emitted when the url property changes.

Note: The corresponding handler is onUrlChanged.

Method Documentation

void clearSelection()

Updates any selected features in the layer back to the un-selected state.

void resetFeaturesVisible()

Resets the visibility of the layer's features to the original visibility when loaded from the data source.

void selectFeature(Feature feature)

Selects the given feature and adds it to the current list of selected features.

feature - The feature.

string selectFeatures(QueryParameters parameters, Enums.SelectionMode mode)

Selects the features that match the criteria in the QueryParameters object and adds them to the current list of selected features

parameters - The definition of the query to submit to the feature table.
mode - Defines how the list of currently selected features will be updated with the features returned from the query.

Returns a string representing the task ID of the asynchronous task.

void selectFeatures(list<Feature> features)

Selects the features in the list and adds them to the current list of selected features.

features - A list of Feature. Contents of the list are copied.

string selectedFeatures()

Returns a list of the currently selected features.

Returns a string representing the task ID of the asynchronous task.

void setFeatureVisible(Feature feature, bool visible)

Sets the visibility of the given feature.

feature - The feature.
visible - true to show, false to hide.

void setFeaturesVisible(list<Feature> features, bool visible)

Sets the visibility of the given features.

features - A list of Feature. Contents of the list are copied.
visible - true to show, false to hide.

void unselectFeature(Feature feature)

Unselects the given feature and removes it from the current list of selected features.

feature - The feature.

void unselectFeatures(list<Feature> features)

Unselects the features in the given list and removes them from the current list of selected features.

features - A list of Feature. Contents of the list are copied.