Class EsriScaleBar

Hierarchy

Widget
- EsriScaleBar

Index

Constructors

constructor

Properties

container declaredClass destroyed id initialized label style unit view viewModel visible

Constructors

constructor

new EsriScaleBar(properties?): EsriScaleBar
The ScaleBar widget displays a scale bar on the map or in a specified HTML node.

Read more...
Parameters
- Optional properties: ScaleBarProperties
Returns EsriScaleBar
Overrides Widget.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:97394

Properties

container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

id

id: string

The unique ID assigned to the widget when the widget is created.

initialized

initialized: boolean

label

label: string

The widget's label.

style

style: "ruler" | "line"

The style for the scale bar.

unit

unit: "non-metric" | "metric" | "dual"

Units to use for the scale bar.

Default

non-metric

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleBar.html#unit)

view

view: EsriMapView

A reference to the MapView.

viewModel

viewModel: ScaleBarViewModel

The view model for this widget.

visible

visible: boolean

Indicates whether the widget is visible.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#visible)

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Widget._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Widget._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriScaleBar
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriScaleBar
Inherited from Widget._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Widget.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

classes

classes(...classNames): string
A utility method used for building the value for a widget's class property.

Read more...
Parameters
- Rest ...classNames: any[]
Returns string
Inherited from Widget.classes
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107554

destroy

destroy(): void
Destroys the widget instance.

Read more...

Returns void
Inherited from Widget.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107560

emit

emit(type, event?): boolean
Emits an event on the instance.

Read more...
Parameters
- type: string
- Optional event: any
Returns boolean
Inherited from Widget.emit
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2063

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Widget.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Widget.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasEventListener

hasEventListener(type): boolean
Indicates whether there is an event listener on the instance that matches the provided event name.

Read more...
Parameters
- type: string
Returns boolean
Inherited from Widget.hasEventListener
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2069

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from Widget.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

isFulfilled

isFulfilled(): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

Read more...

Returns boolean
Inherited from Widget.isFulfilled
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107566

isRejected

isRejected(): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.

Read more...

Returns boolean
Inherited from Widget.isRejected
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107572

isResolved

isResolved(): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.

Read more...

Returns boolean
Inherited from Widget.isResolved
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107578

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from Widget.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

on

on(type, listener): IHandle
Registers an event handler on the instance.

Read more...
Parameters
- type: string | string[]
- listener: EventHandler
Returns IHandle
Inherited from Widget.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2075

own

own(handleOrHandles): void
Adds one or more handles which are to be tied to the lifecycle of the widget.

Read more...
Parameters
- handleOrHandles: WatchHandle | WatchHandle[]
Returns void
Inherited from Widget.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107584

postInitialize

postInitialize(): void
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

Read more...

Returns void
Inherited from Widget.postInitialize
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107590

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Widget.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

render

render(): any
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Read more...

Returns any
Inherited from Widget.render
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107596

renderNow

renderNow(): void
Renders widget to the DOM immediately.

Read more...

Returns void
Inherited from Widget.renderNow
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107602

scheduleRender

scheduleRender(): void
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

Read more...

Returns void
Inherited from Widget.scheduleRender
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107608

set

set<T>(propertyName, value): EsriScaleBar
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriScaleBar
Inherited from Widget.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriScaleBar
Parameters
- props: HashMap<any>
Returns EsriScaleBar
Inherited from Widget.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from Widget.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

when

when(callback?, errback?): Promise<any>
when() may be leveraged once an instance of the class is created.

Read more...
Parameters
- Optional callback: Function
- Optional errback: Function
Returns Promise<any>
Inherited from Widget.when
- Defined in node_modules/@arcgis/core/interfaces.d.ts:107614

Class EsriScaleBar

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: ScaleBarProperties

Returns EsriScaleBar

Properties

container

declaredClass

destroyed

id

initialized

label

style

unit

Default

view

viewModel

visible

Default

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriScaleBar

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

classes

Parameters

Rest ...classNames: any[]

Returns string

destroy

Returns void

emit

Parameters

type: string

Optional event: any

Returns boolean

get

Type Parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

hasEventListener

Parameters

type: string

Returns boolean

hasHandles

Type Parameters

T

Parameters

Optional groupKey: Exclude<T, IHandle>

Returns boolean

isFulfilled

`Optional` properties: ScaleBarProperties

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Rest` ...classNames: any[]

`Optional` event: any

`Optional` groupKey: Exclude<T, IHandle>

`Protected` notifyChange

`Optional` groupKey: Exclude<T, IHandle>

`Optional` sync: boolean

`Optional` callback: Function

`Optional` errback: Function