DimensionSimpleStyle

AMD: require(["esri/analysis/DimensionSimpleStyle"], (DimensionSimpleStyle) => { /* code goes here */ });
ESM: import DimensionSimpleStyle from "@arcgis/core/analysis/DimensionSimpleStyle.js";
Class: esri/analysis/DimensionSimpleStyle
Inheritance: DimensionSimpleStyle Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25

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);
See also

Constructors

DimensionSimpleStyle

Constructor
new DimensionSimpleStyle(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

Color of dimension lines.

DimensionSimpleStyle

The name of the class.

Accessor

Size of text in dimension labels in points.

DimensionSimpleStyle

Width of dimension lines in points.

DimensionSimpleStyle

Background color of dimension labels.

DimensionSimpleStyle

Color of text in dimension labels.

DimensionSimpleStyle
For DimensionSimpleStyle the type is always "simple". DimensionSimpleStyle

Property Details

color

Property
color Colorautocast
Autocasts from Object|Number[]|String

Color of dimension lines.

Default Value:black

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

fontSize

Property
fontSize Numberautocast
Autocasts from Number|String

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

lineSize

Property
lineSize Numberautocast
Autocasts from Number|String

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

textBackgroundColor

Property
textBackgroundColor Colorautocast
Autocasts from Object|Number[]|String

Background color of dimension labels.

Default Value:[255, 255, 255, 0.6]

textColor

Property
textColor Colorautocast
Autocasts from Object|Number[]|String

Color of text in dimension labels.

Default Value:black

type

Property
type Stringreadonly

For DimensionSimpleStyle the type is always "simple".

Method Overview

Show inherited methods Hide inherited methods
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

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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

Method
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.

Returns
Type Description
this A deep clone of the class instance that invoked this method.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.