MapMoveCls
Extends:
assists with map move interactions, trigger callback functions
Constructor Summary
Public Constructor | ||
public |
constructor called implicitly |
Member Summary
Public Members | ||
public get |
mapExtent: * return the map extent |
Method Summary
Public Methods | ||
public |
addCallback(func: mapMoveCallbackFunction, context: *, delay: number, triggerOnAdd: boolean, functionId: string) add a callback to the map move event |
|
public |
addVectorLayer(lyr: LayerBaseVector | *, triggerOnAdd: boolean) Add a layer to the interaction |
|
public |
init(theMap: ol.Map) initialize the map move object |
|
public |
triggerLyrLoad(lyr: LayerBaseVector | *, index: number, eventType: string | *) Trigger the layer load |
|
public |
triggerMoveCallback(ind: number, eventType: string | *, functionId: string) trigger the map move call back at the given index |
Inherited Summary
From class MapInteractionBase | ||
public get |
initialized: boolean: * get if is initialized |
|
public get |
map: ol.Map: * get reference to the ol map object |
|
public |
Check the initialization status and throw exception if not valid yet |
|
public |
base initializer, returns true for already initialized |
|
protected |
Check the initialization status and throw exception if not valid yet |
Public Constructors
Public Members
Public Methods
public addCallback(func: mapMoveCallbackFunction, context: *, delay: number, triggerOnAdd: boolean, functionId: string) source
add a callback to the map move event
Params:
Name | Type | Attribute | Description |
func | mapMoveCallbackFunction | callback function |
|
context | * | the context to use for this function |
|
delay | number |
|
the delay before call load |
triggerOnAdd | boolean |
|
if the layer should be loaded on add to mapMove |
functionId | string |
|
optional id to reference the function later for outside triggering |
public addVectorLayer(lyr: LayerBaseVector | *, triggerOnAdd: boolean) source
Add a layer to the interaction
Params:
Name | Type | Attribute | Description |
lyr | LayerBaseVector | * | layer to add |
|
triggerOnAdd | boolean |
|
if the layer should be loaded on add |
public init(theMap: ol.Map) source
initialize the map move object
Override:
MapInteractionBase#initParams:
Name | Type | Attribute | Description |
theMap | ol.Map | the ol map |
public triggerLyrLoad(lyr: LayerBaseVector | *, index: number, eventType: string | *) source
Trigger the layer load
Params:
Name | Type | Attribute | Description |
lyr | LayerBaseVector | * | the layer being acted on |
|
index | number |
|
index of the layer |
eventType | string | * |
|
the event triggering the load, as 'change:center' or 'change:resolution' |