Type interface
Inheritance
IColumnSeriesSettings extends IBaseColumnSeriesSettings.
IColumnSeriesSettings is extended by IGanttSeriesSettings, ICandlestickSeriesSettings.
Properties
|
active # |
Type Inherited from Applies the element's |
|---|---|
|
adjustBulletPosition # |
Type Default Inherited from Places bullets on the visible part of a column that runs past the plot area, instead of on the whole column. |
|
animations # |
Type Inherited from Animations the element plays on its own, described as data - so they can be set from a JSON config and saved with it. Each one animates a setting of the element (or, with sprite.set("animations", [
{ key: "rotation", to: 360, duration: 4000, loops: 0 },
{ key: "scale", from: 1, to: 1.3, duration: 800, loops: 0, yoyo: true, easing: "sine" }
]);
@since 5.20.8 |
|
appearDelay # |
Type Default Inherited from Milliseconds to wait before the @since 5.21.0 |
|
appearDuration # |
Type Inherited from Duration of the @since 5.21.0 |
|
ariaChecked # |
Type Inherited from
This setting is ignored unless
|
|
ariaControls # |
Type Inherited from
|
|
ariaCurrent # |
Type Inherited from
Click here for more info |
|
ariaExpanded # |
Type Inherited from
Click here for more info |
|
ariaHidden # |
Type Inherited from
|
|
ariaLabel # |
Type Inherited from Label for the element to use for screen readers. Click here for more info |
|
ariaLive # |
Type Inherited from
|
|
ariaOrientation # |
Type Inherited from
|
|
ariaSelected # |
Type Inherited from
Click here for more info |
|
ariaValueMax # |
Type Inherited from
|
|
ariaValueMin # |
Type Inherited from
|
|
ariaValueNow # |
Type Inherited from
|
|
ariaValueText # |
Type Inherited from
|
|
autoAppear # |
Type Default Inherited from Plays the element's reveal animation, as Elements made from a template play as each one is made. An element that starts hidden ( This is how a JSON config gets the opening animation, as a config cannot call chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 });
series.setAll({ autoAppear: true, appearDuration: 1000 });
chart.setAll({ autoAppear: true, appearDuration: 1000, appearDelay: 100 });
series.setAll({ autoAppear: true, appearDuration: 1000 });
Click here for more info |
|
background # |
Type Inherited from Element drawn behind the container's content, sized to fill the container. Click here for more info |
|
baseAxis # |
Type Inherited from The axis the series runs along, such as the category axis of a column series; the other axis holds its values. If not set, the chart picks the Y axis when it is a category or date axis, and the X axis otherwise. Click here for more info |
|
blur # |
Type Inherited from Blur radius in pixels, from IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
|
brightness # |
Type Inherited from Brightness.
Click here for more info |
|
calculateAggregates # |
Type Inherited from Makes the series compute aggregate values, such as sums, averages, lows, highs and changes. Enable it only if they are used, e.g. in tooltips, data fields or heat rules. |
|
categoryXField # |
Type Inherited from Data field with the X category. Click here for more info |
|
categoryYField # |
Type Inherited from Data field with the Y category. Click here for more info |
|
centerX # |
Type Inherited from The point of the element that is placed at its |
|
centerY # |
Type Inherited from The point of the element that is placed at its |
|
clickAnnounceText # |
Type Inherited from If set, the text will be read out (announced) by a screen reader when focused element is "clicked" (by pressing ENTER or SPACE). @since 5.10.8 |
|
clustered # |
Type Default Inherited from Places the columns side by side with those of the other clustered column series on the same base axis, sharing each cell. With Click here for more info |
|
colorByDataItem # |
Type Default Inherited from Gives each column its own color from @since 5.20.4 |
|
colors # |
Type Inherited from Colors for the columns when @since 5.20.4 |
|
contrast # |
Type Inherited from Contrast.
Click here for more info |
|
crisp # |
Type Default Inherited from Draws the element sharply, with minimal anti-aliasing: its position is rounded to whole pixels, and NOTE: it may not work well on several elements that are meant to fit together exactly. @since 5.3.0 |
|
cursorOverStyle # |
Type Inherited from CSS cursor to show while the pointer is over the element, e.g.
Click here for more info |
|
customValueField # |
Type Inherited from A key to look up in data for an extra numeric value of the data item ( |
|
dateFormatter # |
Type Inherited from A Click here for more info |
|
disabled # |
Type Inherited from Applies the element's |
|
draggable # |
Type Inherited from Lets the user drag the element. Touches that start on it no longer scroll the page. |
|
durationFormatter # |
Type Inherited from A Click here for more info |
|
dx # |
Type Inherited from Horizontal shift in pixels. Can be negative to shift leftward. |
|
dy # |
Type Inherited from Vertical shift in pixels. Can be negative to shift upward. |
|
exactLocationX # |
Type Default Inherited from Places data points at their exact date on a @since 5.13.0 |
|
exactLocationY # |
Type Default Inherited from Places data points at their exact date on a @since 5.13.0 |
|
excludeFromAggregate # |
Type Inherited from Fields to leave out of @since 5.14.4 |
|
excludeFromTotal # |
Type Default Inherited from Leaves the series out of the totals ( |
|
exportable # |
Type Inherited from If |
|
fill # |
Type Inherited from Series fill color. Click here for more info |
|
fillGradient # |
Type Inherited from Series fill gradient. Click here for more info |
|
fillPattern # |
Type Inherited from Series fill pattern. Click here for more info |
|
focusable # |
Type Inherited from Can element be focused, i.e. selected using TAB key. Click here for more info |
|
focusableGroup # |
Type Inherited from An identifier by which to group common elements into focusable groups. If set, only the first element in he group will be focusable via TAB key. When it is selected, the rest of the elements in the same group can be selected using arrow keys. It allows users to TAB-through chart elements quickly without the need to TAB into each and every element. It's up to implementer of the charts to provide meaningful Click here for more info |
|
forceHidden # |
Type Inherited from Hides the element whatever its |
|
forceInactive # |
Type Inherited from Makes the element and its children ignore the pointer, even with @since 5.0.21 |
|
groupDataCallback # |
Type Inherited from Function called for each grouped data item once it is complete, to set values of your own. Its Click here for more info |
|
groupDataDisabled # |
Type Inherited from Keeps the series' data ungrouped even when its @since 5.0.19 |
|
groupDataWithOriginals # |
Type Default Inherited from Fills the @since 5.1.11 |
|
heatRules # |
Type Inherited from Heat rules to apply to the series' elements. A rule without Click here for more info |
|
height # |
Type Inherited from Height in pixels, or a |
|
highLocationX # |
Type Default Inherited from Horizontal location of the high data point relative to its cell. |
|
highLocationY # |
Type Default Inherited from Vertical location of the high data point relative to its cell. |
|
highValueXField # |
Type Inherited from Data field with the high X value. Click here for more info |
|
highValueXGrouped # |
Type Default Inherited from How grouping combines the high X values; see |
|
highValueXShow # |
Type Inherited from Which form of the high X value the series plots; see |
|
highValueYField # |
Type Inherited from Data field with the high Y value. Click here for more info |
|
highValueYGrouped # |
Type Default Inherited from How grouping combines the high Y values; see |
|
highValueYShow # |
Type Inherited from Which form of the high Y value the series plots; see |
|
hoverOnFocus # |
Type Inherited from Simulate hover on an element when it gains focus, including changing hover appearance and displaying a tooltip if applicable. Click here for more info |
|
html # |
Type Inherited from HTML content of the container. It can hold data placeholders, such as Click here for more info |
|
hue # |
Type Inherited from Rotates the hue of all colors by this many degrees, from IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
|
id # |
Type Inherited from A unique ID for looking the element up in |
|
idField # |
Type Inherited from A key to look up in data for an id of the data item. |
|
ignoreMinMax # |
Type Default Inherited from Leaves the series out when its axes work out their scale. |
|
ignoreThemes # |
Type Default Inherited from Ignores themes: no theme rule applies to the element, not even one of the default theme. @since 5.15.6 |
|
interactive # |
Type Inherited from Makes the element respond to the pointer. Adding a pointer event listener to it turns this on. |
|
interactiveChildren # |
Type Default Inherited from Makes every descendant, not just direct children, interactive when the container itself is interactive. |
|
interpolationDuration # |
Type Default Inherited from Duration in milliseconds of the animation from old values to new ones, e.g. when data changes. Click here for more info |
|
interpolationEasing # |
Type Inherited from Easing function of the animation from old values to new ones. Click here for more info |
|
invert # |
Type Inherited from Color inversion, from IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
|
isMeasured # |
Type Default Inherited from If |
|
layer # |
Type Inherited from Layer to draw the element on: elements on higher layers show in front of those on lower ones. If not set, the element is on its parent's layer. |
|
layerMargin # |
Type Inherited from Margins in pixels that make the element's layer larger than the chart, or, when negative, smaller. @since @5.2.39 |
|
layout # |
Type Inherited from How children are arranged, e.g. Click here for more info |
|
legendDataItem # |
Type Inherited from The series' data item in a @readonly |
|
legendLabelText # |
Type Inherited from Text template for the item's label in a |
|
legendRangeLabelText # |
Type Inherited from Text of the series' legend label while the cursor is not over any of its data items. If not set, |
|
legendRangeValueText # |
Type Inherited from Text of the series' legend value label while the cursor is not over any of its data items. |
|
legendValueText # |
Type Inherited from Text template for the item's value label in a |
|
linkTarget # |
Type Default Inherited from Where a data item's URL opens: @since 5.20.7 |
|
locationX # |
Type Default Inherited from Horizontal location of the data point relative to its cell. Click here for more info |
|
locationY # |
Type Default Inherited from Vertical location of the data point relative to its cell. Click here for more info |
|
lowLocationX # |
Type Default Inherited from Horizontal location of the low data point relative to its cell. |
|
lowLocationY # |
Type Default Inherited from Vertical location of the low data point relative to its cell. |
|
lowValueXField # |
Type Inherited from Data field with the low X value. Click here for more info |
|
lowValueXGrouped # |
Type Default Inherited from How grouping combines the low X values; see |
|
lowValueXShow # |
Type Inherited from Which form of the low X value the series plots; see |
|
lowValueYField # |
Type Inherited from Data field with the low Y value. Click here for more info |
|
lowValueYGrouped # |
Type Default Inherited from How grouping combines the low Y values; see |
|
lowValueYShow # |
Type Inherited from Which form of the low Y value the series plots; see |
|
marginBottom # |
Type Inherited from Bottom margin in pixels. |
|
marginLeft # |
Type Inherited from Left margin in pixels. |
|
marginRight # |
Type Inherited from Right margin in pixels. |
|
marginTop # |
Type Inherited from Top margin in pixels. |
|
mask # |
Type Inherited from An element whose shape clips the container's children. Click here for more info |
|
maskBullets # |
Type Default Inherited from Clips the series' bullets to the plot area. |
|
maskContent # |
Type Inherited from Clips all content that goes outside the container's bounds. |
|
maxHeight # |
Type Inherited from Maximum allowed height in pixels. |
|
maxWidth # |
Type Inherited from Maximum allowed width in pixels. |
|
minBulletDistance # |
Type Inherited from Hides the bullets while data items are, on average, closer than this many pixels to each other along the base axis. Click here for more info |
|
minHeight # |
Type Inherited from Minimum allowed height in pixels. |
|
minWidth # |
Type Inherited from Minimum allowed width in pixels. |
|
name # |
Type Inherited from Name of the series. |
|
numberFormatter # |
Type Inherited from A Click here for more info |
|
opacity # |
Type Default Inherited from Opacity, from |
|
openCategoryXField # |
Type Inherited from Data field with the X category a column starts at, so that it can span several categories. Click here for more info |
|
openCategoryYField # |
Type Inherited from Data field with the Y category a column starts at, so that it can span several categories. Click here for more info |
|
openLocationX # |
Type Inherited from Where in its X axis cell the open data point sits: |
|
openLocationY # |
Type Inherited from Where in its Y axis cell the open data point sits: |
|
openValueXField # |
Type Inherited from Data field with the open X value, such as where a horizontal column starts. Click here for more info |
|
openValueXGrouped # |
Type Default Inherited from How grouping combines the open X values; see Click here for more info |
|
openValueXShow # |
Type Inherited from Which form of the open X value the series plots; see Click here for more info |
|
openValueYField # |
Type Inherited from Data field with the open Y value, such as where a column starts. Click here for more info |
|
openValueYGrouped # |
Type Default Inherited from How grouping combines the open Y values; see Click here for more info |
|
openValueYShow # |
Type Inherited from Which form of the open Y value the series plots; see Click here for more info |
|
paddingBottom # |
Type Inherited from Bottom padding in pixels. |
|
paddingLeft # |
Type Inherited from Left padding in pixels. |
|
paddingRight # |
Type Inherited from Right padding in pixels. |
|
paddingTop # |
Type Inherited from Top padding in pixels. |
|
position # |
Type Default Inherited from Positioning of the element. |
|
reverseChildren # |
Type Inherited from Lays out the children in reverse order. @since 5.1.1 |
|
role # |
Type Inherited from Element's role. Click here for more info |
|
rotation # |
Type Default Inherited from Rotation in degrees, clockwise, around the point set by |
|
saturate # |
Type Inherited from Saturation.
Click here for more info |
|
scale # |
Type Default Inherited from Scale, around the point set by |
|
sepia # |
Type Inherited from Sepia tone, from IMPORTANT: This setting is not supported in Safari browsers. Click here for more info |
|
sequencedDelay # |
Type Inherited from Extra delay in milliseconds between the animations of consecutive data items, with Click here for more info |
|
sequencedInterpolation # |
Type Inherited from Shows and hides the data items one after another instead of all at once, including in the initial animation. Works in XY and percent series. Click here for more info |
|
seriesTooltipTarget # |
Type Default Inherited from Where the series' tooltip takes its color from: the series (on a column series, the hovered column), or the data item's first bullet. |
|
setStateOnChildren # |
Type Default Inherited from Applies every state set on the container to its children too. Click here for more info |
|
showTooltipOn # |
Type Default Inherited from When the element's tooltip shows:
Click here for more info |
|
snapTooltip # |
Type Inherited from Lets the cursor show the nearest data item even when there is none in the date interval under the pointer. Works only with a |
|
stackToNegative # |
Type Inherited from When stacking, puts negative values on the negative values below and positive on positive, so the stack grows away from zero both ways. With Click here for more info |
|
stacked # |
Type Inherited from Stacks the series on the one before it in the chart's Stacking goes by data item index, so all stacked series need the same data items (dates or categories), in the same order. Click here for more info |
|
stateAnimationDuration # |
Type Default Inherited from How long, in milliseconds, a switch from one state to another animates.
|
|
stateAnimationEasing # |
Type Default Inherited from Easing of the animated switch from one state to another. |
|
stroke # |
Type Inherited from Series stroke color. Click here for more info |
|
strokeGradient # |
Type Inherited from Series stroke gradient. Click here for more info |
|
tabindexOrder # |
Type Inherited from An internal order by which focusable elements will be selected within the chart. Click here for more info |
|
templateField # |
Type Inherited from Field in the data item's data object that holds settings for this element, applied over its template's. Click here for more info |
|
themeTags # |
Type Inherited from Tags that theme rules can target. They also count for the element's children, so a rule can match a child by a tag of its parent. Click here for more info |
|
themeTagsSelf # |
Type Inherited from Tags that theme rules can target, like Click here for more info |
|
themes # |
Type Inherited from Themes applied to the element and everything inside it. |
|
toggleKey # |
Type Inherited from Setting that a click or tap toggles between
|
|
tooltip # |
Type Inherited from The |
|
tooltipDataItem # |
Type Inherited from The data item the series' tooltip currently shows, such as the one under the cursor. @since 5.1.2 |
|
tooltipHTML # |
Type Inherited from HTML content of the element's tooltip, shown in place of @since 5.2.11 |
|
tooltipPosition # |
Type Default Inherited from Where the tooltip points: |
|
tooltipPositionX # |
Type Default Inherited from Which of the data item's X values the series' tooltip points at. @since 5.0.16 |
|
tooltipPositionY # |
Type Default Inherited from Which of the data item's Y values the series' tooltip points at. @since 5.0.16 |
|
tooltipText # |
Type Inherited from Text of the element's tooltip. It can hold data placeholders, such as |
|
tooltipX # |
Type Default Inherited from Where on the element the tooltip points, horizontally: pixels from its left edge, or a percent of its width. |
|
tooltipY # |
Type Default Inherited from Where on the element the tooltip points, vertically: pixels from its top edge, or a percent of its height. |
|
turboMode # |
Type Draws all columns as a single shape instead of one element each, which renders charts with many columns much faster. Experimental: the columns then don't react to the pointer, and some of their settings, such as rounded corners, have no effect. @since 5.14.0 |
|
urlField # |
Type Inherited from A key to look up in data for a URL to open when the data item's element (a bullet, column, slice, map polygon or map line) is clicked. Links are off until this is set. @since 5.20.7 |
|
useLastColorForLegendMarker # |
Type Inherited from Colors the legend marker like the last visible column, instead of with the series' @since 5.1.13 |
|
useSelectionExtremes # |
Type Inherited from Makes the value axis scale to the series' values within the visible range only, instead of all its values. Useful for stacked series. @since 5.10.11 |
|
userData # |
Type Inherited from Any data of your own to keep with the element. |
|
valueField # |
Type Inherited from A key to look up in data for a numeric value of the data item. Some series draw their elements by it; heat rules can use it too. |
|
valueXField # |
Type Inherited from Data field with the X value. Click here for more info |
|
valueXGrouped # |
Type Default Inherited from How a Click here for more info |
|
valueXShow # |
Type Default Inherited from Which form of the X value the series plots on a Click here for more info |
|
valueYField # |
Type Inherited from Data field with the Y value. Click here for more info |
|
valueYGrouped # |
Type Default Inherited from How a Click here for more info |
|
valueYShow # |
Type Default Inherited from Which form of the Y value the series plots on a Click here for more info |
|
verticalScrollbar # |
Type Inherited from A Click here for more info |
|
visible # |
Type Default Inherited from Whether the element is shown. Unlike |
|
wheelable # |
Type Inherited from Makes the element receive mouse wheel events. While the pointer is over it, the wheel no longer scrolls the page. |
|
width # |
Type Inherited from Width in pixels, or a |
|
x # |
Type Inherited from X position in the parent: pixels from its left edge, or a |
|
xAxis # |
Type Inherited from The X axis the series is plotted against. Must be set when creating the series; it can be switched to another axis of the same type later. |
|
y # |
Type Inherited from Y position in the parent: pixels from its top edge, or a |
|
yAxis # |
Type Inherited from The Y axis the series is plotted against. Must be set when creating the series; it can be switched to another axis of the same type later. |
| There are 181 inherited items currently hidden from this list. | |