Class: Imprint

H .map.Imprint

new H.map.Imprint (map, opt_options)

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

Name	Type	Description
`map`	H.Map	The map object with which the imprint information is associated
`opt_options`	H.map.Imprint.Options	optional The configuration options for the imprint information

Extends

H.util.Disposable

Implements

H.util.ICapturable

Methods

addL11NString (tag, value)

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

Name	Type	Description
`tag`	string	IETF language tag
`value`	string	localisation string

addOnDisposeCallback (callback, opt_scope) inherited

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

Name	Type	Description
`callback`	function	A callback function to add
`opt_scope`	Object	optional An object representing the scope

capture (canvas, pixelRatio, callback, opt_errback)

This method is used to capture the element view.

Name	Type	Description
`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 `window.devicePixelRatio`.
`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.

dispose () inherited

Disposes of the object. If the object hasn't already been disposed of, calls H.util.Disposable#disposeInternal. Child classes should override the disposeInternal in order to cleanup references, resources and other disposable data.

disposeInternal () inherited overrides

Performs appropriate cleanup.

getCopyrights ()string

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

Returns:

Type	Description
string	The copyright string for the current map view

setOptions (opt_options)

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

Name	Type	Description
`opt_options`	H.map.Imprint.Options	optional The options to style the imprint

Type Definitions

H.map.Imprint.Options Object

This object encapsulates the initialization options that style imprint information.

Properties:

Name	Type	Argument	Description
`invert`	boolean	<optional>	Indicates whether the logo is inverted. If omitted, the current value remains, the default is `false`.
`font`	string	<optional>	The font of the text. If omitted, the current value remains, the default is `11px "Lucida Grande", Arial, Helvetica, sans-serif`.
`href`	string	<optional>	The URL of the "Terms of use" link. If omitted, the current value remains, the default is "https://here.com/terms".
`locale`	string	<optional>	IETF language tag for the "Terms of use" translation. Available default languages are: "de-DE", "en-US", "en-GB", "es-ES", "fi-FI", "fr-FR", "it-IT", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ru-RU", "tr-TR", "zh-CN". If value is omitted options defaults to "en-US"
`mark`	string	<optional>	A text that will be appended to the content of the imprint. It can be used to add a legal note, for example, like in Chinese builds where the default value of the `mark` property is the ministerial Map Review Approval `"GS (2022) 5659"`.