Document that map render events do not have a context set
This commit is contained in:
@@ -33,8 +33,8 @@ class RenderEvent extends Event {
|
||||
this.frameState = opt_frameState;
|
||||
|
||||
/**
|
||||
* Canvas context. Only available when a Canvas renderer is used, null
|
||||
* otherwise.
|
||||
* Canvas context. Not available when the event is dispatched by the map. Only available
|
||||
* when a Canvas renderer is used, null otherwise.
|
||||
* @type {CanvasRenderingContext2D|null|undefined}
|
||||
* @api
|
||||
*/
|
||||
|
||||
@@ -23,6 +23,7 @@ export default {
|
||||
|
||||
/**
|
||||
* Triggered before layers are rendered.
|
||||
* The event object will not have a `context` set.
|
||||
* @event module:ol/render/Event~RenderEvent#precompose
|
||||
* @api
|
||||
*/
|
||||
@@ -30,6 +31,7 @@ export default {
|
||||
|
||||
/**
|
||||
* Triggered after all layers are rendered.
|
||||
* The event object will not have a `context` set.
|
||||
* @event module:ol/render/Event~RenderEvent#postcompose
|
||||
* @api
|
||||
*/
|
||||
@@ -38,6 +40,7 @@ export default {
|
||||
/**
|
||||
* Triggered when rendering is complete, i.e. all sources and tiles have
|
||||
* finished loading for the current viewport, and all tiles are faded in.
|
||||
* The event object will not have a `context` set.
|
||||
* @event module:ol/render/Event~RenderEvent#rendercomplete
|
||||
* @api
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user