re-add 'validate eventName' TODO.
[dygraphs.git] / experimental / palette / options.js
1 // Copyright (c) 2011 Google, Inc.
2 //
3 // Permission is hereby granted, free of charge, to any person obtaining a copy
4 // of this software and associated documentation files (the "Software"), to deal
5 // in the Software without restriction, including without limitation the rights
6 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 // copies of the Software, and to permit persons to whom the Software is
8 // furnished to do so, subject to the following conditions:
9 //
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
12 //
13 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19 // THE SOFTWARE.
20
21 /**
22 * @fileoverview List of options and their types, used for the palette.
23 *
24 * @author konigsberg@google.com (Robert Konigsberg)
25 */
26
27 "use strict";
28
29 var opts = {
30 animatedZooms: { type: "boolean" },
31 annotationClickHandler : {type: "function(annotation, point, dygraph, event)"},
32 annotationDblClickHandler : {type: "function(annotation, point, dygraph, event)"},
33 annotationMouseOutHandler : {type: "function(annotation, point, dygraph, event)"},
34 annotationMouseOverHandler : {type: "function(annotation, point, dygraph, event)"},
35 avoidMinZero: { type: "boolean" },
36 axisLabelColor: { type: "string" },
37 axisLabelFontSize: {type: "int" },
38 axisLabelWidth: {type: "int" },
39 axisLineColor: {type: "string" },
40 axisLineWidth: {type: "int" },
41 axisTickSize: {type: "int" },
42 clickCallback : {type: "function(e, x, points)"},
43 colorSaturation: { type: "float" },
44 colors: { type: "array<string>" },
45 colorValue: { type: "float" },
46 connectSeparatedPoints: { type: "boolean" },
47 customBars: { type: "boolean" },
48 dateWindow: { type: "array<Date>"},
49 delimiter: { type: "string" },
50 digitsAfterDecimal: { type: "int"},
51 displayAnnotations: { type: "boolean" },
52 drawCallback : {type: "function(dygraph, is_initial)"},
53 drawPoints: { type: "boolean" },
54 drawXAxis: {type: "boolean" },
55 drawXGrid: {type: "boolean" },
56 drawYAxis: {type: "boolean" },
57 drawYGrid: {type: "boolean" },
58 errorBars: { type: "boolean" },
59 fillAlpha: { type: "float" },
60 fillGraph: { type: "boolean" },
61 fractions: { type: "boolean" },
62 gridLineColor: { type: "string" },
63 gridLineWidth: { type: "int" },
64 height: {type: "int"},
65 hideOverlayOnMouseOut: { type: "boolean" },
66 highlightCallback : {type: "function(event, x, points,row)"},
67 highlightCircleSize: { type: "int" },
68 includeZero: { type: "boolean" },
69 isZoomedIgnoreProgrammaticZoom: {type: "boolean" },
70 labelsDivWidth: {type: "integer"},
71 labels: {type: "array<string>" },
72 labelsKMB: {type: "boolean" },
73 labelsKMG2: {type: "boolean"},
74 labelsSeparateLines: {type: "boolean"},
75 labelsShowZeroValues: {type: "boolean"},
76 legend: {type: "string"},
77 logscale: { type: "boolean" },
78 maxNumberWidth: {type: "int"},
79 panEdgeFraction: { type: "float" },
80 pixelsPerLabel: { type: "int" },
81 pixelsPerXLabel: { type: "int" },
82 pixelsPerYLabel: { type: "int" },
83 pointClickCallback : {type: "function(e, point)"},
84 pointSize: { type: "integer" },
85 rangeSelectorHeight: { type: "int" },
86 rangeSelectorPlotFillColor: { type: "int" },
87 rangeSelectorPlotStrokeColor: { type: "int" },
88 rightGap: {type: "boolean"},
89 rollPeriod: {type: "int"},
90 showLabelsOnHighlight: { type: "boolean" },
91 showRangeSelector: { type: "boolean" },
92 showRoller: {type: "boolean" },
93 sigFigs: {type: "int"},
94 sigma: { type: "float" },
95 stackedGraph: { type: "boolean" },
96 stepPlot: { type: "boolean" },
97 strokeWidth: { type: "integer" },
98 timingName: { type: "string" },
99 title: {type: "string"},
100 titleHeight: {type: "integer"},
101 underlayCallback : {type: "function(canvas, area, dygraph)"},
102 unhighlightCallback : {type: "function(event)"},
103 valueRange: {type: "array<float>"},
104 visibility: {type: "array<boolean>"},
105 width: {type: "int"},
106 wilsonInterval: { type: "boolean" },
107 xAxisHeight: {type: "int"},
108 xAxisLabelWidth: {type: "int"},
109 xLabelHeight: {type: "int"},
110 xlabel : {type: "string" },
111 xValueParser : {type: "function(str)"},
112 yAxisLabelWidth: {type: "int"},
113 yLabelWidth: {type: "int"},
114 ylabel : {type: "string" },
115 zoomCallback : {type: "function(minDate, maxDate, yRanges)"},
116 };