fbdbbfb7a7
This change adds a stability value to the api annotation, with 'experimental' as default value. enum, typedef and event annotations are never exportable, but api annotations are needed there to make them appear in the docs. Nested typedefs are no longer inlined recursively, because the resulting tables get too wide with the current template.
18 lines
714 B
JavaScript
18 lines
714 B
JavaScript
goog.provide('ol.CanvasFunctionType');
|
|
|
|
|
|
/**
|
|
* A function returning the canvas element (`{HTMLCanvasElement}`)
|
|
* used by the source as an image. The arguments passed to the function are:
|
|
* {@link ol.Extent} the image extent, `{number}` the image resolution,
|
|
* `{number}` the device pixel ratio, {@link ol.Size} the image size, and
|
|
* {@link ol.proj.Projection} the image projection. The canvas returned by
|
|
* this function is cached by the source. The this keyword inside the function
|
|
* references the {@link ol.source.ImageCanvas}.
|
|
*
|
|
* @typedef {function(this:ol.source.ImageCanvas, ol.Extent, number,
|
|
* number, ol.Size, ol.proj.Projection): HTMLCanvasElement}
|
|
* @todo api
|
|
*/
|
|
ol.CanvasFunctionType;
|