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.
40 // These two exist, but are not used by the palette at all.
41 series
: { type
: null, scope
: [] },
42 axes
: { type
: null, scope
: [] },
47 annotationClickHandler
: {
48 type
: "function(annotation, point, dygraph, event)"
50 annotationDblClickHandler
: {
51 type
: "function(annotation, point, dygraph, event)"
53 annotationMouseOutHandler
: {
54 type
: "function(annotation, point, dygraph, event)"
56 annotationMouseOverHandler
: {
57 type
: "function(annotation, point, dygraph, event)"
64 // scope : [ "x", "y", "y2" ]
68 // scope : [ "x", "y", "y2" ]
70 axisLabelFormatter
: {
71 type
: "function(numberOrDate, granularity, opts, dygraph)",
72 scope
: [ "x", "y", "y2" ]
76 // scope : [ "x", "y", "y2" ]
80 // scope : [ "x", "y", "y2" ]
84 // scope : [ "x", "y", "y2" ]
88 // scope : [ "x", "y", "y2" ]
91 type
: "function(e, x, points)"
97 type
: "array<string>"
102 connectSeparatedPoints
: {
114 digitsAfterDecimal
: {
117 displayAnnotations
: {
124 type
: "function(dygraph, is_initial)"
126 drawGapEdgePoints
: {
129 drawHighlightPointCallback
: {
130 type
: "function(g, seriesName, canvasContext, cx, cy, color, pointSize)",
131 scope
: [ "global", "series", "y", "y2" ]
135 scope
: [ "global", "series", "y", "y2" ]
137 drawPointCallback
: {
138 type
: "function(g, seriesName, canvasContext, cx, cy, color, pointSize)",
139 scope
: [ "global", "series", "y", "y2" ]
174 hideOverlayOnMouseOut
: {
177 highlightCallback
: {
178 type
: "function(event, x, points,row)"
180 highlightCircleSize
: {
182 scope
: [ "global", "series", "y", "y2" ]
187 isZoomedIgnoreProgrammaticZoom
: {
194 type
: "array<string>"
202 labelsSeparateLines
: {
205 labelsShowZeroValues
: {
229 pointClickCallback
: {
230 type
: "function(e, point)"
234 scope
: [ "global", "series", "y", "y2" ]
236 rangeSelectorHeight
: {
239 rangeSelectorPlotFillColor
: {
242 rangeSelectorPlotStrokeColor
: {
251 showLabelsOnHighlight
: {
254 showRangeSelector
: {
272 strokeBorderColor
: {
274 scope
: [ "global", "series", "y", "y2" ]
276 strokeBorderWidth
: {
278 scope
: [ "global", "series", "y", "y2" ]
282 scope
: [ "global", "series", "y", "y2" ]
286 scope
: [ "global", "series", "y", "y2" ]
298 type
: "function(canvas, area, dygraph)"
300 unhighlightCallback
: {
301 type
: "function(event)"
304 type
: "array<float>"
307 type
: "array<boolean>"
328 type
: "function(str)"
340 type
: "function(minDate, maxDate, yRanges)"