Class default

Measure area, length, coordinates and elevation in a map.

Hierarchy

Widget
- default

Index

Constructors

Properties

declaredClass destroyed icon id initialized label view visible

Accessors

Constructors

constructor

new default(properties: MeasureProperties): default
Parameters
- properties: MeasureProperties
Returns default
Overrides Widget.constructor
- Defined in src/components/Measure.tsx:87

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

icon

icon: string | nullish

Icon which represents the widget.

Default

null

id

id: string

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

initialized

initialized: boolean

label

label: string | nullish

The widget's label.

`Readonly`view

view: MapView

visible

visible: boolean

Indicates whether the widget is visible.

Default

true

Accessors

container

get container(): HTMLElement | nullish
The ID or node representing the DOM element containing the widget.

Read more...

Returns HTMLElement | nullish
Inherited from Widget.container
- Defined in node_modules/@arcgis/core/interfaces.d.ts:139835
set container(value: string | HTMLElement | nullish): void
Parameters
- value: string | HTMLElement | nullish
Returns void
Inherited from Widget.container
- Defined in node_modules/@arcgis/core/interfaces.d.ts:139836

Methods

`Protected`_get

_get(propertyName: string): any
Parameters
- propertyName: string
Returns any
Inherited from Widget._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName: string): 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: string, value: T): this
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns this
Inherited from Widget._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

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

classes

classes(...classNames: any[]): string
A utility method used for building the value for a widget's class property.
Parameters
- ...classNames: any[]
  The class names.
  
  Read more...
Returns string
Inherited from Widget.classes
- Defined in node_modules/@arcgis/core/interfaces.d.ts:139844

destroy

destroy(): void
Destroys the widget instance.

Read more...

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

emit

emit(type: string, event?: any): boolean
Emits an event on the instance.
Parameters
- type: string
  The name of the event.
- Optionalevent: any
  The event payload.
  
  Read more...
Returns boolean
Inherited from Widget.emit
- Defined in node_modules/@arcgis/core/interfaces.d.ts:139859

hasEventListener

hasEventListener(type: string): boolean
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
- type: string
  The name of the event.
  
  Read more...
Returns boolean
Inherited from Widget.hasEventListener
- Defined in node_modules/@arcgis/core/interfaces.d.ts:139868

hasHandles

hasHandles<T>(groupKey?: Exclude<T, IHandle>): boolean
Type Parameters
- T
Parameters
- OptionalgroupKey: 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:139874

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:139880

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:139886

`Protected`notifyChange

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

on

on(type: string | string[], listener: EventHandler): IHandle
Registers an event handler on the instance.
Parameters
- type: string | string[]
  An event or an array of events to listen for.
- listener: EventHandler
  The function to call when the event fires.
  
  Read more...
Returns IHandle
Inherited from Widget.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:139895

postInitialize

postInitialize(): Promise<void>
Executes after widget is ready for rendering.

Read more...

Returns Promise<void>
Overrides Widget.postInitialize
- Defined in src/components/Measure.tsx:91

removeHandles

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

render

render(): Element
This method is implemented by subclasses for rendering.

Read more...

Returns Element
Overrides Widget.render
- Defined in src/components/Measure.tsx:606

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:139913

scheduleRender

scheduleRender(): void
Schedules widget rendering.

Read more...

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

set

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

watch

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

when

when(callback?: Function, errback?: Function): Promise<any>
when() may be leveraged once an instance of the class is created.
Parameters
- Optionalcallback: Function
  The function to call when the promise resolves.
- Optionalerrback: Function
  The function to execute when the promise fails.
  
  Read more...
Returns Promise<any>
Inherited from Widget.when
- Defined in node_modules/@arcgis/core/interfaces.d.ts:139928