From da86c9521bbec733726c97f4e2ded8c8aaa6e995 Mon Sep 17 00:00:00 2001 From: jos Date: Mon, 25 Aug 2014 11:41:56 +0200 Subject: [PATCH] Some indentation fixes --- docs/graph2d.html | 818 +++++++++++++++++++++++----------------------- 1 file changed, 409 insertions(+), 409 deletions(-) diff --git a/docs/graph2d.html b/docs/graph2d.html index 2f50e53b..d72b9659 100644 --- a/docs/graph2d.html +++ b/docs/graph2d.html @@ -179,14 +179,14 @@ var items = [

Groups

- 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: 

@@ -270,217 +270,217 @@ var options = {
 The options colored in green can also be used as options for the groups. All options are optional.
 
 
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
-    
-        
-        
-        
-        
-    
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
+
+  
+  
+  
+  
+
NameTypeDefaultDescription
yAxisOrientationString'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.
defaultGroupString'default'This is the label for the default, ungrouped items when shown in a legend.
sortBooleantrueThis 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.
samplingBooleantrueIf 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.
graphHeightNumber | 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.
shadedBoolean | ObjectfalseToggle a shaded area with the default settings.
shaded.enabledBooleanfalseThis toggles the shading.
shaded.orientationString'bottom'This determines if the shaded area is at the bottom or at the top of the curve. The options are 'bottom' or 'top'.
styleString'line'This allows the user to define if this should be a linegraph or a barchart. The options are: 'line' or 'bar'.
barChart.widthNumber50The width of the bars.
barChart.alignString'center'The alignment of the bars with regards to the coordinate. The options are 'left', 'right' or 'center'.
barChart.handleOverlapString'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.
-        
catmullRomBoolean | ObjecttrueToggle the interpolation with the default settings. For more customization use the JSON format.
catmullRom.enabledBooleantrueToggle the interpolation.
catmullRom.parametrizationString'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.
drawPointsBoolean | ObjecttrueToggle the drawing of the datapoints with the default settings.
drawPoints.enabledBooleantrueToggle the drawing of the datapoints.
drawPoints.sizeNumber6Determine the size at which the data points are drawn.
drawPoints.styleString'square'Determine the shape of the data points. The options are 'square' or 'circle'.
dataAxis.showMinorLabelsBooleantrueToggle the drawing of the minor labels on the Y axis.
dataAxis.showMajorLabelsBooleantrueToggle the drawing of the major labels on the Y axis.
dataAxis.iconsBooleanfalseToggle the drawing of automatically generated icons the Y axis.
dataAxis.widthNumber | String'40px'Set the (minimal) width of the yAxis. The axis will resize to accomodate the labels of the Y values.
dataAxis.visibleBooleantrueShow or hide the data axis.
groups.visibilityObjectYou can use this to toggle the visibility of groups per graph2D instance. This is different from setting the visibility flag of the groups since
-            this is not communicated across instances of graph2d. Take a look at Example 14
-            for more explaination.
-        
legendBooleanfalseToggle the legend with the default settings.
legend.enabledBooleanfalseToggle the legend.
legend.iconsBooleantrueShow automatically generated icons on the legend.
legend.left.visibleBooleantrueBoth axis, left and right, have a corresponding legend. This toggles the visibility of the legend that is coupled with the left axis.
legend.left.positionString'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.visibleBooleantrueThis toggles the visibility of the legend that is coupled with the right axis.
legend.right.positionString'top-right'Determine the position of the legend coupled to the right axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'.
NameTypeDefaultDescription
yAxisOrientationString'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.
defaultGroupString'default'This is the label for the default, ungrouped items when shown in a legend.
sortBooleantrueThis 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.
samplingBooleantrueIf 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.
graphHeightNumber | 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.
shadedBoolean | ObjectfalseToggle a shaded area with the default settings.
shaded.enabledBooleanfalseThis toggles the shading.
shaded.orientationString'bottom'This determines if the shaded area is at the bottom or at the top of the curve. The options are 'bottom' or 'top'.
styleString'line'This allows the user to define if this should be a linegraph or a barchart. The options are: 'line' or 'bar'.
barChart.widthNumber50The width of the bars.
barChart.alignString'center'The alignment of the bars with regards to the coordinate. The options are 'left', 'right' or 'center'.
barChart.handleOverlapString'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.
+  
catmullRomBoolean | ObjecttrueToggle the interpolation with the default settings. For more customization use the JSON format.
catmullRom.enabledBooleantrueToggle the interpolation.
catmullRom.parametrizationString'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.
drawPointsBoolean | ObjecttrueToggle the drawing of the datapoints with the default settings.
drawPoints.enabledBooleantrueToggle the drawing of the datapoints.
drawPoints.sizeNumber6Determine the size at which the data points are drawn.
drawPoints.styleString'square'Determine the shape of the data points. The options are 'square' or 'circle'.
dataAxis.showMinorLabelsBooleantrueToggle the drawing of the minor labels on the Y axis.
dataAxis.showMajorLabelsBooleantrueToggle the drawing of the major labels on the Y axis.
dataAxis.iconsBooleanfalseToggle the drawing of automatically generated icons the Y axis.
dataAxis.widthNumber | String'40px'Set the (minimal) width of the yAxis. The axis will resize to accomodate the labels of the Y values.
dataAxis.visibleBooleantrueShow or hide the data axis.
groups.visibilityObjectYou can use this to toggle the visibility of groups per graph2D instance. This is different from setting the visibility flag of the groups since
+    this is not communicated across instances of graph2d. Take a look at Example 14
+    for more explaination.
+  
legendBooleanfalseToggle the legend with the default settings.
legend.enabledBooleanfalseToggle the legend.
legend.iconsBooleantrueShow automatically generated icons on the legend.
legend.left.visibleBooleantrueBoth axis, left and right, have a corresponding legend. This toggles the visibility of the legend that is coupled with the left axis.
legend.left.positionString'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.visibleBooleantrueThis toggles the visibility of the legend that is coupled with the right axis.
legend.right.positionString'top-right'Determine the position of the legend coupled to the right axis. Options are 'top-left', 'top-right', 'bottom-left' or 'bottom-right'.

 

 
 
Timeline Options

@@ -665,146 +665,146 @@ The options colored in green can also be used as options for the groups. All opt
 
 
Methods

 

-    The Graph2d supports the following methods.
+  The Graph2d supports the following methods.
 

 
 
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
+    
+    
+    
+  
+
+  
+    
+    
+    
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
MethodReturn TypeDescription
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:
+  
MethodReturn TypeDescription
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()noneDestroy the Graph2d. The Graph2d is removed from memory. all DOM elements and event listeners are cleaned up.
-        
getCustomTime()DateRetrieve the custom time. Only applicable when the option showCustomTime is true.
-        
setCustomTime(time)noneAdjust the custom time bar. Only applicable when the option showCustomTime is true. time is a Date object.
-        
getLegend(groupId, iconWidth, iconHeight)SVGelement, String, StringReturns 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()ObjectGet the current visible window. Returns an object with properties start: Date and end: Date.
getItemRange()ObjectGet the range of all the items as an object containing min: Date and max: Date.
fit()noneAdjust the visible window such that it fits all items.
-        
on(event, callback)noneCreate 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)noneRemove an event listener created before via function on(event, callback). See section Events for more information.
redraw()noneForce a redraw of the Graph2d. Can be useful to manually redraw when option autoResize=false.
-        
isGroupVisible(groupId)BooleanThis checks if the visible option of the supplied group (by ID) is true or false.
-        
setGroups(groups)noneSet 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)noneSet a data set with items for the Graph2d.
-            items can be an Array with Objects,
-            a DataSet, or a DataView.
-        
setOptions(options)noneSet 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)noneSet 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()noneDestroy the Graph2d. The Graph2d is removed from memory. all DOM elements and event listeners are cleaned up.
+    
getCustomTime()DateRetrieve the custom time. Only applicable when the option showCustomTime is true.
+    
setCustomTime(time)noneAdjust the custom time bar. Only applicable when the option showCustomTime is true. time is a Date object.
+    
getLegend(groupId, iconWidth, iconHeight)SVGelement, String, StringReturns 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()ObjectGet the current visible window. Returns an object with properties start: Date and end: Date.
getItemRange()ObjectGet the range of all the items as an object containing min: Date and max: Date.
fit()noneAdjust the visible window such that it fits all items.
+    
on(event, callback)noneCreate 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)noneRemove an event listener created before via function on(event, callback). See section Events for more information.
redraw()noneForce a redraw of the Graph2d. Can be useful to manually redraw when option autoResize=false.
+    
isGroupVisible(groupId)BooleanThis checks if the visible option of the supplied group (by ID) is true or false.
+    
setGroups(groups)noneSet 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)noneSet a data set with items for the Graph2d.
+      items can be an Array with Objects,
+      a DataSet, or a DataView.
+    
setOptions(options)noneSet 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)noneSet 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.

 
 

 
 
 
Events

 

-    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.
 

 
 
@@ -814,7 +814,7 @@ Graph2d.on('select', function (properties) {
 

 
 

-    A listener can be removed via the function off:
+  A listener can be removed via the function off:
 

 
 
@@ -833,68 +833,68 @@ Graph2d.off('rangechanged', onChange);
 
 
 

-    The following events are available.
+  The following events are available.
 

 
 
-    -        -        -        -    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
-    
-        
-        
-        
-    
-
-    
-        
-        
-        
-    
+  +    +    +    +  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+
+  
+    
+    
+    
+  





nameDescriptionProperties
rangechangeFired repeatedly when the user is dragging the Graph2d window.
-        
-            
    
-                
  • start (Number): timestamp of the current start of the window.
    • 
-                
  • end (Number): timestamp of the current end of the window.
    • 
-            

-        
rangechangedFired once after the user has dragged the Graph2d window.
-        
-            
    
-                
  • start (Number): timestamp of the current start of the window.
    • 
-                
  • end (Number): timestamp of the current end of the window.
    • 
-            

-        
timechangeFired repeatedly when the user is dragging the custom time bar.
-            Only available when the custom time bar is enabled.
-        
-            
    
-                
  • time (Date): the current time.
    • 
-            

-        
timechangedFired once after the user has dragged the custom time bar.
-            Only available when the custom time bar is enabled.
-        
-            
    
-                
  • time (Date): the current time.
    • 
-            

-        





nameDescriptionProperties
rangechangeFired repeatedly when the user is dragging the Graph2d window.
+    
+      
    
+        
  • start (Number): timestamp of the current start of the window.
    • 
+        
  • end (Number): timestamp of the current end of the window.
    • 
+      

+    
rangechangedFired once after the user has dragged the Graph2d window.
+    
+      
    
+        
  • start (Number): timestamp of the current start of the window.
    • 
+        
  • end (Number): timestamp of the current end of the window.
    • 
+      

+    
timechangeFired repeatedly when the user is dragging the custom time bar.
+      Only available when the custom time bar is enabled.
+    
+      
    
+        
  • time (Date): the current time.
    • 
+      

+    
timechangedFired once after the user has dragged the custom time bar.
+      Only available when the custom time bar is enabled.
+    
+      
    
+        
  • time (Date): the current time.
    • 
+      

+    

 
 

 
@@ -956,20 +956,20 @@ Graph2d comes with support for the following locales:
 
 
Styles

 

-    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.
 

 
 
Data Policy

 

-    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.