Page History

An object representing a point at a certain latitude and longitude. For the purposes of interacting with the map component, this object is typically a Python dictionary.

# Example
{ lat:50, lng:30 }

None

A Python dictionary containing keys that can modify the panning behavior on the Map component. The contents of this dictionary are listed below, but the original explanation can be found in Leaflet's documentation.

false

A Python dictionary containing keys that can modify the zooming behavior on the Map. The contents of this dictionary are listed below, but the original explanation can be found in Leaflet's documentation.

false

A Python dictionary containing keys that can modify the zooming behavior on the Map. The contents of this dictionary are listed below, but the original explanation can be found in Leaflet's documentation.

• Description

Returns the geographical center of the man in latitude and longitude. 

• Parameters

none

•  Return

LatLng  Returns the geographical center of the map view as{ lat: number, lng: number }.

• Scope

Session

• Description

Returns the current zoom level of the map view as a number.

• Parameters

none

•  Return

Numeric  Returns the current zoom level of the map view as a number.

• Scope

• Description

Returns the geographical bound of the map as a dictionary.

• Parameters

none

•  Return

Dictonary A dictionary containing the following keys:

north: number
northEast: 
LatLngeast: number
southEast: LatLng
south: number
southWest: LatLng
west: number
northWest: LatLng

• Scope

• Description

Returns a string with bounding box coordinates in a 'South West longitude, South West latitude , North East longitude, North East latitude' format.

• Parameters

none

•  Return

String  Returns the bounding box of the map as a string.

• Scope

• Description

Increases the zoom of the map by delta.

• Parameters

Numeric delta - The numerical value to increase the zoom by. If omitted, uses the value of props.zoom.delta. [optional]

Dictionary options - A dictionary of parameters to use during the zoom, typically containing a single key, animate. See 30345407. [optional]

•  Return

None

• Scope

• Description

Decreases the zoom of the map by delta.

• Parameters

Numeric delta - The numerical value to increase the zoom by. If omitted, uses the value of props.zoom.delta. [optional]

Dictionary options - A dictionary of parameters to use during the zoom, typically containing a single key, animate. See 30345407. [optional]

•  Return

None

• Scope

• Description

Zooms the map while keeping a specified geographical point on the map stationary (e.g. used internally for scroll zoom and double-click zoom)

• Parameters

Dictionary point - The geographic point that the map will zoom around. See 30345407. [required]

Numeric zoom- The numerical value to increase the zoom by. If omitted, uses the value of props.zoom.delta. [optional]

Dictionary options - A dictionary of parameters to use during the zoom, typically containing a single key, animate. See 30345407. [optional]

•  Return

None

• Scope

• Description

Sets a map view that contains the given geographical bounds with the maximum zoom level possible

• Parameters

Dictionary latLngBounds - A dictionary consisting of two LatLng objects. The LatLng objects combined represent the geographical bounds the map view should be set to. [required]

Dictionary options - A dictionary of parameters used to manipulate the FitBound settings. See 30345407. [optional]

•  Return

None

• Scope

• Description

Sets a map view that mostly contains the whole world with the maximum zoom level possible.

• Parameters

Dictionary options - A dictionary of parameters used to manipulate the FitBound settings. See 30345407. [optional]

•  Return

None

• Scope

• Description

Pans the map to a given center.

• Parameters

Dictionary latLng - The geographic point to pan to.[required]

Dictionary options - A dictionary of parameters used to modify the panning behavior. See 30345407. [optional]

•  Return

None

• Scope

• Description

Pans the map by a given number of pixels (animated).

• Parameters

Dictionary point - The geographic point to pan to. The dictionary should contain an 'x' and 'y' key, both with numeric values.[required]

Dictionary options - A dictionary of parameters used to modify the panning behavior. See 30345407. [optional]

•  Return

None

• Scope

• Description

Sets the view of the map (geographical center and zoom) performing a smooth pan-zoom animation. 

• Parameters

Dictionary latLng - A Python Dictionary representing the coordinates to fly to. [required]

Numeric zoom - Sets the zoom level to transition to during the flight. If omitted, uses the value on props.zoom.delta. [optional]

Dictionary options - A dictionary of panning options to use. See 30345407. [optional]

•  Return

None

• Scope

• Description

Sets the view of the map with a smooth animation like flyTo, but takes a bounds parameter like fitBounds.

• Parameters

Dictionary latLngBounds - A dictionary consisting of two LatLng objects. The LatLng objects combined represent the geographical bounds the map view should be set to.[required]

Dictionary options - A dictionary of panning options to use. See 30345407. [optional]

•  Return

None

• Scope

• Description

Pans the map to the closest view that would lie inside the given bounds (if it's not already), controlling the animation using the options specific, if any.

• Parameters

Dictionary latLngBounds - A dictionary consisting of two LatLng objects. The LatLng objects combined represent the geographical bounds the map view should be set to. [required]

Dictionary options - A dictionary of panning options to use. See 30345407. [optional]

•  Return

None

• Scope

• Description

Pans the map the minimum amount to make the latLng visible.

• Parameters

Dictionary latLng - A Python dictionary representing the coordinates to pan to. [required]

Dictionary options - A dictionary of panning options to use. See 30345407. [optional]

•  Return

None

• Scope

• Description

Returns height and width of the Map component.

• Parameters

none

•  Return

JSON Object  Returns a Python dictionary. Contains two items: height  and width .

• Scope

def doMapStuff(self):
	map = self.getSibling("Map")
	coordinateBounds = {'corner1': {'lat': 39.086798, 'lng': -120.069014}, 'corner2': { 'lat': 38.815319, 'lng': -119.787519 }}
	latLngTahoe = {'lat': 39.086798, 'lng': -120.069014 }
	latLngInductive = {'lat': 38.652511, 'lng': -121.189438 }
	zoomPanOptions = { 'animate': True, 'duration': 3, 'easeLinearity': 0.25, 'noMoveStart': False }
	fitBoundsOptions = { 'padding': { 'x': 100, 'y': 100 }, 'animate': True, 'duration': 3 }
	panPixels = { 'x': 200, 'y': 200 }


	print map.getCenter()
	# Returns the geographical bounds visible in the current map view as latLngBounds
	
	map.flyTo(latLng = latLngTahoe, options = zoomPanOptions)
	# Sets the view of the map with a smooth animation like flyTo, but takes a bounds parameter like fitBounds

Interaction event. Fired when the a marker is clicked. Returns the unique name of the marker.

Interaction event. Fired when the map is clicked. Returns the lat and lng of the mouse click as it translates on the map.

Interaction event. Fires as the mouse moves over the map. Returns lat and lng of mouse as it translates on the map.

Map state event. Fired when the map zoom is about to change (e.g. before zoom animation). Returns the zoom level.

Map state event. Fired repeatedly during any change in zoom level, included zoom and fly animations. Returns the zoom level.

Map state event. Fired when the map has changed, after any animations. Returns the zoom level.

Map state event. Fired when the view of the map starts changing (e.g., user starts dragging the map). Returns the map center as lat and lng.

Map state event. Fires repeatedly during any movement on the map, include pan and fly animations. Returns the map center as lat and lng.

Map state event. Fired when the center of the map stops changing (e.g. user stopped dragging the map). Returns the new map center as lat and lng.

Map state event. Fires when the map size has changed. Returns the map size as oldSize and newSize.