Methods

drawAsync

Stability: not documented

Register a function to be called for rendering at a given zIndex. The function will be called asynchronously. The callback will receive a reference to ol.render.canvas.Immediate context for drawing.

Parameters:

Name	Type	Description
zIndex	number	Z index.
callback	function	Callback.

Source:

• canvasimmediate.js, line 384

drawCircleGeometry

Stability: experimental

Render a circle geometry into the canvas. Rendering is immediate and uses the current fill and stroke styles.

Parameters:

Name	Type	Description
circleGeometry	ol.geom.Circle	Circle geometry.
data	Object	Opaque data object,

Source:

• canvasimmediate.js, line 403

drawFeature

Stability: experimental

Render a feature into the canvas. In order to respect the zIndex of the style this method draws asynchronously and thus after calls to drawXxxxGeometry have been finished, effectively drawing the feature on top of everything else. You probably should be using ol.FeatureOverlay instead of calling this method directly.

Parameters:

Name	Type	Description
feature	ol.Feature	Feature.
style	ol.style.Style	Style.

Source:

• canvasimmediate.js, line 448

drawLineStringGeometry

Stability: experimental

Render a LineString into the canvas. Rendering is immediate and uses the current style.

Parameters:

Name	Type	Description
lineStringGeometry	ol.geom.LineString	Line string geometry.
data	Object	Opaque data object.

Source:

• canvasimmediate.js, line 543

drawMultiLineStringGeometry

Stability: experimental

Render a MultiLineString geometry into the canvas. Rendering is immediate and uses the current style.

Parameters:

Name	Type	Description
multiLineStringGeometry	ol.geom.MultiLineString	MultiLineString geometry.
data	Object	Opaque data object.

Source:

• canvasimmediate.js, line 573

drawMultiPointGeometry

Stability: experimental

Render a MultiPoint geometry into the canvas. Rendering is immediate and uses the current style.

Parameters:

Name	Type	Description
multiPointGeometry	ol.geom.MultiPoint	MultiPoint geometry.
data	Object	Opaque data object.

Source:

• canvasimmediate.js, line 522

drawPointGeometry

Stability: experimental

Render a Point geometry into the canvas. Rendering is immediate and uses the current style.

Parameters:

Name	Type	Description
pointGeometry	ol.geom.Point	Point geometry.
data	Object	Opaque data object.

Source:

• canvasimmediate.js, line 501

drawPolygonGeometry

Stability: experimental

Render a Polygon geometry into the canvas. Rendering is immediate and uses the current style.

Parameters:

Name	Type	Description
polygonGeometry	ol.geom.Polygon	Polygon geometry.
data	Object	Opaque data object.

Source:

• canvasimmediate.js, line 609

setFillStrokeStyle

Stability: experimental

Set the fill and stroke style for subsequent draw operations. To clear either fill or stroke styles, pass null for the appropriate parameter.

Parameters:

Name	Type	Description
fillStyle	ol.style.Fill	Fill style.
strokeStyle	ol.style.Stroke	Stroke style.

Source:

• canvasimmediate.js, line 823

setImageStyle

Stability: experimental

Set the image style for subsequent draw operations. Pass null to remove the image style.

Parameters:

Name	Type	Description
imageStyle	ol.style.Image	Image style.

Source:

• canvasimmediate.js, line 868

setTextStyle

Stability: experimental

Set the text style for subsequent draw operations. Pass null to remove the text style.

Parameters:

Name	Type	Description
textStyle	ol.style.Text	Text style.

Source:

• canvasimmediate.js, line 907