Class QmsControl

Hierarchy

Control
- QmsControl

Constructors

constructor

new QmsControl(options?: QmsControlOptions): QmsControl
Parameters
- options: QmsControlOptions = {}
Returns QmsControl
Overrides Control.constructor
- Defined in packages/qms-ol/src/index.ts:183

Properties

`Readonly`control

control: QmsControlElement

`Protected`disposed

disposed: boolean

The object has already been disposed.

`Protected`element

element: HTMLElement

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

un

un: ObjectOnSignature<void>

Methods

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from Control.addChangeListener
- Defined in node_modules/ol/Object.d.ts:145

addEventListener

addEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from Control.addEventListener
- Defined in node_modules/ol/events/Target.d.ts:50

`Protected`applyProperties

applyProperties(source: BaseObject): void
Protected
Apply any properties from another object without triggering events.
Parameters
- source: BaseObject
  The source object.
Returns void
Inherited from Control.applyProperties
- Defined in node_modules/ol/Object.d.ts:172

changed

changed(): void
Increases the revision counter and dispatches a 'change' event.

Returns void

Api
Inherited from Control.changed
- Defined in node_modules/ol/Observable.d.ts:65

dispatchEvent

dispatchEvent(event: string | BaseEvent): boolean | undefined
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.
Parameters
- event: string | BaseEvent
  Event object.
Returns boolean | undefined
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api
Inherited from Control.dispatchEvent
- Defined in node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

Returns void
Inherited from Control.dispose
- Defined in node_modules/ol/Disposable.d.ts:19

`Protected`disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Inherited from Control.disposeInternal
- Defined in node_modules/ol/Disposable.d.ts:24

get

get(key: string): any
Gets a value.
Parameters
- key: string
  Key name.
Returns any
Value.

Api
Inherited from Control.get
- Defined in node_modules/ol/Object.d.ts:114

getKeys

getKeys(): string[]
Get a list of object property names.

Returns string[]
List of property names.

Api
Inherited from Control.getKeys
- Defined in node_modules/ol/Object.d.ts:120

getListeners

getListeners(type: string): Listener[] | undefined
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Parameters
- type: string
  Type.
Returns Listener[] | undefined
Listeners.
Inherited from Control.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

getMap(): Map | null
Get the map associated with this control.

Returns Map | null
Map.

Api
Inherited from Control.getMap
- Defined in node_modules/ol/control/Control.d.ts:94

getProperties

getProperties(): NoInfer<{ [x: string]: any }>
Get an object of all property names and values.

Returns NoInfer<{ [x: string]: any }>
Object.

Api
Inherited from Control.getProperties
- Defined in node_modules/ol/Object.d.ts:126

getPropertiesInternal

getPropertiesInternal(): Partial<NoInfer<{ [x: string]: any }>> | null
Get an object of all property names and values.

Returns Partial<NoInfer<{ [x: string]: any }>> | null
Object.
Inherited from Control.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:131

getRevision

getRevision(): number
Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns number
Revision.

Api
Inherited from Control.getRevision
- Defined in node_modules/ol/Observable.d.ts:72

hasListener

hasListener(type?: string): boolean
Parameters
- Optionaltype: string
  Type. If not provided, true will be returned if this event target has any listeners.
Returns boolean
Has listeners.
Inherited from Control.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from Control.hasProperties
- Defined in node_modules/ol/Object.d.ts:135

notify

notify(key: string, oldValue: any): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from Control.notify
- Defined in node_modules/ol/Object.d.ts:140

`Protected`onceInternal

onceInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from Control.onceInternal
- Defined in node_modules/ol/Observable.d.ts:86

`Protected`onInternal

onInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from Control.onInternal
- Defined in node_modules/ol/Observable.d.ts:79

removeChangeListener

removeChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from Control.removeChangeListener
- Defined in node_modules/ol/Object.d.ts:150

removeEventListener

removeEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from Control.removeEventListener
- Defined in node_modules/ol/events/Target.d.ts:80

render

render(mapEvent: MapEvent): void
Renders the control.
Parameters
- mapEvent: MapEvent
  Map event.
Returns void

Api
Inherited from Control.render
- Defined in node_modules/ol/control/Control.d.ts:88

set

set(key: string, value: any, silent?: boolean): void
Sets a value.
Parameters
- key: string
  Key name.
- value: any
  Value.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from Control.set
- Defined in node_modules/ol/Object.d.ts:158

setMap

setMap(map: Map | null): void
Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.
Parameters
- map: Map | null
  Map.
Returns void

Api
Overrides Control.setMap
- Defined in packages/qms-ol/src/index.ts:197

setProperties

setProperties(values: Partial<NoInfer<Properties>>, silent?: boolean): void
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Parameters
- values: Partial<NoInfer<Properties>>
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from Control.setProperties
- Defined in node_modules/ol/Object.d.ts:166

setTarget

setTarget(target: string | HTMLElement): void
This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.
Parameters
- target: string | HTMLElement
  Target.
Returns void

Api
Inherited from Control.setTarget
- Defined in node_modules/ol/control/Control.d.ts:113

`Protected`unInternal

unInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): void
Protected
Unlisten for a certain type of event.
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns void
Inherited from Control.unInternal
- Defined in node_modules/ol/Observable.d.ts:93

unset

unset(key: string, silent?: boolean): void
Unsets a property.
Parameters
- key: string
  Key name.
- Optionalsilent: boolean
  Unset without triggering an event.
Returns void

Api
Inherited from Control.unset
- Defined in node_modules/ol/Object.d.ts:179

Class QmsControl

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns QmsControl

Properties

Readonlycontrol

Protecteddisposed

Protectedelement

ProtectedlistenerKeys

on

once

un

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

dispatchEvent

Parameters

Returns boolean | undefined

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

get

Parameters

Returns any

Api

getKeys

Returns string[]

Api

getListeners

Parameters

Returns Listener[] | undefined

getMap

Returns Map | null

Api

getProperties

Returns NoInfer<{ [x: string]: any }>

Api

getPropertiesInternal

Returns Partial<NoInfer<{ [x: string]: any }>> | null

getRevision

Returns number

Api

hasListener

Parameters

Returns boolean

hasProperties

Returns boolean

notify

Parameters

Returns void

ProtectedonceInternal

Parameters

Returns EventsKey | EventsKey[]

ProtectedonInternal

Parameters

Returns EventsKey | EventsKey[]

removeChangeListener

Parameters

Returns void

removeEventListener

Parameters

Returns void

`Readonly`control

`Protected`disposed

`Protected`element

`Protected`listenerKeys

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal

`Protected`unInternal