ScaleBarViewModel | References | ArcGIS Maps SDK for JavaScript

import ScaleBarViewModel from "@arcgis/core/widgets/ScaleBar/ScaleBarViewModel.js";

Provides the logic for the Scale Bar component and ScaleBar widget.

See also

Constructors

Parameter	Type	Description	Required
properties	`ScaleBarViewModelProperties`

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

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`state` readonly	`ScaleBarViewModelState`
`view`	`MapView \| null \| undefined`

readonlyinherited Property

Inherited from: Accessor

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

readonly Property

The current state of the widget.

Property

The view from which the widget will operate.

Method	Signature	Class
`getScaleBarProperties`	`getScaleBarProperties(length: number, measurementSystem: MeasurementSystem): any \| null \| undefined`

Method

Signature: getScaleBarProperties (length: number, measurementSystem: MeasurementSystem): any | null | undefined

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

Parameter	Type	Description	Required
length	`number`	The base width of the scale bar widget in pixels.
measurementSystem	`MeasurementSystem`	The measurement system to use.

Returns

any | null | undefined

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.

Type definition