Methods

This section describes members used to manipulate a widget.

addMarker(markerOptions, callback)

Adds a marker to the map.

Parameters:
markerOptions: Object|Array

An object defining added marker options. These options include 'location'(required), 'tooltip'(optional), 'click'(optional) and 'text'(optional).

callback: function

A callback function called after the marker has been added.

Return Value: jQuery.Promise

A Deferred jQuery object.

The markerOptions object can include the following fields.

  • location (required) - the marker location. You can specify the location in one of the following formats:
    • { lat: 40.749825, lng: -73.987963};
    • "40.749825, -73.987963";
    • [40.749825, -73.987963];
    • 'Brooklyn Bridge,New York,NY';
  • tooltip (optional) - the marker tooltip;
  • clickAction (optional) - an action performed when the marker is clicked;
  • text (optional) - the marker caption.
  • iconSrc (optional) - a URL pointing to the custom icon to be used for the marker.
Show Example:
jQuery

addRoute(routeOptions, callback)

Adds a route to the map.

Parameters:
options: Object|Array

An object containing the route locations.

callback: function

A callback function called after the route has been added.

Return Value: jQuery.Promise

A Deferred jQuery object.

The options object should include the locations field, containing an array of route locations. Each location can be specified in any of the following formats.

  • { lat: 40.749825, lng: -73.987963}
  • "40.749825, -73.987963"
  • [40.749825, -73.987963]
  • 'Brooklyn Bridge,New York,NY'
Show Example:
jQuery

beginUpdate()

Prevents the component from refreshing until the endUpdate method is called.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not raise events, and does not update the UI until the endUpdate method is called. Using these methods prevents excessive component updates when changing multiple component settings at once.

endUpdate()

Enables the component to refresh after the beginUpdate method call.

The beginUpdate and endUpdate methods allow you to apply several modifications to the component. After the beginUpdate method is called, the component does not raise events, and does not update the UI until the endUpdate method is called. Using these methods prevents excessive component updates when changing multiple component settings at once.

instance()

Returns an instance of this component class.

Return Value: Object

An instance of this component class

Use this method to access other methods of the component.

option()

Returns the configuration options of this component.

Return Value: Object

An object representing the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

Parameters:
optionName: String

The name of the option to get.

Return Value: any

The value of the specified option.

If you need to get the value of a configuration option field, specify the path to the required field.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

Parameters:
optionName: String

The name of the required option.

optionValue: any

The value you wish to assign to the required option.

To set a value to the configuration option field, specify the path to the required field.

option(options)

Sets one or more options of this component.

Parameters:
options: Object

An object containing the required configuration options.

removeMarker(marker)

Removes a marker from the map.

Parameters:

A marker options object or marker index specifying the marker to be removed.

Show Example:
jQuery

removeRoute(route)

Removes a route from the map.

Parameters:

A route options object or a route index specifying the route to remove.

Show Example:
jQuery