Maps API for JavaScript Developer's Guide

H.map.Imprint

Class Summary

This class encapsulates the brand, copyright and terms of use information displayed on the map.

[ For full details, see the Class Details ]

Table 1. Methods
Methods
`setOptions (opt_options)` This method sets the imprint options. If the argument `opt_options` is not defined, then all values are reset to defaults.
`getCopyrights () : {string}` This method retrieves the copyright string for the current view of the map.
`getStyle () : {CSSStyleDeclaration}` This method gets the CSS style declaration of the imprint DOM element.
`addL11NString (tag, value)` Method adds "Terms of use" L11N string to the available collection.
`addOnDisposeCallback (callback, opt_scope)` This method adds a callback which to be triggered when an object is disposed.
`capture (canvas, pixelRatio, callback, opt_errback)` This method is used to capture the element view.

This class encapsulates the brand, copyright and terms of use information displayed on the map.

H.map.Imprint(map, opt_options)

setOptions (opt_options)

This method sets the imprint options. If the argument opt_options is not defined, then all values are reset to defaults.

getCopyrights () : {string}

This method retrieves the copyright string for the current view of the map.

getStyle () : {CSSStyleDeclaration}

This method gets the CSS style declaration of the imprint DOM element.

Returns:
: {CSSStyleDeclaration}
: An object containing the style details for the DOM element holding the imprint information.

addL11NString (tag, value)

Method adds "Terms of use" L11N string to the available collection.

addOnDisposeCallback (callback, opt_scope)

This method adds a callback which to be triggered when an object is disposed.

capture (canvas, pixelRatio, callback, opt_errback)

This method is used to capture the element view.

Parameters:
canvas:: {HTMLCanvasElement}
: The HTML Canvas element to draw the view of the capturable element
pixelRatio:: {number}
: The pixel ratio to use for over-sampling for high-resolution displays, the default is 1
callback:: {function(HTMLCanvasElement=)}
: A callback function to call once the result of capture is ready
opt_errback:: {function(string)=} [optional]
: A callback function to call if error occurred during capture