Type class
A base class for all series-based charts, like XY, Pie, etc.
Is not useful on its own.
ISerialChartEvents
for a list of available Events
ISerialChartAdapters
for a list of available Adapters
Sources
SerialChart can be used (imported) via one of the following packages.
/** * -------------------------------------------------------- * Import from: "charts.ts" * Use like: am4charts.SerialChart * -------------------------------------------------------- */ import * as am4charts from "@amcharts/amcharts4/charts";
/** * -------------------------------------------------------- * Include via: <script src="charts.js"></script> * Access items like: am4.SerialChart * -------------------------------------------------------- */
Inheritance
SerialChart extends Chart
.
SerialChart is extended by XYChart
, PercentChart
, MapChart
, ForceDirectedTree
, WordCloud
.
Properties
adapter # |
Type Inherited from Holds Adapter. Click here for more info about Adapters |
---|---|
align # |
Type Inherited from Controls horizontal alignment of the element. This is used by parent |
alwaysShowTooltip # |
Type Default Inherited from DEPRECATION NOTICE: This setting is deprecated in favor of a more flexible setting: Indicates if this element should display a tooltip permanently. Useful, if you want to show permanent tooltips on some items. @since 4.5.4 |
animations # |
Type Inherited from Returns a list elements's animations currently being played. If the list has not been initialized it is created. |
appeared # |
Type Default Inherited from A read-only flag which indicates if a sprite has completed its initial animation (if In case @readonly |
applyOnClones # |
Type Default Inherited from Specifies if property changes on this object should be propagated to the objects cloned from this object. This setting affects property changes *after* cloning, since at the moment of cloning all of properties from source object are copied to the clone anyway. |
background # |
Type Inherited from An element to use as container background. |
baseSprite # |
Type Inherited from Returns the mail chart object that this element belongs to. In most cases it will mean the chart object. Can be used to retrieve chart object in various events and adapters. chart.seriesContainer.events.on("hit", function(ev) { console.log(ev.target.baseSprite); }); chart.seriesContainer.events.on("hit", function(ev) { console.log(ev.target.baseSprite); }); { // ... "seriesContainer": { "events": { "hit": function(ev) { console.log(ev.target.baseSprite); } } } } @readonly |
bulletsContainer # |
Type Holds a reference to the container series' bullets are drawn in. |
chartAndLegendContainer # |
Type Inherited from A reference to a container that holds both the chart and the legend. |
chartContainer # |
Type Inherited from Container that holds the chart itself. |
children # |
Inherited from Returns a list of the child |
clickable # |
Type Inherited from Indicates if the element is clickable. Some type of the elements, like buttons are clickable by default. Most of the elements are not clickable by default. Use |
cloneTooltip # |
Type Default Inherited from When cloning a sprite, if the template has it's own tooltip assigned, this tooltip is also cloned by default. This is not good for cpu and sometimes you might only need one single tooltip for all clones. Set this to false in order not to clone tooltip. |
clonedFrom # |
Type Inherited from Reference to the original object this object was cloned from. We need to keep this so we can disassociate it from source object when this object is disposed. |
colors # |
Type Chart's color list. This list can be used by a number of serial items, like applying a new color for each Series added. Or, applying a new color for each slice of a Pie chart. Please see A theme you are using may override default pre-defined colors. |
config # |
Type Inherited from Use this property to set JSON-based config. When set, triggers processing routine, which will go through all properties, and try to apply values, create instances, etc. Use this with caution, as it is a time-consuming process. It's used for initialchart setup only, not routine operations. |
configField # |
Type Inherited from A field in data context of element's This is a very powerful feature, allowing changing virtually any setting, including those for element's children, for the element via data. Example data: { "value": 100, "config": { "fill": "#F00" } } If you set element's |
contentAlign # |
Type Inherited from Horizontal alignment of the elements for the horizontal Container. This is used when Container is larger than the height of all its children. |
contentHeight # |
Type Inherited from Height (in pixels) of the actual content in the Container. Please note that it might be bigger than height of the Container. @readonly |
contentValign # |
Type Inherited from Vertical alignment of the elements for the vertical Container. This is used when Container is larger than the height of all its children. |
contentWidth # |
Type Inherited from Width (in pixels) of the actual content in the Container. Please note that it might be bigger than width of the Container. @readonly |
contextMenuDisabled # |
Type Default Inherited from Should element prevent context menu to be displayed, e.g. when right-clicked? |
currentDataSetId # |
Type Inherited from Returns id of the currently used data set, or @since 4.7.0 |
cursorDownStyle # |
Type Inherited from A shortcut to setting mouse cursor when button is pressed down. Example: series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing; series.slices.template.cursorDownStyle = am4core.MouseCursorStyle.grabbing; { // ... "series": { // ... "slices": { "cursorDownStyle": "grabbing" } } } |
cursorOptions # |
Type Inherited from Returns element's cursor options. Cursor options usually define cursor style for various states of the hovered element. Elements inherit
|
cursorOverStyle # |
Type Inherited from A shortcut to setting mouse cursor on hover. Example: series.slices.template.cursorOverStyle = am4core.MouseCursorStyle.pointer; series.slices.template.cursorOverStyle = am4core.MouseCursorStyle.pointer; { // ... "series": { // ... "slices": { "cursorOverStyle": "pointer" } } } |
data # |
Type Inherited from Sets source (raw) data for the element. The "data" is always an Returns element's source (raw) data. IMPORTANT: The order of data items in |
dataFields # |
Inherited from Holds data field names. Data fields define connection beween |
dataItem # |
Type Inherited from A @todo Review type |
dataItems # |
Type Inherited from Returns a list of source |
dataProvider # |
Type Inherited from A |
dataSource # |
Type Inherited from A Click here for more on loading external data |
dateFormatter # |
Type Inherited from A This is used to format dates, e.g. on a date axes, balloons, etc. chart.dateFormatter.dateFormat = "yyyy-MM-dd"; chart.dateFormatter.dateFormat = "yyyy-MM-dd"; { // ... "dateFormatter": { "dateFormat": "yyyy-MM-dd" } } You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.
|
defaultState # |
Type Inherited from Returns a This is a shortcut to |
disabled # |
Type Inherited from Controls if element is disabled. A disabled element is hidden, and is removed from any processing, layout calculations, and generally treated as if it does not exist. The element itself is not destroyed, though. Setting this back to |
dom # |
Type Inherited from Returns DOM element reference associated with this element. @readonly |
dragGrip # |
Type Inherited from An instance of @since 4.4.0 |
draggable # |
Type Inherited from Controls if the element is draggable. |
dummyData # |
Type Inherited from A property which you can use to store any data you want. |
durationFormatter # |
Type Inherited from A This is used to format numbers as durations, e.g. on a value axes. You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.
|
dx # |
Type Inherited from A horizontal offset for the element in pixels. Can be negative value for offset to the left. |
dy # |
Type Inherited from A vertical offset for the element in pixels. Can be negative value for offset upwards. |
element # |
Inherited from The main element for this Sprite, usually an SVG All other sub-elements are created in it. |
end # |
Type Inherited from End of the current data range (zoom). These are relative values from 0 (beginning) to 1 (end). |
events # |
Type Inherited from Event dispatcher. Click here for more info about Events |
exportable # |
Type Default Inherited from If set to |
exporting # |
Type Inherited from An Used to access API of the chart export functionality. If Upon request, if no parent has such instance, a new one is created, using default settings, what in most cases is just enough. Click here for more info about exporting |
fill # |
Type Inherited from Element's fill color or pattern. |
fillModifier # |
Type Inherited from
|
fillOpacity # |
Type Inherited from Element's fill opacity. Opacity ranges from 0 (fully transparent) to 1 (fully opaque). |
filters # |
Inherited from Returns list of SVG filters (effects) applied to element. If the filter list is not yet initilized, creates and returns an empty one. Note, not all filters combine well with one another. We recommend using one filter per sprite. |
fixedWidthGrid # |
Type Default Inherited from Controls if the grid of the Container should use fixed width. Fixed width grid will divide available space to all its columns/rows equally, without adapting to actual child sizes or size requirements. |
focusable # |
Type Inherited from |
focusedElement # |
Type Inherited from A reference to a currently focused item. @since 4.9.29 |
fontFamily # |
Type Inherited from Font family to be used for the text. Parts of the text may override this setting using in-line formatting. |
fontSize # |
Type Inherited from Font size to be used for the text. The size can either be numeric, in pixels, or other measurements. Parts of the text may override this setting using in-line formatting. |
fontWeight # |
Type Inherited from Font weight to use for text. Parts of the text may override this setting using in-line formatting. |
globalScale # |
Type Inherited from Returns element's current "global" scale. Scale values accumulate over hierarchy of elements. E.g. if a @readonly |
group # |
Type Inherited from Holds Sprite's main SVG group ( |
hasFocused # |
Type Default Inherited from Indicates if this container contains any focused elements, including itself. |
height # |
Type Inherited from Element's absolute or relative height. The height can either be absolute, set in numeric pixels, or relative, set in Relative height will be calculated using closest measured ancestor NOTE: |
Type Inherited from If a sprite has |
|
Type Inherited from Returns a This is a shortcut to |
|
hitOptions # |
Type Inherited from Returns Sprite's click (hit) options. Click (hit) options control things like double-click, timeouts, etc.
|
horizontalCenter # |
Type Inherited from Controls which part of the element to treat as a horizontal center. The setting will be used when positioning, resizing and rotating the element. |
hoverOnFocus # |
Type Default Inherited from If set to Useful as an accessibility feature to display rollover tooltips on items selected via keyboard. |
hoverOptions # |
Type Inherited from Returns Sprite's hover options.
|
hoverable # |
Type Default Inherited from Controls if the element is hoverable (hover events are registered). Use |
htmlContainer # |
Type Inherited from An HTML element to be used when placing wrapper element ( This is the same for all elements within the same chart. |
id # |
Type Inherited from Element's user-defined ID. Will throw an Error if there already is an object with the same ID. Please note that above check will be performed withing the scope of the current chart instance. It will not do checks across other chart instances or in globally in DOM. Make sure the IDs are unique. |
inert # |
Type Default Inherited from Controls if the element should use inertia when interacted with. "Inert" element, when dragged and released, will carry the momentum of the movement, and will continue moving in the same drag direction, gradually reducing in speed until finally stops. |
inertiaOptions # |
Type Inherited from Returns element's options to be used for inertia. This setting is inheritable, meaning that if not set directly, it will search in all its ascendants until very top. Inertia is used only if element's "Inert" element, when dragged and released, will carry the momentum of the movement, and will continue moving in the same drag direction, gradually reducing in speed until finally stops. Check |
inited # |
Type Inherited from Returns |
innerHeight # |
Type Inherited from Returns element's measured inner height in pixels. Inner height is actual available space for content, e.g. element's height minus vertical padding. @readonly |
innerWidth # |
Type Inherited from Returns element's measured inner width in pixels. Inner width is actual available space for content, e.g. element's width minus horizontal padding. @readonly |
interactions # |
Type Inherited from Returns (creates if necessary) an |
interactionsEnabled # |
Type Inherited from Setting this to |
interpolationDuration # |
Type Default Inherited from If set to a non-zero number the element will "animate" data values of its children. This will happen on first load and whenever data values change. Enabling interpolation will mean that elements will transit smoothly into new values rather than updating instantly. Click here for more info about animations |
interpolationEasing # |
Type ( value: Default Inherited from An easing function to use for interpolating values when transiting from one source value to another. Click here for more info about animations |
isActive # |
Type Inherited from Indicates if this element is currently active (toggled on) or not (toggled off). |
isDown # |
Type Inherited from Indicates if this element has any pointers (mouse or touch) pressing down on it. |
isDragged # |
Type Inherited from Returns indicator if this element is being dragged at the moment. |
isFocused # |
Type Inherited from Indicates if this element is focused (possibly by tab navigation). |
isHidden # |
Type Inherited from If This was added becaus hidden state might have visibility set to true and so there would not be possible to find out if a sprite is technically hidden or not. |
isHiding # |
Type Default Inherited from If |
isHover # |
Type Inherited from Indicates if this element has a mouse pointer currently hovering over it, or if it has any touch pointers pressed on it. You can force element to be "hovered" manually, by setting this property to |
isResized # |
Type Inherited from Returns indicator if this element is being resized at the moment. |
isShowing # |
Type Default Inherited from This property indicates if Sprite is currently being revealed from hidden state. This is used to prevent multiple calls to |
keyboardOptions # |
Type Inherited from Returns elements keyboard options. |
language # |
Type Inherited from A Normally it is enough to set language for the top-most element - chart. All other element child elements will automatically re-use that language object. |
layout # |
Type Default Inherited from Container layout. Options: "absolute" (default), "vertical", "horizontal", "grid", "none". "none" is quite the same as "absolute" - the objects will be positioned at their x, y coordinates, the difference is that with "absolute" you can still use align/valign for children and with "none" you can not. Use "none" as much as you can as it's most cpu-saving layout. |
layoutInvalid # |
Type Default Inherited from |
legend # |
Type Inherited from Holds the instance of chart's Click here for more information about legends |
mainDataSet # |
Type Inherited from Returns reference to "main" data set (unaggregated data as it was supplied in @since 4.7.0 |
map # |
Type Inherited from Returns a Can be used to retrieve any object by id, e.g.: console.log(mySprite.map.getKey("myid")); console.log(mySprite.map.getKey("myid")); |
marginBottom # |
Type Inherited from Bottom margin - absolute (px) or relative ( |
marginLeft # |
Type Inherited from Left margin - absolute (px) or relative ( |
marginRight # |
Type Inherited from Right margin - absolute (px) or relative ( |
marginTop # |
Type Inherited from Top margin - absolute (px) or relative ( |
maxColumns # |
Type Inherited from Maximum number of columns (when using |
maxHeight # |
Type Inherited from Maximum allowed height for the element in pixels. |
maxWidth # |
Type Inherited from Maximum allowed width for the element in pixels. |
maxZoomCount # |
Type Default Inherited from Use this for Limits how many categories or base intervals can be shown at the same time. If there are more items in the chart, the chart will auto-zoom. @since 4.6.2 |
maxZoomFactor # |
Type Inherited from Max available The element will not allow zoom to occur beyond this factor. In case you want to restrict category or date axis to be zoomed to more than one category or more than one base interval, use Default value of Feel free to modify it to allow bigger zoom or to restrict zooming. |
measuredHeight # |
Type Inherited from Returns elements's measured height in pixels. A measured height is actual height of contents plus @readonly |
measuredWidth # |
Type Inherited from Returns element's measured width in pixels. A measured width is actual width of contents plus @readonly |
minHeight # |
Type Inherited from Minimum height (px) for the Container. A container will not auto-shrink beyond this value, even if child elements are smaller. |
minWidth # |
Type Inherited from Minimum width (px) for the Container. A container will not auto-shrink beyond this value, even if child elements are smaller. |
minZoomCount # |
Type Default Inherited from Use this for Allows restricting zoom in beyond certain number of categories or base intervals. |
modal # |
Inherited from Returns a (elements top parent)Accessing modal does not make it appear. To make a modal appear, use
|
mouseOptions # |
Type Inherited from Mouse options. Enables controlling options related to the mouse, for example sensitivity of its mouse wheel. E.g. the below will reduce chart's wheel-zoom speed to half its default speed: chart.plotContainer.mouseOptions.sensitivity = 0.5; chart.plotContainer.mouseOptions.sensitivity = 0.5; { // ... "plotContainer": { "mouseOptions": { "sensitivity": 0.5 } } } |
nonScaling # |
Type Inherited from Controls if element should keep constant size and not scale even if there is space available, or it does not fit. |
nonScalingStroke # |
Type Inherited from Controls if the element's stroke (outline) should remain keep constant thicnkess and do not scale when the whole element is resized. |
numberFormatter # |
Type Inherited from A This is used to format numbers. chart.numberFormatter.numberFormat = "#,###.#####"; chart.numberFormatter.numberFormat = "#,###.#####"; { // ... "numberFormatter": { "numberFormat": "#,###.#####" } } You can set a separate instance of formatter for each individual element. However that would be unnecessary overhead as all elements would automatically inherit formatter from their parents, all the way up to the chart itself.
|
opacity # |
Type Inherited from Element's opacity. Opacity setting can range from 0 (fully transparent) to 1 (fully opaque). ATTENTION: It is highly not recommended to use Instead use methods Or, use properties |
outerHeight # |
Type Inherited from Returns element's measured height plus its top and bottom margins in pixels. @readonly |
outerWidth # |
Type Inherited from Returns element's measured width plus its left and right margins in pixels. @readonly |
paddingBottom # |
Type Inherited from Bottom padding - absolute (px) or relative ( |
paddingLeft # |
Type Inherited from Left padding - absolute (px) or relative ( |
paddingRight # |
Type Inherited from Right padding - absolute (px) or relative ( |
paddingTop # |
Type Inherited from Top padding - absolute (px) or relative ( |
parent # |
Inherited from Elements' parent |
parsingStepDuration # |
Type Default Inherited from A duration (ms) of each data parsing step. A Component parses its data in chunks in order to avoid completely freezing the machine when large data sets are used. This setting will control how many milliseconds should pass when parsing data until parser stops for a brief moment to let other processes catch up. |
path # |
Type Inherited from Path of Sprite element |
patterns # |
Type A @since 4.7.5 |
pixelHeight # |
Type Inherited from Returns element's height in pixels. For actual height use measuredHeight property. @readonly |
pixelMarginBottom # |
Type Inherited from Returns current bottom margin in pixels. @readonly |
pixelMarginLeft # |
Type Inherited from Returns current left margin in pixels. @readonly |
pixelMarginRight # |
Type Inherited from Returns current right margin in pixels. @readonly |
pixelMarginTop # |
Type Inherited from Returns current top margin in pixels. @readonly |
pixelPaddingBottom # |
Type Inherited from Returns current bottom padding in pixels. @readonly |
pixelPaddingLeft # |
Type Inherited from Returns current left padding in pixels. @readonly |
pixelPaddingRight # |
Type Inherited from Returns current right padding in pixels. @readonly |
pixelPaddingTop # |
Type Inherited from Returns current top padding in pixels. @readonly |
pixelPerfect # |
Type Inherited from Controls if SVG vectors should be drawn with "pixel" precision, producing perfectly crisp lines on retina displays. Setting this to Different elements use different default setting for We recommend leaving this at their default settings, unless there's a specific need. |
pixelWidth # |
Type Inherited from Returns element's width in pixels, if width was set. For actual width use measuredWidth property. @readonly |
pixelX # |
Type Inherited from Returns element's current absolute X coordinate in pixels. @readonly |
pixelY # |
Type Inherited from Returns element's current absolute Y coordinate in pixels. @readonly |
plugins # |
Type Inherited from A list of plugins (objects that implement @since 4.2.2 |
popups # |
Type Inherited from A list of popups for this chart. |
preloader # |
Type Inherited from A |
properties # |
Inherited from Holds values for Sprite's properties. |
propertyFields # |
Type Inherited from A collection of key/value pairs that can be used to bind specific Sprite properties to For example: Can be set for each |
rangeChangeDuration # |
Type Default Inherited from Whenever selected scope changes (chart is zoomed or panned), for example by interaction from a Scrollbar, or API, a chart needs to reposition its contents. If set to zero (0), the change will happen instantenously. If set to non-zero value, the chart will gradually animate into new position for the set amount of milliseconds. Click here for more info about animations |
rangeChangeEasing # |
Type ( value: Default Inherited from An easing function to use for range change animation.
|
readerDescription # |
Type Inherited from Screen reader description of the element. |
readerHidden # |
Type Inherited from Controls if element should be hidden from screen readers. Click here for more information |
readerOrientation # |
Type Inherited from Orientation of the element. @since 4.7.16 |
readerTitle # |
Type Inherited from Screen reader title of the element. |
readerValueNow # |
Type Inherited from Current value of the element. @since 4.7.16 |
readerValueText # |
Type Inherited from Text representation of the current value of the element. @since 4.7.16 |
realFill # |
Type Inherited from A reference to a real fill object. Sometimes might be useful to modify gradient (when fill is color but we have FillModifier). |
realStroke # |
Type Inherited from A reference to a real stroke object. Sometimes might be useful to modify gradient (when fill is color but we have a FillModifier). |
relativeMarginBottom # |
Type Inherited from Returns current relative bottom margin. @readonly |
relativeMarginLeft # |
Type Inherited from Returns current relative left margin. @readonly |
relativeMarginRight # |
Type Inherited from Returns current relative right margin. @readonly |
relativeMarginTop # |
Type Inherited from Returns current relative top margin. @readonly |
relativePaddingBottom # |
Type Inherited from Returns current relative bottom padding. @readonly |
relativePaddingLeft # |
Type Inherited from Returns current relative left padding. @readonly |
relativePaddingRight # |
Type Inherited from Returns current relative right padding. @readonly |
relativePaddingTop # |
Type Inherited from Returns current relative top padding. @readonly |
relativeX # |
Type Inherited from Returns element's current relative X coordinate in |
relativeY # |
Type Inherited from Returns element's current relative Y coordinate in @readonly |
resizable # |
Type Inherited from Indicates if this element is resizable. Enabling resize will turn on various interactions on the element. Their actual functionality will depend on other properties. If the element also If the element is not draggable, resize can be performed with just one point of contact, touch or mouse. Will invoke |
responsive # |
Type Inherited from A NOTE: Responsive features are currently in development and may not work as expected, if at all. |
reverseOrder # |
Type Default Inherited from If set to |
role # |
Type Inherited from A WAI-ARIA role for the element. Click here for more information on WAI-ARIA roles |
rollOutDelay # |
Type Default Inherited from Time in milliseconds after which rollout event happens when user rolls-out of the sprite. This helps to avoid flickering in some cases. |
rotation # |
Type Inherited from Rotation of the element in degrees. (0-360)Note: For convenience purposes, negative values (for counter-clockwise rotation) and values exceeding 360 can also be used. |
rtl # |
Type Inherited from An RTL (right-to-left) setting. RTL may affect alignment, text, and other visual properties. If you set this on a top-level chart object, it will be used for all child elements, e.g. labels, unless they have their own |
scale # |
Type Inherited from Scale of the element. The scale is set from 0 (element reduced to nothing) to 1 (default size).
Etc. |
sequencedInterpolation # |
Type Default Inherited from Indicates whether transition between data item's values should start and play out all at once, or with a small delay (as defined by Click here for more info about animations |
sequencedInterpolationDelay # |
Type Default Inherited from A delay (ms) to wait between animating each subsequent data item's interpolation animation. Relative only if Click here for more info about animations |
series # |
Type A list of chart's series. |
seriesContainer # |
Type Holds the reference to the container actual series are drawn in. |
setStateOnChildren # |
Type Default Inherited from Specifies if, when state is applied on this container, the same state should be applied to container's children as well as |
setStateOnSprites # |
Type Default Inherited from An array of references to elements the state should be set, when it is set on this element. |
shapeRendering # |
Type Default Inherited from An SVG-specific Click here for more information about |
shouldClone # |
Type Default Inherited from Indicates whether this sprite should be cloned when cloning its parent container. We set this to |
showOnInit # |
Type Inherited from If this is set to If your "default" state's If you need a Sprite which has |
showSystemTooltip # |
Type Inherited from Indicates whether the element should attempt to construct itself in a way so that system tooltip is shown if its |
showTooltipOn # |
Type Default Inherited from Indicates when tooltip needs to be shown on this element:
For example, if you would like to show tooltips on all of the columns of a series.columns.template.showTooltipOn = "always"; series.columns.template.showTooltipOn = "always"; { // ... "series": [{ // ... "columns": { "showTooltipOn": "always" } }] } It can even be set to display on a selected columns via series.columns.template.propertyFields.showTooltipOn = "tooltip"; series.columns.template.propertyFields.showTooltipOn = "tooltip"; { // ... "series": [{ // ... "columns": { "propertyFields": { "showTooltipOn": "tooltip" } } }] } @since 4.7.9 |
skipRangeEvent # |
Type Default Inherited from If set to |
start # |
Type Inherited from Start of the current data range (zoom). These are relative values from 0 (beginning) to 1 (end). |
states # |
Type Inherited from Returns a collection of element's available |
stroke # |
Type Inherited from Element's stroke (outline) color or pattern. |
strokeDasharray # |
Type Inherited from A "Dasharray" allows setting rules to make lines dashed, dotted, etc. Click here for more info on |
strokeDashoffset # |
Type Inherited from A "Dashoffset" allows setting the start position of the dashes if Click here for more info on |
strokeLinecap # |
Type Inherited from A Click here for more info on |
strokeLinejoin # |
Type Inherited from A Click here for more info on |
strokeModifier # |
Type Inherited from
|
strokeOpacity # |
Type Inherited from Stroke (outline) opacity. The values may range from 0 (fully transparent) to 1 (fully opaque). |
strokeWidth # |
Type Inherited from Stroke (outline) thickness in pixels. |
svgContainer # |
Type Inherited from HTML container ( Sets HTML container to add SVG and other chart elements to. |
swipeOptions # |
Type Inherited from Returns element's swipe gesture options. |
swipeable # |
Type Inherited from Controls if element is swipeable. Swipable element will invoke Please note that combining swipe and drag is possible, however will incur a slight but noticeable delay in drag start. |
tabindex # |
Type Inherited from Sets or returns TAB index. Tab index maintains the order in which focusable elements gain focus when TAB key is pressed. Please note, tab index is not local to the chart. It affects the whole of the page, including non-SVG elements. Maintain extreme causion when setting tab indexes, as it affects the user experience for the whole web page. |
tapTimeout # |
Type Default Inherited from If @since 4.4.0 |
tapToActivate # |
Type Default Inherited from If set to User will need to tap the chart in order to activate its regular touch functionality. The chart will remain "active" as long as user keeps interacting with the chart. After @since 4.4.0 |
textDecoration # |
Type Inherited from A text decoration to use for text. Parts of the text may override this setting using in-line formatting. |
titles # |
Type Inherited from A List of chart titles. |
togglable # |
Type Inherited from Indicates if element can be toggled on and off by subsequent clicks/taps. Togglable element will alternate its |
tooltip # |
Type Inherited from A |
tooltipColorSource # |
Type Inherited from A |
tooltipDataItem # |
Type Inherited from A |
tooltipHTML # |
Type Inherited from An HTML template to be used to populate If element has |
tooltipPosition # |
Type Inherited from Specifies if Position |
tooltipText # |
Type Inherited from A text template to be used to populate Tooltip's contents. If element has This template will also be parsed for any special formatting tags. |
tooltipX # |
Type Inherited from X coordinate the |
tooltipY # |
Type Inherited from Y coordinate the |
trackable # |
Type Inherited from Indicates if the element is trackable (mouse position over it is reported to event listeners). Will invoke Please note, touch devices will also invoke |
uid # |
Type Inherited from Returns object's internal unique ID. |
url # |
Type Inherited from Click-through URL for this element. If set, clicking/tapping this element will open the new URL in a target window/tab as set by Please note that URL will be parsed by data placeholders in curly brackets, to be populated from data. E.g.: series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}"; series.columns.template.url = "https://www.google.com/search?q={category.urlEncode()}"; { // ... "series": [{ // ... "columns": { "url": "https://www.google.com/search?q={category.urlEncode()}" } }] } |
urlTarget # |
Type Inherited from Target to use for URL clicks:
|
userClassName # |
Type Inherited from A custom class name to set on the element. If set, the value will be added to element's @since 4.9.11 |
valign # |
Type Inherited from Controls vertical alignment of the element. This is used by parent |
verticalCenter # |
Type Inherited from Controls which part of the element to treat as a vertical center. The setting will be used when positioning, resizing and rotating the element. |
visible # |
Type Inherited from Indicates if element is current visible ( |
wheelable # |
Type Inherited from Indicates if the element can be interacted with mouse wheel. Will invoke |
width # |
Type Inherited from Element's absolute or relative width. The width can either be absolute, set in numeric pixels, or relative, set in Relative width will be calculated using closest measured ancestor NOTE: |
x # |
Type Inherited from Element's absolute or relative X coordinate. If setting both X and Y, please consider using |
y # |
Type Inherited from Element's absolute or relative Y coordinate. If setting both X and Y, please consider using |
zIndex # |
Type Inherited from A "zIndex" of the element. "zIndex" determines the order of how elements are placed over each other. Higher "zIndex" will mean the element will be draw on top of elements with lower "zIndexes". |
zoomFactor # |
Type Inherited from A current zoom factor (0-1). 1 meaning fully zoomed out. (showing all of the available data) |
There are 220 inherited items currently hidden from this list. |
Methods
addData( rawDataItem: ) |
Returns Inherited from Adds one or several (array) of data items to the existing data. |
---|---|
animate( animationOptions: ) |
Returns Inherited from Creates and starts an
|
appear() |
Returns Hides the chart instantly and then shows it. If defaultState.transitionDuration > 0, this will result an animation in which properties of hidden state will animate to properties of visible state. |
applyCurrentState( duration?: ) |
Returns Inherited from Applies proper state based on the condition of the element. A condition is deducted in this order:
|
bind( property: ) |
Returns Inherited from |
bindDataField( field: ) |
Returns Inherited from Binds a data element's field to a specific field in raw data. For example, for the very basic column chart you'd want to bind a Some more advanced Components, like @todo Example |
clone() |
Returns Inherited from Returns a clone of this element. |
closeAllPopups() |
Returns Inherited from Closes all currently open popup windows |
closeModal() |
Returns Inherited from Hides modal window if there is one currently open. |
constructor() |
Returns Constructor |
copyFrom( source: ) |
Returns Copies all parameters from another |
createChild( classType: { } ) |
Returns Inherited from Creates a new element of specific type and assigns as a child to the Container. |
deepInvalidate() |
Returns Inherited from Invalidates the whole element, including layout AND all its child elements. As this will essentially force all elements to redraw, use only if absolutely necessary. |
dispatch( eventType: ) |
Returns Inherited from Dispatches an event using own event dispatcher. Will automatically populate event data object with event type and target (this element). It also checks if there are any handlers registered for this sepecific event. |
dispatchImmediately( eventType: ) |
Returns Inherited from Works like |
dispatchReady() |
Returns Inherited from Dispatches ready event. Dispatches when all children are ready. |
dispose() |
Returns |
disposeChildren() |
Returns Inherited from Removes and destroys all Container's children. To remove children from Container without destroying them, use |
fitsToBounds( point: ) |
Returns Inherited from Checks if point is within bounds of a container. |
getCurrentThemes() |
Returns Inherited from Returns theme(s) used by this object either set explicitly on this element, inherited from parent, or inherited from |
getDataSource( property: ) |
Returns Inherited from Returns (creates if necessary) a For example if I want to bind |
getPixelX( value: ) |
Returns Inherited from Returns an X coordinate in pixel within the element. If number is passed in as parameter, the same number will be returned back. If |
getPixelY( value: ) |
Returns Inherited from Returns an Y coordinate in pixel within the element. If number is passed in as parameter, the same number will be returned back. If |
getPropertyValue( propertyName: ) |
Returns Inherited from Returns element's property value. Will check if there are any bindings with Will also apply any adapters bound to |
getRelativeX( value: ) |
Returns Inherited from Returns relative (percent) value of the X coordindate within this element. A relative value is a hundredth of a percent. So 100% would result in a 1 as relative value. |
getRelativeY( value: ) |
Returns Inherited from Returns relative (percent) value of the Y coordindate within this element. A relative value is a hundredth of a percent. So 100% would result in a 1 as relative value. |
getSvgPoint( point: ) |
Returns Inherited from Converts element's local coordinates to the coordinates within the main chart container. |
hide( duration?: ) |
Returns Inherited from Hides the element, by applying Has no effect if element is already hidden. If While element is fading out, its When element is hidden, its |
hideTooltip( duration?: ) |
Returns Inherited from Hides element's |
hitTest( sprite: ) |
Returns Inherited from Checks if the this element has any of its parts overlapping with another element. @todo Description (review) |
insertAfter( sprite: ) |
Returns Inherited from Insert this element after sibling element. |
insertBefore( sprite: ) |
Returns Inherited from Insert this element before sibling element. |
invalidate() |
Returns Inherited from Invalidates element. Object will be redrawn during the next update cycle. Please note that in most cases elements will auto-invalidate when needed. If everything works, DO NOT use this method. Use it only if some changes do not take otherwise. |
invalidateLabels() |
Returns Inherited from When fontSize of fontFamily changes we need to hard-invalidate all Labels of this container to position them properly. |
invalidateRawData() |
Returns Inherited from If you want to have a smooth transition from one data values to another, you change your raw data and then you must call this method. then instead of redrawing everything, the chart will check raw data and smoothly transit from previous to new data |
isDisposed() |
Returns Inherited from Returns if this object has been already been disposed. |
isInTransition() |
Returns Inherited from Returns |
isInteractive() |
Returns Inherited from Returns true if interactions object was created. Mostly used just to avoid creating interactions object if not needed. |
isReady() |
Returns Inherited from Returns If this object is a |
margin( top: ) |
Returns Inherited from Sets all four margins for the element at once. Margins are set in pixels. |
moveHtmlContainer( htmlElement: ) |
Returns Inherited from Moves the whole chart to other HTML container. @since 4.9.24 |
moveTo( point: ) |
Returns Inherited from Moves the element to a specified coordinates. Using this method is preferred method of moving element, as it saves some CPU processing power over setting The method respects element's center settings. The element will be positioned so that Besides moving the element, you can also at the same time scale and rotate the element. |
openModal( text: ) |
Inherited from Opens a modal window with specific content ( The
|
openPopup( text: ) |
Inherited from Creates, opens, and returns a new |
padding( top: ) |
Returns Inherited from Sets padding for the element in pixels. |
reinit() |
Returns Inherited from Invalidates the whole element, including all its children, causing complete re-parsing of data and redraw. Use sparingly! |
removeChildren() |
Returns Inherited from Removes all Container's children without actually destroying them. To destroy children use |
removeData( count: ) |
Returns Inherited from Removes elements from the beginning of data |
setPropertyValue( property: ) |
Returns Inherited from Sets elements's property value. Will also propagate the same property value on all element's clones. @todo Review propagation to clones. Right now we simply check if clone is disposed before setting the same property on it. It's better to remove from clone list altogether. |
setState( value: ) |
Returns Inherited from Applies a The first parameter can either be a name of the state or a When run, this method will apply SVG properties defined in a |
setVisibility( value: ) |
Returns Inherited from Sets
|
show( duration?: ) |
Returns Inherited from Reveals hidden element. Has no effect if element is already visible. If |
showTooltip( point?: ) |
Returns Inherited from Shows the element's A tooltip will be populated using text templates in either |
toBack() |
Returns Inherited from Moves the element to the very bottom in the element order, so that it appears behind other elements. |
toFront() |
Returns Inherited from Moves the element to the very top in element order, so that it appears in front of other elements. |
zoom( range: ) |
Returns Inherited from Sets current zoom. The range uses relative values from 0 to 1, with 0 marking beginning and 1 marking end of the available data range. This method will not have any effect when called on a chart object. Since the chart can have a number of axes and series, each with its own data, the meaning of "range" is very ambiguous. To zoom the chart use |
zoomToIndexes( startIndex: ) |
Returns Inherited from Zooms to specific data items using their index in data. This method will not have any effect when called on a chart object. Since the chart can have a number of axes and series, each with its own data, the meaning of "index" is very ambiguous. To zoom the chart use |
There are 53 inherited items currently hidden from this list. |
Events
#appeared |
Param { type: Inherited from Invoked when |
---|---|
#beforedatavalidated |
Param { type: Inherited from Invoked just before element is validated (after changes). |
#beforedisposed |
Param { type: Inherited from Invoked just before Sprite is disposed. |
#beforevalidated |
Param { type: Inherited from Invoked before @todo Description (check) |
#blur |
Param { event: Inherited from Invoked when |
#childadded |
Param { newValue: Inherited from Invoked when a child Sprite is added to Container. |
#childremoved |
Param { oldValue: Inherited from Invoked when a child Sprite is removed from |
#dataitemsvalidated |
Param { type: Inherited from Invoked when value(s) of the element's data items are validated. |
#datarangechanged |
Param { type: Inherited from Invoked when range of the currently selected data is validated. @todo: change to datarangevalidated? |
#datavalidated |
Param { type: Inherited from Invoked when the raw data for the component changes. |
#disabled |
Param { type: Inherited from Invoked when sprite is disabled |
#doublehit |
Param Inherited from Invoked when |
#down |
Param Inherited from Invoked when the mouse button is pressed or touch starts. |
#drag |
Param Inherited from Invoked when |
#dragged |
Param Inherited from Invoked when This is simmilar but different then |
#dragstart |
Param Inherited from Invoked when |
#dragstop |
Param Inherited from Invoked when |
#enabled |
Param { type: Inherited from Invoked when sprite is enabled |
#endchanged |
Param { type: Inherited from Invoked when end position changesPlease note that Use |
#focus |
Param { event: Inherited from Invoked when |
#globalscalechanged |
Param { type: Inherited from Invoked when the global scale changed, meaning that scale of |
Param { type: Inherited from Invoked when visible |
|
#hit |
Param Inherited from Invoked when |
#inited |
Param { type: Inherited from Invoked when |
#input |
Param { event: Inherited from Invoked whenever information changes in the textual input elements, like |
#keydown |
Param { event: Inherited from Invoked when the key is pressed on the keyboard. |
#keypress |
Param { event: Inherited from Invoked when the key generates a "press", e.g. pressing and holding a letter key will generate repeated "keypress" events. |
#keyup |
Param { event: Inherited from Invoked when the key is released on the keyboard. |
#layoutvalidated |
Param { type: Inherited from invoked when layout of the container is validated |
#maxsizechanged |
Param { previousHeight: Inherited from Invoked when maximum available size of the Sprite changes, i.e. when the size of parent container changes. |
#out |
Param Inherited from Invoked when mouse cursor moves out of NOTE: this event might not always contains |
#over |
Param Inherited from Invoked when mouse cursor moves over NOTE: this event might not always contains |
#parentset |
Param { type: Inherited from Invoked when a sprite is added to a parent |
#positionchanged |
Param { type: Inherited from Invoked when position of the |
#propertychanged |
Param { property: Inherited from Invoked when property of the |
#rangechangeended |
Param { type: Inherited from Invoked when range change animation ends |
#rangechangestarted |
Param { type: Inherited from Invoked when range change animation starts |
#ready |
Param { type: Inherited from Invoked when For |
#removedfromqueue |
Param { type: Inherited from Invoked when chart is shown if |
#resize |
Param Inherited from Invoked when |
#rightclick |
Param { type: Inherited from Invoked when right mouse button is clicked on the object. |
#shown |
Param { type: Inherited from Invoked when hidden |
#sizechanged |
Param { type: Inherited from Invoked when size of the Sprite changes. |
#startchanged |
Param { type: Inherited from Invoked when start position changes. Please note that Use |
#startendchanged |
Param { type: Inherited from Invoked when start or end position changes, unlike startchanged/endchanged this event is fired not immediately but at the end of a cycle. |
#swipe |
Param Inherited from Invoked when user performs "swiping" gesture (quick horizontal movement) on the object, either using mouse or touch. |
#swipeleft |
Param Inherited from Invoked when user performs "swiping" gesture towards left. |
#swiperight |
Param Inherited from Invoked when user performs "swiping" gesture towards right. |
#toggled |
Param { type: Inherited from Invoked when |
#track |
Param Inherited from Invoked when pointer (mouse cursor or touch point) moves over |
#transformed |
Param { dummyData: Inherited from @todo Description |
#transitionended |
Param { type: Inherited from Invoked when Sprite completes transition to a |
#up |
Param Inherited from Invoked when the mouse button is released or touch ends. |
#validated |
Param { type: Inherited from Invoked when @todo Description (check) |
#visibilitychanged |
Param { visible: Inherited from Invoked when visibility of the |
#wheel |
Param Inherited from Invoked when user turns mouse wheel while over the |
#wheeldown |
Param Inherited from Invoked when user turns mouse wheel downwards while over the |
#wheelleft |
Param Inherited from Invoked when user turns mouse wheel leftwards while over the |
#wheelright |
Param Inherited from Invoked when user turns mouse wheel rightwards while over the |
#wheelup |
Param Inherited from Invoked when user turns mouse wheel upwards while over the |
#zIndexChanged |
Param { type: Inherited from Invoked when zIndex of a sprite is changed |
There are 61 inherited items currently hidden from this list. |
Adapters
#align |
Param Inherited from |
---|---|
#alwaysShowTooltip |
Param Inherited from |
#clickable |
Param Inherited from |
#colors |
Param Inherited from A set of colors to be used for chart elements, like Series, Slices, etc. |
#contentAlign |
Param Inherited from Horizontal alignment of Container's items. |
#contextMenuDisabled |
Param Inherited from |
#criticalError |
Param Inherited from |
#cursorOptions |
Param Inherited from |
#data |
Param Inherited from Applied to chart's data before it is retrieved for use. |
#dataContextValue |
Param { dataItem: Inherited from Applied after |
#disabled |
Param Inherited from |
#draggable |
Param Inherited from |
#dx |
Param Inherited from |
#dy |
Param Inherited from |
#end |
Param Inherited from |
#fill |
Param Inherited from |
#fillModifier |
Param Inherited from |
#fillOpacity |
Param Inherited from |
#fixedWidthGrid |
Param Inherited from If set to |
#focusable |
Param Inherited from |
#fontFamily |
Param Inherited from Font family for the text. |
#fontSize |
Param Inherited from Font size for the text. |
#fontWeight |
Param Inherited from Default font weight. |
#globalScale |
Param Inherited from |
#height |
Param Inherited from |
Param Inherited from |
|
#hitOptions |
Param Inherited from |
#horizontalCenter |
Param Inherited from |
#hoverOnFocus |
Param Inherited from |
#hoverOptions |
Param Inherited from |
#hoverable |
Param Inherited from |
#id |
Param Inherited from |
#inert |
Param Inherited from |
#inertiaOptions |
Param Inherited from |
#innerHeight |
Param Inherited from |
#innerWidth |
Param Inherited from |
#interactionsEnabled |
Param Inherited from |
#isActive |
Param Inherited from |
#isHover |
Param Inherited from |
#keyboardOptions |
Param Inherited from |
#layout |
Param Inherited from Container layout. Options: "absolute" (default), "vertical", "horizontal", or "grid". |
#marginBottom |
Param Inherited from |
#marginLeft |
Param Inherited from |
#marginRight |
Param Inherited from |
#marginTop |
Param Inherited from |
#mask |
Param Inherited from |
#maxColumns |
Param Inherited from Maximum number of columns (when using |
#maxHeight |
Param Inherited from |
#maxWidth |
Param Inherited from |
#maxX |
Param Inherited from |
#maxY |
Param Inherited from |
#maxZoomCount |
Param Inherited from Use this for Limits how many categories or base intervals can be shown at the same time. If there are more items in the chart, the chart will auto-zoom. |
#maxZoomFactor |
Param Inherited from Maximum zoom factor of a component. |
#measuredHeight |
Param Inherited from |
#measuredWidth |
Param Inherited from |
#minHeight |
Param Inherited from |
#minWidth |
Param Inherited from |
#minX |
Param Inherited from |
#minY |
Param Inherited from |
#minZoomCount |
Param Inherited from Use this for Allows restricting zoom in beyond certain number of categories or base intervals. The chart will not zoom in beyond this number of items. |
#mouseOptions |
Param Inherited from |
#nonScaling |
Param Inherited from |
#nonScalingStroke |
Param Inherited from |
#opacity |
Param Inherited from |
#outerHeight |
Param Inherited from |
#outerWidth |
Param Inherited from |
#paddingBottom |
Param Inherited from |
#paddingLeft |
Param Inherited from |
#paddingRight |
Param Inherited from |
#paddingTop |
Param Inherited from |
#path |
Param Inherited from |
#patterns |
Param Inherited from A set of patterns to use for fills, like Series, Slices, etc. @since 4.7.5 |
#pixelHeight |
Param Inherited from |
#pixelMarginBottom |
Param Inherited from |
#pixelMarginLeft |
Param Inherited from |
#pixelMarginRight |
Param Inherited from |
#pixelMarginTop |
Param Inherited from |
#pixelPerfect |
Param Inherited from |
#pixelWidth |
Param Inherited from |
#pixelX |
Param Inherited from |
#pixelY |
Param Inherited from |
#populateString |
Param Inherited from |
#readerChecked |
Param Inherited from |
#readerControls |
Param Inherited from |
#readerDescribedBy |
Param Inherited from |
#readerDescription |
Param Inherited from |
#readerHidden |
Param Inherited from |
#readerLabelledBy |
Param Inherited from |
#readerLive |
Param Inherited from |
#readerOrientation |
Param Inherited from |
#readerTitle |
Param Inherited from |
#readerValueNow |
Param Inherited from |
#readerValueText |
Param Inherited from |
#relativeHeight |
Param Inherited from |
#relativeMarginBottom |
Param Inherited from |
#relativeMarginLeft |
Param Inherited from |
#relativeMarginRight |
Param Inherited from |
#relativeMarginTop |
Param Inherited from |
#relativeWidth |
Param Inherited from |
#relativeX |
Param Inherited from |
#relativeY |
Param Inherited from |
#resizable |
Param Inherited from |
#reverseOrder |
Param Inherited from If set to |
#role |
Param Inherited from |
#rotation |
Param Inherited from |
#scale |
Param Inherited from |
#setStateOnChildren |
Param Inherited from Specifies if, when state is applied on this container, the same state should be applied to container's children as well as |
#shapeRendering |
Param Inherited from |
#showOnInit |
Param Inherited from |
#showTooltipOn |
Param Inherited from |
#start |
Param Inherited from |
#stroke |
Param Inherited from |
#strokeDasharray |
Param Inherited from |
#strokeDashoffset |
Param Inherited from |
#strokeLinecap |
Param Inherited from |
#strokeLinejoin |
Param Inherited from |
#strokeModifier |
Param Inherited from |
#strokeOpacity |
Param Inherited from |
#strokeWidth |
Param Inherited from |
#swipeOptions |
Param Inherited from |
#swipeable |
Param Inherited from |
#tabindex |
Param Inherited from |
#textDecoration |
Param Inherited from Default font decoration. |
#togglable |
Param Inherited from |
#tooltipHTML |
Param Inherited from |
#tooltipPosition |
Param Inherited from |
#tooltipText |
Param Inherited from |
#tooltipX |
Param Inherited from |
#tooltipY |
Param Inherited from |
#trackable |
Param Inherited from |
#url |
Param Inherited from |
#urlTarget |
Param Inherited from |
#userClassName |
Param Inherited from |
#valign |
Param Inherited from |
#verticalCenter |
Param Inherited from |
#visible |
Param Inherited from |
#wheelable |
Param Inherited from |
#width |
Param Inherited from |
#x |
Param Inherited from |
#y |
Param Inherited from |
#zIndex |
Param Inherited from |
There are 141 inherited items currently hidden from this list. |