Maps API for JavaScript Developer's Guide

H.map.Object

Class Summary

An Object is the abstract base class for visual representational objects on a map, such as polylines, polygons, markers, groups, overlays, etc.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods
`getId () : {*}` This method retrieves the ID of the given object.
`setVisibility (opt_visibility) : {H.map.Object}` This method sets the visibility of the given object.
`getVisibility (opt_effective) : {boolean}` This method retrieves a value indicating the visibility of the given object.
`getZIndex () : {(number \| undefined)}` This method retrieves the z-index of the given object.
`setZIndex (zIndex) : {H.map.Object}` This method sets the z-index of the given object.
`static compareZOrder (first, second) : {number}` This method compares the z-order of two objects. It can be useful when sorting a list of objects using the `sort()` method on `Array`
`getParentGroup () : {?H.map.Group}` This method retrieves the parent group which contains the given object or `null` if the object is not contained in any group.
`getRootGroup () : {!H.map.Object}` The root object to which the given object is attached or the object itself if it is not attached to another.
`contains (object) : {boolean}` This method checks whether the received object is an inclusive descendant of the given object.
`getProvider () : {?H.map.provider.ObjectProvider}` This method obtains the current provider of the given object.
`getInvalidations () : {H.map.provider.Invalidations}` This method retrieves the invalidation states for the given object.
`invalidate (flags) : {boolean}` This method invalidates the given map object.
`getData () : {*}` This method retrieves previously stored arbitrary data from the given object.
`setData (data) : {H.map.Object}` This method stores arbitrary data with the given map object.
`addEventListener (type, handler, opt_capture, opt_scope)` This method adds a listener for a specific event.
`removeEventListener (type, handler, opt_capture, opt_scope)` This method removes a previously added listener from the `EventTarget` instance.
`dispatchEvent (evt)` This method dispatches an event on the `EventTarget` object.
`dispose ()` 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.
`addOnDisposeCallback (callback, opt_scope)` This method adds a callback which is triggered when the `EventTarget` object is being disposed.

Class Description

An Object is the abstract base class for visual representational objects on a map, such as polylines, polygons, markers, groups, overlays, etc.

Constructor Details

H.map.Object(opt_options)

Parameters:
opt_options:: {H.map.Object.Options=} [optional]
: An object containing the initialization values for the given object

Method Details

getId () : {*}

This method retrieves the ID of the given object.

Returns:
: {*}
: The identifier of the given object.

setVisibility (opt_visibility) : {H.map.Object}

This method sets the visibility of the given object.

Parameters:
opt_visibility:: {boolean=} [optional]
: Indicates whether the map object should be visible.

Returns:
: {H.map.Object}
: The given object

getVisibility (opt_effective) : {boolean}

This method retrieves a value indicating the visibility of the given object.

Parameters:
opt_effective:: {boolean=} [optional]
: Indicates that the effective visibility is requested. In this case the visibility of all possible ancestor groups is also taken into account

Returns:
: {boolean}
: A value indicating if the object is visible (true) or not false

getZIndex () : {(number | undefined)}

This method retrieves the z-index of the given object.

Returns:
: {(number | undefined)}
: A value reflecting the z-index of the given object.

setZIndex (zIndex) : {H.map.Object}

This method sets the z-index of the given object.

Parameters:
zIndex:: {(number | undefined)}
: A value indicating the new z-index

Returns:
: {H.map.Object}
: The given object

static compareZOrder (first, second) : {number}

This method compares the z-order of two objects. It can be useful when sorting a list of objects using the sort() method on Array

Parameters:
first:: {H.map.Object}
: The first object to compare
second:: {H.map.Object}
: The second object to compare

Returns:
: {number}
: A value lower than 0, indicates that the first object has a lower z-order. 0 indicates that booth objects have the same z-order. A value lower than 0 indicates that the first object has a higher z-order.

getParentGroup () : {?H.map.Group}

This method retrieves the parent group which contains the given object or null if the object is not contained in any group.

Returns:
: {?H.map.Group}
: An object representing the containing group object or null if the given object is not contained in any group.

getRootGroup () : {!H.map.Object}

The root object to which the given object is attached or the object itself if it is not attached to another.

Returns:
: {!H.map.Object}
: An object representing the root group for the given object or the given object if it is not part of a group.

contains (object) : {boolean}

This method checks whether the received object is an inclusive descendant of the given object.

Parameters:
object:: {*}
: The object to check.

Returns:
: {boolean}
: true if the given object is contained in the given object, otherwise false

getProvider () : {?H.map.provider.ObjectProvider}

This method obtains the current provider of the given object.

Returns:
: {?H.map.provider.ObjectProvider}
: An object representing the provider

getInvalidations () : {H.map.provider.Invalidations}

This method retrieves the invalidation states for the given object.

Returns:
: {H.map.provider.Invalidations}
: An object containing the invalidation states

invalidate (flags) : {boolean}

This method invalidates the given map object.

Parameters:
flags:: {H.math.BitMask}
: The flags indicating the types of changes to the given object

Returns:
: {boolean}
: Indicates whether a validation was executed (only if the object has a provider)

getData () : {*}

This method retrieves previously stored arbitrary data from the given object.

Returns:
: {*}
: The previously stored data or undefined if no data was stored.

setData (data) : {H.map.Object}

This method stores arbitrary data with the given map object.

Parameters:
data:: {*}
: The data to be stored

Returns:
: {H.map.Object}
: The given map object

addEventListener (type, handler, opt_capture, opt_scope)

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.

Parameters:
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

removeEventListener (type, handler, opt_capture, opt_scope)

This method removes a previously added listener from the EventTarget instance.

Parameters:
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 oject defining the scope for the handler function

dispatchEvent (evt)

This method dispatches an event on the EventTarget object.

Parameters:
evt:: {(H.util.Event | string)}
: An object representing the event or a string with the event name

dispose ()

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.

addOnDisposeCallback (callback, opt_scope)

This method adds a callback which is triggered when the EventTarget object is being disposed.

Parameters:
callback:: {!Function}
: The callback function.
opt_scope:: {Object=} [optional]
: An optional scope for the callback function