Class: RenderEngine
- Last UpdatedJul 9, 2025
- 3 minute read
This class implements a map render engine. It presents a geographic location (look-at data from a view model) and renders all map layers in the order in which they are provided in a single 2D canvas element.
Extends
Methods
-
addEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method adds a listener for a specific event.
Note that to prevent potential memory leaks, you must either call
removeEventListener
ordispose
on the given object when you no longer need it. -
addOnDisposeCallback (callback, opt_scope) inherited
-
This method adds a callback which is triggered when the
EventTarget
object is being disposed.Name Type Description callback
function The callback function.
opt_scope
Object optional An optional scope for the callback function
-
dispatchEvent (evt) inherited
-
This method dispatches an event on the
EventTarget
object.Name Type Description evt
H.util.Event | string An object representing the event or a string with the event name
-
dispose () inherited
-
This method removes listeners from the given object. Classes that extend
EventTarget
may need to override this method in order to remove references to DOM Elements and additional listeners. -
This method retrieves the current setting indicating the length of animations (duration) run by the the render engine.
Returns:
Type Description number -
This method retrieves the current setting representing the easing to be applied to animations.
Returns:
Type Description function A numeric value in the range 0 to 1 -
removeEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method removes a previously added listener from the
EventTarget
instance. -
This method resets animation settings on the render engine to defaults. The
duration
is set to 300 ms andeasing
toEASE_OUT_QUAD
. -
This method sets the length (duration) for all animations run by the render engine.
Name Type Description duration
number A value indicating the duration of animations
-
This method sets a value indicating the easing to apply to animations run by the render engine.
Name Type Description easeFunction
function(number): number A function that alters the progress ratio of an animation. It receives an argument indicating animation progress as a numeric value in the range between 0 and 1 and must return a numeric value in the same range.
Type Definitions
-
Options that can be used to initialize a new instance of the RenderEngine.
Properties:
Events
-
render inherited
-
Fired when one of the layers or the engine (all layers) has been rendered completely. The event target references either the completed layer or the render engine itself.
Type: