Map Methods

This section describes members used to manipulate a widget.

addMarker(markerOptions)

Adds a marker to the map.

Parameters:
markerOptions: Object|Array
A marker object and an array of marker objects.
Return Value: jQuery.Promise
A Promise of the jQuery Deferred object which is resolved with an original marker instance when the marker is added.

The marker object should 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.

addRoute(routeOptions)

Adds a route to the map.

Parameters:
options: Object|Array
A route object and an array of route objects.
Return Value: jQuery.Promise
A Promise of the jQuery Deferred object which is resolved with an original route instance when the route is added.

The route 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'

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 update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating 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 update the UI until the endUpdate method is called. The usage of these methods prevents excessive component updating when changing multiple component setting 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, marker index or an array of markers to be removed.
Return Value: jQuery.Promise
A Promise of the jQuery Deferred object which is resolved when the marker is removed.

removeRoute(route)

Removes a route from the map.

Parameters:
A route options object, route index or an array of route to be removed.
Return Value: jQuery.Promise
A Promise of the jQuery Deferred object which is resolved when the route is removed.

repaint()

Redraws the widget.

After performing some external modifications that lead to a change of the widget container's size or visibility, the widget's state may become invalid. In this instance, use the repaint() method to redraw the widget.