G4UMap
Extends:
Definition of the map-object Main task of the constructor is to load and read out the configuration. Uses the functions makeMapLayers, makeMapUI to create the map.
Custom properties accessible via method .get('propertyName')
Static Method Summary
Static Public Methods | ||
public static |
loadConfigFile(fileName: *): * |
Constructor Summary
Public Constructor | ||
public |
constructor(target: HTMLElement | jQuery | string, configs: Configs, options: G4UMapOptions) |
Member Summary
Public Members | ||
public |
|
|
public |
|
|
public |
|
|
public |
|
Private Members | ||
private |
defaultInteractions_: Map<string, ol.interaction.Interaction[]> |
|
private |
|
|
private |
supersedingInteractions_: Map<string, ol.interaction.Interaction[]> |
Method Summary
Public Methods | ||
public |
activateInteractions(eventType: string) Reactivates all default interactions which use a specified event type |
|
public |
addDefaultInteraction(eventTypes: string, interaction: ol.interaction.Interaction) Add an interaction that should be active by default (i.e. |
|
public |
overwrite base method to notify developer about differing api |
|
public |
|
|
public |
addModules(modules: Module[]) |
|
public |
addSupersedingInteraction(eventTypes: string, interaction: ol.interaction.Interaction) This adds an interaction to the map which prohibits other interactions which use the same eventtype to be active at the same time. |
|
public |
afterPostrender(listener: *) The listener is called once immediately after the next postrender event |
|
public |
deactivateInteractions(eventType: string) This deactivates all interactions which use a given event type |
|
public |
getControlsByName(name: string): Control[] Searches all controls of the specified name |
|
public |
getControlsByType(type: *): * |
|
public |
getDefaultInteractions(eventType: string): ol.interaction.Interaction[] Gets all interactions which use the specified event type |
|
public |
getModules(): Module[] |
|
public |
loadConfigs(configs: *): * |
|
public |
Remove all controls |
|
public |
removeInteraction(interaction: ol.interaction.Interaction) |
|
public |
Remove all interactions |
|
public |
setLayerGroup(groupLayer: GroupLayer, silent: boolean) |
|
public |
updateClientConfig(config: *): * |
|
public |
updateLayerConfig(config: *): * |
Static Public Methods
public static loadConfigFile(fileName: *): * source
Params:
Name | Type | Attribute | Description |
fileName | * |
Return:
* |
Public Constructors
public constructor(target: HTMLElement | jQuery | string, configs: Configs, options: G4UMapOptions) source
Params:
Name | Type | Attribute | Description |
target | HTMLElement | jQuery | string | element or id of an element |
|
configs | Configs | ||
options | G4UMapOptions |
|
Public Members
public interactionDecativationTimeout_: * source
public oldLayerConfigs_: * source
public oldMapConfigs_: * source
Private Members
Public Methods
public activateInteractions(eventType: string) source
Reactivates all default interactions which use a specified event type
Params:
Name | Type | Attribute | Description |
eventType | string |
public addDefaultInteraction(eventTypes: string, interaction: ol.interaction.Interaction) source
Add an interaction that should be active by default (i.e. in the normal state of the map)
Params:
Name | Type | Attribute | Description |
eventTypes | string | a list of space separated eventtypes this interaction reacts on |
|
interaction | ol.interaction.Interaction |
public addSupersedingInteraction(eventTypes: string, interaction: ol.interaction.Interaction) source
This adds an interaction to the map which prohibits other interactions which use the same eventtype to be active at the same time. When the superseding interaction is activated all affected ones get deactivated and vice versa
Params:
Name | Type | Attribute | Description |
eventTypes | string | a list of space separated eventtypes this interaction reacts on |
|
interaction | ol.interaction.Interaction |
public afterPostrender(listener: *) source
The listener is called once immediately after the next postrender event
Params:
Name | Type | Attribute | Description |
listener | * |
public deactivateInteractions(eventType: string) source
This deactivates all interactions which use a given event type
Params:
Name | Type | Attribute | Description |
eventType | string |
public getControlsByName(name: string): Control[] source
Searches all controls of the specified name
Params:
Name | Type | Attribute | Description |
name | string |
public getDefaultInteractions(eventType: string): ol.interaction.Interaction[] source
Gets all interactions which use the specified event type
Params:
Name | Type | Attribute | Description |
eventType | string |
Return:
ol.interaction.Interaction[] |
public removeInteraction(interaction: ol.interaction.Interaction) source
Params:
Name | Type | Attribute | Description |
interaction | ol.interaction.Interaction |
public setLayerGroup(groupLayer: GroupLayer, silent: boolean) source
Params:
Name | Type | Attribute | Description |
groupLayer | GroupLayer | ||
silent | boolean |
|
provide map to layers |
public updateClientConfig(config: *): * source
Params:
Name | Type | Attribute | Description |
config | * |
Return:
* |
public updateLayerConfig(config: *): * source
Params:
Name | Type | Attribute | Description |
config | * |
Return:
* |