Class GeoportalAttribution

Hierarchy

Attribution
- GeoportalAttribution

Constructors

constructor

new GeoportalAttribution(options: any): GeoportalAttribution
Parameters
- options: any
  ol.control.Attribution options (see ol.Control.Attribution)
Returns GeoportalAttribution
Fires
attributions:update
Example
```
var attribution = new ol.control.GeoportalAttribution({
  collapsed : false
});
map.addControl(attribution);
// listeners for attributions update :
attribution.on("attributions:update", function (e) {});
```
Overrides Attribution.constructor
- Defined in src/packages/Controls/Attribution/GeoportalAttribution.js:36

Properties

`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 Attribution.addChangeListener
- Defined in node_modules/ol/Object.d.ts:146

addEventListener

addEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from Attribution.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 Attribution.applyProperties
- Defined in node_modules/ol/Object.d.ts:175

changed

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

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

dispatchEvent

dispatchEvent(event: string | BaseEvent): undefined | boolean
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 undefined | boolean
false if anyone called preventDefault on the event object or if any of the listeners returned false.

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

dispose

dispose(): void
Clean up.

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

`Protected`disposeInternal

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

Returns void
Inherited from Attribution.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 Attribution.get
- Defined in node_modules/ol/Object.d.ts:111

getCollapsed

getCollapsed(): boolean
Return true when the attribution is currently collapsed or false otherwise.

Returns boolean
True if the widget is collapsed.

Api
Inherited from Attribution.getCollapsed
- Defined in node_modules/ol/control/Attribution.d.ts:215

getCollapsible

getCollapsible(): boolean
Return true if the attribution is collapsible, false otherwise.

Returns boolean
True if the widget is collapsible.

Api
Inherited from Attribution.getCollapsible
- Defined in node_modules/ol/control/Attribution.d.ts:194

getKeys

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

Returns string[]
List of property names.

Api
Inherited from Attribution.getKeys
- Defined in node_modules/ol/Object.d.ts:117

getListeners

getListeners(type: string): undefined | Listener[]
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 undefined | Listener[]
Listeners.
Inherited from Attribution.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

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

Returns null | Map
Map.

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

getProperties

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

Returns { [x: string]: any }
Object.

Api
Inherited from Attribution.getProperties
- Defined in node_modules/ol/Object.d.ts:123

getPropertiesInternal

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

Returns null | { [x: string]: any }
Object.
Inherited from Attribution.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:130

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 Attribution.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 Attribution.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

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

notify

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

`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 Attribution.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 Attribution.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 Attribution.removeChangeListener
- Defined in node_modules/ol/Object.d.ts:151

removeEventListener

removeEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from Attribution.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 Attribution.render
- Defined in node_modules/ol/control/Control.d.ts:86

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 Attribution.set
- Defined in node_modules/ol/Object.d.ts:159

setCollapsed

setCollapsed(collapsed: boolean): void
Collapse or expand the attribution according to the passed parameter. Will not do anything if the attribution isn't collapsible or if the current collapsed state is already the one requested.
Parameters
- collapsed: boolean
  True if the widget is collapsed.
Returns void
Api
Inherited from Attribution.setCollapsed
- Defined in node_modules/ol/control/Attribution.d.ts:208

setCollapsible

setCollapsible(collapsible: boolean): void
Set whether the attribution should be collapsible.
Parameters
- collapsible: boolean
  True if the widget is collapsible.
Returns void
Api
Inherited from Attribution.setCollapsible
- Defined in node_modules/ol/control/Attribution.d.ts:200

setMap

setMap(map: Map): void
Overload setMap function, that enables to catch map events, such as movend events.
Parameters
- map: Map
  Map.
Returns void
Overrides Attribution.setMap
- Defined in src/packages/Controls/Attribution/GeoportalAttribution.js:59

setProperties

setProperties(values: { [x: string]: any }, 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: { [x: string]: any }
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void
Api
Inherited from Attribution.setProperties
- Defined in node_modules/ol/Object.d.ts:167

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 Attribution.setTarget
- Defined in node_modules/ol/control/Control.d.ts:111

`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 Attribution.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 Attribution.unset
- Defined in node_modules/ol/Object.d.ts:182

Class GeoportalAttribution

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GeoportalAttribution

Fires

Example

Properties

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 undefined | boolean

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

get

Parameters

Returns any

Api

getCollapsed

Returns boolean

Api

getCollapsible

Returns boolean

Api

getKeys

Returns string[]

Api

getListeners

Parameters

Returns undefined | Listener[]

getMap

Returns null | Map

Api

getProperties

Returns { [x: string]: any }

Api

getPropertiesInternal

Returns null | { [x: string]: any }

getRevision

Returns number

Api

hasListener

Parameters

Returns boolean

hasProperties

Returns boolean

notify

Parameters

Returns void

ProtectedonceInternal

Parameters

Returns EventsKey | EventsKey[]

ProtectedonInternal

Parameters

`Protected`disposed

`Protected`element

`Protected`listenerKeys

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal

`Protected`unInternal