AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated 7.11.1 version of this document. Switch to the 8.4.0 version to see the up to date information.

class anychart.charts.Map Improve this Doc

Extends: anychart.core.SeparateChart

AnyChart map class.

Methods Overview

Specific 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
transform()Returns coordinate at given latitude and longitude as pixel values relative to a map bounds.
unboundRegions()Unbound regions 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.
Data
geoData()Geo data settings.
geoIdField()Geo id field
getDrilldownPath()Returns the drill down path.
getSelectedPoints()Getter for the selected points.
getStat()Getter for the statistics value by key.
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
print()Prints all elements.
saveAsCsv()Saves chart data as CSV file.
saveAsJson()Saves chart config as JSON document.
saveAsXlsx()Saves chart data as Excel document.
saveAsXml()Saves chart config as XML document.
toCsv()Returns CSV string with series data.
Interactivity
crsAnimation()Animation settings
drillDownMap()Drills down a map.
drillTo()Drills down to a map.
drillUp()Drills one level up from the current level.
interactivity()Interactivity settings.
move()Moves focus point for the map.
tooltip()Tooltip settings.
zoom()Zooms a map.
zoomTo()Zooms the map to passed zoom level and coordinates.
zoomToFeature()Zoom to feature by passed id.
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 setting.
bounds()Bounds settings.
crs()Sets the crs (coordinate system) to map.
featureCrs()Coordinate system for the feature.
featureScaleFactor()Scale settings of the feature
featureTranslation()Getter for the current translation feature by id.
getPixelBounds()Returns pixel bounds.
getPlotBounds()Getter for the current data bounds of the chart.
height()Height setting.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
padding()Padding settings.
right()Right bound setting.
top()Top bound setting.
translateFeature()Translates feature on passed dx and dy.
width()Width setting.
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
container()Getter for the element's container.
draw()Drawing of the chart.
saveAsJpg()Saves the current chart as JPEG image.
saveAsPdf()Saves the current chart as PDF image.
saveAsPng()Saves the current chart as PNG image.
saveAsSvg()Saves the current chart as SVG image.
toSvg()Returns SVG string.

Methods Description

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 the current animation setting.

Returns:

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

Params:

NameTypeDefaultDescription
valueboolean | Object
false
Whether to enable animation.

Returns:

anychart.charts.Map - Self instance for method chaining.
Setter for the 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.

background

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.
Setter for the chart background.

Params:

NameTypeDefaultDescription
valueObject
{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 setting.

Returns:

number | string | undefined - Current element's bottom bound setting.
Sets element bottom bound setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

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

bounds

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.
Sets bounds of the element using one parameter.

Params:

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

Returns:

anychart.charts.Map - Self instance for method chaining.
Setter for the 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.
csvSettingsObject.<string, (string|boolean)>If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

anychart.core.map.series.Bubble - An instance of class 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.
csvSettingsObject.<string, (string|boolean)>If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

colorRange

Getter for the current color range.

Returns:

anychart.core.ui.ColorRange - The current color range.
Setter for the color range.

Params:

NameTypeDescription
valueObjectColor 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.
csvSettingsObject.<string, (string|boolean)>If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

container

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

Params:

NameTypeDescription
valueanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value 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.ui.title();
 element.container( fwElement.container() );

contextMenu

Getter for the current context menu.

Returns:

anychart.ui.ContextMenu - The current context menu.
Setter for the context menu.

Params:

NameTypeDescription
valueObject | boolean | nullContext menu settings

Returns:

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

credits

Getter for the current 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 class for method chaining.

crs

Sets the crs (coordinate system) to map.

Params:

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

crsAnimation

Getter for animation settings.

Returns:

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

Params:

NameTypeDescription
valueboolean | 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
valuestring | anychart.enums.MapSeriesTypeSeries 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 current 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.

featureCrs

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

Params:

NameTypeDescription
idstringFeature id.

Returns:

string - The current 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 current feature scale factor.
Note: Works only after anychart.charts.Map#draw is called.

Params:

NameTypeDescription
idstringFeature id.

Returns:

number - The current 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 current translation feature by id.

Params:

NameTypeDescription
idstringFeature id.

Returns:

Array.<number> - The current 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.

geoData

Getter for the geo data.

Returns:

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

Params:

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

Returns:

Node | string | Object - Passed geo data.

geoIdField

Getter for the current geo id field.

Returns:

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

Params:

NameTypeDescription
valuestringGeo id.

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).

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 current data bounds of the chart. Note: Works only after anychart.charts.Map#draw is called.

Returns:

anychart.math.Rect - The current data bounds of the chart.

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 class for method chaining.

getSeriesAt

Getter for the series by its index.

Params:

NameTypeDescription
indexnumberIndex of the series.

Returns:

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

getSeriesCount

Returns a series count.

Returns:

number - Number of series.

getStat

Getter for the statistics value by key.

Params:

NameTypeDescription
keystring | anychart.enums.StatisticsKey.

Returns:

* - Statistics value.

getType

Returns chart type.

Returns:

string - Current chart type.

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.

hatchFillPalette

Getter for the current map hatch fill palette settings.

Returns:

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

Params:

NameTypeDescription
valueArray.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFillsValue to set.

Returns:

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

height

Getter for element height setting.

Returns:

number | string | undefined - Current element's height setting.
Sets element height setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

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

interactivity

Gets the current interactivity settings for chart.

Returns:

anychart.core.utils.Interactivity - The current interactivity settings.
Sets interactivity settings for chart.

Params:

NameTypeDescription
valueObject | anychart.enums.HoverModeSettings 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.

label

Getter for chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - An instance of class.
Setter for chart label.

Params:

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

Returns:

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

Params:

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

Returns:

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

left

Getter for element left bound setting.

Returns:

number | string | undefined - Current element's left bound setting.
Sets element left bound setting.

Params:

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

Returns:

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

legend

Getter for the current chart legend.

Returns:

anychart.core.ui.Legend - An instance of class for method chaining.
Setter for chart legend setting.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Legend settings.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback 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 }.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject 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

Getter for the current chart margin.

Returns:

anychart.core.utils.Margin - The current chart margin.
Setter for the chart margin in pixels using a single complex object.

Params:

NameTypeDefaultDescription
valueArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value 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.
csvSettingsObject.<string, (string|boolean)>If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

markerPalette

Getter for the current map markers palette settings.

Returns:

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

Params:

NameTypeDescription
valueanychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType>Map marker palette settings to set.

Returns:

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

maxBubbleSize

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

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string
"20%"
Maximum bubble size.

Returns:

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

maxHeight

Getter for maximum height.

Returns:

number | string | null - Current element's maximum height.
Setter for maximum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

maxWidth

Getter for maximum width.

Returns:

number | string | null - Current element's maximum width.
Setter for maximum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minBubbleSize

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

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string
"5%"
Minimum bubble size.

Returns:

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

minHeight

Getter for minimum height.

Returns:

number | string | null - Current element's minimum height.
Setter for minimum height.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minWidth

Getter for minimum width.

Returns:

number | string | null - Current element's minimum width.
Setter for minimum width.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value 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.

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

Getter for the current chart padding.

Returns:

anychart.core.utils.Padding - Current chart padding.
Setter for the chart paddings in pixels using a single value.

Params:

NameTypeDefaultDescription
valueArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value 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 current map palette.
See listing
var currentPalette = map.palette();
Setter for the map palette.

Params:

NameTypeDescription
valueanychart.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
paperSizeanychart.graphics.vector.PaperSize
Paper size.
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 setting.

Returns:

number | string | undefined - Current element's right bound setting.
Sets element right bound setting.

Params:

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

Returns:

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

saveAsCsv

Saves chart data as CSV file.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.
filenamestringFile name to save.

saveAsJpg

Saves the current chart as JPEG image.

Params:

NameTypeDescription
widthnumberImage width.
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
includeThemebooleanIf the current theme properties should be included into the result.
filenamestringFile name to save.

saveAsPdf

Saves the current chart as PDF image.

Params:

NameTypeDescription
paperSizestringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the current chart as PNG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

Saves the current chart as SVG image.

Params:

NameTypeDescription
paperSizestringPaper Size.
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 Excel document.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
includeThemebooleanIf the current theme properties should be included into the result.
filenamestringFile name to save.

title

Getter for chart title.

Returns:

anychart.core.ui.Title - The current chart title.
Setter for the chart title.

Params:

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

Returns:

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

toCsv

Returns CSV string with series data.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.

Returns:

string - CSV string.

toGeoJSON

Exports a map to GeoJSON format.

Returns:

Object - Geo JSON config.

toJson

Return chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.
includeThemeboolean
false
If the current theme properties should be included into the result.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
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.
includeThemeboolean
false
If the current theme properties should be included into the result.

Returns:

string | Node - Chart configuration.

tooltip

Getter for current chart tooltip.

Returns:

anychart.core.ui.ChartTooltip | anychart.core.ui.Tooltip - An instance of class for method chaining.
Example
var tooltipSettings = chart.tooltip();
Setter for chart tooltip.

Params:

NameTypeDescription
valueObject | boolean | null

Returns:

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

top

Getter for element top bound setting.

Returns:

number | string | undefined - Current element's top bound setting.
Sets element top bound setting.

Params:

NameTypeDefaultDescription
valuenumber | 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 current settings for the unbound regions.
Setter for the settings for regions that are not linked to any series data.

Params:

NameTypeDefaultDescription
valueObject | 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:

NameTypeDescription
typestringThe event type id.
listenerfunctionCallback method.
useCapturebooleanWhether to fire in capture phase (defaults to false).
listenerScopeObjectObject 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 setting.

Returns:

number | string | undefined - Current element's width setting.
Sets element width setting.

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
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.

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.