Class: Invalidations

H .map .provider.Invalidations

new H.map.provider.Invalidations ()

This class represents invalidation states of a renderable object. A renderer can optimize its rendering strategies based on the information in this object.

For example, renderers may differentiate between a purely visual change to an object and a spatial change. One may only require the change of a color during rendering, the other requires re-projection of the object.

Members

H.map.provider.Invalidations.Flag static

This enumeration encapsulates bit flags for different invalidations of map objects.

Flags can be combined to signal multiple changes at the same time. These flags are used by providers to differentiate different kinds of property changes in order to optimize rendering.

Properties:

Name	Description
`NONE`	indicates that no change occurred
`VISUAL`	the visual appearance of an object has been changed
`SPATIAL`	the spatial geometry of an object has been changed
`ADD`	an item has been added to a provider
`REMOVE`	an item has been removed from a provider
`Z_ORDER`	the z-index of an item or its index within its parent's children collection has been changed
`VOLATILITY`	the volatility of an object has been changed

H.map.provider.Invalidations.MARK_INITIAL H.map.provider.Invalidations.Mark staticconstantnon-null

This constant represents the initial invalidation mark for an invalidations object.

Methods

getMark ()H.map.provider.Invalidations.Mark

This method retrieves the current invalidation mark of the given invalidations object.

Returns:

Type	Description
H.map.provider.Invalidations.Mark	The current invalidation mark

isAdd (since)boolean

This method checks whether an add-operation occurred after the specified since mark.

Name	Type	Description
`since`	H.map.provider.Invalidations.Mark	The invalidation mark to check against

Returns:

Type	Description
boolean	A value indicating whether an add operation occurred (`true`), or not (`false`)

isAny (since)boolean

This method checks whether any change occurred after the specified since mark.

Name	Type	Description
`since`	H.map.provider.Invalidations.Mark	The invalidation mark to check against

Returns:

Type	Description
boolean	A value indicating whether a change occurred (`true`), or not (`false`)

isRemove (since)boolean

This method checks whether a remove operation occurred after the specified since mark.

Name	Type	Description
`since`	H.map.provider.Invalidations.Mark	The invalidation mark to check against

Returns:

Type	Description
boolean	A value indicating whether a remove operation occurred (`true`), or not (`false`)

isSpatial (since)boolean

This method checks whether a spatial change occurred after the specified since mark.

Name	Type	Description
`since`	H.map.provider.Invalidations.Mark	The invalidation mark to check against

Returns:

Type	Description
boolean	A value indicating whether a spatial change occurred (`true`), or not (`false`)

isVisual (since)boolean

This method checks whether a visual change occurred after the specified since mark.

Name	Type	Description
`since`	H.map.provider.Invalidations.Mark	The invalidation mark to check against

Returns:

Type	Description
boolean	A value indicating whether a visual change occurred (`true`), or not (`false`)

isVolatility (since)boolean

To obtain whether a volatility change occurred after the specified since mark.

Name	Type	Description
`since`	H.map.provider.Invalidations.Mark	The invalidation mark to check against

Returns:

Type	Description
boolean

isZOrder (since)boolean

This method checks whether a z-order change occurred after the specified since mark.

Name	Type	Description
`since`	H.map.provider.Invalidations.Mark	The invalidation mark to check against

Returns:

Type	Description
boolean	A value indicating whether a z-order change operation occurred (`true`), or not (`false`)

update (mark, types)

This method updates invalidation marks according to the caller-provided invalidation types.

Name	Type	Description
`mark`	H.map.provider.Invalidations.Mark	The invalidation mark to set
`types`	H.math.BitMask.<!H.map.provider.Invalidations.Flag>	The discrete invalidation types to update

Type Definitions

H.map.provider.Invalidations.Mark number

The invalidation mark. It represents a counter which is increased whenever an invalidation takes place.