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.Try it:
Setter for the animation setting by one value.
Detailed description
Sets animation settings depending on parameter type:
- null/boolean - disable or enable animation.
- object - sets animation settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | Object | false | Whether to enable animation. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Setter for the animation settings using several parameters.
Detailed description
Note If you use anychart.graphics.vector.Stage#suspend, you will not see animation.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether to enable animation. |
| duration | number | 1000 | Duration in milliseconds. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
background
Getter for the current chart background.
Returns:
anychart.core.ui.Background - The current chart background.Try it:
Setter for the chart background.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | {enabled: true, fill: "#fff", stroke: 'none', zIndex: 1} | Background object to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
bottom
Getter for element bottom bound setting.
Returns:
number | string | undefined - Current element's bottom bound setting.Sets element bottom bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Bottom bound setting for the element. |
Returns:
anychart.charts.Sparkline - Returns self for method chaining.Try it:
bounds
Getter for the element bounds settings.
Returns:
anychart.core.utils.Bounds - Current bounds of the element.Sets bounds of the element using one parameter.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.utils.RectObj | anychart.math.Rect | anychart.core.utils.Bounds | Bounds of element. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Setter for the element bounds settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| x | number | string | null | X-coordinate. |
| y | number | string | null | Y-coordinate. |
| width | number | string | null | Width. |
| height | number | string | null | Height. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
cancelMarquee
Stops current marquee action if any.
Returns:
anychart.charts.Sparkline - Self instance for method chaining.clip
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.
False, if series is created manually. True, if created via the chart.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.math.Rect | true | Enable/disable series clip. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
connectMissingPoints
Getter for connecting missing points settings.
Returns:
boolean - Flag of connecting missing points.Try it:
Setter for connecting missing points settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | 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.Try it:
container
Getter for the element's container.
Setter for the element's container.
Detailed description
Each element appends all its content to this container.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.
The order of adding is not defined, but usually it will be the order in which elements are drawn for the first time. If you need to specify the order use anychart.core.VisualBase#zIndex.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Layer | anychart.graphics.vector.Stage | string | Element | The value to set. |
Returns:
anychart.charts.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() );Try it:
contextMenu
Getter for the current context menu.
Returns:
anychart.ui.ContextMenu - The current context menu.Try it:
Setter for the context menu.
Detailed description
Sets context menu settings depending on parameter type:
- null/boolean - disable or enable context menu.
- object - sets context menu settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Context menu settings |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.data
Setter for the series mapping.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.data.View | anychart.data.Set | Array | string | Value to set. |
| csvSettings | anychart.enums.TextParsingMode | anychart.data.TextParsingSettings | If 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:
| Name | Type | Description |
|---|---|---|
| async | boolean | Whether do draw asynchronously. If set to true, the chart will be drawn asynchronously. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.fill
Setter for fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Fill color with opacity.
Fill as a string or an object.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
firstFill
Getter for the first fill color.
Returns:
anychart.graphics.vector.Fill - The first fill color.Try it:
Setter for first fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Fill color with opacity.
Fill as a string or an object.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
firstHatchFill
Getter for first hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill. See listing
var currentFirstHatchFill = chart.firstHatchFill();
Setter for first hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Description |
|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. |
| thickness | number | Thickness. |
| size | number | Pattern size. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
firstLabels
Getter for data labels of first point.
Returns:
anychart.core.ui.LabelsFactory.Label - Label instance.Try it:
Setter for data labels of first point.
Detailed description
Sets first labels settings depending on parameter type:
- null/boolean - disable or enable first labels.
- object - sets first labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.Try it:
Setter for data markers of the first point.
Detailed description
Sets first markers settings depending on parameter type:
- null/boolean - disable or enable first markers.
- object - sets first markers settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.Try it:
getStat
Getter for a statistical value by the key.
Params:
| Name | Type | Description |
|---|---|---|
| key | string | anychart.enums.Statistics | Key. |
Returns:
* - Statistics value.Try it:
getType
globalToLocal
Converts the global coordinates to local coordinates.
Note: Works only after anychart.core.Chart#draw is called.
Detailed description
Converts global coordinates of the global document into local coordinates of the container or stage.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Global X coordinate. |
| yCoord | number | Global Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
hatchFill
Getter for hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill. See listing
var currentHatchFill = chart.hatchFill();
Setter for hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Description |
|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. |
| thickness | number | Thickness. |
| size | number | Pattern size. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
height
Getter for element height setting.
Returns:
number | string | undefined - Current element's height setting.Sets element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Height setting for the element. |
Returns:
anychart.charts.Sparkline - Returns self for method chaining.Try it:
inMarquee
Gets marquee process running value.
Returns:
boolean - Returns true if there is a marquee process running.label
Getter for chart label.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | string | number | 0 | Index of instance. |
Returns:
anychart.core.ui.Label - An instance of class.Try it:
Setter for chart label.
Detailed description
Sets chart label settings depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | Object | string | false | Chart label instance to add by index 0. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Setter for chart label.
Detailed description
Sets chart label settings by index depending on parameter type:
- null/boolean - disable or enable chart label.
- string - sets chart label text value.
- object - sets chart label settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | string | number | Label index. | |
| value | null | boolean | Object | string | false | Chart label settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.labels
Setter for data labels.
Detailed description
Sets labels settings depending on parameter type:
- null/boolean - disable or enable labels.
- object - sets labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Series data labels settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.lastFill
Setter for last fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Fill color with opacity.
Fill as a string or an object.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
lastHatchFill
Getter for last hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill. See listing
var currentLastHatchFill = chart.lastHatchFill();
Setter for last hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Description |
|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. |
| thickness | number | Thickness. |
| size | number | Pattern size. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
lastLabels
Getter for data labels of the last point.
Returns:
anychart.core.ui.LabelsFactory.Label - Label instance.Try it:
Setter for data labels of the last point.
Detailed description
Sets last labels settings depending on parameter type:
- null/boolean - disable or enable last labels.
- object - sets last labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.Try it:
Setter for data markers of the last point.
Detailed description
Sets last markers settings depending on parameter type:
- null/boolean - disable or enable last markers.
- object - sets last markers settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Left bound setting for the element. |
Returns:
anychart.charts.Sparkline - Returns self for method chaining.Try it:
lineMarker
Getter for the chart line marker.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart 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.Try it:
Setter for the chart line marker.
Detailed description
Sets line marker settings depending on parameter type:
- null/boolean - disable or enable line marker.
- object - sets line marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.
Detailed description
Sets line marker settings depending on parameter type:
- null/boolean - disable or enable line marker.
- object - sets line marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart line marker index. |
| value | Object | 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.
Detailed description
The listener can be added to an object once, and if it is added one more time, its key will be returned.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Note Notice that if the existing listener is one-off (added using listenOnce), it will cease to be such after calling the listen() method.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. Function that looks like function(event){
// event.actualTarget - actual event target
// event.currentTarget - current event target
// event.iterator - event iterator
// event.originalEvent - original event
// event.point - event point
// event.pointIndex - event point index
}. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
listenOnce
Adds an event listener to an implementing object.
Detailed description
After the event is called, its handler will be deleted.
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
If the event handler being added already exists, listenOnce will do nothing.
Note In particular, if the handler is already registered using listen(), listenOnce() will not make it one-off. Similarly, if a one-off listener already exists, listenOnce will not change it (it wil remain one-off).
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
Object - Unique key for the listener.Try it:
localToGlobal
Converts the local coordinates to global coordinates.
Note: Works only after anychart.core.Chart#draw is called.
Detailed description
Converts local coordinates of the container or stage into global coordinates of the global document.
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
On image below, the red point is a starting coordinate point of the chart bounds. Local coordinates work only in area of the stage (container).
Params:
| Name | Type | Description |
|---|---|---|
| xCoord | number | Local X coordinate. |
| yCoord | number | Local Y coordinate. |
Returns:
Object.<string, number> - Object with XY coordinates.Try it:
margin
Getter for current chart margin.
Detailed description
Also, you can use anychart.core.utils.Margin#bottom, anychart.core.utils.Margin#left,
anychart.core.utils.Margin#right, anychart.core.utils.Margin#top methods to setting paddings.
Returns:
anychart.core.utils.Margin - Chart margin.Try it:
Setter for the chart margin in pixels using a single complex object.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.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));Try it:
Setter for the chart margin in pixels using several simple values.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.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);
Try it:
markers
Setter for data markers.
Detailed description
Sets markers settings depending on parameter's type:
- null/boolean - disable or enable markers.
- object - sets markers settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.Try it:
Setter for maximum fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Fill color with opacity.
Fill as a string or an object.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
maxHatchFill
Getter for hatch fill settings of maximum point.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill. See listing
var currentMaxHatchFill = chart.maxHatchFill();
Setter for hatch fill settings of maximum point.
Learn more about hatch fill settings.
Params:
| Name | Type | Description |
|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. |
| thickness | number | Thickness. |
| size | number | Pattern size. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
maxHeight
Getter for maximum height.
Returns:
number | string | null - Current element's maximum height.Setter for maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
maxLabels
Getter for data labels of maximum point.
Returns:
anychart.core.ui.LabelsFactory.Label - Label instance.Try it:
Setter for data labels of maximum point.
Detailed description
Sets maximum labels settings depending on parameter type:
- null/boolean - disable or enable maximum labels.
- object - sets maximum labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.Try it:
Setter for data markers of maximum point.
Detailed description
Sets maximum markers settings depending on parameter type:
- null/boolean - disable or enable maximum markers.
- object - sets maximum markers settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
minFill
Getter for the fill color of minimum point value.
Returns:
anychart.graphics.vector.Fill - The minimum fill color.Try it:
Setter for minimum fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Fill color with opacity.
Fill as a string or an object.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
minHatchFill
Getter for hatch fill settings of minimum point.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill. See listing
var currentMinHatchFill = chart.minHatchFill();
Setter for hatch fill settings of minimum point.
Learn more about hatch fill settings.
Params:
| Name | Type | Description |
|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. |
| thickness | number | Thickness. |
| size | number | Pattern size. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
minHeight
Getter for minimum height.
Returns:
number | string | null - Current element's minimum height.Setter for minimum height.
Detailed description
The method sets a minimum height of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
minLabels
Getter for data labels of minimum point.
Returns:
anychart.core.ui.LabelsFactory.Label - Label instance.Try it:
Setter for data labels of minimum point.
Detailed description
Sets minimum labels settings depending on parameter type:
- null/boolean - disable or enable minimum labels.
- object - sets minimum labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.Try it:
Setter for data markers of minimum point.
Detailed description
Sets minimum markers settings depending on parameter type:
- null/boolean - disable or enable minimum markers.
- object - sets minimum markers settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.
Detailed description
The method sets a minimum width of elements, that will be to remain after a resize of element.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Value to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
negativeFill
Getter for the negative fill color.
Returns:
anychart.graphics.vector.Fill - The negative fill color.Try it:
Setter for the negative fill settings using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Fill color with opacity.
Fill as a string or an object.
Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
negativeHatchFill
Getter for negative hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill. See listing
var currentNegativeHatchFill = chart.negativeHatchFill();
Setter for negative hatch fill settings.
Learn more about hatch fill settings.
Params:
| Name | Type | Description |
|---|---|---|
| patternFillOrType | anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | PatternFill or HatchFill instance or type of hatch fill. |
| color | string | Color. |
| thickness | number | Thickness. |
| size | number | Pattern size. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
negativeLabels
Getter for data labels of negative points.
Returns:
anychart.core.ui.LabelsFactory.Label - Label instance.Try it:
Setter for data labels of negative points.
Detailed description
Sets negative labels settings depending on parameter type:
- null/boolean - disable or enable negative labels.
- object - sets negative labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.Try it:
Setter for data negative markers.
Detailed description
Sets negative markers settings depending on parameter type:
- null/boolean - disable or enable negative markers.
- object - sets negative markers settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Data negative markers settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.padding
Getter for the chart padding.
Detailed description
Also, you can use anychart.core.utils.Padding#bottom, anychart.core.utils.Padding#left, anychart.core.utils.Padding#right, anychart.core.utils.Padding#top methods to setting paddings.
Returns:
anychart.core.utils.Padding - Chart padding.Try it:
Setter for the chart paddings in pixels using a single value.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Array.<(number|string)> | Object | {top: 0, right: 0, bottom: 0, left: 0} | Value to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining. Example.
chart.padding([5, 15]);
or
chart.padding({left: 10, top: 20, bottom: 30, right: "40%"}});Try it:
Setter for the chart paddings in pixels using several numbers.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value1 | string | number | 0 | Top or top-bottom space. |
| value2 | string | number | 0 | Right or right-left space. |
| value3 | string | number | 0 | Bottom space. |
| value4 | string | number | 0 | Left space. |
Returns:
anychart.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);
Try it:
pointWidth
Getter for point width settings.
Returns:
string | number - Point width pixel value.Try it:
Setter for point width settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | "95%" | Point width pixel value. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Prints all elements on related stage.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| paperSizeOrOptions | anychart.graphics.vector.PaperSize | Object | Paper size or object with options. | |
| landscape | boolean | false | Flag of landscape. |
Try it:
rangeMarker
Getter for the chart range marker.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart 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.Try it:
Setter for the chart range marker.
Detailed description
Sets range marker settings depending on parameter type:
- null/boolean - disable or enable range marker.
- object - sets range marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.
Detailed description
Sets range marker settings depending on parameter type:
- null/boolean - disable or enable range marker.
- object - sets range marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart range marker index. |
| value | Object | 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:
| Name | Type | Description |
|---|---|---|
| type | string | Type of event to remove, default is to remove all types. |
Returns:
number - Number of listeners removed.Try it:
right
Getter for element right bound setting.
Returns:
number | string | undefined - Current element's right bound setting.Sets element right bound setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Right bound setting for the element. |
Returns:
anychart.charts.Sparkline - Returns self for method chaining.Try it:
saveAsCsv
Saves chart data as CSV file.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
| filename | string | File name to save. |
Try it:
saveAsJpg
Saves the current chart as JPEG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Object | Image width or object with options. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| forceTransparentWhite | boolean | Force transparent to white or not. |
| filename | string | File name to save. |
Try it:
saveAsJson
Saves chart config as JSON document.
Params:
| Name | Type | Description |
|---|---|---|
| includeTheme | boolean | If the current theme properties should be included into the result. |
| filename | string | File name to save. |
Try it:
saveAsPdf
Saves the current chart as PDF image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSizeOrWidthOrOptions | number | string | Object | Any paper format like 'a0', 'tabloid', 'b4', etc or width, or object with options. |
| landscape | boolean | Define, is landscape. |
| x | number | Offset X. |
| y | number | Offset Y. |
| filename | string | File name to save. |
Try it:
saveAsPng
Saves the current chart as PNG image.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Object | Image width or object with options. |
| height | number | Image height. |
| quality | number | Image quality in ratio 0-1. |
| filename | string | File name to save. |
Try it:
saveAsSvg
Saves the current chart as SVG image.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Object | Paper Size or object with options. |
| landscape | boolean | Landscape. |
| filename | string | File name to save. |
Try it:
Saves the stage as SVG image using width and height.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Try it:
saveAsXlsx
Saves chart data as Excel document.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| filename | string | File name to save. |
Try it:
saveAsXml
Saves chart config as XML document.
Params:
| Name | Type | Description |
|---|---|---|
| includeTheme | boolean | If the current theme properties should be included into the result. |
| filename | string | File name to save. |
Try it:
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:
| Name | Type | Description |
|---|---|---|
| value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Fill color with opacity. Fill as a string or an object.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 opacity.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
| opacity | number | Color opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Linear gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Gradient keys. |
| angle | number | Gradient angle. |
| mode | boolean | anychart.graphics.vector.Rect | Object | Gradient mode. |
| opacity | number | Gradient opacity. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Radial gradient fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| keys | Array.<(anychart.graphics.vector.GradientKey|string)> | Color-stop gradient keys. |
| cx | number | X ratio of center radial gradient. |
| cy | number | Y ratio of center radial gradient. |
| mode | anychart.graphics.math.Rect | If defined then userSpaceOnUse mode, else objectBoundingBox. |
| opacity | number | Opacity of the gradient. |
| fx | number | X ratio of focal point. |
| fy | number | Y ratio of focal point. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
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:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
startSelectMarquee
Starts select marquee drawing.
Note: Works only after anychart.core.Chart#draw is called.
Params:
| Name | Type | Description |
|---|---|---|
| repeat | boolean | Whether to start select marquee drawing. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
stroke
Setter for the stroke by function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| function | function | 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.Try it:
Setter for stroke settings.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
textMarker
Getter for the chart text marker.
Params:
| Name | Type | Description |
|---|---|---|
| index | number | Chart 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.Try it:
Setter for the chart text marker.
Detailed description
Sets text marker settings depending on parameter type:
- null/boolean - disable or enable text marker.
- object - sets text marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | 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.
Detailed description
Sets text marker settings by index depending on parameter type:
- null/boolean - disable or enable text marker.
- object - sets text marker settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| index | number | 0 | Chart text marker index. |
| value | Object | boolean | null | Chart text marker settings to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.title
Setter for the chart title.
Detailed description
Sets chart title settings depending on parameter type:
- null/boolean - disable or enable chart title.
- string - sets chart title text value.
- object - sets chart title settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | null | boolean | Object | string | false | Chart title text or title instance for copy settings from. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.toCsv
Returns CSV string with series data.
Params:
| Name | Type | Description |
|---|---|---|
| chartDataExportMode | string | anychart.enums.ChartDataExportMode | Data export mode. |
| csvSettings | Object.<string, (string|boolean|undefined)> | CSV settings. |
Returns:
string - CSV string.Try it:
toJson
Return chart configuration as JSON object or string.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| stringify | boolean | false | Returns JSON as string. |
| includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
Object | string - Chart configuration.toSvg
Returns SVG string with paper size and landscape.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| paperSize | string | Object | Paper Size or object of options. |
| landscape | boolean | Landscape. |
Returns:
string - SVG content or empty string.Try it:
Returns SVG string with with determined the width and height.
Detailed description
Returns SVG string if type of content is SVG otherwise returns empty string.
Params:
| Name | Type | Description |
|---|---|---|
| width | number | Image width. |
| height | number | Image height. |
Returns:
string - SVG content or empty string.Try it:
toXml
Return chart configuration as XML string or XMLNode.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| asXmlNode | boolean | false | Return XML as XMLNode. |
| includeTheme | boolean | false | If the current theme properties should be included into the result. |
Returns:
string | Node - Chart configuration.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.
Detailed description
Sets tooltip settings depending on parameter type:
- null/boolean - disable or enable tooltip.
- object - sets tooltip settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | 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:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Top bound setting for the element. |
Returns:
anychart.charts.Sparkline - Returns self for method chaining.Try it:
type
Getter for the sparkline series type.
Returns:
string | anychart.enums.SparklineSeriesType - Sparkline series type.Try it:
Setter for the sparkline series type.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | anychart.enums.SparklineSeriesType | "line" | Series type. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
unlisten
Removes a listener added using listen() or listenOnce() methods.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | The event type id. | |
| listener | function | Callback method. | |
| useCapture | boolean | false | Whether to fire in capture phase. Learn more about capturing https://javascript.info/bubbling-and-capturing |
| listenerScope | Object | Object in whose scope to call the listener. |
Returns:
boolean - Whether any listener was removed.Try it:
unlistenByKey
Removes an event listener which was added with listen() by the key returned by listen() or listenOnce().
Params:
| Name | Type | Description |
|---|---|---|
| key | Object | The key returned by listen() or listenOnce(). |
Returns:
boolean - Whether any listener was removed.Try it:
width
Getter for element width setting.
Returns:
number | string | undefined - Current element's width setting.Sets element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | string | null | null | Width setting for the element. |
Returns:
anychart.charts.Sparkline - Returns self for method chaining.Try it:
xScale
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.
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.ScaleTypes | anychart.scales.Base | "ordinal" | X-scale to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
yScale
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.
Note: This scale will be passed to all scale dependent chart elements if they don't have their own scales.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.enums.ScaleTypes | anychart.scales.Base | "linear" | Y Scale to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it:
zIndex
Getter for the current Z-index of the element.
Returns:
number - The current zIndex.Try it:
Setter for the Z-index of the element.
Detailed description
The bigger the index - the higher the element position is.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | number | 0 | Value to set. |
Returns:
anychart.charts.Sparkline - Self instance for method chaining.Try it: