new geo.canvas.renderer(arg){geo.canvas.canvasRenderer}
Create a new instance of class canvasRenderer.
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
arg |
object |
Options for the renderer.
|
Returns:
Type | Description |
---|---|
geo.canvas.canvasRenderer |
Extends
Members
-
inherited idle
-
Getter for the idle state. Read only.
Properties:
Name Type Description idle
boolean true
if the object is idle (onIdle
would call a handler immediately).
Static Methods
-
staticgeo.canvas.renderer.fallback(){null}
-
If the canvas renderer is not supported, supply the name of a renderer that should be used instead. This asks for the null renderer.
Returns:
Type Description null null
for the null renderer. -
staticgeo.canvas.renderer.supported(){boolean}
-
Report if the canvas renderer is supported.
Returns:
Type Description boolean true if available.
Methods
-
Add a new promise object preventing idle event handlers from being called until it is resolved.
Name Type Description promise
Promise A promise object.
Returns:
Type Description this -
api(){string}
-
Get API used by the renderer.
Returns:
Type Description string 'canvas'. -
inherited canvas(val){HTMLElement|this}
-
Get/set canvas for the renderer.
Name Type Description val
HTMLElement optional If
undefined
, return the current canvas element, otherwise set the canvas element and mark the renderer as modified.Returns:
Type Description HTMLElement | this The current canvas element or the renderer instance. -
clearCanvas(arg)
-
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.
Name Type Description arg
boolean Truthy to clear the canvas when rendering is started.
-
Report if an event handler is bound to this object.
Name Type 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 reporttrue
if there is any handler for the specified event.Returns:
Type Description boolean true if any of the specified events are bound to the specified handler. -
Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.
Name Type Description event
string | Array.<string> optional An event or a list of events from
geo.event
or defined by the user, orundefined
to remove all events (in which casearg
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 Description this -
Bind an event handler to this object.
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 ageo.event
object.Returns:
Type Description this -
Bind an event handler to this object that will fire once and then deregister itself.
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 ageo.event
object.Returns:
Type Description function The actual bound handler. This is a wrapper around the handler that was passed to the function. -
Trigger an event (or events) on this object and call all handlers.
Name Type 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 Description this -
inherited height(){number}
-
Get the height of the renderer.
Returns:
Type Description number The height of the renderer. -
inherited initialized(val){boolean|this}
-
Get/set if renderer has been initialized.
Name Type Description val
boolean optional If
undefined
return the initialization state, otherwise set it.Returns:
Type Description boolean | this The initialization state or this renderer instance. -
Get layer of the renderer.
Returns:
Type Description geo.layer -
Get the map associated with the renderer's layer.
Returns:
Type Description geo.map | null The map associated with the renderer's layer or null
if there is no layer. -
inherited modified(){this}
-
Update the timestamp to the next global timestamp value.
Returns:
Type Description this -
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.
Name Type Description handler
function A function taking no arguments.
Returns:
Type Description this -
Mark a promise as no longer required to resolve before the idle state is reached.
Name Type Description promise
Promise A promise object.
Returns:
Type Description this -
inherited timestamp(){number}
-
Get time.
Returns:
Type Description number The timestamp. This is 0 if the timestamp has never been modified. -
inherited width(){number}
-
Get the width of the renderer.
Returns:
Type Description number The width of the renderer.