Events

This section describes events fired by this widget.

click

Fires when the map is clicked.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

location

Object

Returns the location of the clicked point on the map (if the 'google' or 'bing' provider is used).

jQueryEvent

jQuery.Event

Returns a jQuery event that caused the action execution (if a static google provider is used).

Instead, you can use the onClick option to handle the event.

See Also

disposing

Fires when the widget is being removed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onDisposing option to handle the event.

See Also
NOTE
This event fires only if the widget is removed using the remove(), empty(), or html() jQuery methods.

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget instance.

element

jQuery

The widget's container.

Main article: onInitialized

See Also

markerAdded

Fires after a marker is added to the map.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

options

Object

Returns the object that defines the currently added marker in the "markers" array.

originalMarker

Object

Returns an original marker object used by the current map provider (only for 'google' and 'bing' providers).

Instead, you can use the onMarkerAdded option to handle the event.

See Also

markerRemoved

Fires after a marker is removed from the map.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

options

Object

Returns the object that defines the currently removed marker in the "markers" array.

Instead, you can use the onMarkerRemoved option to handle the event.

See Also

optionChanged

Fires after an option of the component is changed.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

name

String

Specifies the name of the option whose value is changed.

fullName

String

Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.

value any

Specifies a new value for the option.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Instead, you can use the onOptionChanged option to handle the event.

See Also

ready

Fires after a map is rendered.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

originalMap

Object

Returns the provider's map instance.

Instead, you can use the onReady option to handle the event.

See Also

routeAdded

Fires after a route is added to the map.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

options

Object

Returns the object that defines the currently added route in the "routes" array.

originalRoute

Object

Returns an original route object used by the current map provider (only for 'google' and 'bing' providers).

Instead, you can use the onRouteAdded option to handle the event.

See Also

routeRemoved

Fires after a route is removed from the map.

Type:

Event

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

options

Object

Returns the object that defines the currently removed route in the "markers" array.

Instead, you can use the onRouteRemoved option to handle the event.

See Also