require(["esri/widgets/ScaleBar/ScaleBarViewModel"], (ScaleBarViewModel) => { /* code goes here */ });
import ScaleBarViewModel from "@arcgis/core/widgets/ScaleBar/ScaleBarViewModel.js";
esri/widgets/ScaleBar/ScaleBarViewModel
Provides the logic for the ScaleBar widget.
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 |
|---|---|---|---|
The name of the class. | Accessor | ||
The current state of the widget. | ScaleBarViewModel | ||
The view from which the widget will operate. | ScaleBarViewModel |
Property Details
-
state
Propertystate Stringreadonly -
The current state of the widget.
Possible Values:"disabled" |"ready"
-
view
Propertyview MapView -
The view from which the widget will operate.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Computes the size and units of the scale bar widget given a base length in pixels. | ScaleBarViewModel | ||
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
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
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.
-
getScaleBarProperties
MethodgetScaleBarProperties(length, measurementSystem){Object}Since: ArcGIS Maps SDK for JavaScript 4.31ScaleBarViewModel since 4.3, getScaleBarProperties added at 4.31. -
Computes the size and units of the scale bar widget given a base length in pixels.
ParametersReturnsType Description Object Property Type Description length number Adjusted length of the scale bar widget in pixels. value number The length of the scale bar in map units. unit "millimeter" | "centimeter" | "meter" | "kilometer" | "inch" | "foot" | "mile" The map units to use on the scale bar.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
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
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
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");