Class LocateCompat

Hierarchy

BaseControlCompat
- LocateCompat

Index

Constructors

Properties

container eventBus graphic lastPosition loaded loadStatus subscriptions view viewModel zoom

Accessors

Methods

attachContainer destroy load locate notifyWatchers onLoad watch when

Constructors

constructor

new LocateCompat(options?: LocateCompatOptions): LocateCompat
Parameters
- options: LocateCompatOptions = {}
Returns LocateCompat
Overrides BaseControlCompat.constructor
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:387

Properties

container

container: string | HTMLElement | null

`Readonly`eventBus

eventBus: CompatEventBus

graphic

graphic: GraphicCompat | undefined

The latest locate result, so a directions stop can clone it.

lastPosition

lastPosition: LocatePositionCompat | undefined

loaded

loaded: boolean

loadStatus

loadStatus: ControlLoadStatusCompat

`Protected` `Readonly`subscriptions

subscriptions: CompatEventSubscription[]

`Readonly`view

view: unknown

`Readonly`viewModel

viewModel: { state: "disabled" | "ready" }

Mirrors the Esri Locate view model state watched by watchUtils.init.

`Readonly`zoom

zoom: number | undefined

Accessors

`Protected`controlName

get controlName(): string
Subclasses override to provide the event-name prefix used in load(), e.g. "home" yields "home.loading" / "home.loaded".

Returns string
Overrides BaseControlCompat.controlName
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:383

Methods

attachContainer

attachContainer(element: HTMLElement): void
Parameters
- element: HTMLElement
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:398

destroy

destroy(): void
Returns void
Inherited from BaseControlCompat.destroy
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:135

load

load(): Promise<LocateCompat>
Returns Promise<LocateCompat>
Inherited from BaseControlCompat.load
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:85

locate

locate(): Promise<LocatePositionCompat>
Returns Promise<LocatePositionCompat>
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:408

`Protected`notifyWatchers

notifyWatchers(propertyName: string, value: unknown): void
Parameters
- propertyName: string
- value: unknown
Returns void
Inherited from BaseControlCompat.notifyWatchers
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:142

`Protected`onLoad

onLoad(): void
Hook for subclasses to perform work during load (e.g. ScaleBarCompat.refresh).

Returns void
Inherited from BaseControlCompat.onLoad
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:103

watch

watch(
propertyName: "visible",
listener: (value: boolean) => void,
): ControlHandleCompat
Parameters
- propertyName: "visible"
- listener: (value: boolean) => void
Returns ControlHandleCompat
Inherited from BaseControlCompat.watch
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:115
watch(
propertyName: "disabled",
listener: (value: boolean) => void,
): ControlHandleCompat
Parameters
- propertyName: "disabled"
- listener: (value: boolean) => void
Returns ControlHandleCompat
Inherited from BaseControlCompat.watch
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:116
watch(
propertyName: "loaded",
listener: (value: boolean) => void,
): ControlHandleCompat
Parameters
- propertyName: "loaded"
- listener: (value: boolean) => void
Returns ControlHandleCompat
Inherited from BaseControlCompat.watch
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:117
watch(
propertyName: "loadStatus",
listener: (value: ControlLoadStatusCompat) => void,
): ControlHandleCompat
Parameters
- propertyName: "loadStatus"
- listener: (value: ControlLoadStatusCompat) => void
Returns ControlHandleCompat
Inherited from BaseControlCompat.watch
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:118
watch(
propertyName: string,
listener: (value: unknown) => void,
): ControlHandleCompat
Parameters
- propertyName: string
- listener: (value: unknown) => void
Returns ControlHandleCompat
Inherited from BaseControlCompat.watch
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:119

when

when(callback?: (widget: this) => void): Promise<LocateCompat>
Parameters
- Optionalcallback: (widget: this) => void
Returns Promise<LocateCompat>
Inherited from BaseControlCompat.when
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:107