Graphset

[ root » graphset ]

graphset is an array of graph objects. It allows you to render multiple graphs at once in the same area and gives you the ability to control the layout of your graphs as well as share interactions between the graphs.




AttributeTypeDescription
3daspect
3d-aspect
ObjectSets the 3D properties for 3D chart types. Allows you to change the viewing angle, chart depth, zoom level, and 3D engine type.
Chart types: 3D Charts
alphaNumberSets 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
anchorStringAllows you to set an object's anchor position
Accepted Values: ['tl', 'tr', 'bl', 'br', 'c', 't', 'r', 'b', 'l']
Default Value: 'tl'
angleNumberSets the rotation angle of the object/shape.
Default Value: 0
angleEnd
angle-end
NumberSets the end angle of a pie shape.
Default Value: 360
angleStart
angle-start
NumberSets the beginning angle of a pie shape.
Default Value: 0
animateType
animate-type
StringSets the animation routine on the chart. If set to 'initial', then the chart will ONLY animate on render. The chart will not animate on zoom and subsequent actions.
Accepted Values: ['initial', 'always']
Default Value: 'always'
arrowsArrayCreates a container to hold any number of chart arrow objects, which are great for drawing attention to a specific area of your chart.
Default Value: []
asyncBooleanPaints the graph's plots in an async mode, one by one with a small delay between each one, making the chart more responsive in case of a large number of plots.
Default Value: false
backgroundClip
background-clip
BooleanClips the background image to the margins of the shape/box.
Default Value: true
backgroundColor
background-color
StringSets 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
StringSets 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
StringSets 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
StringSets the direction/s on which the background image is being "stretched".
Default Value: ''
backgroundImage
background-image
StringSets a background image for the object. Value can be a local file or a web image's location.
Default Value: ''
backgroundPosition
background-position
StringSets the position of the background when the background-repeat value is no-repeat.
Default Value: '50% 50%'
backgroundRepeat
background-repeat
StringSets the repeating mode for the background image.
Default Value: 'repeat'
backgroundScale
background-scale
NumberScales the background image using the specified ratio.
Default Value: 1
borderString,NumberSets 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
NumberSets 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
StringSets the object's bottom border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderColor
border-color
StringSets the border color of the object.
Default Value: '#000'
borderLeft
border-left
StringSets the object's left border style. Accepts solid, dashed, and dotted styles.
borderRadius
border-radius
NumberSets 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
NumberSets 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
NumberSets 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
NumberSets 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
NumberSets 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
StringSets the object's right border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderTop
border-top
StringSets the object's top border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderWidth
border-width
NumberSets the border width of the object.
Default Value: 0
bottomState
bottom-state
ObjectSets the style for a copy of the object which is placed below the object itself.
Introduced in: v1.14.0
calloutBooleanSets whether an object will have a callout arrow or not.
Default Value: false
calloutExtension
callout-extension
NumberSets the length of the extension that extends beyond the tip of the callout arrow.
Default Value: 0
calloutHeight
callout-height
NumberSets 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
NumberSets 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
StringSets 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
ZCStyleTo 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
NumberSets the width of the object's callout arrow. A larger value will create a wider callout arrow.
Default Value: 8
centerRef
center-ref
BooleanSets the (0,0) x/y coordinates as the center of the box (instead of the top-left corner).
Default Value: false
classStringSets a class value on the object.
Default Value: null
crosshairX
crosshair-x
ObjectObject to style the x axis crosshair. Crosshairs are interactive labels that appear when users hover over the data points (or node values) on your chart.
Default Value: null
crosshairY
crosshair-y
ObjectObject to style the y axis crosshair. Crosshairs are interactive labels that appear when users hover over the data points (or node values) on your chart.
Default Value: null
csvObjectConfigure CSV import
csvStringAllows you to either import data from an external CSV file (and a few other similar file types) or import data using a data string within the JSON code.
Default Value: null
cursorStringSets the cursor shape when hovering over the object.
Default Value: 'auto'
Introduced in: v1.9.0
descriptionstringAllows you to set a specific description for your chart
fillAngle
fill-angle
NumberSets the angle of the axis along which the linear gradient is drawn.
Default Value: 90
fillOffsetX
fill-offset-x
NumberSets an X offset to apply to the fill.
Default Value: 0
fillOffsetY
fill-offset-y
NumberSets a Y offset to apply to the fill.
Default Value: 0
fillType
fill-type
String,NumberSets the background gradient fill type to either linear or radial.
Default Value: 'linear'
flatBooleanDisables the active area (used for tooltip) for the object.
Default Value: false
gradientColors
gradient-colors
StringSets 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
StringSets the gradient stops for a complex background gradient consisting of 2 or more colors. To be used with gradient-colors.
Default Value: ''
heightNumberSet the object's height.
Default Value: 0
idStringSets the id of the object.
Default Value: ''
idStringID of the shape
Default Value: ''
imagesArrayCreates a container to hold any number of chart image objects. Images can be styled and placed anywhere on a chart.
Default Value: []
itemStringSets the item id of the map on which the object/shape is being added.
Default Value: ''
labelsArrayStandalone chart labels can be used to display text, URLs, images, and more. When utilized with tokens, they become dynamic labels that users can interact with. To create them, use the `labels` array, which will act as the container for all of your label objects.
Default Value: []
legendObjectCreate a `legend` object to add a legend to your chart.
Default Value: null
lineCap
line-cap
StringSets the stroke-linecap attribute on SVGs
Accepted Values: ['butt', 'round', 'square']
Default Value: 'butt'
lineColor
line-color
StringSets 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,NumberCan 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
StringSets the stroke-linejoin attribute on SVGs
Accepted Values: ['round', 'miter']
Default Value: 'round'
lineSegmentSize
line-segment-size
String,NumberCan 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
StringSets the line style of the object.
Default Value: ''
lineWidth
line-width
NumberSets the line width of the object, applicable on non-closed shapes. See also border-width for closed shapes.
Default Value: 0
mapStringSets the map id of the map on which the object/shape is being added.
marginNumberSets the object's margin/s from the top-left of the chart.
Default Value: 0
marginBottom
margin-bottom
NumberSets the object's bottom margin.
Default Value: -1
marginLeft
margin-left
NumberSets the object's left margin.
Default Value: -1
marginRight
margin-right
NumberSets the object's right margin.
Default Value: -1
marginTop
margin-top
NumberSets the object's top margin.
Default Value: -1
mediaRules
media-rules
ObjectConfigure media rules
noData
no-data
ObjectNo Data attribute gives your charts the ability to let the user know when no graph data has been loaded into a chart. The look and size of the chart will be rendered, but the plotarea will be masked off.
Default Value: null
offsetR
offset-r
NumberSets an R offset to apply when positioning the object/shape.
Default Value: 0
offsetX
offset-x
NumberSets an X offset to apply when positioning the object/shape.
Default Value: 0
offsetY
offset-y
NumberSets a Y offset to apply when positioning the object/shape.
Default Value: 0
offsetZ
offset-z
NumberSets a Z offset to apply when positioning the object/shape.
Default Value: 0
optionsObjectObject to configure graph-specific properties
Chart types: Boxplot,Bubble-pack,Calendar,Chord,Depth,Multi-guide Module,Dragging Module,Flame,Grid,Heat-map,Interactive-maps,,Pareto,Pop-pyramid,Rankflow,Scorecard,Stream,Sunburst,Tilemap,,Tree-module,Treemap,Variwide,Vectorplot,Violin,Waterfall,Wordcloud,Zoom-buttons
pageNumberSets a page number for the current graph. At one moment, on a multi-graph graphset, only graphs with the same page will be displayed. By default all graphs are placed on first page (0) so they are all displayed.
paletteArray.Sets the color palette used for styling the chart.
plotObjectSet plot specific properties
plotArea
plotarea
ObjectAllows you to style the plotarea, which is the area directly behind a chart's plotted data. This area is delimited by the ends of the X and Y scales. To style the area outside of the scales, place the styling attributes within the main graph object.
Default Value: null
pointsArray.Sets the coordinates of the object/shape points.
Default Value: []
positionStringSets 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: ''
previewObjectPreview charts are a miniaturized version of the main chart, allowing users to zoom in and examine sections of a chart while still viewing it in its entirety. Use the `preview` object to style the object, active area, background area, and preview chart handles.
Default Value: null
rectShortcut
rect-shortcut
BooleanUsed 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
refreshObjectSets the chart's automated data refresh system.
Default Value: null
resourcesArrayPreload links using the resources attribute
scaleObjectConfigure scale
scaleK
scale-k
scaleKConfigure scale-k
scaleR
scale-r
ObjectConfigure scale-r
scaleV
scale-v
ObjectConfigure scale-v
scaleX
scale-x
ObjectConfigure scale-x
scaleY
scale-y
ObjectConfigure scale-y
scrollX
scroll-x
ObjectUse to style the bar and handle portions of the X scrollbar
Default Value: null
scrollY
scroll-y
ObjectUse to style the bar and handle portions of the Y scrollbar
Default Value: null
selectionBooleanEnables and disables selection
selectionArray.>Sets the initial selection state for chart nodes. The format is an array of arrays of node indexes, each set of node indexes corresponds to a plot.
seriesObjectSet series specific properties
shadowBooleanSets whether the object's shadow is visible or not. Has limited effect on HTML5 implementation.
Default Value: false
shadowAlpha
shadow-alpha
NumberSets 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
NumberSets the angle of the shadow underneath the object.
Default Value: 45
shadowBlur
shadow-blur
String,NumberSets the blur effect size for the shadow of the object. Has limited effect on HTML5 implementation.
Default Value: 0
shadowColor
shadow-color
StringSets the color of the shadow of the object.
Default Value: '#999'
shadowDistance
shadow-distance
String,NumberSets the distance between the shadow and the object.
Default Value: 2
shapesArrayAn array that contains objects defining chart shapes. Shapes can be styled and placed anywhere on a chart.
Default Value: []
sizeNumberSets the size of the object/shape.
Default Value: 0
size2
size-2
NumberSets the secondary size of the object/shape. Used on ellipses or rectangle shapes.
Default Value: 0
sliceNumberSets the radius of the inner ring of a pie shape.
Default Value: 0
sourceObjectPlaces a text label on a chart to indicate a data source. By default, the source will appear in the bottom right corner of a chart.
Default Value: null
stackType
stack-type
StringChanges the stacking logic for stacked charts.
Accepted Values: ['normal', '100%', ']
Default Value: 'normal'
stackedBooleanSetting 'stacked': true will take each of the 'series': [] value sets and stack them on top of one another
Default Value: false
subtitleObjectAllows you to include a chart subtitle that will, by default, appear just below a title (if one is included).
Default Value: null
targetStringSets 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
timeZone
time-zone
NumberTime-Series Charts only: To set the UTC timezone. Use with the 'utc' attribute and 'transform' object in the applicable scale object.
Default Value: 0
titleObjectDisplays a title across the top of the chart.
Default Value: null
tooltipObjectSets the definition for a tooltip object.
Default Value: null
topState
top-state
ZCShapeSets the style for a copy of the object which is placed above the object itself.
Introduced in: v1.14.0
typeStringSets 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'
typeStringSets the chart type
Default Value: ''
urlStringSets an URL associated with this object. Used mostly on nodes/labels/shapes with their associated click events.
Default Value: null
urlData
url-data
StringSets the url used for full http refresh feed.
Default Value: null
utcBooleanTime-Series Charts only: To set the chart to UTC time. Use with the 'timezone' attribute and 'transform' object in the applicable scale object.
Default Value: false
visibleBooleanSets the visibility of the object. Allows you to turn off the object without removing lines of JSON.
Default Value: true
widgetsObjectA way to extend default ZingChart functionality with object syntax.
widthNumberSets the object's width.
Default Value: 0
xNumberSets the X position of the object.
Default Value: -1
yNumberSets the Y position of the object.
zIndex
z-index
NumberSets the z position of the object. Objects with higher z indexes will appear "above" those with lower z index values.
Default Value: 1
zSort
z-sort
NumberUsed to force the sorting of the active areas (which trigger the tooltip) of two shapes in case they overlap.
Default Value: 1
zoomObjectChart zooming is an interactive chart feature that allows users to select a zoom area by clicking and dragging. Use the `zoom` object to style the zoom area, add zooming labels, turn on shared zooming, and more.
Default Value: null