require(["esri/analysis/DimensionSimpleStyle"], (DimensionSimpleStyle) => { /* code goes here */ });
import DimensionSimpleStyle from "@arcgis/core/analysis/DimensionSimpleStyle.js";
esri/analysis/DimensionSimpleStyle
Style that specifies how dimensions and their labels are displayed.
The simple style is either set on a DimensionAnalysis or on a DimensionLayer and applies to all dimensions added to them.
// create analysis with dimensions
const dimensionAnalysis = new DimensionAnalysis({
dimensions: [
new LengthDimension({
startPoint: new Point({ }),
endPoint: new Point({ })
})
],
style: new DimensionSimpleStyle({
color: "white",
lineSize: 1.5,
textBackgroundColor: "white",
textColor: "black",
fontSize: 9
}),
});
// add the analysis to the view
view.analyses.push(dimensionAnalysis);
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| Color | Color of dimension lines. | DimensionSimpleStyle | |
| String | The name of the class. | Accessor | |
| Number | Size of text in dimension labels in points. | DimensionSimpleStyle | |
| Number | Width of dimension lines in points. | DimensionSimpleStyle | |
| Color | Background color of dimension labels. | DimensionSimpleStyle | |
| Color | Color of text in dimension labels. | DimensionSimpleStyle | |
| String | For DimensionSimpleStyle the type is always "simple". | DimensionSimpleStyle |
Property Details
-
Color of dimension lines.
- Default Value:black
-
Size of text in dimension labels in points. This value may be autocast with a string expressing size in points or pixels (e.g.
12px).- Default Value:10
-
Width of dimension lines in points. This value may be autocast with a string expressing size in points or pixels (e.g.
12px).- Default Value:2
-
Background color of dimension labels.
- Default Value:[255, 255, 255, 0.6]
-
Color of text in dimension labels.
- Default Value:black
-
type
Propertytype Stringreadonly -
For DimensionSimpleStyle the type is always "simple".
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| this | Creates a deep clone of this object. | DimensionSimpleStyle | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");