Dimension
A layer that can visualize dimension features data. 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 https://pro.arcgis.com/en/pro-app/latest/help/data/dimensions/dimensions-in-arcgis-pro.htm.
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 ArcGISFeatureLayerInfoServiceType.DimensionLayer
An offline GeodatabaseFeatureTable returned by the Geodatabase.dimensionTables 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.
You cannot add, change, or delete a dimension feature. Any attempt produces a "Geodatabase table not editable" (3016) error.
The DimensionLayer.featureTable associated with this DimensionLayer contains a set of attributes (fields, in other words) that define https://pro.arcgis.com/en/pro-app/latest/help/data/dimensions/dimensions-in-arcgis-pro.htm. These attributes, automatically added by ArcGIS Pro, are described in https://pro.arcgis.com/en/pro-app/latest/help/data/dimensions/manage-dimension-feature-class-properties.htm. The author of the dimension layer may have also added additional fields. You can query and use any of these attributes in a definition expression but you cannot change their value.
You do not have access to, and cannot change, the renderer or the styles used for rendering dimensions.
Since
200.1.0
Constructors
Creates a dimension layer from a feature table containing dimension features. If the feature table does not contain dimension data then the DimensionLayer will fail to load. ArcGISFeatureTable.layerInfo and ArcGISFeatureLayerInfo.featureServiceType can be checked, to verify the feature type, before attempting to create a Layer.
Creates a new dimension layer object from a feature service portal item.
Creates a new dimension layer from a feature service URI. If the specified URI is not a valid Feature Service endpoint, then it will fail to load.
Properties
The weight of dimension features when considered as barriers to labeling. The default is LabelBarrierWeight.High.
A SQL statement where clause that stipulates a 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. Warning: 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 https://www.esri.com/arcgis-blog/products/api-rest/data-management/querying-feature-services-date-time-queries/.
The feature table associated with this layer.
The reference scale for the layer. 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.
Inherited properties
The attribution text for the layer.
A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.
The description for the layer.
The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.
The unique identifying string for the layer, as specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
The load status.
The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The sub layer contents of a layer content.
Callback invoked when the visibility of the layer changes.
Functions
Updates any selected features in the layer back to the un-selected state.
Clones the DimensionLayer.
Returns a list of the currently selected features.
Resets the visibility of the layer's features back to the original visibility when loaded from the data source.
Selects the given feature and adds it to the current list of selected features.
Selects the features in the list and adds them to the current list of selected features.
Selects the features that match the criteria in the QueryParameters object and adds them to the current list of selected features.
Sets the visibility of the given features.
Sets the visibility of the given feature.
Unselects the given feature and removes it from the current list of selected features.
Unselects the features in the given list and removes them from the current list of selected features.
Inherited functions
Cancels loading metadata for the Loadable object.
Fetches the list of legend info.
Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.