Class: RenderEngine

H .map .render .p2d.RenderEngine

new H.map.render.p2d.RenderEngine (viewPort, viewModel, dataModel, options)

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.

Name	Type	Description
`viewPort`	H.map.ViewPort	An object representing the map viewport
`viewModel`	H.map.ViewModel	An object representing a view of the map
`dataModel`	H.map.DataModel	An object encapsulating the data to be rendered on the map (layers and objects)
`options`	H.map.render.RenderEngine.Options	An object containing the render engine initialization options

Extends

H.map.render.RenderEngine

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 or dispose on the given object when you no longer need it.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	An event handler function
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function

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.

getAnimationDuration ()number

This method retrieves the current setting indicating the length of animations (duration) run by the the render engine.

Returns:

Type	Description
number

getAnimationEase ()function

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.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	A previously added event handler
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function

resetAnimationDefaults ()

This method resets animation settings on the render engine to defaults. The duration is set to 300 ms and easing to EASE_OUT_QUAD.

setAnimationDuration (duration)

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

setAnimationEase (easeFunction)

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

H.map.render.p2d.RenderEngine.Options Object

Options that can be used to initialize a new instance of the RenderEngine.

Properties:

Name	Type	Argument	Description
`renderBaseBackground`	Object	<optional>	Object describes how many cached zoom levels should be used as a base map background while base map tiles are
`pixelRatio`	number		The pixelRatio to use for over-sampling in cases of high-resolution displays
`enableSubpixelRendering`	boolean	<optional>

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:

H.util.Event