AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.charts.Sparkline Improve this Doc

Extends: anychart.core.Chart

Sparkline chart class.
To get the chart use anychart#sparkline method.
Learn more about Sparkline Chart

Methods Overview

Specific settings
a11y()Accessibility 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.
toA11yTable()Creates and returns the chart represented as an invisible HTML table.
toHtmlTable()Creates and returns a chart as HTML table.
Axes and Scales
lineMarker()Line marker settings.
rangeMarker()Range marker settings.
textMarker()Text marker settings.
xScale()X-scale settings.
yScale()Y-scale settings.
Chart Controls
contextMenu()Context menu settings.
credits()Credits settings
label()Label settings.
title()Title settings.
Coloring
background()Background settings.
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.
stroke()Stroke settings.
Data
data()Data settings.
getStat()Getter for a statistical value by the key.
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
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
seriesType()Series type.
Size and Position
bottom()Bottom bound settings.
bounds()Bounds settings.
getPixelBounds()Returns pixel 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 setting.
top()Top bound settings.
width()Width setting.
zIndex()Z-index of the chart.
XML/JSON
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.
container()Chart container
draw()Chart drawing
fullScreen()Fullscreen mode.
id()Chart id.
isFullScreenAvailable()Whether the fullscreen mode available in the browser or not.

Methods Description

a11y

Getter for the accessibility settings.

Returns:

anychart.core.utils.ChartA11y - Accessibility settings object.
See listing.
var stateOfAccsessibility = chart.a11y();
Setter for the accessibility settings.

Params:

NameTypeDescription
settingsboolean | ObjectWhether to enable accessibility or object with settings.

Returns:

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

autoRedraw

Getter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Returns:

boolean - AutoRedraw flag.
See listing
var autoRedraw = chart.autoRedraw();
Setter for the autoRedraw flag.
Flag whether to automatically call chart.draw() on any changes or not.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

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

background

Getter for the chart background.

Returns:

anychart.core.ui.Background - Chart background.
Setter for the chart background settings.

Params:

NameTypeDescription
settingsstring | Object | null | booleanBackground settings to set.

Returns:

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

bottom

Getter for the chart's bottom bound setting.

Returns:

number | string | undefined - Chart's bottom bound settings.
See listing
var bottom = chart.bottom();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
bottomnumber | string | nullBottom bound for the chart.

Returns:

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

bounds

Getter for the chart bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.
See listing
var bounds = chart.bounds();
Setter for the chart bounds using one parameter.

Params:

NameTypeDescription
boundsanychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.BoundsBounds of teh chart.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for the chart 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.

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
enabledboolean
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 chart container.
Setter for the chart container.

Params:

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

Returns:

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

contextMenu

Getter for the context menu.

Returns:

anychart.ui.ContextMenu - Context menu.
Setter for the context menu.

Params:

NameTypeDescription
settingsObject | boolean | nullContext menu settings

Returns:

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

credits

Getter for chart credits.

Returns:

anychart.core.ui.ChartCredits - Chart credits.
Setter for chart credits. Learn more about credits settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Credits 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
dataanychart.data.View | anychart.data.Set | Array | stringValue to set.
csvSettingsanychart.enums.TextParsingMode | string | 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.

exports

Getter for the export charts.

Returns:

anychart.core.utils.Exports - Exports settings.
See listing
var exports = chart.exports();
Setter for the export charts.

Params:

NameTypeDescription
settingsObjectExport settings.

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, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array 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, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array 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 firstHatchFill = chart.firstHatchFill();
Setter for first hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringType of the hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for first hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for first hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for first hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for first hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

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
settingsObject | 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
settingsObject | boolean | null
false
Data first markers settings.

Returns:

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

fullScreen

Getter for the fullscreen mode.

Returns:

boolean - Full screen state (enabled/disabled).
See listing
var fullScreen = chart.fullScreen();
Setter for the fullscreen mode.

Params:

NameTypeDefaultDescription
enabledboolean
false
Enable/Disable fullscreen mode.

Returns:

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

getJpgBase64String

Returns JPG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.

getPdfBase64String

Returns PDF as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.

getPixelBounds

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

Returns:

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

getPngBase64String

Returns PNG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.

getStat

Getter for a statistical value by the key.

Params:

NameTypeDescription
keyanychart.enums.Statistics | stringKey.

Returns:

* - Statistics value.

getSvgBase64String

Returns SVG as base64 string.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.

getType

Returns chart type.

Returns:

string - Chart type.

globalToLocal

Converts the global coordinates to local coordinates. Note: Works only after anychart.charts.Sparkline#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 hatchFill = chart.hatchFill();
Setter for hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringType of the hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

height

Getter for the chart's height setting.

Returns:

number | string | undefined - Chart's height setting.
See listing
var height = chart.height();
Setter for the chart's height setting.

Params:

NameTypeDefaultDescription
heightnumber | string | null
null
Height settings for the chart.

Returns:

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

id

Getter for chart id.

Returns:

string - Return chart id.
Setter for chart id.

Params:

NameTypeDescription
idstringChart id.

Returns:

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

isFullScreenAvailable

Whether the fullscreen mode available in the browser or not.

Returns:

boolean - isFullScreenAvailable state.

label

Getter for the chart label.

Params:

NameTypeDefaultDescription
indexstring | number
0
Index of instance.

Returns:

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

Params:

NameTypeDefaultDescription
settingsnull | 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 using index.

Params:

NameTypeDefaultDescription
indexstring | number
0
Label index.
settingsnull | 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
settingsObject | 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, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array 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 lastHatchFill = chart.lastHatchFill();
Setter for last hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringType of the hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for last hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for last hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for last hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for last hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

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
settingsObject | 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
settingsObject | boolean | null
false
Data last markers settings.

Returns:

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

left

Getter for the chart's left bound setting.

Returns:

number | string | undefined - Chart's left bound setting.
See listing
var left = chart.left();
Setter for the chart's left bound setting.

Params:

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

Returns:

anychart.charts.Sparkline - Self instance 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
settingsObject | 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.
settingsObject | 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(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
}
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(e:Object)
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.charts.Sparkline#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
marginArray.<(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
settingsObject | 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, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array 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 maxHatchFill = chart.maxHatchFill();
Setter for hatch fill settings of maximum point. Learn more about hatch fill settings.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringType of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

maxHeight

Getter for the chart's maximum height.

Returns:

number | string | null - Chart's maximum height.
See listing
var maxHeight = chart.maxHeight();
Setter for the chart's maximum height.

Params:

NameTypeDefaultDescription
maxHeightnumber | string | null
null
Maximum height 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
settingsObject | 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
settingsObject | boolean | null
false
Data maximum markers settings.

Returns:

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

maxWidth

Getter for the chart's maximum width.

Returns:

number | string | null - Chart's maximum width.
See listing
var maxWidth = chart.maxWidth();
Setter for the chart's maximum width.

Params:

NameTypeDefaultDescription
maxWidthnumber | string | null
null
Maximum width 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, an object or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | string | ArrayColor as an object, an array 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 minHatchFill = chart.minHatchFill();
Setter for hatch fill settings of minimum point. Learn more about hatch fill settings.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringType of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

Returns:

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

minHeight

Getter for the chart's minimum height.

Returns:

number | string | null - Chart's minimum height.
See listing
var minHeight = chart.minHeight();
Setter for the chart's minimum height.

Params:

NameTypeDefaultDescription
minHeightnumber | string | null
null
Minimum height 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
settingsObject | 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
settingsObject | boolean | null
false
Data minimum markers settings.

Returns:

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

minWidth

Getter for the chart's minimum width.

Returns:

number | string | null - Chart's minimum width.
See listing
var minWidth = chart.minWidth();
Setter for the chart's minimum width.

Params:

NameTypeDefaultDescription
minWidthnumber | string | null
null
Minimum width 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 negative fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>Color as an object, an array 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 negativeHatchFill = chart.negativeHatchFill();
Setter for negative hatch fill settings. Learn more about hatch fill settings.

Params:

NameTypeDescription
typeanychart.graphics.vector.HatchFill.HatchFillType | stringType of hatch fill.
colorstringColor.
thicknessnumberThickness.
sizenumberPattern size.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for negative hatch fill settings using function. Learn more about coloring.

Params:

NameTypeDescription
hatchFillFunctionfunctionHatchFill function.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for negative hatch fill settings using pattern fill. Learn more about coloring.

Params:

NameTypeDescription
patternFillanychart.graphics.vector.PatternFillPattern fill to set.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for negative hatch fill settings using an instance. Learn more about coloring.

Params:

NameTypeDescription
settingsanychart.graphics.vector.HatchFillHatch fill instance.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for negative hatch fill using boolean. Learn more about hatch fill settings.

Params:

NameTypeDefaultDescription
enabledboolean
false
Whether to enable hatch fill or no.

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
settingsObject | 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
settingsObject | boolean | null
false
Data negative markers settings.

Returns:

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

noData

Getter for noData settings.

Returns:

anychart.core.NoDataSettings - NoData settings.
Setter for noData settings.
Learn more about "No data" feature

Params:

NameTypeDescription
settingsObjectNoData settings.

Returns:

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

padding

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

Params:

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

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
See listing.
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
widthnumber | string
'95%'
Point width pixel value.

Returns:

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

print

Prints chart.

Params:

NameTypeDefaultDescription
paperSizeanychart.graphics.vector.PaperSize
Paper size.
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
settingsObject | 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.
settingsObject | 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 the chart's right bound setting.

Returns:

number | string | undefined - Chart's right bound setting.
See listing
var right = chart.right();
Setter for the chart's right bound setting.

Params:

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

Returns:

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

saveAsCsv

Saves chart data as a CSV file.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<string, (string|boolean|undefined|function(name:*, value:*))>
CSV settings object:
  • rowsSeparator - string or undefined (default is '\n')
  • columnsSeparator - string or undefined (default is ',')
  • ignoreFirstRow - boolean or undefined (default is 'false')
  • formats - Values formatter
  • headers - Headers formatter

Formatters must be represented as one of:
  1. A function with two arguments such as the field name and value, that returns the formatted value.
  2. The object with the key as the field name, and the value as a format function.
filenamestringFile name to save.

saveAsJpg

Saves the chart as JPEG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanDefine, should we force transparent to white background.
filenamestringFile name to save.

saveAsJson

Saves chart config as JSON document.

Params:

NameTypeDescription
filenamestringFile name to save.

saveAsPdf

Saves the chart as PDF image.

Params:

NameTypeDescription
paperSizestringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapebooleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

saveAsPng

Saves the chart as PNG image.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

saveAsSvg

Saves the chart as SVG image using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
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 an Excel document.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
filenamestringFile name to save.
exportOptionsObject.<string, (function(name:*, value:*))>
Export options:
  • headers - Headers formatter

Formatter must be represented as one of:
  1. A function with two arguments such as the field name and value, that returns the formatted value.
  2. The object with the key as the field name, and the value as a format function.

saveAsXml

Saves chart config as XML document.

Params:

NameTypeDescription
filenamestringFile name to save.

seriesType

Getter for the sparkline series type.

Returns:

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

Params:

NameTypeDefaultDescription
typeanychart.enums.SparklineSeriesType | string
'line'
Series type.

Returns:

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

shareAsJpg

Shares a chart as a JPG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
forceTransparentWhitebooleanForce transparent to white or not.
filenamestringFile name to save.

shareAsPdf

Shares a chart as a PDF file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthnumber | stringAny paper format like 'a0', 'tabloid', 'b4', etc.
landscapeOrWidthnumber | booleanDefine, is landscape.
xnumberOffset X.
ynumberOffset Y.
filenamestringFile name to save.

shareAsPng

Shares a chart as a PNG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
widthnumberImage width.
heightnumberImage height.
qualitynumberImage quality in ratio 0-1.
filenamestringFile name to save.

shareAsSvg

Shares a chart as a SVG file and returns a link to the shared image.

Params:

NameTypeDescription
onSuccessOrOptionsfunction(response:string) | ObjectFunction that is called when sharing is complete or object with options.
onErrorfunction(response:string)Function that is called if sharing fails.
asBase64booleanShare as base64 file.
paperSizeOrWidthstring | numberPaper Size or width.
landscapeOrHeightboolean | stringLandscape or height.
filenamestringFile name to save.

shareWithFacebook

Opens Facebook sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for the main link or object with options.
linkstringThe URL is attached to the publication.
namestringThe title for the attached link.
descriptionstringDescription for the attached link.

shareWithLinkedIn

Opens LinkedIn sharing dialog.

Params:

NameTypeDescription
captionOrOptionsstring | ObjectCaption for publication or object with options. If not set 'AnyChart' will be used.
descriptionstringDescription.

shareWithPinterest

Opens Pinterest sharing dialog.

Params:

NameTypeDescription
linkOrOptionsstring | ObjectAttached link or object with options. If not set, the image URL will be used.
descriptionstringDescription.

shareWithTwitter

Opens Twitter sharing dialog.

stroke

Getter for stroke settings.

Returns:

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

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
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 | null
Stroke settings.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.charts.Sparkline - Self instance for method chaining.
Setter for stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

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
settingsObject | 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.
settingsObject | boolean | null
Chart text marker settings to set.

Returns:

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

title

Getter for the chart title.

Returns:

anychart.core.ui.Title - Chart title.
Setter for the chart title.

Params:

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

Returns:

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

toA11yTable

Creates and returns the chart represented as an invisible HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines 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.

toCsv

Returns CSV string with the chart data.

Params:

NameTypeDescription
chartDataExportModeanychart.enums.ChartDataExportMode | stringData export mode.
csvSettingsObject.<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.

toHtmlTable

Creates and returns a chart as HTML table.

Params:

NameTypeDescription
titlestringTitle to set.
asStringbooleanDefines 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.

toJson

Returns chart configuration as JSON object or string.

Params:

NameTypeDefaultDescription
stringifyboolean
false
Returns JSON as string.

Returns:

Object | string - Chart configuration.

toSvg

Returns SVG string using paper size and landscape.

Params:

NameTypeDescription
paperSizestringPaper Size.
landscapebooleanLandscape.

Returns:

string - SVG content or empty string.
Returns SVG string using width and height.

Params:

NameTypeDescription
widthnumberImage width.
heightnumberImage height.

Returns:

string - SVG content or empty string.

toXml

Returns chart configuration as XML string or XMLNode.

Params:

NameTypeDefaultDescription
asXmlNodeboolean
false
Return XML as XMLNode.

Returns:

string | Node - Chart configuration.

tooltip

Getter for the tooltip settings.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for tooltip settings.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Tooltip settings.

Returns:

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

top

Getter for the chart's top bound setting.

Returns:

number | string | undefined - Chart's top bound settings.
See listing
var top = chart.top();
Setter for the chart's top bound setting.

Params:

NameTypeDescription
topnumber | string | nullTop bound for the chart.

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(e:Object)
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 the chart's width setting.

Returns:

number | string | undefined - Chart's width setting.
See listing
var width = chart.width();
Setter for the chart's width setting.

Params:

NameTypeDefaultDescription
widthnumber | string | null
null
Width settings for the chart.

Returns:

anychart.charts.Sparkline - Self instance 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
settingsanychart.enums.ScaleTypes | string | anychart.scales.Base | Object
anychart.scales.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
settingsanychart.enums.ScaleTypes | string | anychart.scales.Base | Object
anychart.scales.Linear
Y Scale to set.

Returns:

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

zIndex

Getter for the Z-index of the chart.

Returns:

number - Chart Z-index.
See listing
var zIndex = chart.zIndex();
Setter for the Z-index of the chart.

Params:

NameTypeDefaultDescription
zIndexnumber
0
Z-index to set.

Returns:

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