x, y, and z,
and can optionally have a property style and filter.
- Graph2d can be provided with two types of data: + Graph2d can be provided with two types of data:
- Like the items, groups are regular JavaScript Arrays and Objects.
- Using groups, items can be grouped together.
- Items are filtered per group, and displayed as individual graphs. Groups can contain the properties id,
- content, className (optional) and options (optional).
+ Like the items, groups are regular JavaScript Arrays and Objects.
+ Using groups, items can be grouped together.
+ Items are filtered per group, and displayed as individual graphs. Groups can contain the properties id,
+ content, className (optional) and options (optional).
- Groups can be applied to a timeline using the method setGroups.
- A table with groups can be created like:
+ Groups can be applied to a timeline using the method setGroups.
+ A table with groups can be created like:
@@ -205,51 +205,51 @@ groups.add({
- Groups can have the following properties:
+ Groups can have the following properties:
| Name | -Type | -Required | -Description | -
|---|---|---|---|
| id | -String | Number | -yes | -An id for the group. The group will display all items having a
- property group which matches the id
- of the group. |
-
| content | -String | -yes | -The contents of the group. This can be plain text or html code. | -
| className | -String | -no | -This field is optional. A className can be used to give groups - an individual css style. - | -
| options | -JSON object | -no | -This field is optional. The options can be used to give a group a specific draw style. - Any options that are colored green in the Configuration Options can be used as options here. - |
| visible | -Boolean | -true | -This field is optional. If false, this group will not be drawn. - |
| Name | +Type | +Required | +Description | +
| id | +String | Number | +yes | +An id for the group. The group will display all items having a
+ property group which matches the id
+ of the group. |
+
| content | +String | +yes | +The contents of the group. This can be plain text or html code. | +
| className | +String | +no | +This field is optional. A className can be used to give groups + an individual css style. + | +
| options | +JSON object | +no | +This field is optional. The options can be used to give a group a specific draw style. + Any options that are colored green in the Configuration Options can be used as options here. + |
| visible | +Boolean | +true | +This field is optional. If false, this group will not be drawn. + |
| Name | -Type | -Default | -Description | -
|---|---|---|---|
| yAxisOrientation | -String | -'left' | -This defines with which axis, left or right, the graph is coupled. Example 5 shows groups with different Y axis. If no groups are coupled - with an axis, it will not be shown. | -
| defaultGroup | -String | -'default' | -This is the label for the default, ungrouped items when shown in a legend. | -
| sort | -Boolean | -true | -This determines if the items are sorted automatically. - They are sorted by the x value. If sort is enabled, more optimizations are possible, increasing the performance. | -
| sampling | -Boolean | -true | -If sampling is enabled, Graph2d will automatically determine the amount of points per pixel. - If there are more than 1 point per pixel, not all points will be drawn. Disabling sampling will cause a decrease in performance. | -
| graphHeight | -Number | String | -'400px' | -This is the height of the graph SVG canvas. - If it is larger than the height of the outer frame, you can drag up and down - the vertical direction as well as the usual horizontal direction. | -
| shaded | -Boolean | Object | -false | -Toggle a shaded area with the default settings. | -
| shaded.enabled | -Boolean | -false | -This toggles the shading. | -
| shaded.orientation | -String | -'bottom' | -This determines if the shaded area is at the bottom or at the top of the curve. The options are 'bottom' or 'top'. | -
| style | -String | -'line' | -This allows the user to define if this should be a linegraph or a barchart. The options are: 'line' or 'bar'. | -
| barChart.width | -Number | -50 | -The width of the bars. | -
| barChart.align | -String | -'center' | -The alignment of the bars with regards to the coordinate. The options are 'left', 'right' or 'center'. | -
| barChart.handleOverlap | -String | -'overlap' | -You can choose how graph2d handles the case where barcharts are occupying the same datapoint. The possible options are:
- overlap, sideBySide, stack.
- See example 10 for more information.
- When using groups, see example 11.
- |
-
| catmullRom | -Boolean | Object | -true | -Toggle the interpolation with the default settings. For more customization use the JSON format. | -
| catmullRom.enabled | -Boolean | -true | -Toggle the interpolation. | -
| catmullRom.parametrization | -String | -'centripetal' | -Define the type of parametrizaion. Example 7 shows the different methods. The options are 'centripetal' (best results), 'chordal' and 'uniform'. Uniform is the computationally cheapest variant. - If catmullRom is disabled, linear interpolation is used. | -
| drawPoints | -Boolean | Object | -true | -Toggle the drawing of the datapoints with the default settings. | -
| drawPoints.enabled | -Boolean | -true | -Toggle the drawing of the datapoints. | -
| drawPoints.size | -Number | -6 | -Determine the size at which the data points are drawn. | -
| drawPoints.style | -String | -'square' | -Determine the shape of the data points. The options are 'square' or 'circle'. | -
| dataAxis.showMinorLabels | -Boolean | -true | -Toggle the drawing of the minor labels on the Y axis. | -
| dataAxis.showMajorLabels | -Boolean | -true | -Toggle the drawing of the major labels on the Y axis. | -
| dataAxis.icons | -Boolean | -false | -Toggle the drawing of automatically generated icons the Y axis. | -
| dataAxis.width | -Number | String | -'40px' | -Set the (minimal) width of the yAxis. The axis will resize to accomodate the labels of the Y values. | -
| dataAxis.visible | -Boolean | -true | -Show or hide the data axis. | -
| legend | -Boolean | -false | -Toggle the legend with the default settings. | -
| legend.enabled | -Boolean | -false | -Toggle the legend. | -
| legend.icons | -Boolean | -true | -Show automatically generated icons on the legend. | -
| legend.left.visible | -Boolean | -true | -Both axis, left and right, have a corresponding legend. This toggles the visibility of the legend that is coupled with the left axis. | -
| legend.left.position | -String | -'top-left' | -Determine the position of the legend coupled to the left axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'. | -
| legend.right.visible | -Boolean | -true | -This toggles the visibility of the legend that is coupled with the right axis. | -
| legend.right.position | -String | -'top-right' | -Determine the position of the legend coupled to the right axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'. | -
| Name | +Type | +Default | +Description | +
| yAxisOrientation | +String | +'left' | +This defines with which axis, left or right, the graph is coupled. Example 5 shows groups with different Y axis. If no groups are coupled + with an axis, it will not be shown. | +
| defaultGroup | +String | +'default' | +This is the label for the default, ungrouped items when shown in a legend. | +
| sort | +Boolean | +true | +This determines if the items are sorted automatically. + They are sorted by the x value. If sort is enabled, more optimizations are possible, increasing the performance. | +
| sampling | +Boolean | +true | +If sampling is enabled, Graph2d will automatically determine the amount of points per pixel. + If there are more than 1 point per pixel, not all points will be drawn. Disabling sampling will cause a decrease in performance. | +
| graphHeight | +Number | String | +'400px' | +This is the height of the graph SVG canvas. + If it is larger than the height of the outer frame, you can drag up and down + the vertical direction as well as the usual horizontal direction. | +
| shaded | +Boolean | Object | +false | +Toggle a shaded area with the default settings. | +
| shaded.enabled | +Boolean | +false | +This toggles the shading. | +
| shaded.orientation | +String | +'bottom' | +This determines if the shaded area is at the bottom or at the top of the curve. The options are 'bottom' or 'top'. | +
| style | +String | +'line' | +This allows the user to define if this should be a linegraph or a barchart. The options are: 'line' or 'bar'. | +
| barChart.width | +Number | +50 | +The width of the bars. | +
| barChart.align | +String | +'center' | +The alignment of the bars with regards to the coordinate. The options are 'left', 'right' or 'center'. | +
| barChart.handleOverlap | +String | +'overlap' | +You can choose how graph2d handles the case where barcharts are occupying the same datapoint. The possible options are:
+ overlap, sideBySide, stack.
+ See example 10 for more information.
+ When using groups, see example 11.
+ |
+
| catmullRom | +Boolean | Object | +true | +Toggle the interpolation with the default settings. For more customization use the JSON format. | +
| catmullRom.enabled | +Boolean | +true | +Toggle the interpolation. | +
| catmullRom.parametrization | +String | +'centripetal' | +Define the type of parametrizaion. Example 7 shows the different methods. The options are 'centripetal' (best results), 'chordal' and 'uniform'. Uniform is the computationally cheapest variant. + If catmullRom is disabled, linear interpolation is used. | +
| drawPoints | +Boolean | Object | +true | +Toggle the drawing of the datapoints with the default settings. | +
| drawPoints.enabled | +Boolean | +true | +Toggle the drawing of the datapoints. | +
| drawPoints.size | +Number | +6 | +Determine the size at which the data points are drawn. | +
| drawPoints.style | +String | +'square' | +Determine the shape of the data points. The options are 'square' or 'circle'. | +
| dataAxis.showMinorLabels | +Boolean | +true | +Toggle the drawing of the minor labels on the Y axis. | +
| dataAxis.showMajorLabels | +Boolean | +true | +Toggle the drawing of the major labels on the Y axis. | +
| dataAxis.icons | +Boolean | +false | +Toggle the drawing of automatically generated icons the Y axis. | +
| dataAxis.width | +Number | String | +'40px' | +Set the (minimal) width of the yAxis. The axis will resize to accomodate the labels of the Y values. | +
| dataAxis.visible | +Boolean | +true | +Show or hide the data axis. | +
| legend | +Boolean | +false | +Toggle the legend with the default settings. | +
| legend.enabled | +Boolean | +false | +Toggle the legend. | +
| legend.icons | +Boolean | +true | +Show automatically generated icons on the legend. | +
| legend.left.visible | +Boolean | +true | +Both axis, left and right, have a corresponding legend. This toggles the visibility of the legend that is coupled with the left axis. | +
| legend.left.position | +String | +'top-left' | +Determine the position of the legend coupled to the left axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'. | +
| legend.right.visible | +Boolean | +true | +This toggles the visibility of the legend that is coupled with the right axis. | +
| legend.right.position | +String | +'top-right' | +Determine the position of the legend coupled to the right axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'. | +
- The Graph2d supports the following methods. + The Graph2d supports the following methods.
| Method | -Return Type | -Description | -
|---|---|---|
| clear([what]) | -none | -
- Clear the Graph2d. An object can be passed specifying which sections to clear: items, groups,
- and/or options. By Default, items, groups and options are cleared, i.e. what = {items: true, groups: true, options: true}. Example usage:
+ |
| Method | +Return Type | +Description | +
| clear([what]) | +none | +
+ Clear the Graph2d. An object can be passed specifying which sections to clear: items, groups,
+ and/or options. By Default, items, groups and options are cleared, i.e. what = {items: true, groups: true, options: true}. Example usage:
Graph2d.clear(); // clear items, groups, and options
Graph2d.clear({options: true}); // clear options only
- |
-
| destroy() | -none | -Destroy the Graph2d. The Graph2d is removed from memory. all DOM elements and event listeners are cleaned up. - | -
| getCustomTime() | -Date | -Retrieve the custom time. Only applicable when the option showCustomTime is true.
- |
-
| setCustomTime(time) | -none | -Adjust the custom time bar. Only applicable when the option showCustomTime is true. time is a Date object.
- |
-
| getLegend(groupId, iconWidth, iconHeight) | -SVGelement, String, String | -Returns an object containing an SVG element with the icon of the group (size determined by iconWidth and iconHeight), the label of the group (content) and the yAxisOrientation of the group (left or right). - | -
| getWindow() | -Object | -Get the current visible window. Returns an object with properties start: Date and end: Date. |
-
| getItemRange() | -Object | -Get the range of all the items as an object containing min: Date and max: Date. |
-
| fit() | -none | -Adjust the visible window such that it fits all items. - | -
| on(event, callback) | -none | -Create an event listener. The callback function is invoked every time the event is triggered. Avialable events: rangechange, rangechanged, select. The callback function is invoked as callback(properties), where properties is an object containing event specific properties. See section Events for more information. |
-
| off(event, callback) | -none | -Remove an event listener created before via function on(event, callback). See section Events for more information. |
-
| redraw() | -none | -Force a redraw of the Graph2d. Can be useful to manually redraw when option autoResize=false. - | -
| isGroupVisible(groupId) | -Boolean | -This checks if the visible option of the supplied group (by ID) is true or false. - | -
| setGroups(groups) | -none | -Set a data set with groups for the Graph2d.
- groups can be an Array with Objects,
- a DataSet, or a DataView. For each of the groups, the items of the
- Graph2d are filtered on the property group, which
- must correspond with the id of the group.
- |
-
| setItems(items) | -none | -Set a data set with items for the Graph2d.
- items can be an Array with Objects,
- a DataSet, or a DataView.
- |
-
| setOptions(options) | -none | -Set or update options. It is possible to change any option of the Graph2d at any time. You can for example switch orientation on the fly. - | -
| setWindow(start, end) | -none | -Set the current visible window. The parameters start and end can be a Date, Number, or String. If the parameter value of start or end is null, the parameter will be left unchanged. |
-
| destroy() | +none | +Destroy the Graph2d. The Graph2d is removed from memory. all DOM elements and event listeners are cleaned up. + | +
| getCustomTime() | +Date | +Retrieve the custom time. Only applicable when the option showCustomTime is true.
+ |
+
| setCustomTime(time) | +none | +Adjust the custom time bar. Only applicable when the option showCustomTime is true. time is a Date object.
+ |
+
| getLegend(groupId, iconWidth, iconHeight) | +SVGelement, String, String | +Returns an object containing an SVG element with the icon of the group (size determined by iconWidth and iconHeight), the label of the group (content) and the yAxisOrientation of the group (left or right). + | +
| getWindow() | +Object | +Get the current visible window. Returns an object with properties start: Date and end: Date. |
+
| getItemRange() | +Object | +Get the range of all the items as an object containing min: Date and max: Date. |
+
| fit([options]) | +none | +Adjust the visible window such that it fits all items.
+ Available options:
+
|
+
| on(event, callback) | +none | +Create an event listener. The callback function is invoked every time the event is triggered. Avialable events: rangechange, rangechanged, select. The callback function is invoked as callback(properties), where properties is an object containing event specific properties. See section Events for more information. |
+
| off(event, callback) | +none | +Remove an event listener created before via function on(event, callback). See section Events for more information. |
+
| redraw() | +none | +Force a redraw of the Graph2d. Can be useful to manually redraw when option autoResize=false. + | +
| isGroupVisible(groupId) | +Boolean | +This checks if the visible option of the supplied group (by ID) is true or false. + | +
| setGroups(groups) | +none | +Set a data set with groups for the Graph2d.
+ groups can be an Array with Objects,
+ a DataSet, or a DataView. For each of the groups, the items of the
+ Graph2d are filtered on the property group, which
+ must correspond with the id of the group.
+ |
+
| setItems(items) | +none | +Set a data set with items for the Graph2d.
+ items can be an Array with Objects,
+ a DataSet, or a DataView.
+ |
+
| setOptions(options) | +none | +Set or update options. It is possible to change any option of the Graph2d at any time. You can for example switch orientation on the fly. + | +
| setWindow(start, end [, options]) | +none | +Set the current visible window. The parameters start and end can be a Date, Number, or String. If the parameter value of start or end is null, the parameter will be left unchanged. Available options:
+
|
+
- Graph2d fires events when changing the visible window by dragging, when - selecting items, and when dragging the custom time bar. + Graph2d fires events when changing the visible window by dragging, when + selecting items, and when dragging the custom time bar.
- Here an example on how to listen for a rangeChanged event.
+ Here an example on how to listen for a rangeChanged event.
@@ -805,7 +813,7 @@ Graph2d.on('select', function (properties) {
- A listener can be removed via the function off:
+ A listener can be removed via the function off:
@@ -824,68 +832,68 @@ Graph2d.off('rangechanged', onChange);
- The following events are available.
+ The following events are available.
| name | -Description | -Properties | -
|---|---|---|
| rangechange | -Fired repeatedly when the user is dragging the Graph2d window. - | -
-
|
-
| rangechanged | -Fired once after the user has dragged the Graph2d window. - | -
-
|
-
| timechange | -Fired repeatedly when the user is dragging the custom time bar. - Only available when the custom time bar is enabled. - | -
-
|
-
| timechanged | -Fired once after the user has dragged the custom time bar. - Only available when the custom time bar is enabled. - | -
-
|
-
| name | +Description | +Properties | +
| rangechange | +Fired repeatedly when the user is dragging the Graph2d window. + | +
+
|
+
| rangechanged | +Fired once after the user has dragged the Graph2d window. + | +
+
|
+
| timechange | +Fired repeatedly when the user is dragging the custom time bar. + Only available when the custom time bar is enabled. + | +
+
|
+
| timechanged | +Fired once after the user has dragged the custom time bar. + Only available when the custom time bar is enabled. + | +
+
|
+
- All parts of the Graph2d have a class name and a default css style just like the Graph2d. - The styles can be overwritten, which enables full customization of the layout - of the Graph2d. + All parts of the Graph2d have a class name and a default css style just like the Graph2d. + The styles can be overwritten, which enables full customization of the layout + of the Graph2d.
- Additionally, Graph2d has 10 preset styles for graphs, which are cycled through when loading groups. These styles can be overwritten - as well, along with defining your own classes to style the graphs! Example 4 and - example 5 show the usage of custom styles. + Additionally, Graph2d has 10 preset styles for graphs, which are cycled through when loading groups. These styles can be overwritten + as well, along with defining your own classes to style the graphs! Example 4 and + example 5 show the usage of custom styles.
- All code and data is processed and rendered in the browser. - No data is sent to any server. + All code and data is processed and rendered in the browser. + No data is sent to any server.