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 opacity on the marker, with 0 being fully transparent and 1 being fully opaque. Note that decimal value requires the leading 0.
angleNumberSets the rotation angle of the object.
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'
arrowsArray.<Object>Creates 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. For patterns, the available patterns are: [`${string}`, 'PATTERN_BACKWARD_DIAGONAL', 'PATTERN_DARK_DOWNWARD_DIAGONAL', 'PATTERN_DARK_HORIZONTAL', 'PATTERN_DARK_UPWARD_DIAGONAL', 'PATTERN_DARK_VERTICAL', 'PATTERN_DASHED_DOWNWARD_DIAGONAL', 'PATTERN_DASHED_HORIZONTAL', 'PATTERN_DASHED_UPWARD_DIAGONAL', 'PATTERN_DASHED_VERTICAL', 'PATTERN_DIAGONAL_BRICK', 'PATTERN_DIAGONAL_CROSS', 'PATTERN_DIVOT', 'PATTERN_DOTTED_DIAMOND', 'PATTERN_DOTTED_GRID', 'PATTERN_FORWARD_DIAGONAL', 'PATTERN_HORIZONTAL', 'PATTERN_HORIZONTAL_BRICK', 'PATTERN_LARGE_CHECKER_BOARD', 'PATTERN_LARGE_GRID', 'PATTERN_LIGHT_DOWNWARD_DIAGONAL', 'PATTERN_LIGHT_HORIZONTAL', 'PATTERN_LIGHT_UPWARD_DIAGONAL', 'PATTERN_LIGHT_VERTICAL', 'PATTERN_NARROW_HORIZONTAL', 'PATTERN_NARROW_VERTICAL', 'PATTERN_OUTLINED_DIAMOND', 'PATTERN_PLAID', 'PATTERN_SHADE_25', 'PATTERN_SHADE_50', 'PATTERN_SHADE_75', 'PATTERN_SHINGLE', 'PATTERN_SMALL_CHECKER_BOARD', 'PATTERN_SMALL_GRID', 'PATTERN_SOLID_DIAMOND', 'PATTERN_SPHERE', 'PATTERN_TRELLIS', 'PATTERN_VERTICAL', 'PATTERN_WAVE', 'PATTERN_WEAVE', 'PATTERN_WIDE_DOWNWARD_DIAGONAL', 'PATTERN_WIDE_UPWARD_DIAGONAL', 'PATTERN_ZIGZAG'].
Accepted Values: ['PATTERN_BACKWARD_DIAGONAL', 'PATTERN_DARK_DOWNWARD_DIAGONAL', 'PATTERN_DARK_HORIZONTAL', 'PATTERN_DARK_UPWARD_DIAGONAL', 'PATTERN_DARK_VERTICAL', 'PATTERN_DASHED_DOWNWARD_DIAGONAL', 'PATTERN_DASHED_HORIZONTAL', 'PATTERN_DASHED_UPWARD_DIAGONAL', 'PATTERN_DASHED_VERTICAL', 'PATTERN_DIAGONAL_BRICK', 'PATTERN_DIAGONAL_CROSS', 'PATTERN_DIVOT', 'PATTERN_DOTTED_DIAMOND', 'PATTERN_DOTTED_GRID', 'PATTERN_FORWARD_DIAGONAL', 'PATTERN_HORIZONTAL', 'PATTERN_HORIZONTAL_BRICK', 'PATTERN_LARGE_CHECKER_BOARD', 'PATTERN_LARGE_GRID', 'PATTERN_LIGHT_DOWNWARD_DIAGONAL', 'PATTERN_LIGHT_HORIZONTAL', 'PATTERN_LIGHT_UPWARD_DIAGONAL', 'PATTERN_LIGHT_VERTICAL', 'PATTERN_NARROW_HORIZONTAL', 'PATTERN_NARROW_VERTICAL', 'PATTERN_OUTLINED_DIAMOND', 'PATTERN_PLAID', 'PATTERN_SHADE_25', 'PATTERN_SHADE_50', 'PATTERN_SHADE_75', 'PATTERN_SHINGLE', 'PATTERN_SMALL_CHECKER_BOARD', 'PATTERN_SMALL_GRID', 'PATTERN_SOLID_DIAMOND', 'PATTERN_SPHERE', 'PATTERN_TRELLIS', 'PATTERN_VERTICAL', 'PATTERN_WAVE', 'PATTERN_WEAVE', 'PATTERN_WIDE_DOWNWARD_DIAGONAL', 'PATTERN_WIDE_UPWARD_DIAGONAL', 'PATTERN_ZIGZAG', `${string}`]
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
Boolean, 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
borderNumberSets 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
NumberSets 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
NumberSets 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
NumberSets the object's right border style. Accepts solid, dashed, and dotted styles.
Default Value: ''
borderTop
border-top
NumberSets 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
bubbleLegend
bubble-legend
ObjectEnables legend for bubble charts.
Introduced in: v2.8.4
Chart types: Bubble Legend Module
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
chartObjectAllows 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
classStringSets a class value on the object.
Default Value: null
colorScale
color-scale
ObjectConfigure the color scale for a choropleth map
Introduced in: v2.8.4
Chart types: Interactive-maps
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
csvObject, StringImports data from external CSV (and few other similar file types). Accepts an object that configures the CSV import . Accepts url or path to CSV (String).
dataN
data-n
AnyPrefix attribute or array using "data-" to define a custom token.
descriptionStringSets a more detailed description for the plot.
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
StringSets the background gradient fill type to either linear or radial.
Accepted Values: ['linear', 'none', 'radial']
Default Value: 'linear'
globalsObjectSets styling attributes that apply globally across all charts in the `graphset` array.
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: ''
guideObjectUsed to style the lines and backgrounds behind the plotted data.
Default Value: null
heatmapObjectCustomizes the heatmap display and functionality.
Introduced in: v2.8.6
Chart types: Heatmap-plugin
heightNumberSets the object's height.
idStringSets the id of the object.
Default Value: ''
imagesArray.<Object>Creates a container to hold any number of chart image objects. Images can be styled and placed anywhere on a chart.
Default Value: []
Chart types: Pictograph
labelsArray.<Object>Sets the labels.
Default Value: []
legendObjectCreate a `legend` object to add a legend to your chart.
Default Value: null
maxTrackers
max-trackers
NumberSets 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.
mediaRules
media-rules
Array.<Object>Configure media rules.
navObjectConfiguration on navigation in pie charts
Introduced in: v1.0.0
Chart types: Pie,Nav Pie Chart,Nav Chart
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
offsetX
offset-x
NumberSets an x-offset to apply when positioning the object.
Default Value: 0
offsetY
offset-y
NumberSets an y-offset to apply when positioning the object.
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,Nav Chart,Pareto,Pop-pyramid,Rankflow,Scorecard,Stream,Sunburst,Tilemap,3D Toolbar,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.<String>, ObjectDefines a custom color palette to apply to chart.
plotObjectSet plot specific properties
plotareaObjectAllows 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
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.
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
resourcesArray.<Object>Preload links using the resources attribute.
scalableYAxis
scalable-y-axis
ObjectSets up click-and-drag scaling on y-axis. Requires explicitly loading the scalableyaxis module.
Introduced in: v2.6.1
scaleObjectConfigures scale.
scaleK
scale-k
ObjectConfigure scale-k.
scaleN
scale-n
ObjectConfigure `scale-n`. Only additional scales up to `scale-9` is supported. Setting `scale-n` styles all scales.
scaleR
scale-r
ObjectConfigure scale-r.
scaleRN
scale-r-n
ObjectConfigure `scale-r-n`. Only additional scales up to `scale-r-9` is supported. Setting `scale-r-n` styles all r-axis scales.
scaleV
scale-v
ObjectConfigure scale-v.
scaleX
scale-x
ObjectConfigure scale-x
scaleXN
scale-x-n
ObjectConfigure `scale-x-n`. Only additional scales `scale-x-9` is supported. Setting `scale-x-n` styles all y-axis scales.
scaleY
scale-y
ObjectConfigure scale-y
scaleYN
scale-y-n
ObjectConfigure `scale-y-n`. Only additional scales up to `scale-y-9` is supported. Setting `scale-y-n` styles all y-axis scales.
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
selectionArray.<Array.<Number>>, BooleanSets selection of the nodes on the chart. Sets the initial selection state for chart nodes. Accepts Array> of node indices, where each set of node indices corresponds to a plot (Array.>). Enables or disables selection on chart (Boolean).
selectionTool
selection-tool
ObjectStyles the mask of the selection area.
seriesArray.<Object>, ObjectSet series specific properties
shapesArray.<Object>An array that contains objects defining chart shapes. Shapes can be styled and placed anywhere on a chart.
Default Value: []
shapesArray.<Object>An array that contains objects defining chart map items to include in map chart.
Default Value: []
sortObjects
sort-objects
BooleanSet to false for a performance boost if there are no objects (with active areas) that overlap. Be default, sorts objects by size so that smaller ones are not obscured by larger objects.
Default Value: true
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
StringSets 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
themeStringSets the theme to apply to the chart(s).
Accepted Values: ['classic', 'dark', 'light', 'spark', `${string}`]
Default Value: 'light'
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
tooltipObjectConfigures the tooltip element, which appears when hovering over an object.
Default Value: null
topLayer
top-layer
StringSet to 'legend' to paint legend above crosshair elements. When crosshair(s) and legend are enabled, by default crosshair(s) are always on top.
Accepted Values: ['legend']
Default Value: ''
Introduced in: v2.3.3
typeStringSets the type of the object.
Accepted Values: ['area', 'area3d', 'bar', 'bar3d', 'boxplot', 'bubble', 'bubble-pack', 'bubble-pie', 'bullet', 'calendar', 'chord', 'depth', 'flame', 'funnel', 'gauge', 'grid', 'hbar', 'hbar3d', 'hboxplot', 'hbubble', 'hbullet', 'heatmap', 'hfunnel', 'hmixed', 'hscatter', 'hwaterfall', 'hwaterfall3d', 'line', 'line3d', 'mixed', 'mixed3d', 'navpie', 'nestedpie', 'null', 'pareto', 'piano', 'pie', 'pie3d', 'pop-pyramid', 'radar', 'rankflow', 'range', 'ring', 'ring3d', 'scatter', 'scorecard', 'stock', 'stream', 'sunburst', 'tilemap', 'tree', 'treemap', 'varea', 'variwide', 'vbar', 'vbar3d', 'vbullet', 'vectorplot', 'venn', 'vfunnel', 'vline', 'vrange', 'vstream', 'waterfall', 'waterfall3d', 'wordcloud', 'zingchart.maps']
Default Value: ''
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
widgetObjectType of the widget. The zingchart.widgets.myWidget object must exist and define a parse method returning an object with graphs, labels, and shapes collections which will be injected in the original JSON.
widgetsArray.<Object>, ObjectA way to extend default ZingChart functionality with object syntax.
widthNumberSets the object's width.
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
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