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
-
new DimensionSimpleStyle(properties)
-
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. more details | DimensionSimpleStyle | |
String | The name of the class. more details | Accessor | |
Number | Size of text in dimension labels in points. more details | DimensionSimpleStyle | |
Number | Width of dimension lines in points. more details | DimensionSimpleStyle | |
Color | Background color of dimension labels. more details | DimensionSimpleStyle | |
Color | Color of text in dimension labels. more details | DimensionSimpleStyle | |
String | For DimensionSimpleStyle the type is always "simple". more details | DimensionSimpleStyle |
Property Details
-
Color of dimension lines.
- Default Value:black
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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 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. more details | Accessor | ||
this | Creates a deep clone of this object. more details | DimensionSimpleStyle | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
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.
-
clone(){this}
-
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.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if 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"); }
-
removeHandles(groupKey)inherited
-
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");