Module: ol/render/canvas

ol/render/canvas


Members

module:ol/render/canvas.labelCache{module:ol/render/canvas/LabelCache~LabelCache}

The label cache for text rendering. To change the default cache size of 2048 entries, use module:ol/structs/LRUCache#setSize.

Type Definitions

DeclutterGroup{Array.<*>}

Container for decluttered replay instructions that need to be rendered or omitted together, i.e. when styles render both an image and text, or for the characters that form text along lines. The basic elements of this array are [minX, minY, maxX, maxY, count], where the first four entries are the rendered extent of the group in pixel space. count is the number of styles in the group, i.e. 2 when an image and a text are grouped, or 1 otherwise. In addition to these four elements, declutter instruction arrays (i.e. the arguments to module:ol/render/canvas~drawImage are appended to the array.

DeclutterGroups{Array.<module:ol/render/canvas~DeclutterGroup>}

Declutter groups for support of multi geometries.

FillState{Object}

Properties:
Name Type Description
fillStyle module:ol/colorlike~ColorLike

FillStrokeState{Object}

Properties:
Name Type Argument Description
currentFillStyle module:ol/colorlike~ColorLike <optional>
currentStrokeStyle module:ol/colorlike~ColorLike <optional>
currentLineCap CanvasLineCap <optional>
currentLineDash Array.<number>
currentLineDashOffset number <optional>
currentLineJoin CanvasLineJoin <optional>
currentLineWidth number <optional>
currentMiterLimit number <optional>
lastStroke number <optional>
fillStyle module:ol/colorlike~ColorLike <optional>
strokeStyle module:ol/colorlike~ColorLike <optional>
lineCap CanvasLineCap <optional>
lineDash Array.<number>
lineDashOffset number <optional>
lineJoin CanvasLineJoin <optional>
lineWidth number <optional>
miterLimit number <optional>

StrokeState{Object}

Properties:
Name Type Description
lineCap CanvasLineCap
lineDash Array.<number>
lineDashOffset number
lineJoin CanvasLineJoin
lineWidth number
miterLimit number
strokeStyle module:ol/colorlike~ColorLike

TextState{Object}

Properties:
Name Type Argument Description
font string
textAlign string <optional>
textBaseline string
placement string <optional>
maxAngle number <optional>
overflow boolean <optional>
backgroundFill module:ol/style/Fill~Fill <optional>
backgroundStroke module:ol/style/Stroke~Stroke <optional>
scale number <optional>
padding Array.<number> <optional>