class anychart.charts.Map Improve this Doc

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.
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
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.
interactivity()	Interactivity settings.
maxZoomLevel()	Maximum zoom level.
move()	Moves focus point for the map.
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
hoverLabels()	Labels settings.
labels()	Labels settings.
selectLabels()	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 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
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

addSeries(var_args)Since version 7.8.0

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:

Usage sample

animation

animation()

Getter for the current animation setting.

Returns:

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

Try it:

Usage sample

animation(value)

Setter for the animation setting by one value.

Detailed description

Sets animation settings depending on parameter type:

null/boolean - disable or enable animation.
object - sets animation settings.

Note If you use anychart.graphics.vector.Stage#suspend, you will not see animation.

Params:

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

Returns:

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

Try it:

animation(enabled, duration)

Setter for the animation settings using several parameters.

Detailed description

Note If you use anychart.graphics.vector.Stage#suspend, you will not see animation.

Params:

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

Returns:

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

Try it:

Usage sample

axes

axes()Since version 7.12.0

Getter for map axes.

Returns:

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

Try it:

Usage sample

axes(value)

Setter for map axes.

Detailed description

A map has 4 axes. Use this method to enable all axes. Sets map axes settings depending on parameter type:

boolean - disable or enable map axes.
object - sets map axes settings.

Params:

Name	Type	Description
value	Object \| boolean	Map axes settings to set.

Returns:

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

Try it:

background

background()

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.

Try it:

Usage sample

background(value)

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

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound setting.

Returns:

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

bottom(value)

Sets element bottom bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

bounds

bounds()

Getter for the element bounds settings.

Returns:

anychart.core.utils.Bounds - Current bounds of the element.

bounds(value)

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

Try it:

Usage sample

bounds(x, y, width, height)

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

Try it:

Usage sample

bubble

bubble(data, csvSettings)Since version 7.7.0

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 \| 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:

Usage sample

callout

callout(index)Since version 7.11.0

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:

Usage sample

callout(value)Since version 7.11.0

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:

Usage sample

callout(index, value)Since version 7.11.0

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:

Usage sample

cancelMarquee

cancelMarquee()Since version 7.14.0

Stops current marquee action if any.

Returns:

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

choropleth

choropleth(data, csvSettings)Since version 7.6.0

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 \| 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:

Usage sample

colorRange

colorRange()Since version 7.6.0

Getter for the current color range.

Returns:

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

Try it:

Usage sample

colorRange(value)Since version 7.6.0

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:

Usage sample

connector

connector(data, csvSettings)Since version 7.10.0

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 \| 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:

Usage sample

container

container()

Getter for the element's container.

Returns:

anychart.graphics.vector.Layer | anychart.graphics.vector.Stage - The current container.

container(value)

Setter for the element's container.

Detailed description

Each element appends all its content to this container.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.

Params:

Name	Type	Description
value	anychart.graphics.vector.Layer \| anychart.graphics.vector.Stage \| string \| Element	The 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.standalones.title();
 element.container( fwElement.container() );

Try it:

Usage sample

contextMenu

contextMenu()Since version 7.10.0

Getter for the current context menu.

Returns:

anychart.ui.ContextMenu - The current context menu.

Try it:

Usage sample

contextMenu(value)Since version 7.10.0

Setter for the context menu.

Detailed description

Sets context menu settings depending on parameter type:

null/boolean - disable or enable context menu.
object - sets context menu settings.

Params:

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

Returns:

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

Try it:

credits

credits()

Getter for the current credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

Usage sample

credits(value)

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

Detailed description

Note: You can't customize credits without your licence key. To buy licence key go to Buy page.
Sets chart credits settings depending on parameter type:

null/boolean - disable or enable chart credits.
object - sets chart credits settings.

Params:

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

Returns:

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

Try it:

crosshair

crosshair()Since version 7.12.0

Getter for map crosshair settings.

Returns:

anychart.core.ui.Crosshair - Crosshair settings.

Try it:

Usage sample

crosshair(value)Since version 7.12.0

Setter for map crosshair settings.

Detailed description

Sets map crosshair settings depending on parameter type:

null/boolean - disable or enable map crosshair.
object - sets map crosshair settings.

Params:

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

Returns:

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

Try it:

crs

crs(value)Since version 7.9.0

Sets the crs (coordinate system) to map.

Detailed description

crs method changes map projections.
See the list of supported projections and samples at https://docs.anychart.com/7.11.0/Maps/Map_Projections

Params:

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

Try it:

crsAnimation

crsAnimation()Since version 7.11.0

Getter for animation settings.

Returns:

anychart.core.utils.Animation - Animations settings object.

Try it:

Usage sample

crsAnimation(value, duration)Since version 7.11.0

Setter for animation settings.

Detailed description

Sets animation settings depending on parameter type:

boolean - disable or enable animation.
object - sets 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.

Try it:

defaultSeriesType

defaultSeriesType()Since version 7.8.0

Getter for the map default series type.

Returns:

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

Try it:

Usage sample

defaultSeriesType(value)Since version 7.8.0

Setter for the map default series type.

Detailed description

Setting the default type using this method affects only series created using addSeries() method after the default is set. All series created prior to that do not change the type.

Params:

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

Returns:

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

Try it:

Usage sample

draw

draw(async)

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

Try it:

drillDownMap

drillDownMap(value)Since version 7.10.0

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:

Usage sample

drillTo

drillTo(id, map)Since version 7.10.0

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:

Usage sample

drillUp

drillUp()Since version 7.10.0

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:

Usage sample

featureCrs

featureCrs(id)Since version 7.9.0

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

Detailed description

This method uses the map data, which include latitude and longitude.

Params:

Name	Type	Description
id	string	Feature id.

Returns:

string - The current crs of the feature.

Try it:

Usage sample

featureCrs(id, crs)Since version 7.9.0

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

Detailed description

This method uses the map data, which include latitude and longitude.

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:

Usage sample

featureScaleFactor

featureScaleFactor(id)Since version 7.9.0

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

Detailed description

This method uses the map data, which include latitude and longitude.

Params:

Name	Type	Description
id	string	Feature id.

Returns:

number - The current scale of the feature.

Try it:

Usage sample

featureScaleFactor(id, ratio)Since version 7.9.0

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

Detailed description

This method uses the map data, which include latitude and longitude.

Params:

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

Returns:

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

Try it:

Usage sample

featureTranslation

featureTranslation(id)Since version 7.9.0

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:

Usage sample

featureTranslation(id, dx, dy)Since version 7.9.0

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

Detailed description

Use the map data, which include latitude and longitude. Method moves the feature from the current position to the passed x and y.

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:

Usage sample

geoData

geoData()Since version 7.6.0

Getter for the geo data.

Returns:

Node | string | Object - The current geo data.

See listing

var currentGeoData = map.geoData();

geoData(data)Since version 7.6.0

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

geoIdField()Since version 7.7.0

Getter for the current geo id field.

Returns:

string - The current geo id field.

See listing

var currentGeoIdField = chart.geoIdField();

geoIdField(value)Since version 7.7.0

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:

Usage sample

getDrilldownPath

getDrilldownPath()Since version 7.10.0

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:

Usage sample

getPixelBounds

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

getPlotBounds()Since version 7.8.0

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:

Usage sample

getSelectedPoints

getSelectedPoints()Since version 7.10.0

Getter for the selected points.

Returns:

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

Try it:

Usage sample

getSeries

getSeries(id)Since version 7.6.0

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:

Usage sample

getSeriesAt

getSeriesAt(index)Since version 7.8.0

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:

Usage sample

getSeriesCount

getSeriesCount()Since version 7.8.0

Returns a series count.

Returns:

number - Number of series.

Try it:

Usage sample

getStat

getStat(key)Since version 7.10.0

Getter for a statistical value by the key.

Params:

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

Returns:

* - Statistics value.

Try it:

Usage sample

getType

getType()Since version 7.6.0

Returns chart type.

Returns:

string - Current chart type.

Try it:

Usage sample

getZoomLevel

getZoomLevel()Since version 7.13.0

Gets the map zoom level.

Returns:

number - Zoom level.

Try it:

Usage sample

globalToLocal

globalToLocal(xCoord, yCoord)Since version 7.9.1

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

Detailed description

Converts global coordinates of the global document into local coordinates of the container or stage.
On the image below, the red point is a starting point of the chart bounds. Local coordinates work only within the area of the stage (container).

Params:

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

Returns:

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

Try it:

Usage sample

grids

grids()Since version 7.12.0

Getter for map grids.

Returns:

anychart.core.grids.MapSettings - Grid instance.

Try it:

Usage sample

grids(value)

Setter for map grids.

Detailed description

Sets map grids settings depending on parameter type:

boolean - disable or enable map grids.
object - sets map grids settings.

Params:

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

Returns:

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

Try it:

hatchFillPalette

hatchFillPalette()Since version 7.6.0

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();

hatchFillPalette(value)Since version 7.6.0

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.

Try it:

height

height()

Getter for element height setting.

Returns:

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

height(value)

Sets element height setting.

Params:

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

Returns:

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

Try it:

Usage sample

hoverLabels

hoverLabels()Since version 7.13.1

Getter for series data hover labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

hoverLabels(value)Since version 7.13.1

Setter for series data hover labels.

Detailed description

Sets chart hover labels settings depending on parameter type:

null/boolean - disable or enable chart hover labels.
object - sets chart hover labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Series data labels settings.

Returns:

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

Try it:

inMarquee

inMarquee()Since version 7.14.0

Gets marquee process running value.

Returns:

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

interactivity

interactivity()Since version 7.7.0

Gets the current interactivity settings for chart.

Returns:

anychart.core.utils.Interactivity - The current interactivity settings.

interactivity(value)Since version 7.7.0

Sets interactivity settings for chart.

Params:

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

Returns:

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

Try it:

Usage sample

inverseTransform

inverseTransform(x, y)Since version 7.9.1

Transforms local pixel coordinates to latitude/longitude values.

Detailed description

Transforms pixel coordinates in the coordinate system of a map to degrees (latitude/longitude)
Use anychart.charts.Map#globalToLocal to convert global coordinates to coordinates relative to a map.

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:

Usage sample

label

label(index)

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:

Usage sample

label(value)

Setter for chart label.

Detailed description

Sets chart label settings depending on parameter type:

null/boolean - disable or enable chart label.
string - sets chart label text value.
object - sets chart label settings.

Params:

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

Returns:

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

Try it:

label(index, value)

Setter for chart label.

Detailed description

Sets chart label settings by index depending on parameter type:

null/boolean - disable or enable chart label.
string - sets chart label text value.
object - sets chart label settings.

Params:

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

Returns:

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

Try it:

labels

labels()Since version 7.13.1

Getter for series data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

labels(value)Since version 7.13.1

Setter for series data labels.

Detailed description

Sets chart labels settings depending on parameter type:

null/boolean - disable or enable chart labels.
object - sets chart labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Series data labels settings.

Returns:

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

Try it:

left

left()

Getter for element left bound setting.

Returns:

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

left(value)

Sets element left bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

legend

legend()

Getter for the current chart legend.

Returns:

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

Try it:

Usage sample

legend(value)

Setter for chart legend setting.

Detailed description

Sets chart legend settings depending on parameter type:

null/boolean - disable or enable chart legend.
object - sets chart legend settings.

Params:

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

Returns:

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

Try it:

listen

listen(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.

Params:

Name	Type	Default	Description
type	string		The event type id.
listener	function		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:

Usage sample

listenOnce

listenOnce(type, listener, useCapture, listenerScope)

Adds an event listener to an implementing object.

Detailed description

After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).

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:

Object - Unique key for the listener.

Try it:

Usage sample

localToGlobal

localToGlobal(xCoord, yCoord)Since version 7.9.1

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

Detailed description

Converts local coordinates of the container or stage into global coordinates of the global document.
On the image below, the red point is a starting point of the chart bounds. Local coordinates work only within the area of the stage (container).

Params:

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

Returns:

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

Try it:

Usage sample

margin

margin()

Getter for current chart margin.

Detailed description

Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left, anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.

Returns:

anychart.core.utils.Margin - Chart margin.

Try it:

Usage sample

margin(value)

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

Try it:

Usage sample

margin(value1, value2, value3, value4)

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

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	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);

Try it:

Usage sample

marker

marker(data, csvSettings)Since version 7.10.0

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 \| 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:

Usage sample

markerPalette

markerPalette()Since version 7.6.0

Getter for the current map markers palette settings.

Returns:

anychart.palettes.Markers - The current map markers palette.

See listing

var currentMarkerPalette = map.markerPalette();

markerPalette(value)Since version 7.6.0

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

maxBubbleSize()Since version 7.7.0

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

Returns:

number | string - The current maximum size.

Try it:

Usage sample

maxBubbleSize(value)Since version 7.7.0

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:

Usage sample

maxHeight

maxHeight()

Getter for maximum height.

Returns:

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

maxHeight(value)

Setter for maximum height.

Params:

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

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for maximum width.

Returns:

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

maxWidth(value)

Setter for maximum width.

Params:

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

Returns:

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

Try it:

Usage sample

maxZoomLevel

maxZoomLevel()Since version 7.13.0

Getter for the maximum zoom level.

Returns:

number - Maximum zoom level.

maxZoomLevel(value)Since version 7.13.0

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:

Usage sample

minBubbleSize

minBubbleSize()Since version 7.7.0

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

Returns:

number | string - The current minimum size.

Try it:

Usage sample

minBubbleSize(value)Since version 7.7.0

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:

Usage sample

minHeight

minHeight()

Getter for minimum height.

Returns:

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

minHeight(value)

Setter for minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

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

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for minimum width.

Returns:

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

minWidth(value)

Setter for minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

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

Returns:

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

Try it:

Usage sample

move

move(dx, dy)Since version 7.9.0

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:

Usage sample

overlapMode

overlapMode()Since version 7.11.0

Getter for labels overlap mode.

Returns:

anychart.enums.LabelsOverlapMode | string - Overlap mode flag.

Try it:

Usage sample

overlapMode(value)Since version 7.11.0

Setter for labels overlap mode.

Detailed description

Global labels overlap settings for map series. Defines if labels are shown if they overlap with other labels. Series settings can override these settings.

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:

Usage sample

padding

padding()

Getter for the chart padding.

Detailed description

Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.

Returns:

anychart.core.utils.Padding - Chart padding.

Try it:

Usage sample

padding(value)

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

Example.

chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});

Try it:

Usage sample

padding(value1, value2, value3, value4)

Setter for the chart paddings in pixels using several numbers.

Params:

Name	Type	Description
value1	string \| number	Top or top-bottom space.
value2	string \| number	Right or right-left space.
value3	string \| number	Bottom space.
value4	string \| number	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);

Try it:

Usage sample

palette

palette()Since version 7.6.0

Getter for the current map palette.

Returns:

anychart.palettes.RangeColors | anychart.palettes.DistinctColors - Color palette instance.

See listing

var currentPalette = map.palette();

palette(value)Since version 7.6.0

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.

Try it:

print

print(paperSizeOrOptions, landscape)

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:

Usage sample

removeAllListeners

removeAllListeners(type)

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:

Usage sample

removeAllSeries

removeAllSeries()Since version 7.8.0

Removes all series from chart.

Returns:

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

Try it:

Usage sample

removeSeries

removeSeries(id)Since version 7.8.0

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:

Usage sample

removeSeriesAt

removeSeriesAt(index)Since version 7.8.0

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:

Usage sample

right

right()

Getter for element right bound setting.

Returns:

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

right(value)

Sets element right bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

saveAsCsv

saveAsCsv(chartDataExportMode, csvSettings, filename)Since version 7.10.0

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:

Usage sample

saveAsJpg

saveAsJpg(width, height, quality, forceTransparentWhite, filename)

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:

Usage sample

saveAsJson

saveAsJson(includeTheme, filename)Since version 7.10.0

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:

Usage sample

saveAsPdf

saveAsPdf(paperSizeOrWidthOrOptions, landscape, x, y, filename)

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:

Usage sample

saveAsPng

saveAsPng(width, height, quality, filename)

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:

Usage sample

saveAsSvg

saveAsSvg(paperSize, landscape, filename)

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:

Usage sample

saveAsSvg(width, height)

Saves the stage as SVG image using width and height.

Params:

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

Try it:

Usage sample

saveAsXlsx

saveAsXlsx(chartDataExportMode, filename)Since version 7.10.0

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:

Usage sample

saveAsXml

saveAsXml(includeTheme, filename)Since version 7.10.0

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:

Usage sample

scale

scale()Since version 7.12.0

Gets map geo scale.

Returns:

anychart.scales.Geo - Map geo scale value.

Try it:

Usage sample

selectLabels

selectLabels()Since version 7.13.1

Getter for series select data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

Usage sample

selectLabels(value)Since version 7.13.1

Setter for series select data labels.

Detailed description

Sets chart select labels settings depending on parameter type:

null/boolean - disable or enable chart select labels.
object - sets chart hover labels settings.

Params:

Name	Type	Description
value	Object \| boolean \| null	Series data labels settings.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.

Try it:

selectMarqueeFill

selectMarqueeFill()Since version 7.14.0

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.

See listing

var selectMarqueeFill = chart.selectMarqueeFill();

selectMarqueeFill(value)Since version 7.14.0

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

Try it:

selectMarqueeFill(color, opacity)Since version 7.14.0

Fill color with opacity. Fill as a string or an object.

Detailed description

Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.

Params:

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

Returns:

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

Try it:

Usage sample

selectMarqueeFill(keys, angle, mode, opacity)Since version 7.14.0

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

Try it:

Usage sample

selectMarqueeFill(keys, cx, cy, mode, opacity, fx, fy)Since version 7.14.0

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

Try it:

Usage sample

selectMarqueeFill(imageSettings)Since version 7.14.0

Image fill. Learn more about coloring.

Params:

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

Returns:

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

Try it:

Usage sample

selectMarqueeStroke

selectMarqueeStroke()Since version 7.14.0

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.

See listing.

var selectMarqueeStroke = chart.selectMarqueeStroke();

selectMarqueeStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.14.0

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	anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

startSelectMarquee

startSelectMarquee(repeat)Since version 7.14.0

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

Try it:

Usage sample

title

title()

Getter for chart title.

Returns:

anychart.core.ui.Title - The current chart title.

Try it:

Usage sample

title(value)

Setter for the chart title.

Detailed description

Sets chart title settings depending on parameter type:

null/boolean - disable or enable chart title.
string - sets chart title text value.
object - sets chart title settings.

Params:

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

Returns:

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

Try it:

toCsv

toCsv(chartDataExportMode, csvSettings)Since version 7.10.0

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:

Usage sample

toGeoJSON

toGeoJSON()Since version 7.9.0

Exports a map to GeoJSON format.

Returns:

Object - Geo JSON config.

Try it:

Usage sample

toJson

toJson(stringify, includeTheme)

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.

Try it:

toSvg

toSvg(paperSize, landscape)Since version 7.5.1

Returns SVG string with paper size and landscape.

Detailed description

Returns SVG string if type of content is SVG otherwise returns empty string.

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:

Usage sample

toSvg(width, height)Since version 7.5.1

Returns SVG string with with determined the width and height.

Detailed description

Returns SVG string if type of content is SVG otherwise returns empty string.

Params:

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

Returns:

string - SVG content or empty string.

Try it:

Usage sample

toXml

toXml(asXmlNode, includeTheme)

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.

Try it:

tooltip()Since version 7.7.0

tooltip(value)Since version 7.7.0

Setter for chart tooltip.

Detailed description

Params:

Name	Type	Description
value	Object \| boolean \| null

Returns:

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

Try it:

top

top()

Getter for element top bound setting.

Returns:

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

top(value)

Sets element top bound setting.

Params:

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

Returns:

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

Try it:

Usage sample

transform

transform(xLong, yLat)Since version 7.9.1

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.

Detailed description

Use anychart.charts.Map#localToGlobal to convert returned coordinates to global coordinates.

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:

Usage sample

translateFeature

translateFeature(id, dx, dy)Since version 7.9.0

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

Detailed description

This method uses the map data, which include latitude and longitude.

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:

Usage sample

unboundRegions

unboundRegions()Since version 7.6.0

Getter for the current settings for the unbound regions.

Returns:

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

Try it:

Usage sample

unboundRegions(value)Since version 7.6.0

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

Detailed description

Sets settings for regions depending on parameter type:

boolean - disable or enable regions.
object - sets regions settings.
string - hide regions ("hide") or set settings as is ("asis").

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.

Try it:

unlisten

unlisten(type, listener, useCapture, listenerScope)

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:

Usage sample

unlistenByKey

unlistenByKey(key)

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:

Usage sample

width

width()

Getter for element width setting.

Returns:

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

width(value)

Sets element width setting.

Params:

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

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Usage sample

zIndex(value)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
value	number	0	Value to set.

Returns:

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

Try it:

Usage sample

zoom

zoom(value, cx, cy, duration)Since version 7.9.0

Zooms a map.

Detailed description

Minimum zoom is map bounds. Maximum zoom is autocalculated from the bounds of 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:

Usage sample

zoomTo

zoomTo(value, cx, cy)Since version 7.10.0

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:

Usage sample

zoomToFeature

zoomToFeature(id)Since version 7.10.0

Zoom to feature by passed id.

Params:

Name	Type	Description
id	string	Feature id.

Try it:

Usage sample