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 cache.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	FillStyle.

FillStrokeState{Object}

Properties:

Name	Type	Argument	Description
currentFillStyle	module:ol/colorlike~ColorLike	<optional>	Current FillStyle.
currentStrokeStyle	module:ol/colorlike~ColorLike	<optional>	Current StrokeStyle.
currentLineCap	CanvasLineCap	<optional>	Current LineCap.
currentLineDash	Array.<number>		Current LineDash.
currentLineDashOffset	number	<optional>	Current LineDashOffset.
currentLineJoin	CanvasLineJoin	<optional>	Current LineJoin.
currentLineWidth	number	<optional>	Current LineWidth.
currentMiterLimit	number	<optional>	Current MiterLimit.
lastStroke	number	<optional>	Last stroke.
fillStyle	module:ol/colorlike~ColorLike	<optional>	FillStyle.
strokeStyle	module:ol/colorlike~ColorLike	<optional>	StrokeStyle.
lineCap	CanvasLineCap	<optional>	LineCap.
lineDash	Array.<number>		LineDash.
lineDashOffset	number	<optional>	LineDashOffset.
lineJoin	CanvasLineJoin	<optional>	LineJoin.
lineWidth	number	<optional>	LineWidth.
miterLimit	number	<optional>	MiterLimit.

Label

Properties:

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

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	LineCap.
lineDash	Array.<number>	LineDash.
lineDashOffset	number	LineDashOffset.
lineJoin	CanvasLineJoin	LineJoin.
lineWidth	number	LineWidth.
miterLimit	number	MiterLimit.
strokeStyle	module:ol/colorlike~ColorLike	StrokeStyle.

TextState{Object}

Properties:

Name	Type	Argument	Description
font	string		Font.
textAlign	string	<optional>	TextAlign.
textBaseline	string		TextBaseline.
placement	string	<optional>	Placement.
maxAngle	number	<optional>	MaxAngle.
overflow	boolean	<optional>	Overflow.
backgroundFill	module:ol/style/Fill~Fill	<optional>	BackgroundFill.
backgroundStroke	module:ol/style/Stroke~Stroke	<optional>	BackgroundStroke.
scale	module:ol/size~Size	<optional>	Scale.
padding	Array.<number>	<optional>	Padding.