graph » series
series
[ root » graph » series ]
Use the series object to provide your data values and to make local changes to a specific dataset. (Use the plot object to make global changes that apply to all datasets.)
| Attribute | Type | Description |
|---|---|---|
| activeArea active-area | Boolean | Extends the activation area by allowing tooltips and API events to be triggered by the area under a line. Refer to the Area Chart Tutorial for more information. Default Value: false Introduced in: v2.1.1 Chart types: Area |
| activeArea active-area | Boolean | Extends the activation area by allowing tooltips and API events to be triggered by the area under a line. Default Value: false Introduced in: v2.5.1 Chart types: Radar |
| alpha | Number | Sets the transparency level of the object. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading 0 before the decimal point. Default Value: 1 |
| alphaArea alpha-area | Number | Sets the transparency level of the area between the center of the radar chart and the line. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading zero before the decimal point. Default Value: 0.5 Chart types: Radar |
| alphaArea alpha-area | Number | Sets the transparency level of the polygon region (for `poly` aspect). Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading zero before the decimal point. Default Value: 0.5 Chart types: Scatter |
| alphaArea alpha-area | Number | Sets the transparency level of the area between the two lines of the chart. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading zero before the decimal point. Default Value: 0.5 Introduced in: v1.3.0 Chart types: Range |
| alphaArea alpha-area | Number | Sets the transparency level of the background under the gauge line Default Value: 0.5 Chart types: Gauge |
| alphaArea alpha-area | Number | Sets the transparency level of the area below a line. Refer to the Area Chart Tutorial for more information. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading zero before the decimal point. Default Value: 0.5 Chart types: Area |
| anchor | String | Allows you to set an object's anchor position Accepted Values: ['tl', 'tr', 'bl', 'br', 'c', 't', 'r', 'b', 'l'] Default Value: 'tl' |
| angle | Number | Sets the rotation angle of the object/shape. Default Value: 0 |
| angleEnd angle-end | Number | Sets the end angle of a pie shape. Default Value: 360 |
| angleSpace angle-space | Number | On `rose` aspect, it modifies the aperture of the pie section relative to the entire space of the scale interval. Default Value: null Chart types: Radar |
| angleStart angle-start | Number | Sets the beginning angle of a pie shape. Default Value: 0 |
| animation | Object | Sets and customizes the animation used on chart load and reload. |
| aspect | String | Allows you to change the appearance of your series data so that they appear as lines (default), polygons (area), columns/bars (rose), scatter markers, or a combination of any of the aspect options. Accepted Values: [line, area, rose, column, bar, scatter, mixed] Default Value: 'line' Chart types: Radar |
| aspect | String | Modifies how data points appear on a chart. Refer to the applicable chart types page for more information. Accepted Values: ['segmented', 'spline', 'stepped', 'jumped', 'cone', 'histogram', ...] Default Value: null |
| backgroundClip background-clip | Boolean | Clips the background image to the margins of the shape/box. Default Value: true |
| backgroundColor background-color | String | Sets the background color of the object. Colors can be entered by name (e.g., "purple", "blue"), hexadecimal notation (e.g., "#666699", #33ccff"), or RGB notation (e.g., "rgb(255,0,0)", "rgb(0,0,255)") Default Value: null |
| backgroundColor1 background-color-1 | String | Sets the first color of a 2 color background gradient of the object. To be used with background-color-2. Default Value: null |
| backgroundColor2 background-color-2 | String | Sets the second color of a 2 color background gradient of the object. To be used with background-color-1. Default Value: null |
| backgroundFit background-fit | String | Sets the direction/s on which the background image is being "stretched". Default Value: '' |
| backgroundImage background-image | String | Sets a background image for the object. Value can be a local file or a web image's location. Default Value: '' |
| backgroundMarker background-marker | Object | Allows you to set marker styling attributes for non-selected (or background) data points. This object may be used in conjunction with the "background-state" object, depending on the chart type. You can also style the selected data points using the "selected-state" and/or "selected-marker" object(s). Note: The "selection-mode" attribute must be included for styling to activate. You can also add a "background-mode" attribute to set whether non-selected data points activate per plot or graph. Default Value: null |
| backgroundMode background-mode | String | To be used with the "selection-mode" attribute. It allows you to set whether non-selected data points activate per plot (default) or graph. Note: Use this attribute with the "background-state" and/or "background-marker" object(s), which allow you specify the styling attributes you want applied. Default Value: 'plot' |
| backgroundPosition background-position | String | Sets the position of the background when the background-repeat value is no-repeat. Default Value: '50% 50%' |
| backgroundRepeat background-repeat | String | Sets the repeating mode for the background image. Default Value: 'repeat' |
| backgroundScale background-scale | Number | Scales the background image using the specified ratio. Default Value: 1 |
| backgroundState background-state | Object | Allows you to set styling attributes for non-selected (or background) data points. This object may be used in conjunction with the "background-marker" object, depending on the chart type. You can also style the selected data points using the "selected-state" and/or "selected-marker" object(s). Note: The "selection-mode" attribute must be included for styling to activate. You can also add a "background-mode" attribute to set whether non-selected data points activate per plot or graph. Default Value: null |
| bandSpace band-space | Number | Sets the spacing between pie layers Chart types: Nested-pie |
| bandWidths band-widths | Array. | Sets the width of each band Chart types: Nested-pie |
| barMaxWidth bar-max-width | Number | Sets the max width of bars. Default Value: -1 Chart types: Bar |
| barSpace bar-space | Number | Sets the amount of space between each bar in a single plot index. Default Value: 0.1 Chart types: Bar |
| barWidth bar-width | Number | Sets the width of each bar. Default Value: 0 Chart types: Bar |
| barsOverlap bars-overlap | Number | Defines how much the bars in each plot index should overlap. Default Value: 0 Chart types: Bar |
| barsSpaceLeft bars-space-left | Number | Defines the spacing to the left of the bars at each index position. Default Value: 0.1 Chart types: Bar |
| barsSpaceRight bars-space-right | Number | Defines the spacing to the right of the bars at each index position. Default Value: 0.1 Chart types: Bar |
| border | String,Number | Sets the border width of the object. Can be a single value or a string of values, setting the values in the order "top right bottom left" |
| borderAlpha border-alpha | Number | Sets the transparency level of the border on the object. Values must range between 0.0 and 1.0, with 0.0 being completely transparent and 1.0 being completely opaque. Note that values require the leading 0 before the decimal point. Default Value: 1 Introduced in: v2.1.1 |
| borderBottom border-bottom | String | Sets the object's bottom border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderColor border-color | String | Sets the border color of the object. Default Value: '#000' |
| borderLeft border-left | String | Sets the object's left border style. Accepts solid, dashed, and dotted styles. |
| borderRadius border-radius | Number | Sets the object's border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A single value will affect all 4 corners; multiple values will have separate effects on each corner, with the first value affecting the top-left corner, the second value affecting the top-right corner, and so on, in a clockwise direction. A negative value will cut a corner off without rounding. Default Value: 0 |
| borderRadiusBottomLeft border-radius-bottom-left | Number | Sets the object's bottom-left border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding. Default Value: 0 |
| borderRadiusBottomRight border-radius-bottom-right | Number | Sets the object's bottom-right border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding. Default Value: 0 |
| borderRadiusTopLeft border-radius-top-left | Number | Sets the object's top-left border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding. Default Value: 0 |
| borderRadiusTopRight border-radius-top-right | Number | Sets the object's top-right border radius for rounded corners. Larger values create rounder corners, while smaller values create sharper corners. A negative value will cut a corner off without rounding. Default Value: 0 |
| borderRight border-right | String | Sets the object's right border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderTop border-top | String | Sets the object's top border style. Accepts solid, dashed, and dotted styles. Default Value: '' |
| borderWidth border-width | Number | Sets the border width of the object. Default Value: 0 |
| bottomState bottom-state | Object | Sets the style for a copy of the object which is placed below the object itself. Introduced in: v1.14.0 |
| callout | Boolean | Sets whether an object will have a callout arrow or not. Default Value: false |
| calloutExtension callout-extension | Number | Sets the length of the extension that extends beyond the tip of the callout arrow. Default Value: 0 |
| calloutHeight callout-height | Number | Sets the height of the object's callout arrow. A larger value will create a taller callout arrow. Default Value: 8 |
| calloutHook callout-hook | Array. | Sets the point of the tip of the callout arrow to a specified coordinate on the chart, with the starting point of [0,0] being the top left corner of the chart. Default Value: null |
| calloutOffset callout-offset | Number | Sets the offset along the callout direction of the arrow's base. Positive and negative values can be used to offset the callout arrow up, down, left, or right depending on the callout-position. Default Value: 0 |
| calloutPosition callout-position | String | Sets the position for the object's callout arrow. The position is "bottom" by default. Default Value: 'bottom' |
| calloutRatio callout-ratio | Array. | Sets how much to stretch/squeeze the callout arrow on its two sides. A zero value for example on one side would create like a half callout arrow. Negative values can also be set, in order to create various aspects. Default Value: [1, 1] |
| calloutTip callout-tip | ZCStyle | To style the tip of the callout. You can modify the shape with a "type" attribute. Value options include "circle", "diamond", "cross", and "arrow". For styling, use attributes such as "background-color", "border-color", "border-width", "line-color", "line-width", and so on. Default Value: null |
| calloutWidth callout-width | Number | Sets the width of the object's callout arrow. A larger value will create a wider callout arrow. Default Value: 8 |
| centerRef center-ref | Boolean | Sets the (0,0) x/y coordinates as the center of the box (instead of the top-left corner). Default Value: false |
| class | String | Sets a class value on the object. Default Value: null |
| clusterIndex cluster-index | Number | Sets the index of the cluster the plot will use. Default Value: -1 |
| clusterOffset cluster-offset | Number | Sets a margin for the scale step cluster. Default Value: 0 |
| clustered | Boolean | Sets if the entire plot will be painted within one step of the key scale. Default Value: false Introduced in: v2.8.2 |
| connectNulls connect-nulls | Boolean | If true, connects the line over a null point rather than having a break in the chart. Default Value: false Introduced in: v2.6.1 Chart types: Area |
| connectNulls connect-nulls | Boolean | If true, connects the line over a null point rather than having a break in the chart. Default Value: false Introduced in: v2.6.1 Chart types: Line |
| contourOnTop contour-on-top | Boolean | Sets whether the contour lines on area plots will be on top of all areas or will be hidden by the next area plot on top of it. You will notice when the attribute is set to true, the lines are all set above the shaded regions. Default Value: true Chart types: Area |
| cursor | String | Sets the cursor shape when hovering over the object. Default Value: 'auto' Introduced in: v1.9.0 |
| decimals | Number | Using the decimals attribute will allow you to set the number of decimal places associated to each value. Default Value: -1 |
| decimalsSeparator decimals-separator | String | The "decimals-separator" attribute allows you to set what type of punctuation will be used in the decimal place. Default Value: null |
| density | Number | Sets a factor which will affect the data sampling. Values larger than 1 will increase the sampling step, values smaller than 1 will decrease the sampling step. Default Value: 1 |
| description | String | Sets a more detailed description for the plot. Default Value: null |
| detach | Boolean | Specifies whether or not the slice detaches from the pie when clicked on. Default Value: true Chart types: Pie |
| dragging | Object | Sets options for the dragging module. Chart types: Dragging Module |
| error | Object | Error Bars Only: To set the styling of the error bars. (Error bar values are set with the "errors" array. Default Value: null |
| errors | Array. | Error Bars Only: An array of items specifying the value of error bars for items in the plot. Error can be specified using a specific max error and min error respectively, or both at once. Note errors can be set for all plot indexes within the "plot": {} object or they can be set within each series value set. Default Value: [] |
| exact | Boolean | By default, ZingChart uses sampling when rendering charts. This helps improve rendering speeds and typically does not affect the appearance of the chart. However, using the attribute "exact": true within the "plot": { } object forces ZingChart to render all nodes. Default Value: false |
| exponent | Boolean | This attribute sets the values to scientific notation Default Value: false |
| exponentDecimals exponent-decimals | Number | This attribute set the number of decimals to be used when using exponents for scientific notation Default Value: 2 |
| extraValues extra-values | Array. | Sets additional values that will be attached to the plot. Default Value: 0 |
| facets | Object | 3D objects are made up of front, left, right, top, and bottom sections. As such, these terms are used within the "facets" object to style each section. Introduced in: v1.15.0 Chart types: 3D Charts |
| fillAngle fill-angle | Number | Sets the angle of the axis along which the linear gradient is drawn. Default Value: 90 |
| fillOffsetX fill-offset-x | Number | Sets an X offset to apply to the fill. Default Value: 0 |
| fillOffsetY fill-offset-y | Number | Sets a Y offset to apply to the fill. Default Value: 0 |
| fillType fill-type | String,Number | Sets the background gradient fill type to either linear or radial. Default Value: 'linear' |
| flat | Boolean | Disables the active area (used for tooltip) for the object. Default Value: false |
| goal | Object | To set the styling of the goals in bullet charts. Refer to the Bullet Charts Tutorial for more information. Chart types: Bullet |
| goals | Array. | Accepts numerical values. Determines where goals are set for all plots. The "goals": [ ] values can also be set individually within each value set. Chart types: Bullet |
| gradientColors gradient-colors | String | Sets a set of colors for a complex background gradient consisting of 2 or more colors. To be used with gradient-stops. Default Value: '' |
| gradientStops gradient-stops | String | Sets the gradient stops for a complex background gradient consisting of 2 or more colors. To be used with gradient-colors. Default Value: '' |
| groupBars group-bars | Boolean | If false, will force full overlapping of the bars. Default Value: true Chart types: Bar |
| groupSelections group-selections | Boolean | When true, automatically selects all nodes with the same scale index as the selected node. The selection-mode attribute must also be set. Default Value: false |
| guideLabel guide-label | Object | To use with crosshair plot labels. When you have multiple series in your chart, you may want to separate the crosshair plot labels so that a label appears for each series. To do this, you must add a multiple attribute in the plot-label object in crosshair-x, and set the value to true. You can then createguide-label objects in individual series objects to specify how the text and styling for individual plot labels appear. |
| height | Number | Set the object's height. Default Value: 0 |
| highlight | Boolean | When set to true, it highlights the corresponding series when the user hovers over it in the legend. Note: This attribute may be used in conjunction with the "highlight-state" and/or "highlight-marker" object(s), which allow for custom styling. Default Value: false |
| highlightLegend highlight-legend | Boolean | Sets whether the legend entry for the plot will be highlighted when hovering the plot. Default Value: false |
| hoverMarker hover-marker | Object | Allows you to set styling attributes, which are triggered when the user hovers over the data points (or nodes) on the chart. This object may be used in conjunction with the "hover-state" object, depending on the chart type. Note: The "hover-mode" attribute may be used to set whether hover styling activates per node or plot. Default Value: null |
| hoverMode hover-mode | String | o specify whether data points that are hovered over activate per node (default) or plot. Note: Use this attribute with the "hover-state" and/or "hover-marker" object(s), which allow you specify the styling attributes you want applied. Accepted Values: ['node', 'plot'] Default Value: 'node' |
| hoverState hover-state | Object | Allows you to set styling attributes, which are triggered when the user hovers over the data points (or nodes) on the chart. This object may be used in conjunction with the "hover-marker" object, depending on the chart type. Note: The "hover-mode" attribute may be used to set whether hover styling activates per node or plot. Default Value: null |
| id | String | ID of the shape Default Value: '' |
| id | String | Sets the id of the object. Default Value: '' |
| indicator | Array. | Your gauge chart's needle (sometimes referred to as a dial) indicates where your data value falls on your scale. You can modify the shape of your gauge needle with the indicator attribute. This allows you to display a curved or flat base, rounded or pointed tip, and/or needle that is offset from the gauge's center. Provide your indicator values in an array in the following format: indicator: [R-Base, R-Tip, A-Base, A-Tip, Offset]. See the Gauge tutorial for more information. Chart types: Gauge |
| item | String | Sets the item id of the map on which the object/shape is being added. Default Value: '' |
| join | Array. | The value of the joined area between the venn sets (the current and the next one). Chart types: Venn-diagram |
| keyWidth key-width | Boolean | If true, the bar width will be the size on the key scale (X scale) of that value. Default Value: true Chart types: Bar |
| legendItem legend-item | Object | Sets the styling for the active legend items. Accepted Values: defaultValue |
| legendMarker legend-marker | Object | Sets the styling for the legend markers. Accepted Values: defaultValue |
| legendText legend-text | String | Sets a text which will appear in the legend instead of the plot's text attribute. Default Value: null |
| lineCap line-cap | String | Sets the stroke-linecap attribute on SVGs Accepted Values: ['butt', 'round', 'square'] Default Value: 'butt' |
| lineColor line-color | String | Sets the line color of the object, applicable on non-closed shapes. See also border-color for closed shapes. Default Value: '#000' |
| lineGapSize line-gap-size | String,Number | Can be used to create custom dashed or dotted lines when used with line-segment-size. This will control the size of the gaps between each line segment. Default Value: 0 |
| lineJoin line-join | String | Sets the stroke-linejoin attribute on SVGs Accepted Values: ['round', 'miter'] Default Value: 'round' |
| lineSegmentSize line-segment-size | String,Number | Can be used to create custom dashed or dotted lines when used with line-gap-size. This will control the size of the visible segment of line. Default Value: 0 |
| lineStyle line-style | String | Sets the line style of the object. Default Value: '' |
| lineWidth line-width | Number | Sets the line width of the object, applicable on non-closed shapes. See also border-width for closed shapes. Default Value: 0 |
| map | String | Sets the map id of the map on which the object/shape is being added. |
| margin | Number | Sets the object's margin/s from the top-left of the chart. Default Value: 0 |
| marginBottom margin-bottom | Number | Sets the object's bottom margin. Default Value: -1 |
| marginLeft margin-left | Number | Sets the object's left margin. Default Value: -1 |
| marginRight margin-right | Number | Sets the object's right margin. Default Value: -1 |
| marginTop margin-top | Number | Sets the object's top margin. Default Value: -1 |
| marker | Object | Using the "marker": { } within "plot": { } allows you to style markers associated to all plots. You can also use "marker": { } within individual "series": [ ] values to style each value set individually. Default Value: null |
| maxDecimals max-decimals | Number | Sets the max number of decimals that will be used to format the values. Accepted Values: -1 |
| maxNodes max-nodes | Number | Applies to charts, such as line and area, which have markers. When there are too many markers for the chart, ZingChart does not display all markers. Example 1000 nodes on a 300px wide chart. Setting max-nodes will override the default setting and force nodes to be displayed. Default Value: null |
| maxRatio max-ratio | Number | Sets the maximum aspect that the heat map operates in. Must be a value between 0 and 1. Chart types: Heat-map |
| maxSize max-size | Number | Sets a maximum bubble size Default Value: null Chart types: Bubble |
| maxTrackers max-trackers | Number | Sets the maximum numbers of nodes for which a tracking area will be created. This is best used to optimize charts with large sets of data. Default Value: null |
| midPoint mid-point | Boolean | Sets whether or not a node is wrapped equally before and after its position. Default Value: true |
| minExit min-exit | Number | Sets the minimum width of the funnel exit. Accepted Values: A percentage or decimal between 0 and 1, Default Value: 0 Chart types: Funnel |
| minRatio min-ratio | Number | Sets the minimum aspect that the heat map operates in. Must be a value between 0 and 1. Chart types: Heat-map |
| minSize min-size | Number | Sets a minimum bubble size Default Value: null Chart types: Bubble |
| mode | String | Sets the plot's painting mode. Normal mode paints node by node, allowing for rules, fast mode is faster but lacks rule feature. Accepted Values: ['normal', 'fast'] Default Value: null |
| monotone | Boolean | Sets whether monotone interpolation is used for charts using the "spline" aspect. Default Value: false |
| negation | String | This attribute will determine how negative values are handled. When using "format":"$%v" setting "negation":"currency" will move the - symbol to the outside of the $ sign. When using "negation" within the "plot": { } object you will see changes in things such as tooltips or anywhere else series data is used to populate values. You need to set "negation" in things such as "scale-y": { } separately. Accepted Values: ['standard', 'currency'] Default Value: 'standard' |
| offset | Number | Often used to create an exploded pie chart, the attribute allows you to pull out one or more slices from a pie chart. Note that it differs from the "detached" attribute, which reattaches the slice back to the pie when clicked on. Refer to the Pie Chart Tutorial for more information. Chart types: Pie |
| offsetR offset-r | Number | Sets an R offset to apply when positioning the object/shape. Default Value: 0 |
| offsetValues offset-values | Array. | Sets the starting point of each bar on a floating chart. Default Value: [] Chart types: Bar |
| offsetX offset-x | Number | Sets an X offset to apply when positioning the object/shape. Default Value: 0 |
| offsetY offset-y | Number | Sets a Y offset to apply when positioning the object/shape. Default Value: 0 |
| offsetZ offset-z | Number | Sets a Z offset to apply when positioning the object/shape. Default Value: 0 |
| palette | Array. | Sets the color palette to be used on the chart. Default Value: null |
| palette | Number | Sets a index of the palette which will be used to color the plot. Default Value: -1 |
| points | Array. | Sets the coordinates of the object/shape points. Default Value: [] |
| position | String | Sets the object's position relative to its container. Similar results can be obtained by setting [margin] and [margin-...] attributes. Uses x,y coordinates originating from the top left of the chart. Default Value: '' |
| preview | Boolean | Enables a chart preview object. Default Value: true |
| previewState preview-state | Object | Defines how plot elements appear in the preview Introduced in: v2.6.1 Chart types: Line |
| previewState preview-state | Object | Defines how plot items appear in the preview Introduced in: v2.6.1 Chart types: Bar |
| previewState preview-state | Object | Styles the series elements to be shown in the preview. Introduced in: v2.6.1 Chart types: Area |
| rectShortcut rect-shortcut | Boolean | Used to force the library to create rectangles using a faster drawing API (instead of painting them like a closed polygon). However, using this would disable effects like rounded borders. It is a performance setting for edge cases. Default Value: false |
| refAngle ref-angle | Number | Sets the angle that the chart is rotated. Default Value: 0 Chart types: Pie |
| refAngle ref-angle | Number | Provides the ability to rotate the chart. Chart types: Nested-pie |
| reference | String | Sets the relationship for setting the heat map values. Refer to the Heat Map tutorial for more information. Accepted Values: ['plot-max', 'plot-total', 'chart-max', 'chart-total'] Default Value: 'plot-max' Chart types: Heat-map |
| rules | Array | null |
| samplingStep sampling-step | Number | By default, ZingChart uses sampling when rendering large datasets. If you are trying to render 10000 data points on a chart which is only 500px wide, there is not enough space for each data point. ZingChart will automatically determine which data points to show. The "sampling-step": attribute allows you to set the step for sampling. For example, if you have 10000 data points and set "sampling-step":10, it will show points 1,10,20,... Also note the "exact": true attribute if you want to force all data points. Default Value: null |
| scales | Array. | Specifies the scales used by the plot item. Default Value: [] |
| scaling | String | Sets whether the area or radius of the bubble should reflect the bubble value Accepted Values: ['area', 'radius'] Default Value: 'area' Chart types: Bubble |
| scrollStepMultiplier scroll-step-multiplier | Number | When scrolling is enabled for a chart, ZingChart automatically samples the data in order to maintain performance during the re-rendering of the chart that occurs during scrolling. By default, ZingChart will automatically sample every other item (scroll-step-multiplier:2). Setting scroll-step-multiplier to 1 will force the library to sample every data point, essentially disabling sampling. Default Value: 1 |
| segmentTrackers segment-trackers | Boolean | Line Charts and Area Charts Only: Allows you to specify whether tooltips are activated by the markers and lines (default) or the markers only. Default Value: true |
| selectedMarker selected-marker | Object | Allows you to set marker styling attributes, which are triggered when the user clicks on or selects data points on your chart. This object may be used in conjunction with the 'selected-state' object, depending on the chart type. You can also style the unselected (or background) data points using the 'background-state' and/or 'background-marker' object(s). Default Value: null |
| selectedState selected-state | Object | Sets the styling for the plot's selected state. Default Value: null |
| selectionMode selection-mode | String | To set how data points are selected on a chart. 'none' (default) prevents any selection. 'plot' allows you to select one node (or data point) per series (or dataset). 'graph' allows you to select one node per chart. 'multiple' allows you to select as many nodes as you want. Note: Use this attribute with the selected-state and/or selected-marker object(s), which allow you specify the styling attributes you want applied. Accepted Values: ['none', 'plot', 'graph', 'multiple'] Default Value: 'none' |
| series | Object | Set series specific properties |
| shadow | Boolean | Sets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation. Default Value: false |
| shadowAlpha shadow-alpha | Number | Sets the transparency of the shadow of the object. The higher the value, the less transparent the shadow will be. Default Value: 0.75 |
| shadowAngle shadow-angle | Number | Sets the angle of the shadow underneath the object. Default Value: 45 |
| shadowBlur shadow-blur | String,Number | Sets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation. Default Value: 0 |
| shadowColor shadow-color | String | Sets the color of the shadow of the object. Default Value: '#999' |
| shadowDistance shadow-distance | String,Number | Sets the distance between the shadow and the object. Default Value: 2 |
| share | Array. | The value of the shared area between all venn sets. Chart types: Venn-diagram |
| short | Boolean | Setting "short": true will abbreviate long numbers such as 100000 to 1K or 1000000 to 1M. When set within the "plot": {} object, this change will be noticed anywhere values are pulled from series data. This can also be used in places such as scale-y, scale-x, etc Default Value: false Introduced in: v2.3.1 |
| shortUnit short-unit | String | By default when setting "short": true ZingChart will round to the nearest short unit (ie 100000 to 100K and 1000000 to 1M). You can set the short-unit and ZingChart will round all numbers to that unit. Note when setting this within the "plot": { } object the changes will only effect values which are pulled from the series values. Things such as scale are set separately. Default Value: '' Introduced in: v2.3.1 |
| showZero show-zero | Boolean | For 0 values in the series, showZero: true will render 0 values with a 1px width so the values are just visible. Default Value: false Chart types: Pie |
| showZero show-zero | Boolean | On bar charts, when the value of a bar is 0, setting `show-zero`: true will add 1 pixel to the height of the bar so that it is only just visible. Default Value: false Chart types: Bar |
| size | Number | Sets the size of the object/shape. Default Value: 0 |
| size2 size-2 | Number | Sets the secondary size of the object/shape. Used on ellipses or rectangle shapes. Default Value: 0 |
| sizeFactor size-factor | Number | Scales the size of the bubble Default Value: 1 Chart types: Bubble |
| sizingGroup sizing-group | Number | Sets a group for the bubble plot. The sizing of the bubbles belonging to different groups is independent. Default Value: 1 Chart types: Bubble |
| slice | Number | To create and/or specify the sizing of the donut ring. Provide a percentage or pixel value. Note that we have a donut chart type ("type": "ring"), where the donut ring size is set by default to 35%. This attribute can be used to adjust the sizing. Refer to the Pie Chart Tutorial for more information. Default Value: 0 Chart types: Pie |
| slice | Number | Sets the radius of the inner ring of a pie shape. Default Value: 0 |
| sliceStart slice-start | Number | Sets the size of the center hole for a donut chart Chart types: Nested-pie |
| smartSampling smart-sampling | Boolean | A boolean to smart sample and render data at a sampled size. Used in conjunction with exact:false Default Value: false Introduced in: v1.10.0 Chart types: Area |
| smartSampling smart-sampling | Boolean | A boolean to smart sample and render data at a sampled size. Used in conjunction with exact:false Default Value: false Chart types: Bar |
| smartSampling smart-sampling | Boolean | A boolean to smart sample and render data at a sampled size. Used in conjunction with exact:false Default Value: false Introduced in: v1.10.0 Chart types: Line |
| spaceEntry space-entry | Number | Modifies the width of the space before funnel sections Accepted Values: A percentage or decimal between 0 and 1, Default Value: 0.1 Chart types: Funnel |
| spaceExit space-exit | Number | Modifies the width of the space after funnel secions Accepted Values: A percentage or decimal between 0 and 1, Default Value: 0.1 Chart types: Funnel |
| stack | Number | Using the 'stack': attribute allows you to assign which stack you want each value set associated with when using a multiple stacked chart. Default Value: 0 |
| stackType stack-type | String | Sets the stacking logic for stacked charts Accepted Values: ['normal', '100%'] Default Value: 'normal' |
| stacked | Boolean | Setting 'stacked': true will take each of the 'series' value sets and stack them on top of one another Default Value: false |
| startWidth start-width | String | Sets how the starting width of the funnel is set, dynamically (based on the starting value) or statically (always the same width) Accepted Values: ['dynamic', 'static'] Default Value: 'dynamic' Introduced in: v1.3.0 Chart types: Funnel |
| stepStart step-start | String | Applicable on aspect=stepped, sets the location of the stepping relative to two consecutive nodes. Accepted Values: ['before', 'middle', 'after'] Default Value: 'middle' Introduced in: v1.8.0 Chart types: Area |
| stepStart step-start | String | Applicable on aspect=stepped, sets the location of the stepping relative to two consecutive nodes. Accepted Values: ['before', 'middle', 'after'] Default Value: 'middle' Introduced in: v1.8.0 Chart types: Line |
| styles | Array.<(Object|String)> | The "styles" array allows you to style charts by node, or individual data point. Most often used with column and bar charts, the feature can be used to differentiate each node on a single series chart. You may also want to style charts by node index rather than series on a multi-series chart. Default Value: [] |
| target | String | Sets the target for the URL. Depending on its value, it either opens the URL or uses the content fetched from the URL (when target is graph=ID). Accepted Values: _blank, _top, _parent, _window=NAME, graph=ID Default Value: null |
| target | String | Sets the URL's target for the link associated with the object. Use with 'url'. Default Value: null |
| text | String | Sets the plot's name. Default Value: null |
| thickness | Number | Sets the thickness of the chart Default Value: -1 Chart types: 3D Pie |
| thousandsSeparator thousands-separator | String | When you set the 'thousands-separator': attribute, the punctuation which is used will be placed to separate digits which go into 1,000s, 10,000s, etc. When placed in the 'plot': { } object, this will only effect values which are pulled directly from the series data. Objects such as 'scale-y': { }, 'scale-x': { }, etc..., will need to be set separately. Default Value: null |
| tooltip | Object | Tooltips are the labels that appear when users hover over data points (or nodes) on your chart. Use this object to modify how they appear and what values, tokens, and/or text to display. Default Value: null |
| tooltipText tooltip-text | String | Using the 'tooltip-text' attribute allows you to set text for tooltips. This can also be done using a variety of tokens. Default Value: null |
| topLayer top-layer | String | Solution for crosshair z sorting with legend. Accepted Values: ['guide', 'legend'] Default Value: 'legend' Introduced in: v2.3.3 |
| topState top-state | ZCShape | Sets the style for a copy of the object which is placed above the object itself. Introduced in: v1.14.0 |
| trendDown trend-down | Object | Styles day with stock losses Chart types: Stock |
| trendEqual trend-equal | Object | Styles day with no stock gain or loss Chart types: Stock |
| trendUp trend-up | Object | Styles days with stock gains Chart types: Stock |
| type | String | Sets the type of the object/shape. Accepted Values: ['arc', 'arrow', 'circle', 'cross', 'diamond', 'ellipse','gear3', 'gear4', 'gear5', 'gear6', 'gear7', 'gear8', 'gear9', 'hamburger', 'line', 'parallelogram', 'pie','plus', 'poly', 'rect', 'rpoly3', 'rpoly4', 'rpoly5', 'rpoly6', 'rpoly7', 'rpoly8', 'rpoly9', 'square', 'star3', 'star4', 'star5', 'star6', 'star7', 'star8', 'star9', 'trapezoid', 'triangle'] Default Value: 'poly' |
| url | String | Sets an URL associated with this object. Used mostly on nodes/labels/shapes with their associated click events. Default Value: null |
| valueBox value-box | Object | Value boxes are the labels that appear next to or over data points (or nodes) on your chart. Use this object to modify how they appear and what values, tokens, and/or text to display. Default Value: null |
| visible | Boolean | Sets the visibility of the object. Allows you to turn off the object without removing lines of JSON. Default Value: true |
| width | Number | Sets the object's width. Default Value: 0 |
| x | Number | Sets the X position of the object. Default Value: -1 |
| y | Number | Sets the Y position of the object. |
| zIndex z-index | Number | Sets the z position of the object. Objects with higher z indexes will appear "above" those with lower z index values. Default Value: 1 |
| zIndex z-index | Number | Sets the z position of the object. Objects with higher z indexes will appear "above" those with lower z index values. Default Value: 0 |
| zSort z-sort | Number | Used to force the sorting of the active areas (which trigger the tooltip) of two shapes in case they overlap. Default Value: 1 |