Module: ol/render/canvas

Members

module:ol/render/canvas.labelCache{?}

The label cache for text rendering. To change the default cache size of 2048 entries, use module:ol/structs/LRUCache#setSize. Deprecated - there is no label cache any more.

Deprecated

• Yes

Type Definitions

DeclutterImageWithText{Object.<number, module:ol/render/canvas/Executor~ReplayImageOrLabelArgs>}

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>

Label

Properties:

Name	Type	Description
width	number
height	number
contextInstructions	Array.<(string|number)>

SerializableInstructions{Object}

Properties:

Name	Type	Argument	Description
instructions	Array.<*>		The rendering instructions.
hitDetectionInstructions	Array.<*>		The rendering hit detection instructions.
coordinates	Array.<number>		The array of all coordinates.
textStates	Object.<string, module:ol/render/canvas~TextState>	<optional>	The text states (decluttering).
fillStates	Object.<string, module:ol/render/canvas~FillState>	<optional>	The fill states (decluttering).
strokeStates	Object.<string, module:ol/render/canvas~StrokeState>	<optional>	The stroke states (decluttering).

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	module:ol/size~Size	<optional>
padding	Array.<number>	<optional>