Maps API for JavaScript Developer's Guide

H.util.DataEvent

Class Summary

Extends: H.util.Event

An event which holds any kind of data. It uses one generic type:

[ For full details, see the Class Details ]

Property Summary

Table 1. Properties
Properties

data : {T}

Arbitrary data stored in the event.

target : {*}

This property holds the object which triggered the event.

currentTarget : {*}

This property holds an object that receives notification of the event (via an attached listener).

type : {string}

This property holds the name of the dispatched event.

defaultPrevented : {boolean}

This property holds indicates if preventDefault was called on the current event.

CAPTURING_PHASE : {number}

This property identifies the current event phase as the capturing phase.

AT_TARGET : {number}

This property indicates that the event is being evaluated at the target.

BUBBLING_PHASE : {number}

This property identifies the current event phase as the bubbling phase.

eventPhase : {number}

This property indicates which phase of the event flow is being evaluated.

Method Summary

Table 2. Methods
Methods

preventDefault ()

This method sets a flag that can be used to prevent the default behavior when the even is fired.

stopPropagation ()

This method stops the propagation of the event.

Class Description

An event which holds any kind of data. It uses one generic type:

  • T: The type of the data

Constructor Details

H.util.DataEvent(type, data, opt_target)

Parameters:
 
type:
{string}
 
Event Type.
data:
{T}
 
Data that should be stored in the event object.
opt_target:
{Object=} [optional]
 
A reference to the object that is the target of the given event. It must implement the EventTarget interface.

Property Details

data: {T}

Arbitrary data stored in the event.

target: {*}

This property holds the object which triggered the event.

currentTarget: {*}

This property holds an object that receives notification of the event (via an attached listener).

type: {string}

This property holds the name of the dispatched event.

defaultPrevented: {boolean}

This property holds indicates if preventDefault was called on the current event.

CAPTURING_PHASE: {number}

This property identifies the current event phase as the capturing phase.

AT_TARGET: {number}

This property indicates that the event is being evaluated at the target.

BUBBLING_PHASE: {number}

This property identifies the current event phase as the bubbling phase.

eventPhase: {number}

This property indicates which phase of the event flow is being evaluated.

Method Details

preventDefault ()

This method sets a flag that can be used to prevent the default behavior when the even is fired.

stopPropagation ()

This method stops the propagation of the event.