GeoJS

renderer

geo .canvas. renderer

new renderer(arg) → {geo.canvas.canvasRenderer}

Description:

Create a new instance of class canvasRenderer.

Source:

canvas/canvasRenderer.js, line 17

Parameters:

Name Type Description

arg

object

Options for the renderer.

Properties

Name	Type	Attributes	Description
`layer`	geo.layer	<optional>	Layer associated with the renderer.
`canvas`	HTMLElement	<optional>	Canvas element associated with the renderer.

Returns:

Type: geo.canvas.canvasRenderer

Extends

geo.renderer

Members

idle

Description:

Getter for the idle state. Read only.

Source:

object.js, line 45

Inherited From:

geo.object#idle

Properties:

Name	Type	Description
`idle`	boolean	`true` if the object is idle (`onIdle` would call a handler immediately).

Getter for the idle state. Read only.

Methods

addPromise(promise) → {this}

Description:

Add a new promise object preventing idle event handlers from being called until it is resolved.

Source:

object.js, line 80

Inherited From:

geo.object#addPromise

Parameters:

Name	Type	Description
`promise`	Promise	A promise object.

Returns:

Type: this

api() → {string}

Description:

Get API used by the renderer.

Source:

canvas/canvasRenderer.js, line 48

Overrides:

geo.renderer#api

Returns:

'canvas'.

Type: string

canvas(valopt) → {HTMLElement|this}

Description:

Get/set canvas for the renderer.

Source:

renderer.js, line 50

Inherited From:

geo.renderer#canvas

Parameters:

Name	Type	Attributes	Description
`val`	HTMLElement	<optional>	If `undefined`, return the current canvas element, otherwise set the canvas element and mark the renderer as modified.

Returns:

The current canvas element or the renderer instance.

Type: HTMLElement | this

clearCanvas(arg)

Description:

Set the clear canvas flag. If truthy, the canvas is erased at the start of the render cycle. If falsy, the old data is kept.

Source:

canvas/canvasRenderer.js, line 39

Parameters:

Name	Type	Description
`arg`	boolean	Truthy to clear the canvas when rendering is started.

geoIsOn(event, handleropt) → {boolean}

Description:

Report if an event handler is bound to this object.

Source:

object.js, line 187

Inherited From:

geo.object#geoIsOn

Parameters:

Name	Type	Attributes	Description
`event`	string \| Array.<string>		An event or list of events to check.
`handler`	function	<optional>	A function that might be bound. If `undefined`, this will report `true` if there is any handler for the specified event.

Returns:

true if any of the specified events are bound to the specified handler.

Type: boolean

geoOff(eventopt, argopt, nullable) → {this}

Description:

Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.

Source:

object.js, line 246

Inherited From:

geo.object#geoOff

Parameters:

Name	Type	Attributes	Description
`event`	string \| Array.<string>	<optional>	An event or a list of events from `geo.event` or defined by the user, or `undefined` to remove all events (in which case `arg` is ignored).
`arg`	function \| Array.<function()>	<optional> <nullable>	A function or array of functions to remove from the events or a falsy value to remove all handlers from the events.

Returns:

Type: this

geoOn(event, handler) → {this}

Description:

Bind an event handler to this object.

Source:

object.js, line 139

Inherited From:

geo.object#geoOn

Parameters:

Name	Type	Description
`event`	string	An event from `geo.event` or a user-defined value.
`handler`	function	A function that is called when `event` is triggered. The function is passed a `geo.event` object.

Returns:

Type: this

geoOnce(event, handler) → {function}

Description:

Bind an event handler to this object that will fire once and then deregister itself.

Source:

object.js, line 168

Inherited From:

geo.object#geoOnce

Parameters:

Name	Type	Description
`event`	string	An event from `geo.event` or a user-defined value.
`handler`	function	A function that is called when `event` is triggered. The function is passed a `geo.event` object.

Returns:

The actual bound handler. This is a wrapper around the handler that was passed to the function.

Type: function

geoTrigger(event, argsopt) → {this}

Description:

Trigger an event (or events) on this object and call all handlers.

Source:

object.js, line 207

Inherited From:

geo.object#geoTrigger

Parameters:

Name	Type	Attributes	Description
`event`	string \| Array.<string>		An event or list of events from `geo.event` or defined by the user.
`args`	object	<optional>	Additional information to add to the `geo.event` object passed to the handlers.

Returns:

Type: this

height() → {number}

Description:

Get the height of the renderer.

Source:

renderer.js, line 113

Inherited From:

geo.renderer#height

Returns:

The height of the renderer.

Type: number

initialized(valopt) → {boolean|this}

Description:

Get/set if renderer has been initialized.

Source:

renderer.js, line 81

Inherited From:

geo.renderer#initialized

Parameters:

Name	Type	Attributes	Description
`val`	boolean	<optional>	If `undefined` return the initialization state, otherwise set it.

Returns:

The initialization state or this renderer instance.

Type: boolean | this

layer() → {geo.layer}

Description:

Get layer of the renderer.

Source:

renderer.js, line 37

Inherited From:

geo.renderer#layer

Returns:

Type: geo.layer

map() → {geo.map|null}

Description:

Get the map associated with the renderer's layer.

Source:

renderer.js, line 65

Inherited From:

geo.renderer#map

Returns:

The map associated with the renderer's layer or null if there is no layer.

Type: geo.map | null

modified() → {this}

Description:

Update the timestamp to the next global timestamp value.

Source:

timestamp.js, line 25

Inherited From:

geo.timestamp#modified

Returns:

Type: this

onIdle(handler) → {this}

Description:

Bind a handler that will be called one time when all internal promises are resolved. If there are no outstanding promises, this is invoked synchronously.

Source: