Top
You are looking at an outdated 7.14.0 version of this document. Switch to the 7.14.3 version to see the up to date information.

class anychart.charts.TagCloud Improve this Doc

Extends: anychart.core.SeparateChart

TagCloud chart class.

Methods Overview

Specific settings
getType()Definition of the chart type.
globalToLocal()Converts the global coordinates to local coordinates.
localToGlobal()Converts the local coordinates to global coordinates.
Axes and Scales
colorScale()Color scale settings.
scale()Scale settings.
Chart Coloring
animation()Animation settings
background()Background settings.
palette()Palette settings.
Chart Controls
colorRange()Color range settings.
contextMenu()Context menu settings.
credits()Credits settings
label()Label settings.
legend()Legend settings.
title()Title settings.
Data
data()Data settings.
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
hover()Hovers a point by its index.
hovered()Hovered state settings
interactivity()Interactivity settings.
normal()Normal state settings
select()Selects points.
selected()Selected state settings
unhover()Removes hover from all chart points.
unselect()Deselects all points or points by index.
Point Elements
getPoint()Gets wrapped point by index.
Size and Position
angles()Angles settings.
anglesCount()Angles count.
bottom()Bottom bound setting.
bounds()Bounds settings.
fromAngle()Starting angle.
getPixelBounds()Returns pixel bounds.
height()Height setting.
left()Left bound setting.
margin()Margin settings.
maxHeight()Maximum height.
maxWidth()Maximum width.
minHeight()Minimum height.
minWidth()Minimum width.
mode()Mode settings.
padding()Padding settings.
right()Right bound setting.
textSpacing()Text spacing settings.
toAngle()End angle.
top()Top bound setting.
width()Width setting.
zIndex()Z-index of the element.
XML/JSON
toJson()Return chart configuration as JSON object or string.
toXml()Return chart configuration as XML string or XMLNode.
Miscellaneous
container()Getter for the element's container.
draw()Drawing of the chart.
saveAsJpg()Saves the current chart as JPEG image.
saveAsPdf()Saves the current chart as PDF image.
saveAsPng()Saves the current chart as PNG image.
saveAsSvg()Saves the current chart as SVG image.
toSvg()Returns SVG string.

Methods Description

angles

Getter for tags rotation angles.

Returns:

Array.<number> - Array of tags rotation angles.
See listing
var angles = chart.angles();
Setter for tags rotation angles.

Params:

Name Type Description
value Array.<number> Array of tags rotation angles.

Returns:

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

Try it:

anglesCount

Getter for the angles count.

Returns:

number - Angles count.
See listing
var anglesCount = chart.anglesCount();
Setter for the angles count.

Params:

Name Type Default Description
value number
2
Angles count.

Returns:

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

Try it:

animation

Getter for the current animation setting.

Returns:

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

Try it:

Setter for the animation setting by one value.

Params:

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

Returns:

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

Params:

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

Returns:

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

Try it:

background

Getter for the current chart background.

Returns:

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

Try it:

Setter for the chart background.

Params:

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

Returns:

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

Try it:

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

bounds

Getter for the element bounds settings.

Returns:

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

Params:

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

Returns:

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

Try it:

Setter for the element bounds settings.

Params:

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

Returns:

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

Try it:

colorRange

Getter for color range.

Returns:

anychart.core.ui.ColorRange - Color range.

Try it:

Setter for color range.

Params:

Name Type Description
value Object | boolean Color range settings to set.

Returns:

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

colorScale

Getter for the color scale.
See listing
var colorScale = chart.colorScale();
Setter for the color scale.

Params:

Name Type Description
value anychart.scales.LinearColor | anychart.scales.OrdinalColor Color scale to set.

Returns:

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

container

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

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example
// string
 element.container('containerIdentifier');
// DOM-element
 var domElement = document.getElementById('containerIdentifier');
 element.container(domElement);
// Framework-element
 var fwElement = anychart.standalones.title();
 element.container( fwElement.container() );

Try it:

contextMenu

Getter for the current context menu.

Returns:

anychart.ui.ContextMenu - The current context menu.

Try it:

Setter for the context menu.

Params:

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

Returns:

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

credits

Getter for the current credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.

Try it:

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

Params:

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

Returns:

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

data

Getter for chart data.

Returns:

anychart.data.View - Returns mapping.
See listing
var data = chart.data();
Setter for chart data. Note: All data is words values.

Params:

Name Type Description
value anychart.data.View | anychart.data.Set | Array | anychart.data.DataSettings | string Value to set.
settings anychart.enums.TextParsingMode | anychart.data.TextParsingSettings If CSV string is passed, you can pass CSV parser settings here as a hash map.

Returns:

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

draw

Starts the rendering of the chart into the container.

Params:

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

Returns:

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

fromAngle

Getter for the starting angle.

Returns:

number - Starting angle.
See listing
var fromAngle = chart.fromAngle();
Setter for the starting angle.

Params:

Name Type Default Description
value number
0
Starting angle value.

Returns:

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

Try it:

getPixelBounds

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

getPoint

Gets wrapped point by index.

Params:

Name Type Description
index number Point index.

Returns:

anychart.core.Point - Wrapped point.

Try it:

getSelectedPoints

Getter for the selected points.

Returns:

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

Try it:

getStat

Getter for a statistical value by the key.

Params:

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

Returns:

* - Statistics value.

Try it:

getType

Returns chart type.

Returns:

string - Chart type.

Try it:

globalToLocal

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

Params:

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

Returns:

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

Try it:

height

Getter for element height setting.

Returns:

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

Params:

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

Returns:

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

Try it:

hover

Hovers a point by its index.

Params:

Name Type Description
index number | Array.<number> Index of the point to hover.

Returns:

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

Try it:

hovered

Getter for the hovered state settings.

Returns:

anychart.core.TagCloudStateSettings - Hovered state settings.

Try it:

Setter for the hovered state settings.

Params:

Name Type Description
value Object State settings.

Returns:

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

Try it:

interactivity

Gets the current interactivity settings for chart.

Returns:

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

Params:

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

Returns:

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

Try it:

label

Getter for chart label.

Params:

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

Returns:

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

Try it:

Setter for chart label.

Params:

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

Returns:

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

Params:

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

Returns:

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

left

Getter for element left bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

legend

Getter for the current chart legend.

Returns:

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

Try it:

Setter for chart legend setting.

Params:

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

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

Name Type Default Description
type string
The event type id.
listener function
Callback method. Function that looks like function(event){ // event.actualTarget - actual event target // event.currentTarget - current event target // event.iterator - event iterator // event.originalEvent - original event // event.point - event point // event.pointIndex - event point index }.
useCapture boolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScope Object
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

Try it:

listenOnce

Adds an event listener to an implementing object.

Params:

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

Returns:

Object - Unique key for the listener.

Try it:

localToGlobal

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

Params:

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

Returns:

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

Try it:

margin

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

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// all margins 15px
chart.margin(15);
// all margins 15px
chart.margin("15px");
// top and bottom 5px, right and left 15px
chart.margin(anychart.utils.margin(5, 15));

Try it:

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

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.margin(10);
// 2) top and bottom 10px, left and right 15px
chart.margin(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.margin(10, "15px", 5);
// 4) top 10px, right 15px, bottom 5px, left 12px
chart.margin(10, "15px", "5px", 12);

Try it:

maxHeight

Getter for maximum height.

Returns:

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

Params:

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

Returns:

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

Try it:

maxWidth

Getter for maximum width.

Returns:

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

Params:

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

Returns:

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

Try it:

minHeight

Getter for minimum height.

Returns:

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

Params:

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

Returns:

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

Try it:

minWidth

Getter for minimum width.

Returns:

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

Params:

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

Returns:

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

Try it:

mode

Getter for the tag cloud mode.

Returns:

anychart.enums.TagCloudMode - Tag cloud mode.
See listing
var mode = chart.mode();
Setter for the tag cloud mode.

Params:

Name Type Default Description
value anychart.enums.TagCloudMode | string
"spiral"
Tag cloud mode.

Returns:

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

Try it:

normal

Getter for normal state settings.

Returns:

anychart.core.TagCloudStateSettings - Normal state settings

Try it:

Setter for normal state settings.

Params:

Name Type Description
value Object State settings.

Returns:

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

Try it:

padding

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

Params:

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

Returns:

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

Try it:

Setter for the chart paddings in pixels using several numbers.

Params:

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

Returns:

anychart.core.Chart - Self instance for method chaining.
Example.
// 1) all 10px
chart.padding(10);
// 2) top and bottom 10px, left and right 15px
chart.padding(10, "15px");
// 3) top 10px, left and right 15px, bottom 5px
chart.padding(10, "15px", 5);
// 4) top 10px, right 15%, bottom 5px, left 12px
chart.padding(10, "15%", "5px", 12);

Try it:

palette

Getter for the palette.
See listing
var palette = chart.palette();
Setter for the palette. Note: You can use predefined palettes from anychart.palettes.

Params:

Name Type Description
value anychart.palettes.RangeColors | anychart.palettes.DistinctColors | Object | Array.<string> Color palette instance.

Returns:

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

print

Prints all elements on related stage.

Params:

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

Try it:

removeAllListeners

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

Params:

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

Returns:

number - Number of listeners removed.

Try it:

Getter for element right bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

saveAsCsv

Saves chart data as CSV file.

Params:

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

Try it:

saveAsJpg

Saves the current chart as JPEG image.

Params:

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

Try it:

saveAsJson

Saves chart config as JSON document.

Params:

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

Try it:

saveAsPdf

Saves the current chart as PDF image.

Params:

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

Try it:

saveAsPng

Saves the current chart as PNG image.

Params:

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

Try it:

saveAsSvg

Saves the current chart as SVG image.

Params:

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

Try it:

Saves the stage as SVG image using width and height.

Params:

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

Try it:

saveAsXlsx

Saves chart data as Excel document.

Params:

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

Try it:

saveAsXml

Saves chart config as XML document.

Params:

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

Try it:

scale

Getter for the font scale.

Returns:

anychart.scales.Base - Font scale.

Try it:

Setter for the font scale.

Params:

Name Type Description
value anychart.enums.ScaleTypes | anychart.scales.Base Scale to set or scale type.

Returns:

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

Try it:

select

Selects points by index. Note: Works only after anychart.charts.TagCloud#draw is called.

Params:

Name Type Description
index number Index of the point to select.

Returns:

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

Try it:

Selects points by indexes. Note: Works only after anychart.charts.TagCloud#draw is called.

Params:

Name Type Description
indexes Array.<number> Array of indexes of the point to select.

Returns:

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

Try it:

selected

Getter for selected state settings.

Returns:

anychart.core.TagCloudStateSettings - Selected state settings.

Try it:

Setter for selected state settings.

Params:

Name Type Description
value Object State settings.

Returns:

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

Try it:

textSpacing

Getter for text spacing.

Returns:

number - Text spacing value.
See listing
var textSpacing = chart.textSpacing();
Setter for text spacing.

Params:

Name Type Default Description
value number
1
Text spacing value.

Returns:

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

Try it:

title

Getter for chart title.

Returns:

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

Try it:

Setter for the chart title.

Params:

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

Returns:

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

toAngle

Getter for the end angle.

Returns:

number - End angle.
See listing
var toAngle = chart.toAngle();
Setter for the end angle.

Params:

Name Type Default Description
value number
90
End angle value.

Returns:

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

Try it:

toCsv

Returns CSV string with series data.

Params:

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

Returns:

string - CSV string.

Try it:

toJson

Return chart configuration as JSON object or string.

Params:

Name Type Default Description
stringify boolean
false
Returns JSON as string.
includeTheme boolean
false
If the current theme properties should be included into the result.

Returns:

Object string - Chart configuration.

toSvg

Returns SVG string with paper size and landscape.

Params:

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

Returns:

string - SVG content or empty string.

Try it:

Returns SVG string with with determined the width and height.

Params:

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

Returns:

string - SVG content or empty string.

Try it:

toXml

Return chart configuration as XML string or XMLNode.

Params:

Name Type Default Description
asXmlNode boolean
false
Return XML as XMLNode.
includeTheme boolean
false
If the current theme properties should be included into the result.

Returns:

string Node - Chart configuration.

top

Getter for element top bound setting.

Returns:

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

Params:

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

Returns:

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

Try it:

unhover

Removes hover from all chart points.

Returns:

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

Try it:

unlisten

Removes a listener added using listen() or listenOnce() methods.

Params:

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

Returns:

boolean - Whether any listener was removed.

Try it:

unlistenByKey

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

Params:

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

Returns:

boolean - Whether any listener was removed.

Try it:

unselect

Deselects all points or points by index.

Params:

Name Type Description
indexOrIndexes number | Array.<number> Index or array of indexes of the point to select.

Try it:

width

Getter for element width setting.

Returns:

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

Params:

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

Returns:

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

Try it:

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.

Try it:

Setter for the Z-index of the element.

Params:

Name Type Default Description
value number
0
Value to set.

Returns:

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

Try it: