Class CompassCompat

Hierarchy

BaseControlCompat
- CompassCompat

Index

Constructors

constructor

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

Properties

`Readonly`container

container: null | string | HTMLElement

`Readonly`eventBus

eventBus: CompatEventBus

loaded

loaded: boolean

loadStatus

loadStatus: ControlLoadStatusCompat

orientation

orientation: number

`Protected` `Readonly`subscriptions

subscriptions: CompatEventSubscription[]

`Readonly`view

view: unknown

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

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

goToNorth

goToNorth(): number
Returns number
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:413

load

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

`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

reset

reset(): number
Returns number
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:407

rotateTo

rotateTo(rotation): number
Parameters
- rotation: number
Returns number
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:396

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<CompassCompat>
Parameters
- Optionalcallback: ((widget: this) => void)
  - - (widget): void
    - Parameters
      widget: this
      Returns void
Returns Promise<CompassCompat>
Inherited from BaseControlCompat.when
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:94

Class CompassCompat

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CompassCompat

Properties

Readonlycontainer

ReadonlyeventBus

loaded

loadStatus

orientation

Protected Readonlysubscriptions

Readonlyview

Accessors

ProtectedcontrolName

Returns string

Methods

destroy

Returns void

goToNorth

Returns number

load

Returns Promise<CompassCompat>

ProtectednotifyWatchers

Parameters

Returns void

ProtectedonLoad

Returns void

reset

Returns number

rotateTo

Parameters

Returns number

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<CompassCompat>

Settings

On This Page

`Readonly`container

`Readonly`eventBus

`Protected` `Readonly`subscriptions

`Readonly`view

`Protected`controlName

`Protected`notifyWatchers

`Protected`onLoad