Build fast and powerful charts with ZingChart and jQuery
npm install zingchart-jqueryIntro
-----
Before we get started with this wrapper, it'd be a good idea to familiarize yourself with the ZingChart library. There's even a tutorial for creating your first chart with ZingChart. It should get you up to speed on how this library works.
Looking for more info? Check out any of the below tutorials to get up to speed on the ZingChart library or dig into our docs pages.
Tutorials
+ Your First Chart
+ Basic Scale Configuration
+ Improving Data Indicators
+ Adding Style
+ Calling Attention
+ Customizing the Context-Menu
+ Using Data From a Database
Basics
------
Step One is to make sure you have jQuery loaded. This wrapper won't work without it.
Step Two is to have the ZingChart library loaded. We suggest you use our new, fandangled CDN to keep up to date with the latest build.
Step Three is to have this library loaded. Again, in order to stay up to date with the latest build, we suggest using our CDN.
Here's what should be in the ``` once you're done.
`html`
All good? Time to make some sweet charts.
The ZingChart jQuery wrapper works just like normal jQuery. Each method or event is tacked on to the standard jQuery selector method. All methods should be placed inside a ` $(document).ready() ` call to ensure the DOM is fully loaded. Here's an example of creating a ZingChart object on a div with an ID of "myChart":
`javascript`
$(document).ready(function() {
$("#myChart").zingchart({
"data":{
"type": "line",
"series": [
{
"values": [1,2,5,3,9,4]
}
]
}
});
})
> For the sake of brevity, the rest of the examples will omit the $(document).ready() ` wrapper. That being said, you still need to include it when using this library.
All of the methods which take an object as a parameter can have it passed through directly or by reference. Both are equivalent.
Directly
`javascript`
$("#myChart").zingchart({
"data": {
"type": "bar",
"series": [
{
"values": [3,7,9,2]
}
]
}
});
Referencejavascript
var myData = {
"type": "bar",
"series": [
{
"values": [3,7,9,2]
}
]
};
$("#myChart").zingchart({data: myData});
`
Woohoo! Congrats! You've just made your first ZingChart. Pretty straightforward, isn't it? Now we get into the nitty gritty of the API: how to make your chart do stuff.
Chaining
--------
One of the more user-friendly aspects of jQuery is the chaining of functions, allowing for users to specify the target once but call multiple functions that affect it. This wrapper supports chaining for any methods or events that return a jQuery object. For example, say you want to set a chart to the 3D view and resize it. Instead of calling each method on the chart separately, you could chain them like this:
`javascript`
$("#myChart").set3dView({"y-angle":10}).resizeChart({"width":600,"height":400});
$("#myChart") is now set to a 3D view and resized in just one line of code!
Pat yourself on the back for saving time by using chaining. You're a rockstar!
An Important Note: many of the event functions may be very similar in name to the method functions and vice versa. This is intentional. The differentiation between the method functions and the event functions is that the method functions always start with a verb: the action they're performing, while the event functions always start with a noun: the object they're watching.
Examples
--------
1. Chart Manipulation: Using Methods and Events Together
Check out this example to see how to make a chart with lots of plots into an interactive and much more legible chart. Edit in JSFiddle
---
2. Chart to DOM: Manipulating the DOM with Events
Learn how to manipulate the DOM through the use of ZingChart jQuery events. Edit in JSFiddle
---
3. DOM to Chart: Manipulating the Chart with Methods
This is a great first example if you're looking to learn how to integrate ZingChart jQuery methods with standard DOM input elements. Edit in JSFiddle
---
4. AJAX Data: Using Asynchronous Data with your Chart
No need to load your data at once. Check out this example to see how to get started with AJAX and the ZingChart jQuery wrapper. Edit in JSFiddle
---
5. Table to Chart: Using the Zingify Tool
Take your well-formed HTML tables and turn them into snazzy charts with ease. Edit in JSFiddle
---
Questions?
----------
Check out out extensive documentation below or feel free to email us at support@zingchart.com if you have any questions.
#### .zingchart( object ) ####
Creates a new ZingChart object
Values | Type | Details
--- | --- | ---
Parameter | Object | ZingChart Object
Return | jQuery | jQuery Object
Rendering a chart
`javascript`
$("#myChart").zingchart({
"type": "line",
"title": {
"text": "Hello, ZingChart World!"
},
"series": [
{
"values": [5, 10, 15, 5, 10, 5]
}
]
});
Values | Type | Details
--- | --- | ---
Parameter | Object | Node Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").addNode({
"plotindex": 1,
"nodeindex": 2,
"value": 12
});
#### .addPlot( object ) ####
Adds a new plot to an exising chart
Values | Type | Details
--- | --- | ---
Parameter | Object | Plot Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").addPlot({
"plotindex": 0,
"data": {
"values": [10,20,15]
}
});
#### .appendSeriesData( object ) ####
Appends data to the existing series. Can be used on a single plot or the whole series. Note that the value arrays sent do not concatenate the existing ones.
Values | Type | Details
--- | --- | ---
Parameter | Object | Series Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").appendSeriesData({
"plotindex": 0,
data: {
"lineColor": "red"
}
});
#### .appendSeriesValues( object ) ####
Appends data to the end of a plot. Can be used on a single plot or the whole series.
Values | Type | Details
--- | --- | ---
Parameter | Object | Series Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").appendSeriesData({
"plotindex": 1,
"values": [19,28,13,42]
});
#### .getSeriesData( object ) ####
Returns the series data. If a series object is passed through, the data for that series is returned. If no argument is passed through, the data for every series of the chart is returned.
Values | Type | Details
--- | --- | ---
Parameter | Object (OPTIONAL) | Series Object
Return | Object | Series Object
`javascript
var myData = $("#myChart").getSeriesData({
"plotindex": 1
});
// myData = the series data for plot[1] of the chart
var allData = $("#myChart").getSeriesData();
// allData = the series data for all plots of the chart
`
#### .getSeriesValues( object ) ####
Returns the series values. If a series object is passed through, the values for that series are returned. If no argument is passed through, the values for every series of the chart are returned concatenated in order from the first plot to the last plot.
Values | Type | Details
--- | --- | ---
Parameter | Object (OPTIONAL) | Series Object
Return | Object | Series Object
`javascript
var myValues = $("#myChart").getSeriesValues({
"plotindex": 0
});
// myValues = the series values for plot[0] of the chart
var allValues = $("#myChart").getSeriesValues();
// allValues = the series values for all plots of the chart
`
#### .modifyPlot( object ) ####
Modifies an existing plot on the chart specified by plotindex.
Values | Type | Details
--- | --- | ---
Parameter | Object | Plot Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").modifyPlot({
"plotindex": 0,
"data": {
"lineWidth": 2,
"lineColor": "yellow",
}
});
#### .removeNode( object ) ####
Removes a node specified by plotindex and nodeindex.
Values | Type | Details
--- | --- | ---
Parameter | Object | Node Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").removeNode({
"plotindex": 1,
"nodeindex": 2
});
#### .removePlot( object ) ####
Removes a plot specified by plotindex.
Values | Type | Details
--- | --- | ---
Parameter | Object | Plot Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").removePlot({
"plotindex": 0
});
#### .set3dView( object ) ####
Sets the new 3D parameters for the view. This overrides the settings from the 3d-aspect attribute of the chart.
Values | Type | Details
--- | --- | ---
Parameter | Object | 3D View Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").set3dView({
"y-angle": 10,
"depth": 60
});
#### .setNodeValue( object ) ####
Changes the value of a single node specified via plotindex and nodeindex to the new value.
Values | Type | Details
--- | --- | ---
Parameter | Object | Node Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").setNodeValue({
"plotindex": 1,
"nodeindex": 2,
"value": 22
});
#### .setSeriesData( object ) ####
Replaces the series data. It can be used on one plot or the whole series depending on if plotindex is set.
Values | Type | Details
--- | --- | ---
Parameter | Object | Series Object
Return | jQuery | jQuery Object
Setting the series data for a single plot:
`javascript`
$("#myChart").setSeriesData({
"plotindex": 1,
"data" : {
"values": [12, 33, 20],
"lineColor": "red"
}
});
Setting the series data for all plots:
`javascript`
$("#myChart").setSeriesData({
"data": [
{
"values": [10,15,20],
"lineColor": "blue"
},
{
"values": [12,17,10],
"lineColor": "pink"
}
]
});
#### .setSeriesValues( object ) ####
Replaces the series values. It can be used on one plot or the whole series depending on if plotindex is set.
Values | Type | Details
--- | --- | ---
Parameter | Object | Series Object
Return | jQuery | jQuery Object
Setting the series values for a single plot:
`javascript`
$("#myChart").setSeriesValues({
"plotindex": 1,
"values": [99,98,97]
});
Setting the series values for all plots:
`javascript`
$("#myChart").setSeriesValues({
"values": [
[19,28,13,42],
[37,11,27,25]
]
});Export ###
#### .exportData() ####
Exports the current data for the chart. This only works if the exportdataurl is set in the render options.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").exportData();
//Assuming the exportdataurl is set in the render options, the current data for the chart will be exported to that url.
#### .getImageData( string ) ####
Returns a Base64 encoded image string of the current chart.
Values | Type | Details
--- | --- | ---
Parameter | String | "png", "jpg", "bmp" (only if rendering in Flash)
Return | jQuery | jQuery Object
`javascript
$("#myChart").getImageData("png");
// or...
$("#myChart").getImageData("jpg");
// or (if you're rendering via Flash)...
$("#myChart").getImageData("bmp");
`
#### .print() ####
Creates a printable version of the chart and attempts to print it.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
// Results in the printer dialog opening on the page
$("#myChart").print();
#### .saveAsImage() ####
Produces an image of the graph. This will only work if the exportimageurl is set in the render options.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
// Assuming the exportimageurl is set in the render options, an image of the current chart will be exported to that url.
$("#myChart").saveAsImage();
Values | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").clearFeed();
#### .getInterval() ####
Returns the current interval value set on the feed.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | Number | Seconds (1,2,..) or Miliseconds (100,200,...)
`javascript`
var myInterval = $("#myChart").getInterval();
#### .setInterval( number ) ####
Sets the feed update interval on a feed graph.
Values | Type | Details
--- | --- | ---
Parameter | Number | Seconds (1,2,...) or Miliseconds (100,200,...)
Return | jQuery | jQuery Object
`javascript`
$("#myChart").setInterval(500);
// Sets the feed update interval to 500ms (1/2 sec)
#### .startFeed() ####
Starts the data feed of the chart.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").startFeed();
#### .stopFeed() ####
Stops the data feed of the chart.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").stopFeed();
Values | Type | Details
--- | --- | ---
Parameter | Object (OPTIONAL) | Graph Object
Return | String | The chart type in lowercase ("line", "pie", "area",...)
`javascript
var myType = $("#myChart").getChartType();
// myType = the type of the chart at #$("#myChart")
var indexOneType = $("#myChart").getChartType({
"graphid": 1
});
// indexOneType = the type of the chart at index 1 of #$("#myChart")
`
#### .getData() ####
Returns the entire JSON for the chart. All of it. Every single nugget of info.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | Object | Chart Data Object
#### .getEditMode() ####
Returns 'true' if the user is in edit more for the chart or 'false' if not.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | Boolean | true if in edit more, false if not
`javascript
if ( $("#myChart").getEditMode() ) {
alert("I am editing my chart")
}
// If we were in edit more on the chart, the alert would fire.
`
#### .getGraphLength() ####
Returns the number of graph objects in the chart.
Values | Type | Details
--- | --- | ---
Parameter | |
Return | Number | 1,2,...
`javascript
var numberOfGraphs = $("#myChart").getGraphLength();
// numberOfGraphs = the number of graph objects in the chart
`
#### .getNodeLength( object ) ####
Returns the number of nodes in a plot specified by plotindex. If no object is passed, the function returns the number of nodes in the 0 index plot.
Values | Type | Details
--- | --- | ---
Parameter | Object (OPTIONAL) | Plot Object
Return | Number | 1,2,...
`javascript
var numberOfNodes = $("#myChart").getNodeLength();
// numberOfNodes = the number of nodes in the 0 index plot
var nodesInPlot = $("#myChart").getNodeLength({
"plotindex": 1
});
// nodesInPlot = the number of nodes in the plot at index 1
`
#### .getNodeValue( object ) ####
Returns the value of the node specified by plotindex and nodeindex.
Value | Type | Details
--- | --- | ---
Parameter | Object | Node Object
Return | Number | 1,2,...
`javascript`
var myValue = $("#myChart").getNodeValue({
"plotindex": 1,
"nodeindex": 5
});
#### .getObjectInfo( object ) ####
Returns various attributes for specific chart elements (graph, plotarea, scale, plot, node). Depending on the object passed, a subset of the following attributes will be returned:
`x, y, width, height, lineColor, lineWidth, borderColor, borderWidth, backgroundColor1, backgroundColor2, text, values, minValue, maxValue, step, stepSize`
Value | Type | Details
--- | --- | ---
Parameter | Object | Info Object
Return | Object | Dependent on targeted object
`javascript
$("#myChart").getObjectInfo({
"object": "graph"
});
// This would return all the object info available for the graph object.
`
#### .getPlotLength( object ) ####
Returns the number of plots in a given graph. If graphid* is specified, the number of plots for that graph are returned.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | Graph ID Object
Return | Number | 1,2,...
`javascript
var myPlotLength = $("#myChart").getPlotLength();
// myPlotLength would then equal the number of plots in $("#myChart")
`
#### .getPlotValues( object ) ####
Returns the value of the plot specified by plotindex.
Value | Type | Details
--- | --- | ---
Parameter | Object | Plot Object
Return | Array | ex: [12,23,45]
`javascript
var myPlotValues = $("#myChart").getPlotValues({
"plotindex": 0
});
// myPlotValues = the array of values for the plot at index 0.
`
#### .getRender() ####
Returns the render mode for the chart.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | String | "svg", "canvas", "vml"
`javascript
var myRenderMode = $("#myChart").getRender();
// myRenderMode = the render more of $("#myChart")
`
#### .getRules( object ) ####
Returns an array containing the ids of the existing rules in the chart, specified by plotindex.
Value | Type | Details
--- | --- | ---
Parameter | Object | Plot Object
Return | Array | ["rule1", "rule2"]
`javascript
var myRules = $("#myChart").getRules({
"plotindex": 0
});
myRules = the rules for the plot at index 0.
`
#### .getVersion() ####
Returns the version of the library you're currently running. This is usefulf for debugging and good information to provide if you need to contacting support.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | String | ex: "0.141015pre"
`javascript
var myVersion = $("#myChart").getVersion();
// myVersion = the version of the library you're currently running.
`
#### .getXYInfo( object ) ####
Returns various scale and node related information based on x and y positions in the chart. The returned data is an array of object holding information relative to key scales, value scales, and node proximity.
Value | Type | Details
--- | --- | ---
Parameter | Object | XY Coords.
Return | Array | [Object1, Object2, ...]
`javascript
var myXYInfo = $("#myChart").getXYInfo({
x: 100,
y: 200
});
// myXYInfo = an array of information relative to the XY coordinates.
`
Value | Type | Details
--- | --- | ---
Parameter | Object | Scale Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").addScaleValue({
"scale": "scale-x",
"nodeindex": 4,
"value": 23
});
#### .destroy() ####
Destroys the chart, removing the associated DOM nodes and events. This is the recommended way to remove a chart from a page.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript
$("#myChart").destroy();
// ZingChart jQuery Wrapper uses 'destroy'. It's super effective!
`
#### .loadNewData( string ) ####
Loads a new JSON packet from a URL.
Value | Type | Details
--- | --- | ---
Parameter | String | 'newjson.php', 'somedata.php', etc.
Return | jQuery | jQuery Object
`javascript`
$("#myChart").loadNewData("awholenewdata.php");
#### .modify( object ) ####
Modifies any part of the current graph that you specify in the passed object.
Value | Type | Details
--- | --- | ---
Parameter | Object | Modify Data Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").modify({
"data": {
"title": {
"text": "Supermodified"
},
"subtitle": {
"text": "by Amon Tobin"
}
}
});
// The title of $("#myChart") is now "Supermodified" and the subtitle is now "by Amon Tobin"
`
#### .reloadChart( object ) ####
If an object is passed through specifying the graphid of a graph, only that graph will be reloaded. If no object is passed through, the entire chart is reloaded.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | Graphset Object
Return | jQuery | jQuery Object
Reloading the entire chart.
`javascript`
$("#myChart").reloadChart();
Reloading a single graph of the chart.
`javascript`
$("#myChart").reload({
"graphid": 0
});
#### .removeScaleValue( object ) ####
Removes a value from the scale specified by the scale and the nodeindex.
Value | Type | Details
--- | --- | ---
Parameter | Object | Scale Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").removeScaleValue({
"scale": "scale-x",
"nodeindex": 4
});
// The scale value at index 4 on the x-axis has now been removed.
`
#### .resizeChart( object ) ####
Resizes the chart according to new dimensions set by the width and height. For pixel-based widths and heights, you can just use a number (i.e. 600 instead of "600px"). For percentages, you'll need to use a string (i.e. "100%").
Value | Type | Details
--- | --- | ---
Parameter | Object | Size Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").resize({
"width": 600,
"height": 400
});
// Wha-Bam! Your chart is now 600px wide and 400px tall.
`
#### .setData( object ) ####
Takes a full JSON packet to replace the current one. Like the .zingchart() method, you can pass the object through directly or by reference.
Value | Type | Details
--- | --- | ---
Parameter | Object | Data Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").setData({
"data": {
"type": "bar",
"title": {
"text": "A whole new chart"
},
"subtitle": {
"text": "A new fantastic point of view"
},
"series": [
{
"values": [1,2,3,4,5,6,7]
}
]
}
});
#### .update() ####
Flushes and applies all queued data manipulation changes set via API calls.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").update();
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").goBack();
#### .goForward() ####
Goes forward one page in the chart history. This is very useful for navigating drilldown charts.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").goForward();
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | Added Node Object
Return | jQuery | jQuery Object
For a non-bubble graph
`javascript`
$("#myChart").addNodeIA();
For a bubble graph
`javascript`
$("#myChart").addNodeIA({
"size": 10
});
#### .enterEditMode( object ) ####
Turns on interactive mode, allowing the selection of a node or plot by clicking on it. The object need only be passed through if you wish you specify a graph in the graphset for which you wish to turn on edit mode.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | Graph ID
Return | jQuery | jQuery Object
`javascript`
$("#myChart").enterEditMode();
#### .exitEditMode( object ) ####
Deselects the previously selected plot or node when interactive mode is on and exits interactive mode. The object need only be passed through if you wish to specify a graph in the graphset for which you wish to turn off edit mode.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | Graph ID
Return | jQuery | jQuery Object
`javascript`
$("#myChart").exitEditMode();
#### .removeNodeIA( object ) ####
Removes a node selected in interactive mode. The object need only be passed through if you wish to specify a graph in the graphset for which you wish to remove a selected node.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | Graph ID
Return | jQuery | jQuery Object
`javascript`
$("#myChart").removeNodeIA();
#### .removePlotIA( object ) ####
Removes a plot selected in interactive mode. The object need only be passed through if you wish to specify a graph in the graphset for which you wish to remove a selected plot.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | Graph ID
Return | jQuery | jQuery Object
`javascript`
$("#myChart").removePlotIA();
Requires the zingchart-html5-api-annotations-min.js module
*
#### .addNote( object ) ####
Adds a note to a chart. The id of the note allows it to be updated or removed later.
Value | Type | Details
--- | --- | ---
Parameter | Object | Note Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").addNote({
"id": "note1",
"type": "node",
"text": "I am a note. Hear me roar.",
"plotindex": 0,
"nodeindex": 3,
"style": {
"background-color": "#F90"
}
});
#### .removeNote( string OR array) ####
Removes a note, specified by id from a chart. If you wish to remove a single note, pass just the id of that note as a string. If you wish to remove multiple notes, pass an array of the ids of the notes you wish to remove.
Value | Type | Details
--- | --- | ---
Parameter | String OR Array | Note Name or Note Array
Return | jQuery | jQuery Object
Removing a single note
`javascript`
$("#myChart").removeNote("note1");
Removing multiple notes
`javascript`
$("#myChart").removeNote(["note1","note2","note3"]);
#### .updateNote( object ) ####
Updates an existing note specified by the id of the passed note object. The note's position can be moved, the type can be changed, the style can be modified, and much more.
Value | Type | Details
--- | --- | ---
Parameter | Object | Node Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").updateNote({
"id": "note1",
"style": {
"border-color": "#F7A93E"
},
"type": "node",
"text": "I have been updated."
});
Value | Type | Details
--- | --- | ---
Parameter | Object | Shape/Label Object
Return | jQuery | jQuery Object
Adding a single object
`javascript`
$("#myChart").addObject({
"type": "label",
"data": {
"id": "label1",
"text": "Made in San Diego",
"x": 200,
"y": 100
}
});
Adding multiple objects
`javascript`
$("#myChart").addObject({
"type": "shape",
"data":[
{
"id": "shape1",
"x": 100,
"y": 200,
"type": "circle",
"size": 20,
"label": {
"text": "I AM A CIRCLE!"
}
},
{
"id": "shape2",
"x": 200,
"y": 300,
"type": "star5",
"size": 15,
"label": {
"text": "I AM A STAR!"
}
}
]
})
#### .removeObject( object ) ####
Removes one or more objects (labels or shapes) from the chart.
Adds one or more objects (labels or shapes) on the chart. Single objects are passed through with to the id attribute. Multiple objects are passed through as an array of objects to the id attribute.
Value | Type | Details
--- | --- | ---
Parameter | Object | Shape/Label Object
Return | jQuery | jQuery Object
Removing a single object
`javascript`
$("#myChart").removeObject({
"type": "label",
"id": "label1"
});
Removing multiple objects
`javascript`
$("#myChart").removeObject({
"type": "shape",
"id": ["shape1","shape2"]
});
#### .repaintObjects( object ) ####
Repaints the entire object collection that was called with update set to false in the options. It's useful for deferring object changes if you want all the changes to appear at once.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | GraphID Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").repaintObjects();
#### .updateObject( object ) ####
Updates one or more objects (labels or shapes) of the chart. Single objects are passed through within the data object. Multiple objects are passed through as an array of objects within the data object.
Value | Type | Details
--- | --- | ---
Parameter | Object | Shape/Label Object
Return | jQuery | jQuery Object
Updating a single object
`javascript`
$("#myChart").updateObject({
"type": "label",
"data": {
"id": "label1",
"background-color": "pink"
}
});
Updating multiple objects
`javascript`
$("#myChart").updateObject({
"type": "shapes",
"data": [
{
"id": "shape1",
"type": "square",
"label": {
"text": "I AM A SQUARE!"
}
},
{
"id": "shape2",
"type": "square",
"label": {
"text": "¡SOY UN CUADRADO!"
}
}
]
});
Value | Type | Details
--- | --- | ---
Parameter | Object | Label Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").addLabel({
"id": "label1",
"text":"Donde esta la biblioteca?",
"font-size":"20px",
"color":"white",
"background-color":"pink",
"x":20,
"y":20
});
Requires the zingchart-html5-api-rules-min.js module
*
#### .addRule( object ) ####
Adds a rule to a chart, applying the effect to any node that meets the conditions. The rules make use of the various tokens that ZingChart has available. Visit here to see the full range of available tokens (be warned: there are lots).
Value | Type | Details
--- | --- | ---
Parameter | Object | Rule Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").addRule({
"id": "rule1",
"plotindex": 0,
"rule": "%node-value < 50",
"style": {
"background-color": "#FF0"
}
});
// Now, any nodes with a value below 50 will have a background color of #FF0. Pretty simple!
`
#### .removeRule( object ) ####
Removes either a single rule or a series of rules from a chart.
Value | Type | Details
--- | --- | ---
Parameter | Object | Rule Object
Return | jQuery | jQuery Object
Removing a single rule.
`javascript
$("#myChart").removeRule({
"id": "rule1"
});
// Poof. Rule1 is gone.
`
Removing multiple rules.
`javascript`
$("#myChart").removeRule({
"id": ["rule1","rule2",...]
});
#### .updateRule( object ) ####
Update an existing rule, specified by the id and the plotindex if there are multiple plots.
Value | Type | Details
--- | --- | ---
Parameter | Object | Rule Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").updateRule({
"id": "rule1",
"plotindex": 0,
"style": {
"background-color": "#F00 #00F"
}
});
// rule1 on plotindex 0 now has a background gradient from red to blue
`
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | GraphID Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").clearSelection();
// Any nodes specified by selection are now deselected.
`
#### .deselect( object ) ####
Deselects a combination of nodes in the chart specified by plotindex and nodeindex. Both the nodeindex and plotindex can be specified individually (0), as a range ("0-3"), or as a group ([0,2,6]).
Value | Type | Details
--- | --- | ---
Parameter | Object | Select Object
Return | jQuery | jQuery Object
Deselecting from a single plot.
`javascript
$("#myChart").deselect({
"plotindex":0,
"nodeindex":"1-3"
});
// Nodes at index 1-3 in plot 0 have been deselected.
`
Deselecting from multiple plots.
`javascript
$("#myChart").deselect([
{
"plotindex":0,
"nodeindex":[0,2]
},
{
"plotindex":1,
"nodeindex":1
}
]);
// Nodes at index 0 and 2 in plot 0 and the node at index 1 in plot 1 have been deselected.
`
#### .getSelection( object ) ####
Returns the current node(s) selected.
Value | Type | Details
--- | --- | ---
Parameter | Object (optional) | GraphID Object
Return | jQuery | jQuery Object
`javascript`
mySelection = $("#myChart").getSelection();
#### .select( object ) ####
Sets a combination of nodes in the chart if selected. If toggle is true, then the nodes already selected will be deselected. Both the nodeindex and plotindex can be specified individually aa number (0), as a range in a string ("0-3"), or as a group in an array ([0,2,6]).
Value | Type | Details
--- | --- | ---
Parameter | Object | Select Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").select({
[
{
"plotindex":0,
"nodeindex":[0,2]
},
{
"plotindex":1,
"nodeindex":3
}
]
})
#### .setSelection( object ) ####
Another method setting node selection of the chart. Selection is passed as an array of arrays where each array corresponds to a plotindex of the chart and each number in the array corresponds to a nodeindex in that plot.
Value | Type | Details
--- | --- | ---
Parameter | Object | Select Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").setSelection({
"selection": [
[1,2],
[0,3]
]
});
// The nodes at index 1 and 2 of plot index 0 are now selected as are the nodes at 0 and 3 of plot index 1.
`
Value | Type | Details
--- | --- | ---
Parameter | String (optional) | Disable Message
Return | jQuery | jQuery Object
`javascript
$("#myChart").disable("Waiting on the world to change...");
// Disclaimer: you don't have to use John Mayer lyrics in your disable message but no one would fault you if you did.
`
#### .enable() ####
Enables a chart for user interactions, turning off the disabled attribute.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").enable();
#### .fullscreen() ####
Randers the chart in fullscreen. Can be exited with .exitFullscreen() or hitting the escape key.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").fullscreen();
#### .exitFullscreen() ####
Destroys the fullscreen render of the chart.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").exitFullscreen();
#### .maximizeLegend() ####
Maximizes the legend.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").maximizeLegend();
#### .minimizeLegend() ####
Minimizes the legend.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").minimizeLegend();
#### .showMenu() ####
Shows the context menu.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").showMenu();
#### .hideMenu() ####
Hides the context menu.
Value | Type | Details
--- | --- | ---
Parameter | |
Return | jQuery | jQuery Object
`javascript`
$("#myChart").hideMenu();
#### .showPlot( object ) ####
Shows the plot specified by plotindex or plotid.
Value | Type | Details
--- | --- | ---
Parameter | Object | Plot Index Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").showPlot({
"plotindex": 1
});
#### .showAllPlots( object ) ####
Shows ALL plots. Takes an optional object as a parameter than can specify a graphid.
Value | Type | Details
--- | --- | ---
Parameter | Object | Graph ID Object
Return | jQuery | jQuery Object
Show all plots for all graphs.
`javascript`
$("#myChart").showAllPlots();
Show all plots for a specific graph.javascript`
$("#myChart").showAllPlots({
graphid: "graph1"
});
#### .showAllPlotsBut( object ) ####
> This won't have a visible effect unless some charts have been hidden.
Shows ALL plots EXCEPT the plotindex you specify.
An optional graphid attribute can be passed as well to affect only that graph.
Value | Type | Details
--- | --- | ---
Parameter | Object | Specify the plotindex (required) and the graphid (optional)
Return | jQuery | jQuery Object
Show all plots except plotindex 0 for all graphsets.
`javascript`
$("#myChart").showAllPlotsBut({
plotindex: 0
});
Show all plots except plotindex 0 for graphid "graph0".
`javascript`
$("#myChart").showAllPlotsBut({
graphid: "graph0",
plotindex: 0
});
#### .hidePlot( object ) ####
Hides the plot specified by plotindex or plotid.
Value | Type | Details
--- | --- | ---
Parameter | Object | Plot Index Object
Return | jQuery | jQuery Object
`javascript`
$("#myChart").hidePlot({
plotindex: 1
});
#### .hideAllPlots( object ) ####
Hides ALL plots. Takes an optional object as a parameter than can specify a graphid.
Value | Type | Details
--- | --- | ---
Parameter | Object | Graph ID Object
Return | jQuery | jQuery Object
Hide all plots for all graphs.
`javascript`
$("#myChart").hideAllPlots();
Hide all plots for a specific graph.javascript`
$("#myChart").hideAllPlots({
graphid: "graph1"
});
#### .hideAllPlotsBut( object ) ####
Hides ALL plots EXCEPT the plot index you specify via the attribute plotindex.
An optional graphset can be set via the attribute graphid.
Value | Type | Details
--- | --- | ---
Parameter | Object | Specify the plotindex (required) and the graphid (optional)
Return | jQuery | jQuery Object
Hide all plots across all graphsets except plotindex 0
`javascript`
$("#myChart").hideAllPlotsBut({
plotindex: 0
});
Hide all plots on the graphid "graph0" except plotindex 0
`javascript`
$("#myChart").hideAllPlotsBut({
graphid: "graph0",
plotindex: 0
});
#### .toggleAbout() ####
Toggle the 'About' screen on and off.
Value | Type | Details
--- | --- | ---
Return | jQuery | jQuery Object
`javascript`
$("#myChart").toggleAbout();
#### .toggleBugReport() ####
Toggle the 'Bug Report' screen on an off.
Value | Type | Details
--- | --- | ---
Return | jQuery | jQuery Object
`javascript`
$("#myChart").toggleBugReport();
#### .toggleDimension() ####
For graphs with the option of 3D mode, toggles between 2D and 3D.
Value | Type | Details
--- | --- | ---
Return | jQuery | jQuery Object
`javascript`
$("#myChart").toggleDimension();
#### .toggleLegend() ####
Toggle the visibility of the legend.
Value | Type | Details
--- | --- | ---
Return | jQuery | jQuery Object
`javascript`
$("#myChart").toggleLegend();
#### .toggleLens() ####
Toggle the visibility of the lens.
Value | Type | Details
--- | --- | ---
Return | jQuery | jQuery Object
`javascript`
$("#myChart").toggleLens();
#### .toggleSource() ####
Toggle the visibility of the View Source Screen.
Value | Type | Details
--- | --- | ---
Return | jQuery | jQuery Object
`javascript`
$("#myChart").toggleSource();
Value | Type | Details
--- | --- | ---
Return | jQuery | jQuery Object
`javascript`
$("#myChart").viewAll();
#### .zoomIn( object ) ####
Zooms in the graph. zoomx and zoomy allow you to determine which scales will zoom by setting them to `true` or `false`.
Value | Type | Details
--- | --- | ---
Parameter | Object | Zoom Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").zoomIn({
"zoomx": true,
"zoomy": false
});
// The chart will now zoom in only by scaling the x-scale.
`
#### .zoomOut( object ) ####
Zooms out the graph. zoomx and zoomy allow you to determine which scales will zoom out by setting them to `true` or `false`.
Value | Type | Details
--- | --- | ---
Parameter | Object | Zoom Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").zoomOut({
"zoomx": false,
"zoomy": true
});
// The chart will now zoom out only by scaling the y-scale.
`
#### .zoomTo( object ) ####
Zooms to a specific area in a graph specified by xmin, xmax, ymin, ymax.
Value | Type | Details
--- | --- | ---
Parameter | Object | Zoom To Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").zoomTo({
"xmin": 10,
"xmax": 30,
"ymin": 12,
"ymax": 17
});
// The chart will now be zoomed in to show
// values 10 through 30 on the x-scale and
// values 12 through 17 on the y scale.
`
#### .zoomToValues( object ) ####
Zooms to a specific area in a graph specified by x-scale values or labels. Use this option when you're x-axis doesn't use numbers (i.e. months, names, etc).
Value | Type | Details
--- | --- | ---
Parameter | Object | Zoom To Values Object
Return | jQuery | jQuery Object
`javascript
$("#myChart").zoomToValues({
"xmin": "Feb",
"xmax": "Apr",
"ymin": 200,
"ymax": 300
});
// The chart will now be zoomed in to show
// values "Feb" through "Apr" on the x-scale
// and values 200 through 300 on the y scale.
`
Events are one of the most powerful aspects of the ZingChart API. While other charting libraries have only a handful of events, ZingChart provides dozens of built-in events to monitor and track.
All events take a callback as a argument. Within that callback, you have access to both the jQuery object (the DOM element in which the chart resides) and the event object, an object which reveals different data for each event.
To access the jQuery object, simply use `this`.
To access the event object, use `this.event`.
Here's an example using the node click event:
`javascript
$("#myChart").nodeClick(function(){
// Below, we're accessing the event object
console.log("Node Value:"+this.event.value); // Print the node's value
console.log("Node Index:"+this.event.nodeindex); // Print the node's index
console.log("Plot Index:"+this.event.plotindex); // Print the plot index
console.log("Chart ID:"+this.event.id); // Print the chart's ID
// Down here, we're accessing the jQuery object and using normal
// jQuery functionality on the chart's DOM element. Snazzy!
$(this).css("border","5px solid #F00");
});
`
Under The Hood
> What we're doing here is extending the jQuery object with a custom 'event' attribute. That event attribute holds all the event data returned by the ZingChart event API call. What this allows us to do is retain access to the jQuery element and all it's associated attributes and functionality while also providing easy and granular access to the event attributes. The scope of the extended jQuery object only exists inside the event function and doesn't affect jQuery performance or functionality in anyway. That means less code and more win.
The Event Object
`javascript`
{
ev: MouseEvent,
graphid: "myChart-graph-id0",
id: "myChart",
key: 2,
nodeindex: 2,
plotid: "",
plotindex: 0,
scaletext: "2",
text: "9",
value: 9
}
Let's get down to business with the events.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0"
}
`javascript`
$("#myChart").animationStart(function(){
// Make some magic
});
#### .animationEnd( callback )
Fires the callback when the chart's animation ends.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0"
}
`javascript`
$("#myChart").animationEnd(function(){
// Make some magic
});
#### .animationStep( callback )
Fires the callback for every step of the animation, for every plot/node. That means it fires A LOT. Like, dozens of times. Be very careful what you do inside the callback as it is very easy to kill your browser if you use this improperly.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// The index of the node being animated
nodeindex: 0,
// The index of the plot being animated
plotindex: 0,
// The "position" in the animation timeline.
// It starts from 0 and ends as 1 but for several animation methods, intermediate values can exceed 1
stage: 1
}
`javascript`
$("#myChart").animationStep(function(){
// Make some magic
});
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// The object being modified
object: 'title',
// The data passed through to modify the object.
// In this case, it's text for a new title.
text: 'A whole new title',
}
`javascript`
$("#myChart").chartModify(function(){
// Make some magic
});
#### .nodeAdd( callback )
Fires the callback when a node is added to the chart.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// The node's key
key: 5,
// The node's index.
nodeindex: 5,
// The plot's index to which the node was added.
plotindex: 0,
// The text of the node (similar to value)
text: 11,
// The value of the node
value: 11
}
`javascript`
$("#myChart").nodeAdd(function(){
// Make some magic
});
#### .nodeRemove( callback )
Fires the callback when a node is removed from the chart.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// The node's key
key: 2,
// The node's index.
nodeindex: 2,
// The plot's index from which the node was removed.
plotindex: 1,
// The text of the node (similar to value)
text: 21,
// The value of the node
value: 21
}
`javascript`
$("#myChart").nodeRemove(function(){
// Make some magic
});
#### .plotAdd( callback )
Fires the callback when a plot is added to the chart.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// The index of the added plot.
plotindex: 1,
// Data about the added plot (object)
data: {
// This object contains information about the added plot.
// Example data includes: an array of values, the palette, etc.
}
}
`javascript`
$("#myChart").plotAdd(function(){
// Make some magic
});
#### .plotRemove( callback )
Fires the callback when a plot is removed from the chart.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// The node's key
key: 2,
// The index of the removed plot.
plotindex: 1
}
`javascript`
$("#myChart").plotRemove(function(){
// Make some magic
});
#### .plotModify( callback )
Fires the callback when a plot of the chart is modified.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// The index of the added plot.
plotindex: 0,
// Data about the added plot (object)
data: {
// This object contains information about the modified plot.
// Whatever info is passed in the data object when modifyPlot
// is called will appear here.
// Example data includes: an array of values, the color, etc.
}
}
`javascript`
$("#myChart").plotModify(function(){
// Make some magic
});
#### .chartReload( callback )
Fires the callback when the chart is reloaded.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The render type of the added chart.
output: 'canvas',
// The new height of the chart.
height: 300,
// The new width of the chart.
width: 500,
// The x position of the chart.
x: 0,
// The y position of the chart.
y: 0,
// Data about the reload call (object)
params: { }
}
`javascript`
$("#myChart").chartReload(function(){
// Make some magic
});
#### .dataSet( callback )
Fires the callback when the chart is reloaded.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The data packet that was sent (object)
data: { }
}
`javascript`
$("#myChart").dataSet(function(){
// Make some magic
});
NOTE: Only works if exportdataurl is set in .zingchart options.
`javascript`
$("#myChart").dataExport(function(){
// Make some magic
});
#### .imageSave( callback )
Fires the callback when the user saves an image of the graph.
NOTE: Only works if exportimageurl is set in .zingchart options.
`javascript`
$("#myChart").imageSave(function(){
// Make some magic
});
#### .chartPrint( callback )
Fires the callback when the user prints the graph.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The render type of the printed chart.
output: 'canvas',
// The height of the chart.
height: 300,
// The width of the chart.
width: 500,
// The x position of the chart.
x: 0,
// The y position of the chart.
y: 0,
// Data about the print call (object)
params: { }
}
`javascript`
$("#myChart").chartPrint(function(){
// Make some magic
});
Value | Type | Details
--- | --- | ---
Parameter | Callback
Return | jQuery
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The render type of the feed chart.
output: 'canvas',
// The height of the chart.
height: 300,
// The width of the chart.
width: 500,
// The x position of the chart.
x: 0,
// The y position of the chart.
y: 0,
// Data about the clearFeed call (object)
params: { }
}
`javascript`
$("#myChart").feedClear(function(){
// Make some magic
});
#### .feedIntervalModify( callback )
Fires the callback when the feed's interval is modified.
`javascript`
$("#myChart").feedIntervalModify(function(){
// Make some magic
});
#### .feedStart( callback )
Fires the callback when the feed starts.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The render type of the feed chart.
output: 'canvas',
// The height of the chart.
height: 300,
// The width of the chart.
width: 500,
// The x position of the chart.
x: 0,
// The y position of the chart.
y: 0,
// Data about the clearFeed call (object)
params: { }
}
`javascript`
$("#myChart").feedStart(function(){
// Make some magic
});
#### .feedStop( callback )
Fires the callback when the feed stops.
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The render type of the feed chart.
output: 'canvas',
// The height of the chart.
height: 300,
// The width of the chart.
width: 500,
// The x position of the chart.
x: 0,
// The y position of the chart.
y: 0,
// Data about the stopFeed call (object)
params: { }
}
`javascript`
$("#myChart").feedStop(function(){
// Make some magic
});
Sample Event Object
`javascript`
{
// The id of the chart
id: "myChart",
// The id of the graph
graphid: "myChart-graph-id0",
// If the click was inside, the plotarea, this will be true.
// Otherwise, it will be false.
plotarea: true,
// The target will be set to whatever element of the chart was clicked.
// If no specific object was clicked, target will equal "none".
target: "node",
// The targetid will be the ID in the DOM of the object you clicked.
targetid: "myChart-graph-id0-plotset0-plot0-plot-1-node-0"
// The x position of the click event.
x: 168.203125,
// The y position of the click event.
y: 21.5625,
// Touch tells if the event was triggered by a touch-screen.
touch: false,
// Data about the stopFeed call (object)
ev: { } // MouseEvent
}
`javascript`
$("#myChart").graphClick(function(){
// Make some magic
});
#### .graphComplete( callback )
Fires the callback when the graphset is completely rendered. It's called even on API calls that require chart repaint.
Value | Type | Details
--- | --- | ---
Parameter | Callback
Return | jQuery
`javascript`
$("#myChart").graphComplete(function(){
// Make some magic
});
#### .graphDataParse( callback )
Fires the callback when the data is availabe for the chart, prior to parsing routines. Useful for changing/adding elements into the data.
Value | Type | Details
--- | --- | ---
Parameter | Callback
Return | jQuery
`javascript`
$("#myChart").graphDataParse(function(){
// Make some magic
});
#### .graphDataReady( callback )
Fires the callback when the data is ready to be parsed.
Value | Type | Details
--- | --- | ---
Parameter | Callback
Return | jQuery
`javascript``
$("#myChart").graphDataReady(function(){
// Make some magic
});
#### .graphGuideMouseMove( callback )
Fires the callback when the guide position changes.
Value | Type | Details
--- | --- | ---
Parameter | Callback
Return | jQuery