Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 95fa17a

Browse files
theengineeartheengineear
authoredFeb 2, 2017
Merge pull request #685 from plotly/update-default-schema
Update default schema.
2 parents 6f9621a + 5efc550 commit 95fa17a

File tree

2 files changed

+108
-70
lines changed

2 files changed

+108
-70
lines changed
 

‎plotly/graph_objs/graph_objs.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -822,8 +822,9 @@ class Annotation(PlotlyDict):
822822
823823
['align', 'arrowcolor', 'arrowhead', 'arrowsize', 'arrowwidth', 'ax',
824824
'axref', 'ay', 'ayref', 'bgcolor', 'bordercolor', 'borderpad',
825-
'borderwidth', 'font', 'opacity', 'ref', 'showarrow', 'text',
826-
'textangle', 'visible', 'x', 'xanchor', 'xref', 'y', 'yanchor', 'yref']
825+
'borderwidth', 'clicktoshow', 'font', 'opacity', 'ref', 'showarrow',
826+
'standoff', 'text', 'textangle', 'visible', 'x', 'xanchor', 'xclick',
827+
'xref', 'y', 'yanchor', 'yclick', 'yref']
827828
828829
Run `<annotation-object>.help('attribute')` on any of the above.
829830
'<annotation-object>' is the object at []
@@ -1308,10 +1309,10 @@ class Histogram(PlotlyDict):
13081309
"""
13091310
Valid attributes for 'histogram' at path [] under parents ():
13101311
1311-
['autobinx', 'autobiny', 'bardir', 'error_x', 'error_y', 'histfunc',
1312-
'histnorm', 'hoverinfo', 'legendgroup', 'marker', 'name', 'nbinsx',
1313-
'nbinsy', 'opacity', 'orientation', 'showlegend', 'stream', 'text',
1314-
'textsrc', 'type', 'uid', 'visible', 'x', 'xaxis', 'xbins',
1312+
['autobinx', 'autobiny', 'bardir', 'cumulative', 'error_x', 'error_y',
1313+
'histfunc', 'histnorm', 'hoverinfo', 'legendgroup', 'marker', 'name',
1314+
'nbinsx', 'nbinsy', 'opacity', 'orientation', 'showlegend', 'stream',
1315+
'text', 'textsrc', 'type', 'uid', 'visible', 'x', 'xaxis', 'xbins',
13151316
'xcalendar', 'xsrc', 'y', 'yaxis', 'ybins', 'ycalendar', 'ysrc']
13161317
13171318
Run `<histogram-object>.help('attribute')` on any of the above.
@@ -1777,9 +1778,9 @@ class ZAxis(PlotlyDict):
17771778
17781779
['autorange', 'backgroundcolor', 'calendar', 'categoryarray',
17791780
'categoryarraysrc', 'categoryorder', 'color', 'dtick',
1780-
'exponentformat', 'fixedrange', 'gridcolor', 'gridwidth',
1781-
'hoverformat', 'linecolor', 'linewidth', 'mirror', 'nticks', 'range',
1782-
'rangemode', 'separatethousands', 'showaxeslabels', 'showbackground',
1781+
'exponentformat', 'gridcolor', 'gridwidth', 'hoverformat', 'linecolor',
1782+
'linewidth', 'mirror', 'nticks', 'range', 'rangemode',
1783+
'separatethousands', 'showaxeslabels', 'showbackground',
17831784
'showexponent', 'showgrid', 'showline', 'showspikes', 'showticklabels',
17841785
'showtickprefix', 'showticksuffix', 'spikecolor', 'spikesides',
17851786
'spikethickness', 'tick0', 'tickangle', 'tickcolor', 'tickfont',

‎plotly/package_data/default-schema.json

Lines changed: 98 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -223,45 +223,42 @@
223223
}
224224
},
225225
"frames": {
226-
"baseframe": {
227-
"description": "The name of the frame into which this frame's properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames.",
228-
"role": "info",
229-
"valType": "string"
230-
},
231-
"data": {
232-
"description": "A list of traces this frame modifies. The format is identical to the normal trace definition.",
233-
"role": "data",
234-
"valType": "data_array"
235-
},
236-
"datasrc": {
237-
"description": "Sets the source reference on plot.ly for data .",
238-
"role": "info",
239-
"valType": "string"
240-
},
241-
"group": {
242-
"description": "An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames.",
243-
"role": "info",
244-
"valType": "string"
245-
},
246-
"layout": {
247-
"description": "Layout properties which this frame modifies. The format is identical to the normal layout definition.",
248-
"valType": "any"
249-
},
250-
"name": {
251-
"description": "A label by which to identify the frame",
252-
"role": "info",
253-
"valType": "string"
254-
},
255-
"traces": {
256-
"description": "A list of trace indices that identify the respective traces in the data attribute",
257-
"role": "data",
258-
"valType": "data_array"
226+
"items": {
227+
"frames_entry": {
228+
"baseframe": {
229+
"description": "The name of the frame into which this frame's properties are merged before applying. This is used to unify properties and avoid needing to specify the same values for the same properties in multiple frames.",
230+
"role": "info",
231+
"valType": "string"
232+
},
233+
"data": {
234+
"description": "A list of traces this frame modifies. The format is identical to the normal trace definition.",
235+
"role": "object",
236+
"valType": "any"
237+
},
238+
"group": {
239+
"description": "An identifier that specifies the group to which the frame belongs, used by animate to select a subset of frames.",
240+
"role": "info",
241+
"valType": "string"
242+
},
243+
"layout": {
244+
"description": "Layout properties which this frame modifies. The format is identical to the normal layout definition.",
245+
"role": "object",
246+
"valType": "any"
247+
},
248+
"name": {
249+
"description": "A label by which to identify the frame",
250+
"role": "info",
251+
"valType": "string"
252+
},
253+
"role": "object",
254+
"traces": {
255+
"description": "A list of trace indices that identify the respective traces in the data attribute",
256+
"role": "info",
257+
"valType": "any"
258+
}
259+
}
259260
},
260-
"tracessrc": {
261-
"description": "Sets the source reference on plot.ly for traces .",
262-
"role": "info",
263-
"valType": "string"
264-
}
261+
"role": "object"
265262
},
266263
"layout": {
267264
"layoutAttributes": {
@@ -451,6 +448,17 @@
451448
"role": "style",
452449
"valType": "number"
453450
},
451+
"clicktoshow": {
452+
"description": "Makes this annotation respond to clicks on the plot. If you click a data point that exactly matches the `x` and `y` values of this annotation, and it is hidden (visible: false), it will appear. In *onoff* mode, you must click the same point again to make it disappear, so if you click multiple points, you can show multiple annotations. In *onout* mode, a click anywhere else in the plot (on another data point or not) will hide this annotation. If you need to show/hide this annotation in response to different `x` or `y` values, you can set `xclick` and/or `yclick`. This is useful for example to label the side of a bar. To label markers though, `standoff` is preferred over `xclick` and `yclick`.",
453+
"dflt": false,
454+
"role": "style",
455+
"valType": "enumerated",
456+
"values": [
457+
false,
458+
"onoff",
459+
"onout"
460+
]
461+
},
454462
"font": {
455463
"color": {
456464
"role": "style",
@@ -486,6 +494,13 @@
486494
"role": "style",
487495
"valType": "boolean"
488496
},
497+
"standoff": {
498+
"description": "Sets a distance, in pixels, to move the arrowhead away from the position it is pointing at, for example to point at the edge of a marker independent of zoom.",
499+
"dflt": 0,
500+
"min": 0,
501+
"role": "style",
502+
"valType": "number"
503+
},
489504
"text": {
490505
"description": "Sets the text associated with this annotation. Plotly uses a subset of HTML tags to do things like newline (<br>), bold (<b></b>), italics (<i></i>), hyperlinks (<a href='...'></a>). Tags <em>, <sup>, <sub> <span> are also supported.",
491506
"role": "info",
@@ -509,7 +524,7 @@
509524
"valType": "any"
510525
},
511526
"xanchor": {
512-
"description": "Sets the annotation's horizontal position anchor This anchor binds the `x` position to the *left*, *center* or *right* of the annotation. For example, if `x` is set to 1, `xref` to *paper* and `xanchor` to *right* then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If *auto*, the anchor is equivalent to *center* for data-referenced annotations whereas for paper-referenced, the anchor picked corresponds to the closest side.",
527+
"description": "Sets the text box's horizontal position anchor This anchor binds the `x` position to the *left*, *center* or *right* of the annotation. For example, if `x` is set to 1, `xref` to *paper* and `xanchor` to *right* then the right-most portion of the annotation lines up with the right-most edge of the plotting area. If *auto*, the anchor is equivalent to *center* for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.",
513528
"dflt": "auto",
514529
"role": "info",
515530
"valType": "enumerated",
@@ -520,6 +535,11 @@
520535
"right"
521536
]
522537
},
538+
"xclick": {
539+
"description": "Toggle this annotation when clicking a data point whose `x` value is `xclick` rather than the annotation's `x` value.",
540+
"role": "info",
541+
"valType": "any"
542+
},
523543
"xref": {
524544
"description": "Sets the annotation's x coordinate axis. If set to an x axis id (e.g. *x* or *x2*), the `x` position refers to an x coordinate If set to *paper*, the `x` position refers to the distance from the left side of the plotting area in normalized coordinates where 0 (1) corresponds to the left (right) side.",
525545
"role": "info",
@@ -535,7 +555,7 @@
535555
"valType": "any"
536556
},
537557
"yanchor": {
538-
"description": "Sets the annotation's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the annotation. For example, if `y` is set to 1, `yref` to *paper* and `yanchor` to *top* then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If *auto*, the anchor is equivalent to *middle* for data-referenced annotations whereas for paper-referenced, the anchor picked corresponds to the closest side.",
558+
"description": "Sets the text box's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the annotation. For example, if `y` is set to 1, `yref` to *paper* and `yanchor` to *top* then the top-most portion of the annotation lines up with the top-most edge of the plotting area. If *auto*, the anchor is equivalent to *middle* for data-referenced annotations or if there is an arrow, whereas for paper-referenced with no arrow, the anchor picked corresponds to the closest side.",
539559
"dflt": "auto",
540560
"role": "info",
541561
"valType": "enumerated",
@@ -546,6 +566,11 @@
546566
"bottom"
547567
]
548568
},
569+
"yclick": {
570+
"description": "Toggle this annotation when clicking a data point whose `y` value is `yclick` rather than the annotation's `y` value.",
571+
"role": "info",
572+
"valType": "any"
573+
},
549574
"yref": {
550575
"description": "Sets the annotation's y coordinate axis. If set to an y axis id (e.g. *y* or *y2*), the `y` position refers to an y coordinate If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where 0 (1) corresponds to the bottom (top).",
551576
"role": "info",
@@ -1910,12 +1935,6 @@
19101935
"B"
19111936
]
19121937
},
1913-
"fixedrange": {
1914-
"description": "Determines whether or not this axis is zoom-able. If true, then zoom is disabled.",
1915-
"dflt": false,
1916-
"role": "info",
1917-
"valType": "boolean"
1918-
},
19191938
"gridcolor": {
19201939
"description": "Sets the color of the grid lines.",
19211940
"dflt": "rgb(204, 204, 204)",
@@ -2343,12 +2362,6 @@
23432362
"B"
23442363
]
23452364
},
2346-
"fixedrange": {
2347-
"description": "Determines whether or not this axis is zoom-able. If true, then zoom is disabled.",
2348-
"dflt": false,
2349-
"role": "info",
2350-
"valType": "boolean"
2351-
},
23522365
"gridcolor": {
23532366
"description": "Sets the color of the grid lines.",
23542367
"dflt": "rgb(204, 204, 204)",
@@ -2776,12 +2789,6 @@
27762789
"B"
27772790
]
27782791
},
2779-
"fixedrange": {
2780-
"description": "Determines whether or not this axis is zoom-able. If true, then zoom is disabled.",
2781-
"dflt": false,
2782-
"role": "info",
2783-
"valType": "boolean"
2784-
},
27852792
"gridcolor": {
27862793
"description": "Sets the color of the grid lines.",
27872794
"dflt": "rgb(204, 204, 204)",
@@ -10707,6 +10714,36 @@
1070710714
"role": "style",
1070810715
"valType": "boolean"
1070910716
},
10717+
"cumulative": {
10718+
"currentbin": {
10719+
"description": "Only applies if cumulative is enabled. Sets whether the current bin is included, excluded, or has half of its value included in the current cumulative value. *include* is the default for compatibility with various other tools, however it introduces a half-bin bias to the results. *exclude* makes the opposite half-bin bias, and *half* removes it.",
10720+
"dflt": "include",
10721+
"role": "info",
10722+
"valType": "enumerated",
10723+
"values": [
10724+
"include",
10725+
"exclude",
10726+
"half"
10727+
]
10728+
},
10729+
"direction": {
10730+
"description": "Only applies if cumulative is enabled. If *increasing* (default) we sum all prior bins, so the result increases from left to right. If *decreasing* we sum later bins so the result decreases from left to right.",
10731+
"dflt": "increasing",
10732+
"role": "info",
10733+
"valType": "enumerated",
10734+
"values": [
10735+
"increasing",
10736+
"decreasing"
10737+
]
10738+
},
10739+
"enabled": {
10740+
"description": "If true, display the cumulative distribution by summing the binned values. Use the `direction` and `centralbin` attributes to tune the accumulation method. Note: in this mode, the *density* `histnorm` settings behave the same as their equivalents without *density*: ** and *density* both rise to the number of data points, and *probability* and *probability density* both rise to the number of sample points.",
10741+
"dflt": false,
10742+
"role": "info",
10743+
"valType": "boolean"
10744+
},
10745+
"role": "object"
10746+
},
1071010747
"error_x": {
1071110748
"_deprecated": {
1071210749
"opacity": {
@@ -10927,7 +10964,7 @@
1092710964
]
1092810965
},
1092910966
"histnorm": {
10930-
"description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent*, the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If *probability density*, the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).",
10967+
"description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
1093110968
"dflt": "",
1093210969
"role": "style",
1093310970
"valType": "enumerated",
@@ -12059,7 +12096,7 @@
1205912096
]
1206012097
},
1206112098
"histnorm": {
12062-
"description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent*, the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If *probability density*, the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).",
12099+
"description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
1206312100
"dflt": "",
1206412101
"role": "style",
1206512102
"valType": "enumerated",
@@ -12796,7 +12833,7 @@
1279612833
]
1279712834
},
1279812835
"histnorm": {
12799-
"description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent*, the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If *probability density*, the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).",
12836+
"description": "Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent* / *probability*, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If *probability density*, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).",
1280012837
"dflt": "",
1280112838
"role": "style",
1280212839
"valType": "enumerated",

0 commit comments

Comments
 (0)
Please sign in to comment.