ScaleBarViewModel

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

Provides the logic for the ScaleBar widget.

See also

Constructors

ScaleBarViewModel

Constructor
new ScaleBarViewModel(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

The name of the class.

Accessor

The current state of the widget.

ScaleBarViewModel

The view from which the widget will operate.

ScaleBarViewModel

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

state

Property
state Stringreadonly

The current state of the widget.

Possible Values:"disabled" |"ready"

view

Property
view MapView

The view from which the widget will operate.

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

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

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
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.

getScaleBarProperties

Method
getScaleBarProperties(length, measurementSystem){Object}
Since: ArcGIS Maps SDK for JavaScript 4.31 ScaleBarViewModel since 4.3, getScaleBarProperties added at 4.31.

Computes the size and units of the scale bar widget given a base length in pixels.

Parameters
length Number

The base width of the scale bar widget in pixels.

measurementSystem String

The measurement system to use.

Possible Values:"imperial"|"metric"

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

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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.