1 // Copyright (c) 2011 Google, Inc.
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:
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software.
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
22 * @fileoverview List of options and their types, used for the palette.
24 * @author konigsberg@google.com (Robert Konigsberg)
30 * Options availabile to the palette.
32 * Each entry is the name of the option, followed by:
33 * type: describes the type of option, which can be:
34 * boolean|string|float|int|array<boolean>|array<int>|array<float>|array<Date>
35 * or function(parameter list)
36 * scope: if empty, then available in global scope only. Otherwise,
37 * it's an array with possible values global|series|x|y|y2|highlight.
43 annotationClickHandler
: {
44 type
: "function(annotation, point, dygraph, event)"
46 annotationDblClickHandler
: {
47 type
: "function(annotation, point, dygraph, event)"
49 annotationMouseOutHandler
: {
50 type
: "function(annotation, point, dygraph, event)"
52 annotationMouseOverHandler
: {
53 type
: "function(annotation, point, dygraph, event)"
60 // scope : [ "x", "y", "y2" ]
64 // scope : [ "x", "y", "y2" ]
66 axisLabelFormatter
: {
67 type
: "function(numberOrDate, granularity, opts, dygraph)",
68 scope
: [ "x", "y", "y2" ]
72 // scope : [ "x", "y", "y2" ]
76 // scope : [ "x", "y", "y2" ]
80 // scope : [ "x", "y", "y2" ]
84 // scope : [ "x", "y", "y2" ]
87 type
: "function(e, x, points)"
93 type
: "array<string>"
98 connectSeparatedPoints
: {
110 digitsAfterDecimal
: {
113 displayAnnotations
: {
120 type
: "function(dygraph, is_initial)"
122 drawGapEdgePoints
: {
125 drawHighlightPointCallback
: {
126 type
: "function(g, seriesName, canvasContext, cx, cy, color, pointSize)",
127 scope
: [ "global", "series", "y", "y2" ]
131 scope
: [ "global", "series", "y", "y2" ]
133 drawPointCallback
: {
134 type
: "function(g, seriesName, canvasContext, cx, cy, color, pointSize)",
135 scope
: [ "global", "series", "y", "y2" ]
170 hideOverlayOnMouseOut
: {
173 highlightCallback
: {
174 type
: "function(event, x, points,row)"
176 highlightCircleSize
: {
182 isZoomedIgnoreProgrammaticZoom
: {
189 type
: "array<string>"
197 labelsSeparateLines
: {
200 labelsShowZeroValues
: {
224 pointClickCallback
: {
225 type
: "function(e, point)"
229 scope
: [ "global", "series", "y", "y2" ]
231 rangeSelectorHeight
: {
234 rangeSelectorPlotFillColor
: {
237 rangeSelectorPlotStrokeColor
: {
246 showLabelsOnHighlight
: {
249 showRangeSelector
: {
267 strokeBorderColor
: {
270 strokeBorderWidth
: {
274 type
: "array<integer>"
289 type
: "function(canvas, area, dygraph)"
291 unhighlightCallback
: {
292 type
: "function(event)"
295 type
: "array<float>"
298 type
: "array<boolean>"
319 type
: "function(str)"
331 type
: "function(minDate, maxDate, yRanges)"