Top
You are looking at an outdated 7.10.0 version of this document. Switch to the 8.0.1 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.
transform()Returns coordinate at given latitude and longitude as pixel values relative to a map bounds.
unboundRegions()Region's settings, that don't linked to anything regions.
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
getCurrentPath()Returns bread crumbs 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
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 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 bubble series.
choropleth()Creates choropleth series.
connector()Creates connector series.
getSeries()Getter for the series by its id.
marker()Creates 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 chart.
defaultSeriesType()Default series type.
getSeriesAt()Gets 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 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 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 the current animation setting.

Returns:

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

Try it:

Setter for the animation setting 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 the 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:

background

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current 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 setting.

Returns:

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

Params:

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

Returns:

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

Try it:

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:

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 the 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 bubble series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Series data as SVG, SVGString, GeoJSON or MapNameString.
csvSettings Object.<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.

Try it:

choropleth

Creates choropleth series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Series data as SVG, SVGString, GeoJSON or MapNameString.
csvSettings Object.<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.

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

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.ui.title();
 element.container( fwElement.container() );

Try it:

contextMenu

Getter for the current context menu.

Returns:

anychart.ui.ContextMenu - The current 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 current credits.

Returns:

anychart.core.ui.Credits - 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 class for method chaining.

crs

Sets the crs (coordinate system) to map.

Params:

Name Type Description
value Object | function | anychart.enums.MapProjections | string Projection name, or projection string representation, or projection Object or Function.

defaultSeriesType

Getter for the map default series type.

Returns:

string - The map default series type.

Try it:

Setter for the map default series type.

Params:

Name Type Description
value string Series type.

Returns:

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

Try it:

draw

Starts the rendering of the chart into the container.

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:

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 current geo data.

Returns:

Node string Object - The current geo data.
Setter for the geo data.

Params:

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

Returns:

Node string Object - Passed geo data.

Try it:

geoIdField

Getter for the current geo id field.

Returns:

string - The current geo id field.
See listing
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:

getCurrentPath

Returns bread crumbs path.
Returns path of the visited levels 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 class for method chaining.

Try it:

getSeriesAt

Gets the series by its index.

Params:

Name Type Description
index number Index of the series.

Returns:

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

Try it:

getSeriesCount

Returns a series count.

Returns:

number - Number of series.

Try it:

getStat

Getter for the statistics value by key.

Params:

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

Returns:

* - Statistics value.

Try it:

getType

Returns chart type.

Returns:

string - Current chart type.

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:

hatchFillPalette

Getter for the current map hatch fill palette settings.

Returns:

anychart.palettes.HatchFills - The current chart hatch fill palette.
Setter for map hatch fill palette settings.

Params:

Name Type Description
value Array.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFills Chart hatch fill palette settings to set.

Returns:

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

Try it:

height

Getter for element height setting.

Returns:

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

Params:

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

Returns:

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

Try it:

interactivity

Gets the current interactivity settings for chart.

Returns:

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

Params:

Name Type Description
value Object | anychart.enums.HoverMode 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 chart label.

Params:

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

Returns:

anychart.core.ui.Label - An instance of class.

Try it:

Setter for 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 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.

left

Getter for element left bound setting.

Returns:

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

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 current chart legend.

Returns:

anychart.core.ui.Legend - An instance of class for method chaining.

Try it:

Setter for chart legend setting.

Params:

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

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

Name Type Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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

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:

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.space(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 marker series.

Params:

Name Type Description
data anychart.data.View | anychart.data.Set | Array | string Series data as SVG, SVGString, GeoJSON or MapNameString.
csvSettings Object.<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.

Try it:

markerPalette

Getter for map markers palette settings.

Returns:

anychart.palettes.Markers - The current map markers palette.
Setter for map markers palette settings.

Params:

Name Type Description
value anychart.palettes.Markers | Object | Array.<anychart.enums.MarkerType> Map marker palette settings to set.

Returns:

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

Try it:

maxBubbleSize

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

Returns:

number string - The current maximum size.

Try it:

Sets the maximum size for all bubbles on the charts.

Params:

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

Returns:

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

Try it:

maxHeight

Getter for maximum height.

Returns:

number string null - Current element's maximum height.
Setter for 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 maximum width.

Returns:

number string null - Current element's maximum width.
Setter for 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:

minBubbleSize

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

Returns:

number string - The current minimum size.

Try it:

Sets the minimum size for all bubbles on the charts.

Params:

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

Returns:

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

Try it:

minHeight

Getter for minimum height.

Returns:

number string null - Current element's minimum height.
Setter for 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 minimum width.

Returns:

number string null - Current element's minimum width.
Setter for 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 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:

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:

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.
Setter for the current map palette. Note: You can use predefined palettes from anychart.palettes.

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
paperSize anychart.graphics.vector.PaperSize
Paper size.
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 setting.

Returns:

number string undefined - Current element's right bound setting.
Sets 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 CSV file.

Params:

Name Type Description
chartDataExportMode string | anychart.enums.ChartDataExportMode 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 Image width.
height number Image height.
quality number Image quality in ratio 0-1.
forceTransparentWhite boolean Define, should we force transparent to white background.
filename string File name to save.

Try it:

saveAsJson

Saves chart config as JSON document.

Params:

Name Type Description
includeTheme boolean If the current theme properties should be included into the result.
filename string File name to save.

Try it:

saveAsPdf

Saves the current chart as PDF image.

Params:

Name Type Description
paperSize string Any paper format like 'a0', 'tabloid', 'b4', etc.
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 Image width.
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 Paper Size.
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 Excel document.

Params:

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

Try it:

saveAsXml

Saves chart config as XML document.

Params:

Name Type Description
includeTheme boolean If the current theme properties should be included into the result.
filename string File name to save.

Try it:

title

Getter for chart title.

Returns:

anychart.core.ui.Title - The current 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 series data.

Params:

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

Returns:

string - CSV string.

Try it:

toGeoJSON

Exports 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.
includeTheme boolean
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:

Name Type Description
paperSize string Paper Size.
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.
includeTheme boolean
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:

Name Type Description
value Object | boolean | null

Returns:

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

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 regions, that don't linked to anything regions.

Returns:

anychart.core.utils.UnboundRegionsSettings - 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 | 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 Description
type string The event type id.
listener function Callback method.
useCapture boolean Whether to fire in capture phase (defaults to false).
listenerScope scope 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 setting.

Returns:

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

Params:

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

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

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.

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: