AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.charts.Sparkline Improve this Doc

Extends: anychart.core.Chart

Sparkline chart class.
To get the chart use anychart#sparkline method.

Methods Overview

Specific settings
clip()Series clip settings.
connectMissingPoints()Connect missing points settings.
getType()Definition of the chart type.
globalToLocal()Converts the global coordinates to local coordinates.
localToGlobal()Converts the local coordinates to global coordinates.
pointWidth()Point width settings.
Axes and Scales
lineMarker()Line marker settings.
rangeMarker()Range marker settings.
textMarker()Text marker settings.
xScale()X-scale settings.
yScale()Y-scale settings.
Chart Coloring
animation()Animation settings
background()Background settings.
Chart Controls
contextMenu()Context menu settings.
label()Label settings.
title()Title settings.
Coloring
fill()Fill settings.
firstFill()First fill settings.
firstHatchFill()First hatch fill settings.
hatchFill()Hatch fill settings.
lastFill()Last fill settings.
lastHatchFill()Last hatch fill settings.
maxFill()Fill color settings for maximum point.
maxHatchFill()Hatch fill settings for maximum point.
minFill()Fill color settings for minimum point.
minHatchFill()Hatch fill settings for minimum point.
negativeFill()Negative fill settings.
negativeHatchFill()Negative hatch fill settings.
selectMarqueeFill()Select marquee fill settings.
selectMarqueeStroke()Stroke settings.
stroke()Stroke 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
startSelectMarquee()Starts select marquee drawing.
tooltip()Tooltip settings.
Point Elements
firstLabels()First labels settings.
firstMarkers()First markers settings.
labels()Labels settings.
lastLabels()Last labels settings.
lastMarkers()Last markers settings.
markers()Markers settings.
maxLabels()Labels settings for maximum point.
maxMarkers()Markers settings for maximum point.
minLabels()Labels settings for minimum point.
minMarkers()Markers settings for minimum point.
negativeLabels()Negative labels settings.
negativeMarkers()Negative markers settings.
Series
type()Series type.
Size and Position
bottom()Bottom bound setting.
bounds()Bounds settings.
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.
padding()Padding settings.
right()Right bound setting.
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
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

animation

Getter for the current animation setting.

Returns:

anychart.core.utils.Animation - Returns true if the animation is enabled.
Setter for the animation setting by one value.

Params:

NameTypeDefaultDescription
valueboolean | Object
false
Whether to enable animation.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for the animation settings using several parameters.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable animation.
durationnumber
1000
Duration in milliseconds.

Returns:

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

background

Getter for the current chart background.

Returns:

anychart.core.ui.Background - The current chart background.
Setter for the chart background.

Params:

NameTypeDefaultDescription
valueObject
{enabled: true, fill: "#fff", stroke: 'none', zIndex: 1}
Background object to set.

Returns:

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

bottom

Getter for element bottom bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Bottom bound setting for the element.

Returns:

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

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:

NameTypeDescription
valueanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of element.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for the element bounds settings.

Params:

NameTypeDefaultDescription
xnumber | string
null
X-coordinate.
ynumber | string
null
Y-coordinate.
widthnumber | string
null
Width.
heightnumber | string
null
Height.

Returns:

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

cancelMarquee

Stops current marquee action if any.

Returns:

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

clip

Getter for series clip settings.

Returns:

boolean | anychart.math.Rect - Clip settings.
Setter for series clip settings. Clips visible part of a series by a rectangle (or chart).
False, if series is created manually. True, if created via the chart.

Params:

NameTypeDefaultDescription
valueanychart.math.Rect
true
Enable/disable series clip.

Returns:

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

connectMissingPoints

Getter for connecting missing points settings.

Returns:

boolean - Flag of connecting missing points.
Setter for connecting missing points settings.

Params:

NameTypeDefaultDescription
valueboolean
false
If set to true, the series will not be interrupted on missing points.
Markers will not be drawn for missing points in both cases.

Returns:

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

container

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

Params:

NameTypeDescription
valueanychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | ElementThe value to set.

Returns:

anychart.charts.Sparkline - 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() );

contextMenu

Getter for the current context menu.

Returns:

anychart.ui.ContextMenu - The current context menu.
Setter for the context menu.

Params:

NameTypeDescription
valueObject | boolean | nullContext menu settings

Returns:

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

data

Getter for the series mapping.

Returns:

anychart.data.View - Returns series mapping.
Setter for the series mapping.

Params:

NameTypeDescription
valueanychart.data.View | anychart.data.Set | Array | stringValue to set.
csvSettingsanychart.enums.TextParsingMode | anychart.data.TextParsingSettingsIf CSV string is passed by first param, you can pass CSV parser settings here as a hash map.

Returns:

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

draw

Starts the rendering of the chart into the container.

Params:

NameTypeDescription
asyncbooleanWhether do draw asynchronously. If set to true, the chart will be drawn asynchronously.

Returns:

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

fill

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill - The fill color.
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

firstFill

Getter for the first fill color.

Returns:

anychart.graphics.vector.Fill - The first fill color.
Setter for first fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

firstHatchFill

Getter for first hatch fill settings.
See listing
var currentFirstHatchFill = chart.firstHatchFill();
Setter for first hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | stringPatternFill or HatchFill instance or type of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

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

firstLabels

Getter for data labels of first point.

Returns:

anychart.core.ui.LabelsFactory.Label - Label instance.
Setter for data labels of first point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data first labels settings.

Returns:

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

firstMarkers

Getter for data markers of the first point.

Returns:

anychart.core.ui.MarkersFactory.Marker - Marker instance.
Setter for data markers of the first point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data first markers settings.

Returns:

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

getPixelBounds

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

Returns:

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

getSelectedPoints

Getter for the selected points.

Returns:

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

getStat

Getter for a statistical value by the key.

Params:

NameTypeDescription
keystring | anychart.enums.StatisticsKey.

Returns:

* - Statistics value.

getType

Returns chart type.

Returns:

string - Chart type.

globalToLocal

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

Params:

NameTypeDescription
xCoordnumberGlobal X coordinate.
yCoordnumberGlobal Y coordinate.

Returns:

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

hatchFill

Getter for hatch fill settings.
See listing
var currentHatchFill = chart.hatchFill();
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | stringPatternFill or HatchFill instance or type of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

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

height

Getter for element height setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Height setting for the element.

Returns:

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

inMarquee

Gets marquee process running value.

Returns:

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

label

Getter for chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

anychart.core.ui.Label - An instance of class.
Setter for chart label.

Params:

NameTypeDefaultDescription
valuenull | boolean | Object | string
false
Chart label instance to add by index 0.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for chart label.

Params:

NameTypeDefaultDescription
indexstring | number
Label index.
valuenull | boolean | Object | string
false
Chart label settings.

Returns:

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

labels

Getter for data labels.

Returns:

anychart.core.ui.LabelsFactory.Label - Label instance.
Setter for data labels.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Series data labels settings.

Returns:

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

lastFill

Getter for the last fill color.

Returns:

anychart.graphics.vector.Fill - The last fill color.
Setter for last fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

lastHatchFill

Getter for last hatch fill settings.
See listing
var currentLastHatchFill = chart.lastHatchFill();
Setter for last hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | stringPatternFill or HatchFill instance or type of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

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

lastLabels

Getter for data labels of the last point.

Returns:

anychart.core.ui.LabelsFactory.Label - Label instance.
Setter for data labels of the last point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data last labels settings.

Returns:

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

lastMarkers

Getter for data markers of the last point.

Returns:

anychart.core.ui.MarkersFactory.Marker - Marker instance.
Setter for data markers of the last point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data last markers settings.

Returns:

anychart.charts.Sparkline - 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:

NameTypeDefaultDescription
valuenumber | string | null
null
Left bound setting for the element.

Returns:

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

lineMarker

Getter for the chart line marker.

Params:

NameTypeDescription
indexnumberChart line marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Line - Line marker instance by index.
Setter for the chart line marker.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart line marker settings to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for the chart line marker by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart line marker index.
valueObject | boolean | null
Chart line marker settings to set.

Returns:

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

listen

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
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 }.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

listenOnce

Adds an event listener to an implementing object.

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

Object - Unique key for the listener.

localToGlobal

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

Params:

NameTypeDescription
xCoordnumberLocal X coordinate.
yCoordnumberLocal Y coordinate.

Returns:

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

margin

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

Params:

NameTypeDefaultDescription
valueArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Sparkline - 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));
Setter for the chart margin in pixels using several simple values.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Sparkline - 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);

markers

Getter for data markers.

Returns:

anychart.core.ui.MarkersFactory.Marker - Markers instance.
Setter for data markers.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Series data markers settings.

Returns:

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

maxFill

Getter for the fill color of maximum point value.

Returns:

anychart.graphics.vector.Fill - The maximum fill color.
Setter for maximum fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

maxHatchFill

Getter for hatch fill settings of maximum point.
See listing
var currentMaxHatchFill = chart.maxHatchFill();
Setter for hatch fill settings of maximum point. Learn more about hatch fill settings.

Params:

NameTypeDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | stringPatternFill or HatchFill instance or type of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

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

maxHeight

Getter for maximum height.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

maxLabels

Getter for data labels of maximum point.

Returns:

anychart.core.ui.LabelsFactory.Label - Label instance.
Setter for data labels of maximum point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data maximum labels settings.

Returns:

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

maxMarkers

Getter for data markers of maximum point.

Returns:

anychart.core.ui.MarkersFactory.Marker - Marker instance.
Setter for data markers of maximum point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data maximum markers settings.

Returns:

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

maxWidth

Getter for maximum width.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minFill

Getter for the fill color of minimum point value.

Returns:

anychart.graphics.vector.Fill - The minimum fill color.
Setter for minimum fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

minHatchFill

Getter for hatch fill settings of minimum point.
See listing
var currentMinHatchFill = chart.minHatchFill();
Setter for hatch fill settings of minimum point. Learn more about hatch fill settings.

Params:

NameTypeDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | stringPatternFill or HatchFill instance or type of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

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

minHeight

Getter for minimum height.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

minLabels

Getter for data labels of minimum point.

Returns:

anychart.core.ui.LabelsFactory.Label - Label instance.
Setter for data labels of minimum point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data minimum labels settings.

Returns:

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

minMarkers

Getter for data markers of minimum point.

Returns:

anychart.core.ui.MarkersFactory.Marker - Marker instance.
Setter for data markers of minimum point.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data minimum markers settings.

Returns:

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

minWidth

Getter for minimum width.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Value to set.

Returns:

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

negativeFill

Getter for the negative fill color.

Returns:

anychart.graphics.vector.Fill - The negative fill color.
Setter for the negative fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

negativeHatchFill

Getter for negative hatch fill settings.
See listing
var currentNegativeHatchFill = chart.negativeHatchFill();
Setter for negative hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | stringPatternFill or HatchFill instance or type of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

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

negativeLabels

Getter for data labels of negative points.

Returns:

anychart.core.ui.LabelsFactory.Label - Label instance.
Setter for data labels of negative points.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data negative labels settings.

Returns:

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

negativeMarkers

Getter for data negative markers.

Returns:

anychart.core.ui.MarkersFactory.Marker - Marker instance.
Setter for data negative markers.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Data negative markers settings.

Returns:

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

padding

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

Params:

NameTypeDefaultDescription
valueArray.<(number|string)> | Object
{top: 0, right: 0, bottom: 0, left: 0}
Value to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});
Setter for the chart paddings in pixels using several numbers.

Params:

NameTypeDefaultDescription
value1string | number
0
Top or top-bottom space.
value2string | number
0
Right or right-left space.
value3string | number
0
Bottom space.
value4string | number
0
Left space.

Returns:

anychart.charts.Sparkline - 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);

pointWidth

Getter for point width settings.

Returns:

string | number - Point width pixel value.
Setter for point width settings.

Params:

NameTypeDefaultDescription
valuenumber | string
"95%"
Point width pixel value.

Returns:

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

print

Prints all elements on related stage.

Params:

NameTypeDefaultDescription
paperSizeOrOptionsanychart.graphics.vector.PaperSize | Object
Paper size or object with options.
landscapeboolean
false
Flag of landscape.

rangeMarker

Getter for the chart range marker.

Params:

NameTypeDescription
indexnumberChart range marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Range - Range marker instance by index.
Setter for the chart range marker.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart range marker settings to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for the chart range marker by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart range marker index.
valueObject | boolean | null
Chart range marker settings to set.

Returns:

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

removeAllListeners

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

Params:

NameTypeDescription
typestringType of event to remove, default is to remove all types.

Returns:

number - Number of listeners removed.
Getter for element right bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Right bound setting for the element.

Returns:

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

saveAsCsv

Saves chart data as CSV file.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.
filenamestringFile name to save.

saveAsJpg

Saves the current chart as JPEG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
includeThemebooleanIf the current theme properties should be included into the result.
filenamestringFile name to save.

saveAsPdf

Saves the current chart as PDF image.

Params:

NameTypeDescription
paperSizeOrWidthOrOptionsnumber | string | ObjectAny paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the current chart as PNG image.

Params:

NameTypeDescription
widthnumber | ObjectImage width or object with options.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

Saves the current chart as SVG image.

Params:

NameTypeDescription
paperSizestring | ObjectPaper Size or object with options.
landscapebooleanLandscape.
filenamestringFile name to save.
Saves the stage as SVG image using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

saveAsXlsx

Saves chart data as Excel document.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
filenamestringFile name to save.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
includeThemebooleanIf the current theme properties should be included into the result.
filenamestringFile name to save.

selectMarqueeFill

Getter for the select marquee fill.

Returns:

anychart.graphics.vector.Fill - Select marquee fill.
See listing
var selectMarqueeFill = chart.selectMarqueeFill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an object or a string.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

selectMarqueeStroke

Getter for the select marquee stroke.

Returns:

anychart.graphics.vector.Stroke - Select marquee stroke.
See listing.
var selectMarqueeStroke = chart.selectMarqueeStroke();
Setter for the select marquee stroke. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

startSelectMarquee

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

Params:

NameTypeDescription
repeatbooleanWhether to start select marquee drawing.

Returns:

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

stroke

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
Setter for the stroke by function.

Params:

NameTypeDefaultDescription
functionfunction
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like function(){ // this.index - series index. // this.sourceColor - color returned by fill() getter. // this.iterator - series point iterator. return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill }.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for stroke settings. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinanychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapanychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

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

textMarker

Getter for the chart text marker.

Params:

NameTypeDescription
indexnumberChart text marker index. If not set - creates a new instance and adds it to the end of array.

Returns:

anychart.core.axisMarkers.Text - Text marker instance by index.
Setter for the chart text marker.

Params:

NameTypeDefaultDescription
valueObject | boolean | null
false
Chart text marker settings to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for the chart text marker by index.

Params:

NameTypeDefaultDescription
indexnumber
0
Chart text marker index.
valueObject | boolean | null
Chart text marker settings to set.

Returns:

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

title

Getter for chart title.

Returns:

anychart.core.ui.Title - The current chart title.
Setter for the chart title.

Params:

NameTypeDefaultDescription
valuenull | boolean | Object | string
false
Chart title text or title instance for copy settings from.

Returns:

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

toCsv

Returns CSV string with series data.

Params:

NameTypeDescription
chartDataExportModestring | anychart.enums.ChartDataExportModeData export mode.
csvSettingsObject.<string, (string|boolean|undefined)>CSV settings.

Returns:

string - CSV string.

toJson

Return chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.
includeThemeboolean
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:

NameTypeDescription
paperSizestring | ObjectPaper Size or object of options.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string with with determined the width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Return chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.
includeThemeboolean
false
If the current theme properties should be included into the result.

Returns:

string | Node - Chart configuration.

tooltip

Getter for current chart tooltip.

Returns:

anychart.core.ui.Tooltip - An instance of the class for method chaining.
Example
var tooltipSettings = chart.tooltip();
Setter for chart tooltip.

Params:

NameTypeDescription
valueObject | boolean | null

Returns:

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

top

Getter for element top bound setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Top bound setting for the element.

Returns:

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

type

Getter for the sparkline series type.

Returns:

string | anychart.enums.SparklineSeriesType - Sparkline series type.
Setter for the sparkline series type.

Params:

NameTypeDefaultDescription
typestring | anychart.enums.SparklineSeriesType
"line"
Series type.

Returns:

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

unlisten

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

Params:

NameTypeDefaultDescription
typestring
The event type id.
listenerfunction
Callback method.
useCaptureboolean
false
Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing
listenerScopeObject
Object in whose scope to call the listener.

Returns:

boolean - Whether any listener was removed.

unlistenByKey

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

Params:

NameTypeDescription
keyObjectThe key returned by listen() or listenOnce().

Returns:

boolean - Whether any listener was removed.

width

Getter for element width setting.

Returns:

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

Params:

NameTypeDefaultDescription
valuenumber | string | null
null
Width setting for the element.

Returns:

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

xScale

Getter for the chart X scale.

Returns:

anychart.scales.Ordinal - Default chart scale value.
Setter for the chart X scale.
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.

Params:

NameTypeDefaultDescription
valueanychart.enums.ScaleTypes | anychart.scales.Base
"ordinal"
X-scale to set.

Returns:

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

yScale

Getter for the chart Y scale.

Returns:

anychart.scales.Base - Default chart scale value.
Setter for the chart Y scale.
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.

Params:

NameTypeDefaultDescription
valueanychart.enums.ScaleTypes | anychart.scales.Base
"linear"
Y Scale to set.

Returns:

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

zIndex

Getter for the current Z-index of the element.

Returns:

number - The current zIndex.
Setter for the Z-index of the element.

Params:

NameTypeDefaultDescription
valuenumber
0
Value to set.

Returns:

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