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
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
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.
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.
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.
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.
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 current translation feature by id.
getPixelBounds()Returns pixel bounds.
getPlotBounds()Getter for the current 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 current marquee action if any.
container()Getter for the element's container.
draw()Drawing of the chart.
inMarquee()Gets marquee process running value.
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:

Name Type Description
var_args anychart.data.View | anychart.data.Set | Array Chart series data.

Returns:

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

Try it:

animation

Getter for animation settings.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.

Try it:

Setter for animation settings by one value.

Params:

Name Type Default Description
value boolean | Object
false
Whether to enable animation.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for animation settings using several parameters.

Params:

Name Type Default Description
enabled boolean
false
Whether to enable animation.
duration number
1000
Duration in milliseconds.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

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:

Name Type Default Description
value boolean
true
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

axes

Getter for map axes.

Returns:

anychart.core.axes.MapSettings - Common axes settings.

Try it:

Setter for map axes.

Params:

Name Type Description
value Object | boolean Map 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.

Try it:

Setter for the chart background.

Params:

Name Type Default Description
value Object
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

bottom

Getter for element bottom bound settings.

Returns:

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

Params:

Name Type Default Description
value number | string | null
null
Bottom bound settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

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:

Name Type Description
value anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds Bounds of element.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

Setter for element bounds settings.

Params:

Name Type Default Description
x number | string
null
X-coordinate.
y number | string
null
Y-coordinate.
width number | string
null
Width.
height number | string
null
Height.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

bubble

Creates a Bubble series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Series data as SVG, SVGString, GeoJSON or MapNameString.
csvSettings anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings 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 the created series.

Try it:

callout

Getter for callout elements.

Params:

Name Type Description
index number Index of existing callout element to get.

Returns:

anychart.core.ui.Callout - Callout instance by index.

Try it:

Setter for callout elements.

Params:

Name Type Description
value Object | boolean | null Callout settings to set.

Returns:

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

Try it:

Setter for callout elements by index.

Params:

Name Type Description
index number Index of existing callout element.
value Object | boolean | null Callout settings to set.

Returns:

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

Try it:

cancelMarquee

Stops current marquee action if any.

Returns:

anychart.core.Chart - Self instance for method chaining.

choropleth

Creates a Choropleth series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Series data as SVG, SVGString, GeoJSON or MapNameString.
csvSettings anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings 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 the created series.

Try it:

colorRange

Getter for the current color range.

Returns:

anychart.core.ui.ColorRange - The current color range.

Try it:

Setter for the color range.

Params:

Name Type Description
value Object Color range settings to set.

Returns:

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

Try it:

connector

Creates connector series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Series data as SVG, SVGString, GeoJSON or MapNameString.
csvSettings anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings 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 the class for method chaining

Try it:

container

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

Params:

Name Type Description
value anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element The value to set.

Returns:

anychart.core.Chart - 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() );

Try it:

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.

Try it:

Setter for the context menu.

Params:

Name Type Description
value Object | boolean | null Context menu settings

Returns:

anychart.core.Chart - Self instance for method chaining.

credits

Getter for the credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Setter for the chart credits. Learn more about credits settings.

Params:

Name Type Default Description
value Object | boolean | null
true
Credits settings

Returns:

anychart.core.Chart - An instance of the class for method chaining.

crosshair

Getter for map crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.

Try it:

Setter for map crosshair settings.

Params:

Name Type Default Description
value Object | 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:

Name Type Description
Projection Object | function | anychart.enums.MapProjections | string 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.

Try it:

Setter for animation settings.

Params:

Name Type Description
value boolean | Object Animation settings.
duration number A 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.

Try it:

Setter for the map default series type.

Params:

Name Type Description
value anychart.enums.MapSeriesType | string Series type.

Returns:

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

Try it:

draw

Starts the rendering of the chart into the container.

Params:

Name Type Description
async boolean Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

anychart.core.Chart - Self instance for method chaining.

drillDownMap

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

Params:

Name Type Description
value Object.<string, (Object|anychart.charts.Map)> Value to set.

Returns:

Object - The current object with id and map instance.

Try it:

drillTo

Drills down to a map.

Params:

Name Type Description
id string Region id.
map anychart.charts.Map Map instance.

Returns:

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

Try it:

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.

Try it:

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:

Name Type Description
value Object Export settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

featureCrs

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

Params:

Name Type Description
id string Feature id.

Returns:

string - The current crs of the feature.

Try it:

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

Params:

Name Type Description
id string Feature id.
crs string String crs (coordinate system) representation.

Returns:

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

Try it:

featureScaleFactor

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

Params:

Name Type Description
id string Feature id.

Returns:

number - The current scale of the feature.

Try it:

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

Params:

Name Type Description
id string Feature id.
ratio number Scale ratio.

Returns:

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

Try it:

featureTranslation

Getter for the current translation feature by id.

Params:

Name Type Description
id string Feature id.

Returns:

Array.<number> - The current translating feature.

Try it:

Setter for the translation feature.
Note: Works only after anychart.charts.Map#draw is called.

Params:

Name Type Description
id string Feature id.
dx number Offset by X coordinate.
dy number Offset by Y coordinate.

Returns:

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

Try it:

geoData

Getter for the geo data.

Returns:

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

Params:

Name Type Description
data Node | string | Object Map data as SVG, SVGString, GeoJSON or MapNameString.

Returns:

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

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:

Name Type Description
value string Geo id.

Returns:

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

Try it:

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

Try it:

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.

Try it:

getSelectedPoints

Getter for the selected points.

Returns:

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

Try it:

getSeries

Getter for the series by its id.

Params:

Name Type Default Description
id number | string
index
Id of the series.

Returns:

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

Try it:

getSeriesAt

Getter for the series by its index.

Params:

Name Type Description
index number Index of the series.

Returns:

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

Try it:

getSeriesCount

Returns a series count.

Returns:

number - Number of series.

Try it:

getStat

Getter for a statistical value by the key.

Params:

Name Type Description
key anychart.enums.Statistics | string Key.

Returns:

* - Statistics value.

Try it:

getType

Returns chart type.

Returns:

string - Current chart type.

Try it:

getZoomLevel

Gets the map zoom level.

Returns:

number - Zoom level.

Try it:

globalToLocal

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

Params:

Name Type Description
xCoord number Global X coordinate.
yCoord number Global Y coordinate.

Returns:

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

Try it:

grids

Getter for map grids.

Returns:

anychart.core.grids.MapSettings - Grid instance.

Try it:

Setter for map grids.

Params:

Name Type Default Description
value Object | boolean | null
false
Chart grids settings to set.

Returns:

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

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:

Name Type Description
value Array.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFills Value 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:

Name Type Default Description
value number | string | null
null
Height settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Setter for hovered state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

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

Try it:

inMarquee

Gets marquee process running value.

Returns:

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

interactivity

Getter for interactivity settings for the chart.

Returns:

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

Params:

Name Type Description
value Object | anychart.enums.HoverMode | string Settings object or boolean value like enabled state.

Returns:

anychart.core.SeparateChart - Self instance for method chaining.

Try it:

inverseTransform

Transforms local pixel coordinates to latitude/longitude values.

Params:

Name Type Description
x number X pixel value to transform.
y number Y pixel value to transform.

Returns:

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

Try it:

label

Getter for the chart label.

Params:

Name Type Default Description
index string | number
0
Index of instance.

Returns:

anychart.core.ui.Label - Label instance.

Try it:

Setter for the chart label.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.core.Chart - Self instance for method chaining.
Setter for the chart label.

Params:

Name Type Default Description
index string | number
Label index.
value null | boolean | Object | string
false
Chart label settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

labels

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Setter for series data labels.

Params:

Name Type Description
value Object | boolean | null Series 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:

Name Type Default Description
value number | string | null
null
Left bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

legend

Getter for the chart legend.

Returns:

anychart.core.ui.Legend - Legend instance.

Try it:

Setter for chart legend settings.

Params:

Name Type Default Description
value Object | boolean | null
false
Legend settings.

Returns:

anychart.core.Chart - An instance of the class for method chaining.

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
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 }.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function(Object e)
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

localToGlobal

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

Params:

Name Type Description
xCoord number Local X coordinate.
yCoord number Local Y coordinate.

Returns:

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

Try it:

margin

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

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - 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));

Try it:

Setter for the chart margin in pixels using several simple values.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.core.Chart - 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);

Try it:

marker

Creates a Marker series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Series data as SVG, SVGString, GeoJSON or MapNameString.
csvSettings anychart.enums.TextParsingMode | string | anychart.data.TextParsingSettings 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 the created series.

Try it:

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:

Name Type Description
value anychart.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 current maximum size for all bubbles on the charts.

Returns:

number string - The current maximum size.

Try it:

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

Params:

Name Type Default Description
value number | string
"20%"
Maximum bubble size.

Returns:

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

Try it:

maxHeight

Getter for the maximum height.

Returns:

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

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxWidth

Getter for the maximum width.

Returns:

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

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

maxZoomLevel

Getter for the maximum zoom level.

Returns:

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

Params:

Name Type Description
value number Maximum zoom level.

Returns:

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

Try it:

minBubbleSize

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

Returns:

number string - The current minimum size.

Try it:

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

Params:

Name Type Default Description
value number | string
"5%"
Minimum bubble size.

Returns:

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

Try it:

minHeight

Getter for the minimum height.

Returns:

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

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

minWidth

Getter for the minimum width.

Returns:

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

Params:

Name Type Default Description
value number | string | null
null
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

move

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

Params:

Name Type Default Description
dx number
0
Offset x coordinate.
dy number
0
Offset y coordinate.

Returns:

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

Try it:

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.

Try it:

Setter for noData settings.
Learn more about "No data" feature

Params:

Name Type Description
value Object NoData settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

normal

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Setter for normal state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

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

Try it:

overlapMode

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode string - Overlap mode flag.

Try it:

Setter for labels overlap mode.

Params:

Name Type Default Description
value anychart.enums.LabelsOverlapMode | string | boolean
"noOverlap"
Overlap mode settings.

Returns:

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

Try it:

padding

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

Params:

Name Type Default Description
value Array.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});

Try it:

Setter for the chart paddings in pixels using several numbers.

Params:

Name Type Default Description
value1 string | number
0
Top or top-bottom space.
value2 string | number
0
Right or right-left space.
value3 string | number
0
Bottom space.
value4 string | number
0
Left space.

Returns:

anychart.core.Chart - 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);

Try it:

palette

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

Params:

Name Type Description
value anychart.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:

Name Type Default Description
paperSizeOrOptions anychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscape boolean
false
Flag of landscape.

Try it:

removeAllListeners

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

Params:

Name Type Description
type string Type of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.

Try it:

removeAllSeries

Removes all series from chart.

Returns:

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

Try it:

removeSeries

Removes one of series from chart by its id.

Params:

Name Type Description
id number | string Series id.

Returns:

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

Try it:

removeSeriesAt

Removes one of series from chart by its index.

Params:

Name Type Description
index number Series index.

Returns:

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

Try it:

Getter for element right bound settings.

Returns:

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

Params:

Name Type Default Description
value number | string | null
null
Right bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

saveAsCsv

Saves chart data as a CSV file.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<string, (string|boolean|undefined)> CSV settings.
filename string File name to save.

Try it:

saveAsJpg

Saves the current chart as JPEG image.

Params:

Name Type Description
width number | Object Image width or object with options.
height number Image height.
quality number Image quality in ratio 0-1.
forceTransparentWhite boolean Force transparent to white or not.
filename string File name to save.

Try it:

saveAsJson

Saves chart config as JSON document.

Params:

Name Type Description
filename string File name to save.

Try it:

saveAsPdf

Saves the current chart as PDF image.

Params:

Name Type Description
paperSizeOrWidthOrOptions number | string | Object Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscape boolean Define, is landscape.
x number Offset X.
y number Offset Y.
filename string File name to save.

Try it:

saveAsPng

Saves the current chart as PNG image.

Params:

Name Type Description
width number | Object Image width or object with options.
height number Image height.
quality number Image quality in ratio 0-1.
filename string File name to save.

Try it:

saveAsSvg

Saves the current chart as SVG image.

Params:

Name Type Description
paperSize string | Object Paper Size or object with options.
landscape boolean Landscape.
filename string File name to save.

Try it:

Saves the stage as SVG image using width and height.

Params:

Name Type Description
width number Image width.
height number Image height.

Try it:

saveAsXlsx

Saves chart data as an Excel document.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
filename string File name to save.

Try it:

saveAsXml

Saves chart config as XML document.

Params:

Name Type Description
filename string File name to save.

Try it:

scale

Getter for the map geo scale.

Returns:

anychart.scales.Geo - Map geo scale value.

Try it:

Setter for the map geo scale.

Params:

Name Type Default Description
value anychart.scales.Geo | Object
"geo"
Scale to set.

Returns:

anychart.scales.Geo - Map geo scale value.

Try it:

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 or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an object or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

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:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

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

Try it:

startSelectMarquee

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

Params:

Name Type Description
repeat boolean Whether to start select marquee drawing.

Returns:

anychart.core.Chart - Self instance for method chaining.

Try it:

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.

Try it:

Setter for the chart title.

Params:

Name Type Default Description
value null | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

anychart.core.Chart - Self instance for method chaining.

toCsv

Returns CSV string with the chart data.

Params:

Name Type Description
chartDataExportMode anychart.enums.ChartDataExportMode | string Data export mode.
csvSettings Object.<string, (string|boolean|undefined|function(* name,* value)|Object)> CSV settings. CSV settings object has fields like: rowsSeparator - string or undefined (default is '\n') columnsSeparator - string or undefined (default is ',') ignoreFirstRow - boolean or undefined (default is 'false') formats - a function with two arguments such as the field name and value, that returns the formatted value, 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.

Try it:

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.

Returns:

Object string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

Name Type Description
paperSize string | Object Paper Size or object of options.
landscape boolean Landscape.

Returns:

string - SVG content or empty string.

Try it:

Returns SVG string with with determined the width and height.

Params:

Name Type Description
width number Image width.
height number Image height.

Returns:

string - SVG content or empty string.

Try it:

toXml

Return chart configuration as XML string or XMLNode.

Params:

Name Type Default Description
asXmlNode boolean
false
Return XML as XMLNode.

Returns:

string Node - Chart configuration.

tooltip

Getter for the chart tooltip.

Returns:

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

Params:

Name Type Description
tooltipSettings Object | boolean | null Tooltip settings to set.

Returns:

anychart.core.Chart - 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:

Name Type Default Description
value number | string | null
null
Top bound setting for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

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:

Name Type Description
xLong number Longitude in degrees.
yLat number Latitude in degrees.

Returns:

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

Try it:

translateFeature

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

Params:

Name Type Description
id string Feature id.
dx number Offset x coordinate.
dy number Offset y coordinate.

Returns:

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

Try it:

unboundRegions

Getter for the current settings for the unbound regions.

Returns:

anychart.core.utils.UnboundRegionsSettings anychart.enums.MapUnboundRegionsMode string - The current settings for regions.

Try it:

Setter for the settings for regions that are not linked to any series data.

Params:

Name Type Default Description
value Object | 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:

Name Type Default Description
type string
The event type id.
listener function
Callback method.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

Name Type Description
key Object The key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

Try it:

width

Getter for element width settings.

Returns:

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

Params:

Name Type Default Description
value number | string | null
null
Width settings for the element.

Returns:

anychart.core.VisualBaseWithBounds - Returns self for method chaining.

Try it:

zIndex

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

anychart.core.VisualBase - Self instance for method chaining.

Try it:

zoom

Zooms a map.

Params:

Name Type Default Description
value number
1
Zoom value.
cx number
Center X value.
cy number
Center Y value.
duration number
Duration of zoom animation.

Returns:

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

Try it:

zoomTo

Zooms the map to passed zoom level and coordinates.

Params:

Name Type Description
value number Zoom level for zooming.
cx number X coord of zoom point.
cy number Y coord of zoom point.

Returns:

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

Try it:

zoomToFeature

Zoom to feature by passed id.

Params:

Name Type Description
id string Feature id.

Try it: