AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Map Improve this Doc

Extends: anychart.core.SeparateChart

AnyChart map class.

Methods Overview

Specific settings
a11y()Accessibility setting.
callout()Callout settings.
getType()Returns chart type.
globalToLocal()Converts the global coordinates to local coordinates.
inverseTransform()Transforms local pixel coordinates to latitude/longitude values.
localToGlobal()Converts the local coordinates to global coordinates.
overlapMode()Overlap mode for labels
toA11yTable()Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()Creates and returns a chart as HTML table.
transform()Returns coordinate at given latitude and longitude as pixel values relative to a map bounds.
unboundRegions()Unbound regions settings.
Axes and Scales
axes()Axes settings.
grids()Grid settings.
scale()Map geo scale settings.
Chart Coloring
animation()Animation settings
background()Background settings
hatchFillPalette()Hatch fill palette.
markerPalette()Markers palette.
palette()Map palette.
Chart Controls
colorRange()Color range settings.
contextMenu()Context menu settings.
credits()Credits settings
label()Label settings
legend()Legend settings.
title()Title settings
Charts
getCurrentScene()Returns the current chart after drilling down into the map.
Coloring
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
Data
geoData()Geo data settings.
geoIdField()Geo id field
getDrilldownPath()Returns the drill down path.
getSelectedPoints()Getter for the selected points.
getStat()Getter for a statistical value by the key.
noData()NoData settings.
Events
listen()Adds an event listener
listenOnce()Adds a single time event listener
removeAllListeners()Removes all listeners
unlisten()Removes the listener
unlistenByKey()Removes the listener by the key
Export
exports()Exports settings
print()Prints all elements.
saveAsCsv()Saves chart data as a CSV file.
saveAsJson()Saves chart config as JSON document.
saveAsXlsx()Saves chart data as an Excel document.
saveAsXml()Saves chart config as XML document.
shareWithFacebook()Opens Facebook sharing dialog.
shareWithLinkedIn()Opens LinkedIn sharing dialog.
shareWithPinterest()Opens Pinterest sharing dialog.
shareWithTwitter()Opens Twitter sharing dialog.
toCsv()Returns CSV string with the chart data.
Interactivity
crosshair()Map crosshair settings.
crsAnimation()Animation settings
drillDownMap()Drills down a map.
drillTo()Drills down to a map.
drillUp()Drills one level up from the current level.
fitAll()Fits all visible part to width of map. Maximum zoom out.
getZoomLevel()Gets the map zoom level.
hovered()Hovered state settings.
interactivity()Interactivity settings.
maxZoomLevel()Maximum zoom level.
move()Moves focus point for the map.
normal()Normal state settings.
selected()Selected state settings.
startSelectMarquee()Starts select marquee drawing.
tooltip()Tooltip settings
zoom()Zooms a map.
zoomIn()Zoom the map in the center.
zoomOut()Zoom the map out the center.
zoomTo()Zooms the map to passed zoom level and coordinates.
zoomToFeature()Zoom to feature by passed id.
Point Elements
labels()Labels settings.
Series
bubble()Creates a Bubble series.
choropleth()Creates a Choropleth series.
connector()Creates connector series.
getSeries()Getter for the series by its id.
marker()Creates a Marker series.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
crs()Coordinate system settings
featureCrs()Coordinate system for the feature.
featureScaleFactor()Scale settings of the feature
featureTranslation()Getter for the translation feature by id.
getPixelBounds()Returns pixel bounds.
getPlotBounds()Getter for the data bounds of the chart.
height()Height settings.
left()Left bound settings.
margin()Margin settings
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings
right()Right bound settings.
top()Top bound settings.
translateFeature()Translates feature on passed dx and dy.
width()Width settings.
zIndex()Z-index of the element.
Specific Series Settings
addSeries()Add series to the chart.
defaultSeriesType()Default series type.
getSeriesAt()Getter for the series by its index.
getSeriesCount()Returns a series count.
maxBubbleSize()Maximum size for all bubbles on the charts.
minBubbleSize()Minimum size for all bubbles on the charts.
removeAllSeries()Removes all series from chart.
removeSeries()Removes one of series from chart by its id.
removeSeriesAt()Removes one of series from chart by its index.
XML/JSON
toGeoJSON()Exports a map to GeoJSON format.
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
autoRedraw()Redraw chart after changes or not.
cancelMarquee()Stops marquee action if any.
container()Getter for the element's container.
draw()Drawing of the chart.
fullScreen()Fullscreen mode.
getJpgBase64String()Returns JPG as base64 string.
getPdfBase64String()Returns PDF as base64 string.
getPngBase64String()Returns PNG as base64 string.
getSvgBase64String()Returns SVG as base64 string.
id()Chart id.
inMarquee()Gets marquee process running value.
isFullScreenAvailable()Whether the fullscreen mode available in the browser or not.
saveAsJpg()Saves the chart as JPEG image.
saveAsPdf()Saves the chart as PDF image.
saveAsPng()Saves the chart as PNG image.
saveAsSvg()Saves the chart as SVG image.
shareAsJpg()Shares a chart as a JPG file and returns a link to the shared image.
shareAsPdf()Shares a chart as a PDF file and returns a link to the shared image.
shareAsPng()Shares a chart as a PNG file and returns a link to the shared image.
shareAsSvg()Shares a chart as a SVG file and returns a link to the shared image.
toSvg()Returns SVG string.

Methods Description

a11y

Getter for the accessibility setting.

Returns:

anychart.core.utils.ChartA11y - Accessibility settings object.
See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility setting.

Params:

NameTypeDescription
settingsboolean | ObjectWhether to enable accessibility or object with settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

addSeries

Add series to the chart.

Params:

NameTypeDescription
var_argsanychart.data.View | anychart.data.Set | ArrayChart series data.

Returns:

Array.<anychart.core.map.series.Base> - Array of created series.

animation

Getter for animation settings.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.
Setter for animation settings by one value.

Params:

NameTypeDefaultDescription
settingsboolean | Object
false
Whether to enable animation.

Returns:

anychart.charts.Map - Self instance for method chaining.
Setter for animation settings using several parameters.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable animation.
durationnumber
1000
Duration in milliseconds.

Returns:

anychart.charts.Map - Self instance for method chaining.

autoRedraw

Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Returns:

boolean - AutoRedraw flag.
See listing
var autoRedraw = chart.autoRedraw();
Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

axes

Getter for map axes.

Returns:

anychart.core.axes.MapSettings - Common axes settings.
Setter for map axes.

Params:

NameTypeDescription
settingsObject | booleanMap axes settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.
Setter for the chart background.

Params:

NameTypeDefaultDescription
settingsObject
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

bottom

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.
Setter for element bottom bound settings.

Params:

NameTypeDefaultDescription
bottomnumber | string | null
null
Bottom bound settings for the element.

Returns:

anychart.charts.Map - Returns self for method chaining.

bounds

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
Setter for bounds of the element using one parameter.

Params:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.charts.Map - Self instance for method chaining.
Setter for element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

anychart.charts.Map - Self instance for method chaining.

bubble

Creates a Bubble series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringSeries data as SVG, SVGString, GeoJSON or MapNameString.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.map.series.Bubble - An instance of the created series.

callout

Getter for callout elements.

Params:

NameTypeDescription
indexnumberIndex of existing callout element to get.

Returns:

anychart.core.ui.Callout - Callout instance by index.
Setter for callout elements.

Params:

NameTypeDescription
settingsObject | boolean | nullCallout settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.
Setter for callout elements by index.

Params:

NameTypeDescription
indexnumberIndex of existing callout element.
settingsObject | boolean | nullCallout settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

cancelMarquee

Stops marquee action if any.

Returns:

anychart.charts.Map - Self instance for method chaining.

choropleth

Creates a Choropleth series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringSeries data as SVG, SVGString, GeoJSON or MapNameString.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.map.series.Choropleth - An instance of the created series.

colorRange

Getter for the color range.

Returns:

anychart.core.ui.ColorRange - Color range.
Setter for the color range.

Params:

NameTypeDescription
settingsObjectColor range settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

connector

Creates connector series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringSeries data as SVG, SVGString, GeoJSON or MapNameString.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.map.series.Connector - An instance of the class for method chaining

container

Getter for the element's container.
Setter for the element's container.

Params:

NameTypeDescription
elementanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementContainer to set.

Returns:

anychart.charts.Map - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.standalones.title();
 element.container( fwElement.container() );

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.
Setter for the context menu.

Params:

NameTypeDescription
settingsObject | boolean | nullContext menu settings

Returns:

anychart.charts.Map - Self instance for method chaining.

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.
Setter for the chart credits. Learn more about credits settings.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
true
Credits settings

Returns:

anychart.charts.Map - An instance of the class for method chaining.

crosshair

Getter for map crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.
Setter for map crosshair settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Crosshair settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

crs

Getter for the the crs (coordinate system) to map.

Returns:

Object | function | anychart.enums.MapProjections | string - Projection name, or projection string representation, or projection Object or Function.
Setter for the the crs (coordinate system) to map.

Params:

NameTypeDescription
settingsObject | function | anychart.enums.MapProjections | stringProjection name, or projection string representation, or projection Object or Function.

Returns:

anychart.charts.Map - Self instance for method chaining.

crsAnimation

Getter for animation settings.

Returns:

anychart.core.utils.Animation - Animations settings object.
Setter for animation settings.

Params:

NameTypeDescription
settingsboolean | ObjectAnimation settings.
durationnumberA duration in milliseconds.

Returns:

anychart.charts.Map - Self instance for method chaining.

defaultSeriesType

Getter for the map default series type.

Returns:

anychart.enums.MapSeriesType | string - The map default series type.
Setter for the map default series type.

Params:

NameTypeDescription
typeanychart.enums.MapSeriesType | stringSeries type.

Returns:

anychart.charts.Map - Self instance for method chaining.

draw

Starts the rendering of the chart into the container.

Params:

NameTypeDescription
asyncbooleanWhether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

anychart.charts.Map - Self instance for method chaining.

drillDownMap

Drills down a map.
Set the transitions to drill down.

Params:

NameTypeDescription
valueObject.<string, (Object|anychart.charts.Map)>Value to set.

Returns:

Object - The object with id and map instance.

drillTo

Drills down to a map.

Params:

NameTypeDescription
idstringRegion id.
mapanychart.charts.MapMap instance.

Returns:

anychart.charts.Map - Self instance for method chaining.

drillUp

Drills one level up from the current level.
Rises up from the current level of drill down, if possible.

Returns:

anychart.charts.Map - Self instance for method chaining.

exports

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.
See listing
var exports = chart.exports();
Setter for the export charts.

Params:

NameTypeDescription
settingsObjectExport settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

featureCrs

Getter for the crs of the feature.
Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
idstringFeature id.

Returns:

string - The crs of the feature.
Setter for the crs of the feature.
Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
idstringFeature id.
crsstringString crs (coordinate system) representation.

Returns:

anychart.charts.Map - Self instance for method chaining.

featureScaleFactor

Getter for the feature scale factor.
Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
idstringFeature id.

Returns:

number - The scale of the feature.
Setter for the feature scale factor.
Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
idstringFeature id.
rationumberScale ratio.

Returns:

anychart.charts.Map - Self instance for method chaining.

featureTranslation

Getter for the translation feature by id.

Params:

NameTypeDescription
idstringFeature id.

Returns:

Array.<number> - The translating feature.
Setter for the translation feature.
Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
idstringFeature id.
dxnumberOffset by X coordinate.
dynumberOffset by Y coordinate.

Returns:

anychart.charts.Map - Self instance for method chaining.

fitAll

Fits all visible part to width of map. Maximum zoom out.
The fitAll() method should be used after drawing a chart.

Returns:

anychart.charts.Map - Self instance for method chaining.

fullScreen

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).
See listing
var fullScreen = chart.fullScreen();
Setter for the fullscreen mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enable/Disable fullscreen mode.

Returns:

anychart.charts.Map - Self instance for method chaining.

geoData

Getter for the geo data.

Returns:

Node | string | Object - The geo data.
See listing
var geoData = map.geoData();
Setter for the geo data.

Params:

NameTypeDescription
dataNode | string | ObjectMap data as SVG, SVGString, GeoJSON or MapNameString.

Returns:

anychart.charts.Map - Self instance for method chaining.

geoIdField

Getter for the geo id field.

Returns:

string - Geo id field.
See listing
var geoIdField = chart.geoIdField();
Setter for the geo id field.

Params:

NameTypeDescription
idstringGeo id.

Returns:

anychart.charts.Map - Self instance for method chaining.

getCurrentScene

Returns the current chart after drilling down into the map.

Returns:

anychart.charts.Map - Self instance for method chaining.

getDrilldownPath

Returns the drill down path.
Returns path of drill down from the root map to the current level.

Returns:

Array.<anychart.core.MapPoint> - An array of objects with map points (anychart.core.MapPoint).

getJpgBase64String

Returns JPG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.

getPdfBase64String

Returns PDF as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

getPlotBounds

Getter for the data bounds of the chart. Note: Works only after anychart.charts.Map#draw is called.

Returns:

anychart.math.Rect - Data bounds of the chart.

getPngBase64String

Returns PNG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

getSelectedPoints

Getter for the selected points.

Returns:

Array.<anychart.core.Point> - An array of the selected points.

getSeries

Getter for the series by its id.

Params:

NameTypeDefaultDescription
idnumber | string
index
Id of the series.

Returns:

anychart.core.map.series.Base - An instance of the created series.

getSeriesAt

Getter for the series by its index.

Params:

NameTypeDescription
indexnumberIndex of the series.

Returns:

anychart.core.map.series.Base - An instance of the created series.

getSeriesCount

Returns a series count.

Returns:

number - Number of series.

getStat

Getter for a statistical value by the key.

Params:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

getSvgBase64String

Returns SVG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.

getType

Returns chart type.

Returns:

string - Chart type.

getZoomLevel

Gets the map zoom level.

Returns:

number - Zoom level.

globalToLocal

Converts the global coordinates to local coordinates. Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

grids

Getter for map grids.

Returns:

anychart.core.grids.MapSettings - Grid instance.
Setter for map grids.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Chart grids settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

hatchFillPalette

Getter for the map hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - Chart hatch fill palette.
See listing
var hatchFillPalette = map.hatchFillPalette();
Setter for the map hatch fill palette settings.

Params:

NameTypeDescription
settingsArray.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFillsHatch fill palette to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

height

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.
Setter for element height setting.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the element.

Returns:

anychart.charts.Map - Returns self for method chaining.

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

id

Getter for chart id.

Returns:

string - Return chart id.
Setter for chart id.

Params:

NameTypeDescription
idstringChart id.

Returns:

anychart.charts.Map - Self instance for method chaining.

inMarquee

Gets marquee process running value.

Returns:

boolean - Returns true if there is a marquee process running.

interactivity

Getter for the interactivity settings.

Returns:

anychart.core.utils.MapInteractivity - Interactivity settings.
Setter for the interactivity settings.

Params:

NameTypeDescription
settingsObject | anychart.enums.HoverMode | stringSettings object or boolean value like enabled state.

Returns:

anychart.charts.Map - Self instance for method chaining.

inverseTransform

Transforms local pixel coordinates to latitude/longitude values.

Params:

NameTypeDescription
xnumberX pixel value to transform.
ynumberY pixel value to transform.

Returns:

Object.<string, number> - Object with latitude/longitude coordinates.

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

label

Getter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.
Setter for the chart label.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.Map - Self instance for method chaining.
Setter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
Label index.
settingsnull | boolean | Object | string
false
Chart label settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

labels

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for series data labels.

Params:

NameTypeDescription
settingsObject | boolean | nullSeries data labels settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

left

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.
Setter for element left bound settings.

Params:

NameTypeDefaultDescription
leftnumber | string | null
null
Left bound setting for the element.

Returns:

anychart.charts.Map - Returns self for method chaining.

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.
Setter for chart legend settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
false
Legend settings.

Returns:

anychart.charts.Map - An instance of the class for method chaining.

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method. Function that looks like:
function(event){
   // event.actualTarget - actual event target
   // event.currentTarget - current event target
   // event.iterator - event iterator
   // event.originalEvent - original event
   // event.point - event point
   // event.pointIndex - event point index
}
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object)
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

localToGlobal

Converts the local coordinates to global coordinates. Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
xCoordnumberLocal X coordinate.
yCoordnumberLocal Y coordinate.

Returns:

Object.<string, number> - Object with XY coordinates.

margin

Setter for the chart margin in pixels using a single complex object.

Params:

NameTypeDefaultDescription
marginArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Margin to set.

Returns:

anychart.charts.Map - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));
Setter for the chart margin in pixels using several simple values.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Map - Self instance for method chaining.
Example.
// 1) all 10px
chart.margin(10);
// 2) top and bottom 10px, left and right 15px
chart.margin(10, '15px');
// 3) top 10px, left and right 15px, bottom 5px
chart.margin(10, '15px', 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, '15px', '5px', 12);

marker

Creates a Marker series.

Params:

NameTypeDescription
dataanychart.data.View | anychart.data.Set | Array | stringSeries data as SVG, SVGString, GeoJSON or MapNameString.
csvSettingsanychart.enums.TextParsingMode | string | anychart.data.TextParsingSettingsIf CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.map.series.Marker - An instance of the created series.

markerPalette

Getter for the map markers palette settings.

Returns:

anychart.palettes.Markers - Map markers palette.
See listing
var markerPalette = map.markerPalette();
Setter for the map markers palette settings.

Params:

NameTypeDescription
settingsanychart.palettes.Markers | Object | Array.<(anychart.enums.MarkerType|string)>Map marker palette settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

maxBubbleSize

Getter for the maximum size for all bubbles on the charts.

Returns:

number | string - Maximum size.
Setter for the maximum size for all bubbles on the charts.

Params:

NameTypeDefaultDescription
sizenumber | string
'10%'
Maximum bubble size.

Returns:

anychart.charts.Map - Self instance for method chaining.

maxHeight

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.
Setter for the maximum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Maximum height to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

maxWidth

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.
Setter for the maximum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Maximum width to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

maxZoomLevel

Getter for the maximum zoom level.

Returns:

number - Maximum zoom level.
Setter for the maximum zoom level.

Params:

NameTypeDescription
valuenumberMaximum zoom level.

Returns:

anychart.charts.Map - Self instance for method chaining.

minBubbleSize

Getter for the minimum size for all bubbles on the charts.

Returns:

number | string - Minimum size.
Setter for the minimum size for all bubbles on the charts.

Params:

NameTypeDefaultDescription
sizenumber | string
'1%'
Minimum bubble size.

Returns:

anychart.charts.Map - Self instance for method chaining.

minHeight

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.
Setter for the minimum height.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Minimum height to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

minWidth

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.
Setter for the minimum width.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Minimum width to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

move

Moves focus point for the map.
Note: Works only with anychart.charts.Map#zoom

Params:

NameTypeDefaultDescription
dxnumber
0
Offset x coordinate.
dynumber
0
Offset y coordinate.

Returns:

anychart.charts.Map - Self instance for method chaining.

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.
Setter for noData settings.
Learn more about "No data" feature

Params:

NameTypeDescription
settingsObjectNoData settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode | string - Overlap mode flag.
Setter for labels overlap mode.

Params:

NameTypeDefaultDescription
valueanychart.enums.LabelsOverlapMode | string | boolean
'noOverlap'
Overlap mode settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

padding

Setter for the chart paddings in pixels using a single value.

Params:

NameTypeDefaultDescription
paddingArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Padding to set.

Returns:

anychart.charts.Map - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});
Setter for the chart paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Map - Self instance for method chaining.
Example.
// 1) all 10px
chart.padding(10);
// 2) top and bottom 10px, left and right 15px
chart.padding(10, '15px');
// 3) top 10px, left and right 15px, bottom 5px
chart.padding(10, '15px', 5);
// 4) top 10px, right 15%, bottom 5px, left 12px
chart.padding(10, '15%', '5px', 12);

palette

Getter for the map palette.
See listing
var palette = map.palette();
Setter for the map palette.

Params:

NameTypeDescription
settingsanychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string>Color palette instance.

Returns:

anychart.charts.Map - Self instance for method chaining.

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

removeAllListeners

Removes all listeners from an object. You can also optionally remove listeners of some particular type.

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

removeAllSeries

Removes all series from chart.

Returns:

anychart.charts.Map - Self instance for method chaining.

removeSeries

Removes one of series from chart by its id.

Params:

NameTypeDescription
idnumber | stringSeries id.

Returns:

anychart.charts.Map - Self instance for method chaining.

removeSeriesAt

Removes one of series from chart by its index.

Params:

NameTypeDescription
indexnumberSeries index.

Returns:

anychart.charts.Map - Self instance for method chaining.
Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.
Setter for element right bound setting.

Params:

NameTypeDefaultDescription
rightnumber | string | null
null
Right bound setting for the element.

Returns:

anychart.charts.Map - Returns self for method chaining.

saveAsCsv

Saves chart data as a CSV file.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*))>CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').
filenamestringFile name to save.

saveAsJpg

Saves the chart as JPEG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
filenamestringFile name to save.

saveAsPdf

Saves the chart as PDF image.

Params:

NameTypeDescription
paperSizeOrWidthOrOptionsnumber | string | ObjectAny paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the chart as PNG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

Saves the chart as SVG image.

Params:

NameTypeDescription
paperSizestring | ObjectPaper Size or object with options.
landscapebooleanLandscape.
filenamestringFile name to save.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves chart data as an Excel document.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
filenamestringFile name to save.

scale

Getter for the map geo scale.

Returns:

anychart.scales.Geo - Map geo scale value.
Setter for the map geo scale.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Geo | Object
'geo'
Scale to set.

Returns:

anychart.scales.Geo - Map geo scale value.

selectMarqueeFill

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.
See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array or a string.

Returns:

anychart.charts.Map - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Map - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Map - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.charts.Map - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.charts.Map - Self instance for method chaining.

selectMarqueeStroke

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.
See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
Setter for the select marquee stroke. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.charts.Map - Self instance for method chaining.

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

shareAsJpg

Shares a chart as a JPG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

shareAsPdf

Shares a chart as a PDF file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

shareAsPng

Shares a chart as a PNG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

shareAsSvg

Shares a chart as a SVG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.
filenamestringFile name to save.

shareWithFacebook

Opens Facebook sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for the main link or object with options.
linkstringThe URL is attached to the publication.
namestringThe title for the attached link.
descriptionstringDescription for the attached link.

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for publication or object with options. If not set 'AnyChart' will be used.
descriptionstringDescription.

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

NameTypeDescription
linkOrOptionsstring | ObjectAttached link or object with options. If not set, the image URL will be used.
descriptionstringDescription.

shareWithTwitter

Opens Twitter sharing dialog.

startSelectMarquee

Starts select marquee drawing. Note: Works only after anychart.core.Chart#draw is called.

Params:

NameTypeDescription
repeatbooleanWhether to start select marquee drawing.

Returns:

anychart.charts.Map - Self instance for method chaining.

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.
Setter for the chart title.

Params:

NameTypeDefaultDescription
settingsnull | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

anychart.charts.Map - Self instance for method chaining.

toA11yTable

Creates and returns the chart represented as an invisible HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.

toCsv

Returns CSV string with the chart data.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*)|Object)>CSV settings.
CSV settings object:
rowsSeparator - string or undefined (default is '\n')
columnsSeparator - string or undefined (default is ',')
ignoreFirstRow - boolean or undefined (default is 'false')
formats -
1) a function with two arguments such as the field name and value, that returns the formatted value
or
2) the object with the key as the field name, and the value as a format function.
(default is 'undefined').

Returns:

string - CSV string.

toGeoJSON

Exports a map to GeoJSON format.

Returns:

Object - Geo JSON config.

toHtmlTable

Creates and returns a chart as HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines output: HTML string if True, DOM element if False.

Returns:

Element | string | null - HTML table instance, HTML string or null if parsing chart to table fails.

toJson

Return chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

NameTypeDescription
paperSizestring | ObjectPaper Size or object of options.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string with with determined the width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Return chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

tooltip

Getter for the chart tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
See listing
var tooltipSettings = chart.tooltip();
Setter for the chart tooltip.

Params:

NameTypeDescription
settingsObject | boolean | nullTooltip settings to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

top

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.
Setter for element top bound settings.

Params:

NameTypeDefaultDescription
topnumber | string | null
null
Top bound setting for the element.

Returns:

anychart.charts.Map - Returns self for method chaining.

transform

Returns coordinate at given latitude and longitude as pixel values relative to a map bounds.
Note: Returns correct values only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
xLongnumberLongitude in degrees.
yLatnumberLatitude in degrees.

Returns:

Object.<string, number> - Transformed value adjusted to map bounds.

translateFeature

Translates feature on passed dx and dy.
Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
idstringFeature id.
dxnumberOffset x coordinate.
dynumberOffset y coordinate.

Returns:

anychart.charts.Map - Self instance for method chaining.

unboundRegions

Getter for the settings for the unbound regions.

Returns:

anychart.core.utils.UnboundRegionsSettings | anychart.enums.MapUnboundRegionsMode | string - Settings for unbound regions.
Setter for the settings for regions that are not linked to any series data.

Params:

NameTypeDefaultDescription
settingsObject | anychart.enums.MapUnboundRegionsMode | string | boolean
true
Settings object or boolean value like enabled state.

Returns:

anychart.charts.Map - Self instance for method chaining.

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction(e:Object):boolean|undefined
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.
Setter for element width setting.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the element.

Returns:

anychart.charts.Map - Returns self for method chaining.

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Value to set.

Returns:

anychart.charts.Map - Self instance for method chaining.

zoom

Zooms a map.

Params:

NameTypeDefaultDescription
valuenumber
1
Zoom value.
cxnumber
Center X value.
cynumber
Center Y value.
durationnumber
Duration of zoom animation.

Returns:

anychart.charts.Map - Self instance for method chaining.

zoomIn

Zoom the map in the center.

Params:

NameTypeDescription
durationnumberDuration of zoom animation.

Returns:

anychart.charts.Map - Self instance for method chaining.

zoomOut

Zoom the map out the center.

Params:

NameTypeDescription
durationnumberDuration of zoom animation.

Returns:

anychart.charts.Map - Self instance for method chaining.

zoomTo

Zooms the map to passed zoom level and coordinates.

Params:

NameTypeDescription
valuenumberZoom level for zooming.
cxnumberX coord of zoom point.
cynumberY coord of zoom point.

Returns:

anychart.charts.Map - Self instance for method chaining.

zoomToFeature

Zoom to feature by passed id.

Params:

NameTypeDescription
idstringFeature id.