Class LocateCompat

Hierarchy

BaseControlCompat
- LocateCompat

Index

Constructors

constructor

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

Properties

`Readonly`container

container: null | string | HTMLElement

`Readonly`eventBus

eventBus: CompatEventBus

lastPosition

lastPosition: undefined | LocatePositionCompat

loaded

loaded: boolean

loadStatus

loadStatus: ControlLoadStatusCompat

`Protected` `Readonly`subscriptions

subscriptions: CompatEventSubscription[]

`Readonly`view

view: unknown

`Readonly`zoom

zoom: undefined | number

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

Methods

destroy

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

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

locate

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

`Protected`notifyWatchers

notifyWatchers(propertyName, value): 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:129

`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:90

watch

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

when

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

Class LocateCompat

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LocateCompat

Properties

Readonlycontainer

ReadonlyeventBus

lastPosition

loaded

loadStatus

Protected Readonlysubscriptions

Readonlyview

Readonlyzoom

Accessors

ProtectedcontrolName

Returns string

Methods

destroy

Returns void

load

Returns Promise<LocateCompat>

locate

Returns Promise<LocatePositionCompat>

ProtectednotifyWatchers

Parameters

Returns void

ProtectedonLoad

Returns void

watch

Parameters

Parameters

Returns void

Returns ControlHandleCompat

Parameters

Parameters

Returns void

Returns ControlHandleCompat

Parameters

Parameters

Returns void

Returns ControlHandleCompat

Parameters

Parameters

Returns void

Returns ControlHandleCompat

Parameters

Parameters

Returns void

Returns ControlHandleCompat

when

Parameters

Parameters

Returns void

Returns Promise<LocateCompat>

Settings

On This Page

`Readonly`container

`Readonly`eventBus

`Protected` `Readonly`subscriptions

`Readonly`view

`Readonly`zoom

`Protected`controlName

`Protected`notifyWatchers

`Protected`onLoad