class anychart.charts.Map Improve this Doc
Extends: anychart.core.SeparateChart
AnyChart map class.
Learn more about Map Chart
Methods Overview
Specific settings | |
a11y() | Accessibility 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 |
toA11yTable() | Creates and returns the chart represented as an invisible HTML table. |
toHtmlTable() | Creates and returns a chart as HTML table. |
transform() | Returns coordinate at given latitude and longitude as pixel values relative to a map bounds. |
unboundRegions() | Unbound regions settings. |
Axes and Scales | |
axes() | Axes settings. |
grids() | Grid settings. |
scale() | Map geo scale settings. |
Chart Coloring | |
hatchFillPalette() | Hatch fill palette. |
markerPalette() | Markers palette. |
palette() | Map palette. |
Chart Controls | |
colorRange() | Color range settings. |
contextMenu() | Context menu settings. |
credits() | Credits settings |
label() | Label settings. |
legend() | Legend settings. |
title() | Title settings. |
Charts | |
getCurrentScene() | Returns the current chart after drilling down into the map. |
Coloring | |
background() | Background settings. |
selectPolygonMarqueeFill() | Select polygon marquee fill settings. |
selectRectangleMarqueeFill() | Select marquee fill settings. |
selectRectangleMarqueeStroke() | Stroke settings. |
Data | |
geoData() | Geo data settings. |
geoIdField() | Geo id field |
getDrilldownPath() | Returns the drill down path. |
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 |
getJpgBase64String() | Returns JPG as base64 string. |
getPdfBase64String() | Returns PDF as base64 string. |
getPngBase64String() | Returns PNG as base64 string. |
getSvgBase64String() | Returns SVG as base64 string. |
print() | Prints chart. |
saveAsCsv() | Saves chart data as a CSV file. |
saveAsJpg() | Saves the chart as JPEG image. |
saveAsJson() | Saves chart config as JSON document. |
saveAsPdf() | Saves the chart as PDF image. |
saveAsPng() | Saves the chart as PNG image. |
saveAsSvg() | Saves the chart as SVG image. |
saveAsXlsx() | Saves chart data as an Excel document. |
saveAsXml() | Saves chart config as XML document. |
shareAsJpg() | Shares a chart as a JPG file and returns a link to the shared image. |
shareAsPdf() | Shares a chart as a PDF file and returns a link to the shared image. |
shareAsPng() | Shares a chart as a PNG file and returns a link to the shared image. |
shareAsSvg() | Shares a chart as a SVG file and returns a link to the shared image. |
shareWithFacebook() | Opens Facebook sharing dialog. |
shareWithLinkedIn() | Opens LinkedIn sharing dialog. |
shareWithPinterest() | Opens Pinterest sharing dialog. |
shareWithTwitter() | Opens Twitter sharing dialog. |
toCsv() | Returns CSV string with the chart data. |
toSvg() | Returns SVG string. |
Interactivity | |
crosshair() | Map crosshair settings. |
crsAnimation() | Animation settings |
drillDownMap() | Drills down a map. |
drillTo() | Drills down to a map. |
drillUp() | Drills one level up from the current level. |
fitAll() | Fits all visible part to width of map. Maximum zoom out. |
getZoomLevel() | Gets the map zoom level. |
hovered() | Hovered state settings. |
interactivity() | Interactivity settings. |
maxZoomLevel() | Maximum zoom level. |
move() | Moves focus point for the map. |
normal() | Normal state settings. |
selectPolygonMarqueeMarker() | Polygon selection start area settings. |
selected() | Selected state settings. |
startSelectPolygonMarquee() | Starts polygon selection drawing. |
startSelectRectangleMarquee() | Starts select marquee drawing. |
tooltip() | Tooltip settings. |
zoom() | Zooms a map. |
zoomIn() | Zoom the map in the center. |
zoomOut() | Zoom the map out the center. |
zoomTo() | Zooms the map to passed zoom level and coordinates. |
zoomToFeature() | Zoom to feature by passed id. |
Point Elements | |
getSelectedPoints() | Getter for the selected points. |
labels() | Labels settings. |
Series | |
bubble() | Creates a Bubble series. |
choropleth() | Creates a Choropleth series. |
connector() | Creates connector series. |
getSeries() | Getter for the series by its id. |
marker() | Creates a Marker series. |
Size and Position | |
bottom() | Bottom bound settings. |
bounds() | Bounds settings. |
crs() | Coordinate system settings |
featureCrs() | Coordinate system for the feature. |
featureScaleFactor() | Scale settings of the feature |
featureTranslation() | Getter for the translation feature by id. |
getPixelBounds() | Returns pixel bounds of the chart. |
getPlotBounds() | Getter for the data bounds of the chart. |
height() | Height setting. |
left() | Left bound setting. |
margin() | Margin settings. |
maxHeight() | Maximum height setting. |
maxWidth() | Maximum width setting. |
minHeight() | Minimum height setting. |
minWidth() | Minimum width setting. |
padding() | Padding settings. |
right() | Right bound settings. |
top() | Top bound settings. |
translateFeature() | Translates feature on passed dx and dy. |
width() | Width setting. |
zIndex() | Z-index of the chart. |
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() | Returns chart configuration as JSON object or string. |
toXml() | Returns chart configuration as XML string or XMLNode. |
Miscellaneous | |
autoRedraw() | Redraw chart after changes or not. |
cancelMarquee() | Stops marquee action if any. |
cancelPolygon() | Stops polygon selection drawing. |
container() | Chart container |
draw() | Chart drawing |
fullScreen() | Fullscreen mode. |
id() | Chart id. |
inMarquee() | Gets marquee process running value. |
inPolygon() | If polygon selection is in process. |
isFullScreenAvailable() | Whether the fullscreen mode available in the browser or not. |
selectPolygonMarqueeStroke() | Setter for the select polygon marquee stroke. |
Methods Description
a11y
Returns:
anychart.core.utils.ChartA11y - Accessibility settings object.var stateOfAccsessibility = chart.a11y();
Sets accessibility setting depending on parameter type:
- boolean - disable or enable accessibility.
- object - sets accessibility settings.
Params:
Name | Type | Description |
---|---|---|
settings | boolean | Object | Whether to enable accessibility or object with settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.addSeries
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:
autoRedraw
Flag whether to automatically call chart.draw() on any changes or not.
Returns:
boolean - AutoRedraw flag.var autoRedraw = chart.autoRedraw();
Flag whether to automatically call chart.draw() on any changes or not.
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | true | Value to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
axes
- boolean - disable or enable map axes.
- object - sets map axes settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | Map axes settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.background
- null/boolean - disable or enable chart background.
- object - sets chart background settings.
- string - sets chart background color.
Params:
Name | Type | Description |
---|---|---|
settings | string | Object | null | boolean | Background settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.bottom
Returns:
number | string | undefined - Chart's bottom bound settings.var bottom = chart.bottom();
Params:
Name | Type | Description |
---|---|---|
bottom | number | string | null | Bottom bound for the chart. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
bounds
Returns:
anychart.core.utils.Bounds - Bounds of the element.var bounds = map.bounds();
Params:
Name | Type | Description |
---|---|---|
bounds | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of teh chart. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
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:
bubble
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
Params:
Name | Type | Description |
---|---|---|
index | number | Index of existing callout element to get. |
Returns:
anychart.core.ui.Callout - Callout instance by index.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Callout settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
Params:
Name | Type | Description |
---|---|---|
index | number | Index of existing callout element. |
settings | Object | boolean | null | Callout settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
cancelMarquee
Returns:
anychart.charts.Map - Self instance for method chaining.cancelPolygon
Returns:
anychart.charts.Map - Self instance for method chaining.choropleth
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
Params:
Name | Type | Description |
---|---|---|
settings | Object | Color range settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
connector
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 chainingTry it:
container
Params:
Name | Type | Description |
---|---|---|
element | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
contextMenu
- null/boolean - disable or enable context menu.
- object - sets context menu settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Context menu settings |
Returns:
anychart.charts.Map - Self instance for method chaining.credits
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 |
---|---|---|---|
settings | Object | boolean | null | true | Credits settings |
Returns:
anychart.charts.Map - Self instance for method chaining.crosshair
- null/boolean - disable or enable map crosshair.
- object - sets map crosshair settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | Object | boolean | null | false | Crosshair settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.crs
Returns:
Object | function | anychart.enums.MapProjections | string - Projection name, or projection string representation, or projection Object or Function.See the list of supported projections and samples at https://docs.anychart.com/7.11.0/Maps/Map_Projections
Params:
Name | Type | Description |
---|---|---|
settings | Object | function | anychart.enums.MapProjections | string | Projection name, or projection string representation, or projection Object or Function. |
Returns:
anychart.charts.Map - Self instance for method chaining.crsAnimation
Returns:
anychart.core.utils.Animation - Animations settings object.Try it:
- boolean - disable or enable animation.
- object - sets animation settings.
Params:
Name | Type | Description |
---|---|---|
settings | boolean | Object | Animation settings. |
duration | number | A duration in milliseconds. |
Returns:
anychart.charts.Map - Self instance for method chaining.defaultSeriesType
Returns:
anychart.enums.MapSeriesType | string - The map default series type.Try it:
Params:
Name | Type | Description |
---|---|---|
type | anychart.enums.MapSeriesType | string | Series type. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
draw
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
Set the transitions to drill down.
Params:
Name | Type | Description |
---|---|---|
value | Object.<string, (Object|anychart.charts.Map)> | Value to set. |
Returns:
Object - The object with id and map instance.Try it:
drillTo
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
Rises up from the current level of drill down, if possible.
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
exports
Returns:
anychart.core.utils.Exports - Exports settings.var exports = chart.exports();
Params:
Name | Type | Description |
---|---|---|
settings | Object | Export settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
featureCrs
Note: Works only after anychart.charts.Map#draw is called.
Params:
Name | Type | Description |
---|---|---|
id | string | Feature id. |
Returns:
string - The crs of the feature.Try it:
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
Note: Works only after anychart.charts.Map#draw is called.
Params:
Name | Type | Description |
---|---|---|
id | string | Feature id. |
Returns:
number - The scale of the feature.Try it:
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
Params:
Name | Type | Description |
---|---|---|
id | string | Feature id. |
Returns:
Array.<number> - The translating feature.Try it:
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:
fitAll
The fitAll() method should be used after drawing a chart.
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
fullScreen
Returns:
boolean - Full screen state (enabled/disabled).var fullScreen = chart.fullScreen();
Params:
Name | Type | Default | Description |
---|---|---|---|
enabled | boolean | false | Enable/Disable fullscreen mode. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
geoData
Returns:
Node | string | Object - The geo data.var geoData = map.geoData();
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
Returns:
string - Geo id field.var geoIdField = chart.geoIdField();
Params:
Name | Type | Description |
---|---|---|
id | string | Geo id. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
getCurrentScene
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
getDrilldownPath
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:
getJpgBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
onError | function(response:string) | Function that is called if sharing fails. |
width | number | Image width. |
height | number | Image height. |
quality | number | Image quality in ratio 0-1. |
forceTransparentWhite | boolean | Force transparent to white or not. |
Try it:
getPdfBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
onError | function(response:string) | Function that is called if sharing fails. |
paperSizeOrWidth | number | string | Any paper format like 'a0', 'tabloid', 'b4', etc. |
landscapeOrWidth | number | boolean | Define, is landscape. |
x | number | Offset X. |
y | number | Offset Y. |
Try it:
getPixelBounds
Returns pixel bounds of the chart due to parent bounds and self bounds settings.
Returns:
anychart.math.Rect - Pixel bounds of the chart.Try it:
getPlotBounds
Returns:
anychart.math.Rect - Data bounds of the chart.Try it:
getPngBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
onError | function(response:string) | Function that is called if sharing fails. |
width | number | Image width. |
height | number | Image height. |
quality | number | Image quality in ratio 0-1. |
Try it:
getSelectedPoints
Returns:
Array.<anychart.core.MapPoint> - An array of the selected points.Try it:
getSeries
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
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
getSvgBase64String
Params:
Name | Type | Description |
---|---|---|
onSuccessOrOptions | function(response:string) | Object | Function that is called when sharing is complete or object with options. |
onError | function(response:string) | Function that is called if sharing fails. |
paperSizeOrWidth | string | number | Paper Size or width. |
landscapeOrHeight | boolean | string | Landscape or height. |
Try it:
getType
getZoomLevel
globalToLocal
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:
grids
- boolean - disable or enable map grids.
- object - sets map grids settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | Object | boolean | null | false | Chart grids settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.hatchFillPalette
Returns:
anychart.palettes.HatchFills - Chart hatch fill palette.var hatchFillPalette = map.hatchFillPalette();
Params:
Name | Type | Description |
---|---|---|
settings | Array.<anychart.graphics.vector.HatchFill.HatchFillType> | Object | anychart.palettes.HatchFills | Hatch fill palette to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.height
Returns:
number | string | undefined - Chart's height setting.var height = chart.height();
Params:
Name | Type | Default | Description |
---|---|---|---|
height | number | string | null | null | Height settings for the chart. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
hovered
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
id
Params:
Name | Type | Description |
---|---|---|
id | string | Chart id. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
inMarquee
Returns:
boolean - Returns true if there is a marquee process running.inPolygon
Returns:
boolean - Returns true if there is a polygon selection process is running.interactivity
Returns:
anychart.core.utils.MapInteractivity - Interactivity settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | anychart.enums.HoverMode | string | Settings object or boolean value like enabled state. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
inverseTransform
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:
isFullScreenAvailable
Returns:
boolean - isFullScreenAvailable state.Try it:
label
Params:
Name | Type | Default | Description |
---|---|---|---|
index | string | number | 0 | Index of instance. |
Returns:
anychart.core.ui.Label - An instance of class.Try it:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.charts.Map - Self instance for method chaining.- 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 | 0 | Label index. |
settings | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.labels
- null/boolean - disable or enable chart labels.
- object - sets chart labels settings.
Params:
Name | Type | Description |
---|---|---|
settings | Object | boolean | null | Series data labels settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.left
Returns:
number | string | undefined - Chart's left bound setting.var left = chart.left();
Params:
Name | Type | Default | Description |
---|---|---|---|
value | number | string | null | null | Left bound setting for the chart. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
legend
- null/boolean - disable or enable chart legend.
- object - sets chart legend settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | Object | boolean | null | false | Legend settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.listen
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(e:Object) | Callback method.
Function that looks like: function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index } | |
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
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(e:Object) | 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
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:
margin
Returns:
anychart.core.utils.Margin - Chart margin.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
margin | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.// 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:
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.charts.Map - Self instance for method chaining.// 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
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
Returns:
anychart.palettes.Markers - Map markers palette.var markerPalette = map.markerPalette();
Params:
Name | Type | Description |
---|---|---|
settings | 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
Returns:
number | string - Maximum size.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
size | number | string | '10%' | Maximum bubble size. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
maxHeight
Returns:
number | string | null - Chart's maximum height.var maxHeight = chart.maxHeight();
Params:
Name | Type | Default | Description |
---|---|---|---|
maxHeight | number | string | null | null | Maximum height to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
maxWidth
Returns:
number | string | null - Chart's maximum width.var maxWidth = chart.maxWidth();
Params:
Name | Type | Default | Description |
---|---|---|---|
maxWidth | number | string | null | null | Maximum width to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
maxZoomLevel
Returns:
number - Maximum zoom level.Params:
Name | Type | Description |
---|---|---|
value | number | Maximum zoom level. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
minBubbleSize
Returns:
number | string - Minimum size.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
size | number | string | '1%' | Minimum bubble size. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
minHeight
Returns:
number | string | null - Chart's minimum height.var minHeight = chart.minHeight();
Params:
Name | Type | Default | Description |
---|---|---|---|
minHeight | number | string | null | null | Minimum height to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
minWidth
Returns:
number | string | null - Chart's minimum width.var minWidth = chart.minWidth();
Params:
Name | Type | Default | Description |
---|---|---|---|
minWidth | number | string | null | null | Minimum width to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
move
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
Learn more about "No data" feature
Params:
Name | Type | Description |
---|---|---|
settings | Object | NoData settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
normal
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
overlapMode
Returns:
anychart.enums.LabelsOverlapMode | string - Overlap mode flag.Try it:
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
Returns:
anychart.core.utils.Padding - Chart padding.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
padding | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.chart.padding([5, 15]); or chart.padding({left: 10, top: 20, bottom: 30, right: '40%'}});
Try it:
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.charts.Map - Self instance for method chaining.// 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
var palette = map.palette();
Params:
Name | Type | Description |
---|---|---|
settings | anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> | Color palette instance. |
Returns:
anychart.charts.Map - Self instance for method chaining.Params:
Name | Type | Default | Description |
---|---|---|---|
paperSize | anychart.graphics.vector.PaperSize | Paper size. | |
landscape | boolean | false | Flag of landscape. |
Try it:
removeAllListeners
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
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
removeSeries
Params:
Name | Type | Description |
---|---|---|
id | number | string | Series id. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
removeSeriesAt
Params:
Name | Type | Description |
---|---|---|
index | number | Series index. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
right
Returns:
number | string | undefined - Chart's right bound setting.var right = chart.right();
Params:
Name | Type | Description |
---|---|---|
right | number | string | null | Right bound for the chart. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
saveAsCsv
Params:
Name | Type | Description |
---|---|---|
chartDataExportMode | anychart.enums.ChartDataExportMode | string | Data export mode. |
csvSettings | Object.<string, (string|boolean|undefined|function(name:*, value:*))> | CSV settings object:
Formatters must be represented as one of:
|
filename | string | File name to save. |
Try it:
saveAsJpg
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
Params:
Name | Type | Description |
---|---|---|
filename | string | File name to save. |
Try it:
saveAsPdf
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
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
Params:
Name | Type | Description |
---|---|---|
paperSize | string | Paper Size. |
landscape | boolean | Landscape. |
filename | string | File name to save. |
Try it:
Params:
Name | Type | Description |
---|---|---|
width | number | Image width. |
height | number | Image height. |
Try it:
saveAsXlsx
Params:
Name | Type | Description |
---|---|---|
chartDataExportMode | anychart.enums.ChartDataExportMode | string | Data export mode. |
filename | string | File name to save. |
exportOptions | Object.<string, (function(name:*, value:*))> | Export options:
Formatter must be represented as one of:
|
Try it:
saveAsXml
Params:
Name | Type | Description |
---|---|---|
filename | string | File name to save. |
Try it:
scale
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | anychart.scales.Geo | Object | 'geo' | Scale to set. |
Returns:
anychart.scales.Geo - Map geo scale value.Try it:
selectPolygonMarqueeFill
Returns:
anychart.graphics.vector.Fill - Select polygon marquee fill.var selectPolygonMarqueeFill = chart.selectPolygonMarqueeFill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | Fill settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
selectPolygonMarqueeMarker
NOTE: start area appears as a circle at the first point of polygon selection. Can be used to close that polygon selection.
Params:
Name | Type | Description |
---|---|---|
config | Object | Start marker config, must look like:
map.selectPolygonMarqueeMarker({
fill: anychart.graphics.vector.Fill,
stroke: anychart.graphics.vector.Stroke,
radius: number
})
|
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
selectPolygonMarqueeStroke
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Stroke | Stroke settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
selectRectangleMarqueeFill
Returns:
anychart.graphics.vector.Fill - Select marquee fill.var selectRectangleMarqueeFill = chart.selectRectangleMarqueeFill();
Params:
Name | Type | Description |
---|---|---|
color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an object, an array or a string. |
Returns:
anychart.charts.Map - Self instance for method chaining.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:
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:
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:
Params:
Name | Type | Description |
---|---|---|
imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
selectRectangleMarqueeStroke
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke.var selectRectangleMarqueeStroke = chart.selectRectangleMarqueeStroke();
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.charts.Map - Self instance for method chaining.Try it:
Returns:
anychart.graphics.vector.Stroke - Select marquee stroke.var selectPolygonMarqueeStroke = chart.selectPolygonMarqueeStroke();
selected
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Params:
Name | Type | Description |
---|---|---|
settings | Object | State settings to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
shareAsJpg
shareAsPdf
shareAsPng
shareAsSvg
shareWithFacebook
shareWithLinkedIn
shareWithPinterest
shareWithTwitter
startSelectPolygonMarquee
Use double click to end polygon selection or click the last point of polygon within radius of the first point.
When you move mouse within radius of the first point dashed line appears.
Note: Works only after anychart.charts.Map#draw is called.
Params:
Name | Type | Description |
---|---|---|
repeat | boolean | Whether to repeat select polygon drawing. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
startSelectRectangleMarquee
Params:
Name | Type | Description |
---|---|---|
repeat | boolean | Whether to start select marquee drawing. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
title
- null/boolean - disable or enable chart title.
- string - sets chart title text value.
- object - sets chart title settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.charts.Map - Self instance for method chaining.toA11yTable
Params:
Name | Type | Description |
---|---|---|
title | string | Title to set. |
asString | boolean | Defines output: HTML string if True, DOM element if False. |
Returns:
Element | string | null - HTML table instance with a11y style (invisible), HTML string or null if parsing chart to table fails.Try it:
toCsv
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: rowsSeparator - string or undefined (default is '\n') columnsSeparator - string or undefined (default is ',') ignoreFirstRow - boolean or undefined (default is 'false') formats - 1) a function with two arguments such as the field name and value, that returns the formatted value or 2) the object with the key as the field name, and the value as a format function. (default is 'undefined'). |
Returns:
string - CSV string.Try it:
toGeoJSON
toHtmlTable
Params:
Name | Type | Description |
---|---|---|
title | string | Title to set. |
asString | boolean | Defines output: HTML string if True, DOM element if False. |
Returns:
Element | string | null - HTML table instance, HTML string or null if parsing chart to table fails.Try it:
toJson
Params:
Name | Type | Default | Description |
---|---|---|---|
stringify | boolean | false | Returns JSON as string. |
Returns:
Object | string - Chart configuration.toSvg
Params:
Name | Type | Description |
---|---|---|
paperSize | string | Paper Size. |
landscape | boolean | Landscape. |
Returns:
string - SVG content or empty string.Try it:
Params:
Name | Type | Description |
---|---|---|
width | number | Image width. |
height | number | Image height. |
Returns:
string - SVG content or empty string.Try it:
toXml
Params:
Name | Type | Default | Description |
---|---|---|---|
asXmlNode | boolean | false | Return XML as XMLNode. |
Returns:
string | Node - Chart configuration.tooltip
- null/boolean - disable or enable chart data tooltip.
- object - sets chart data tooltip settings.
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.charts.Map - Self instance for method chaining.top
Returns:
number | string | undefined - Chart's top bound settings.var top = chart.top();
Params:
Name | Type | Description |
---|---|---|
top | number | string | null | Top bound for the chart. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
transform
Note: Returns correct values only after anychart.charts.Map#draw is called.
Note that the longitude and latitude are set as parameters for the transform() method.
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
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
Returns:
anychart.core.utils.UnboundRegionsSettings | anychart.enums.MapUnboundRegionsMode | string - Settings for unbound regions.Try it:
- boolean - disable or enable regions.
- object - sets regions settings.
- string - hide regions ('hide') or set settings as is ('as-is').
Params:
Name | Type | Default | Description |
---|---|---|---|
settings | 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
Params:
Name | Type | Default | Description |
---|---|---|---|
type | string | The event type id. | |
listener | function(e:Object) | 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
Params:
Name | Type | Description |
---|---|---|
key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
width
Returns:
number | string | undefined - Chart's width setting.var width = chart.width();
Params:
Name | Type | Default | Description |
---|---|---|---|
width | number | string | null | null | Width settings for the chart. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
zIndex
Returns:
number - Chart Z-index.var zIndex = chart.zIndex();
Params:
Name | Type | Default | Description |
---|---|---|---|
zIndex | number | 0 | Z-index to set. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
zoom
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:
zoomIn
Params:
Name | Type | Description |
---|---|---|
duration | number | Duration of zoom animation. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
zoomOut
Params:
Name | Type | Description |
---|---|---|
duration | number | Duration of zoom animation. |
Returns:
anychart.charts.Map - Self instance for method chaining.Try it:
zoomTo
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: