Class AttributionCompat

Hierarchy

BaseControlCompat
- AttributionCompat

Index

Constructors

constructor

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

Properties

attributions

attributions: string[]

`Readonly`container

container: null | string | HTMLElement

`Readonly`eventBus

eventBus: CompatEventBus

itemDelimiter

itemDelimiter: string

loaded

loaded: boolean

loadStatus

loadStatus: ControlLoadStatusCompat

`Readonly`map

map: unknown

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

Methods

addAttribution

addAttribution(value): void
Parameters
- value: string
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:545

destroy

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

getText

getText(): string
Returns string
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:567

load

load(): Promise<AttributionCompat>
Returns Promise<AttributionCompat>
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

removeAttribution

removeAttribution(value): boolean
Parameters
- value: string
Returns boolean
- Defined in work/honua-sdk-js/honua-sdk-js/src/esri-compat/controls.ts:555

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

Class AttributionCompat

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AttributionCompat

Properties

attributions

Readonlycontainer

ReadonlyeventBus

itemDelimiter

loaded

loadStatus

Readonlymap

Protected Readonlysubscriptions

Readonlyview

Accessors

ProtectedcontrolName

Returns string

Methods

addAttribution

Parameters

Returns void

destroy

Returns void

getText

Returns string

load

Returns Promise<AttributionCompat>

ProtectednotifyWatchers

Parameters

Returns void

ProtectedonLoad

Returns void

removeAttribution

Parameters

Returns boolean

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

Settings

On This Page

`Readonly`container

`Readonly`eventBus

`Readonly`map

`Protected` `Readonly`subscriptions

`Readonly`view

`Protected`controlName

`Protected`notifyWatchers

`Protected`onLoad