diff --git a/plotly/graph_reference/default-schema.json b/plotly/graph_reference/default-schema.json index 386ceededed..9c3a11e689b 100644 --- a/plotly/graph_reference/default-schema.json +++ b/plotly/graph_reference/default-schema.json @@ -19,7 +19,8 @@ "description": "Any type.", "otherOpts": [ "dflt", - "values" + "values", + "arrayOk" ], "requiredOpts": [] }, @@ -415,14 +416,10 @@ "role": "object" }, "autosize": { - "description": "Determines whether or not the dimensions of the figure are computed as a function of the display size.", + "description": "Determines whether or not a layout width or height that has been left undefined by the user is initialized on each relayout. Note that, regardless of this attribute, an undefined layout width or height is always initialized on the first call to plot.", + "dflt": false, "role": "info", - "valType": "enumerated", - "values": [ - true, - false, - "initial" - ] + "valType": "boolean" }, "direction": { "description": "For polar plots only. Sets the direction corresponding to positive angles.", @@ -1799,6 +1796,12 @@ ] }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showaxeslabels": { "description": "Sets whether or not this axis is labeled", "dflt": true, @@ -2204,6 +2207,12 @@ ] }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showaxeslabels": { "description": "Sets whether or not this axis is labeled", "dflt": true, @@ -2609,6 +2618,12 @@ ] }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showaxeslabels": { "description": "Sets whether or not this axis is labeled", "dflt": true, @@ -2992,6 +3007,336 @@ "role": "info", "valType": "boolean" }, + "sliders": { + "active": { + "description": "Determines which button (by index starting from 0) is considered active.", + "dflt": 0, + "min": 0, + "role": "info", + "valType": "number" + }, + "activebgcolor": { + "description": "Sets the background color of the slider grip while dragging.", + "dflt": "#dbdde0", + "role": "style", + "valType": "color" + }, + "bgcolor": { + "description": "Sets the background color of the slider.", + "dflt": "#f8fafc", + "role": "style", + "valType": "color" + }, + "bordercolor": { + "description": "Sets the color of the border enclosing the slider.", + "dflt": "#bec8d9", + "role": "style", + "valType": "color" + }, + "borderwidth": { + "description": "Sets the width (in px) of the border enclosing the slider.", + "dflt": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "currentvalue": { + "font": { + "color": { + "role": "style", + "valType": "color" + }, + "description": "Sets the font of the current value label text.", + "family": { + "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.", + "noBlank": true, + "role": "style", + "strict": true, + "valType": "string" + }, + "role": "object", + "size": { + "min": 1, + "role": "style", + "valType": "number" + } + }, + "offset": { + "description": "The amount of space, in pixels, between the current value label and the slider.", + "dflt": 10, + "role": "info", + "valType": "number" + }, + "prefix": { + "description": "When currentvalue.visible is true, this sets the prefix of the label.", + "role": "info", + "valType": "string" + }, + "role": "object", + "suffix": { + "description": "When currentvalue.visible is true, this sets the suffix of the label.", + "role": "info", + "valType": "string" + }, + "visible": { + "description": "Shows the currently-selected value above the slider.", + "dflt": true, + "role": "info", + "valType": "boolean" + }, + "xanchor": { + "description": "The alignment of the value readout relative to the length of the slider.", + "dflt": "left", + "role": "info", + "valType": "enumerated", + "values": [ + "left", + "center", + "right" + ] + } + }, + "font": { + "color": { + "role": "style", + "valType": "color" + }, + "description": "Sets the font of the slider step labels.", + "family": { + "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.", + "noBlank": true, + "role": "style", + "strict": true, + "valType": "string" + }, + "role": "object", + "size": { + "min": 1, + "role": "style", + "valType": "number" + } + }, + "len": { + "description": "Sets the length of the slider This measure excludes the padding of both ends. That is, the slider's length is this length minus the padding on both ends.", + "dflt": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "lenmode": { + "description": "Determines whether this slider length is set in units of plot *fraction* or in *pixels. Use `len` to set the value.", + "dflt": "fraction", + "role": "info", + "valType": "enumerated", + "values": [ + "fraction", + "pixels" + ] + }, + "minorticklen": { + "description": "Sets the length in pixels of minor step tick marks", + "dflt": 4, + "min": 0, + "role": "style", + "valType": "number" + }, + "pad": { + "b": { + "description": "The amount of padding (in px) along the bottom of the component.", + "dflt": 0, + "role": "style", + "valType": "number" + }, + "description": "Set the padding of the slider component along each side.", + "l": { + "description": "The amount of padding (in px) on the left side of the component.", + "dflt": 0, + "role": "style", + "valType": "number" + }, + "r": { + "description": "The amount of padding (in px) on the right side of the component.", + "dflt": 0, + "role": "style", + "valType": "number" + }, + "role": "object", + "t": { + "description": "The amount of padding (in px) along the top of the component.", + "dflt": 20, + "role": "style", + "valType": "number" + } + }, + "role": "object", + "steps": { + "items": { + "step": { + "args": { + "description": "Sets the arguments values to be passed to the Plotly method set in `method` on slide.", + "freeLength": true, + "items": [ + { + "valType": "any" + }, + { + "valType": "any" + }, + { + "valType": "any" + } + ], + "role": "info", + "valType": "info_array" + }, + "label": { + "description": "Sets the text label to appear on the slider", + "role": "info", + "valType": "string" + }, + "method": { + "description": "Sets the Plotly method to be called when the slider value is changed.", + "dflt": "restyle", + "role": "info", + "valType": "enumerated", + "values": [ + "restyle", + "relayout", + "animate", + "update" + ] + }, + "role": "object", + "value": { + "description": "Sets the value of the slider step, used to refer to the step programatically. Defaults to the slider label if not provided.", + "role": "info", + "valType": "string" + } + } + }, + "role": "object" + }, + "tickcolor": { + "description": "Sets the color of the border enclosing the slider.", + "dflt": "#333", + "role": "style", + "valType": "color" + }, + "ticklen": { + "description": "Sets the length in pixels of step tick marks", + "dflt": 7, + "min": 0, + "role": "style", + "valType": "number" + }, + "tickwidth": { + "description": "Sets the tick width (in px).", + "dflt": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "transition": { + "duration": { + "description": "Sets the duration of the slider transition", + "dflt": 150, + "min": 0, + "role": "info", + "valType": "number" + }, + "easing": { + "description": "Sets the easing function of the slider transition", + "dflt": "cubic-in-out", + "role": "info", + "valType": "enumerated", + "values": [ + "linear", + "quad", + "cubic", + "sin", + "exp", + "circle", + "elastic", + "back", + "bounce", + "linear-in", + "quad-in", + "cubic-in", + "sin-in", + "exp-in", + "circle-in", + "elastic-in", + "back-in", + "bounce-in", + "linear-out", + "quad-out", + "cubic-out", + "sin-out", + "exp-out", + "circle-out", + "elastic-out", + "back-out", + "bounce-out", + "linear-in-out", + "quad-in-out", + "cubic-in-out", + "sin-in-out", + "exp-in-out", + "circle-in-out", + "elastic-in-out", + "back-in-out", + "bounce-in-out" + ] + }, + "role": "object" + }, + "visible": { + "description": "Determines whether or not the slider is visible.", + "dflt": true, + "role": "info", + "valType": "boolean" + }, + "x": { + "description": "Sets the x position (in normalized coordinates) of the slider.", + "dflt": 0, + "max": 3, + "min": -2, + "role": "style", + "valType": "number" + }, + "xanchor": { + "description": "Sets the slider's horizontal position anchor. This anchor binds the `x` position to the *left*, *center* or *right* of the range selector.", + "dflt": "left", + "role": "info", + "valType": "enumerated", + "values": [ + "auto", + "left", + "center", + "right" + ] + }, + "y": { + "description": "Sets the y position (in normalized coordinates) of the slider.", + "dflt": 0, + "max": 3, + "min": -2, + "role": "style", + "valType": "number" + }, + "yanchor": { + "description": "Sets the slider's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the range selector.", + "dflt": "top", + "role": "info", + "valType": "enumerated", + "values": [ + "auto", + "top", + "middle", + "bottom" + ] + } + }, "smith": { "dflt": false, "role": "info", @@ -3076,6 +3421,12 @@ "valType": "integer" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -3340,6 +3691,12 @@ "valType": "integer" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -3610,6 +3967,12 @@ "valType": "integer" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -3941,7 +4304,9 @@ "valType": "enumerated", "values": [ "restyle", - "relayout" + "relayout", + "animate", + "update" ] }, "role": "object" @@ -3949,6 +4314,18 @@ }, "role": "object" }, + "direction": { + "description": "Determines the direction in which the buttons are laid out, whether in a dropdown menu or a row/column of buttons. For `left` and `up`, the buttons will still appear in left-to-right or top-to-bottom order respectively.", + "dflt": "down", + "role": "info", + "valType": "enumerated", + "values": [ + "left", + "right", + "up", + "down" + ] + }, "font": { "color": { "role": "style", @@ -3969,11 +4346,55 @@ "valType": "number" } }, - "role": "object", - "visible": { - "description": "Determines whether or not the update menu is visible.", - "role": "info", - "valType": "boolean" + "pad": { + "b": { + "description": "The amount of padding (in px) along the bottom of the component.", + "dflt": 0, + "role": "style", + "valType": "number" + }, + "description": "Sets the padding around the buttons or dropdown menu.", + "l": { + "description": "The amount of padding (in px) on the left side of the component.", + "dflt": 0, + "role": "style", + "valType": "number" + }, + "r": { + "description": "The amount of padding (in px) on the right side of the component.", + "dflt": 0, + "role": "style", + "valType": "number" + }, + "role": "object", + "t": { + "description": "The amount of padding (in px) along the top of the component.", + "dflt": 0, + "role": "style", + "valType": "number" + } + }, + "role": "object", + "showactive": { + "description": "Highlights active dropdown item or active button if true.", + "dflt": true, + "role": "info", + "valType": "boolean" + }, + "type": { + "description": "Determines whether the buttons are accessible via a dropdown menu or whether the buttons are stacked horizontally or vertically", + "dflt": "dropdown", + "role": "info", + "valType": "enumerated", + "values": [ + "dropdown", + "buttons" + ] + }, + "visible": { + "description": "Determines whether or not the update menu is visible.", + "role": "info", + "valType": "boolean" }, "x": { "description": "Sets the x position (in normalized coordinates) of the update menu.", @@ -4005,7 +4426,7 @@ }, "yanchor": { "description": "Sets the update menu's vertical position anchor This anchor binds the `y` position to the *top*, *middle* or *bottom* of the range selector.", - "dflt": "bottom", + "dflt": "top", "role": "info", "valType": "enumerated", "values": [ @@ -4411,6 +4832,12 @@ } }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -5026,6 +5453,12 @@ } }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -5262,11 +5695,12 @@ "area": { "attributes": { "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -5654,6 +6088,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -5709,6 +6145,18 @@ ] } }, + "base": { + "arrayOk": true, + "description": "Sets where the bar base is drawn (in position axis units). In *stack* or *relative* barmode, traces that set *base* will be excluded and drawn in *overlay* mode instead.", + "dflt": null, + "role": "info", + "valType": "any" + }, + "basesrc": { + "description": "Sets the source reference on plot.ly for base .", + "role": "info", + "valType": "string" + }, "dx": { "description": "Sets the x coordinate step. See `x0` for more info.", "dflt": 1, @@ -5928,11 +6376,12 @@ } }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -6059,6 +6508,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -6410,6 +6865,18 @@ "role": "info", "valType": "string" }, + "offset": { + "arrayOk": true, + "description": "Shifts the position where the bar is drawn (in position axis units). In *group* barmode, traces that set *offset* will be excluded and drawn in *overlay* mode instead.", + "dflt": null, + "role": "info", + "valType": "number" + }, + "offsetsrc": { + "description": "Sets the source reference on plot.ly for offset .", + "role": "info", + "valType": "string" + }, "opacity": { "description": "Sets the opacity of the trace.", "dflt": 1, @@ -6446,6 +6913,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -6498,6 +6967,19 @@ "legendonly" ] }, + "width": { + "arrayOk": true, + "description": "Sets the bar width (in position axis units).", + "dflt": null, + "min": 0, + "role": "info", + "valType": "number" + }, + "widthsrc": { + "description": "Sets the source reference on plot.ly for width .", + "role": "info", + "valType": "string" + }, "x": { "description": "Sets the x coordinates.", "role": "data", @@ -6616,11 +7098,12 @@ "valType": "color" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -7053,6 +7536,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -7164,92 +7649,347 @@ } } }, - "choropleth": { + "candlestick": { "attributes": { - "autocolorscale": { - "description": "Determines whether or not the colorscale is picked using the sign of the input z values.", - "dflt": true, - "role": "style", - "valType": "boolean" + "close": { + "description": "Sets the close values.", + "dflt": [], + "role": "data", + "valType": "data_array" }, - "colorbar": { - "bgcolor": { - "description": "Sets the color of padded area.", - "dflt": "rgba(0,0,0,0)", - "role": "style", - "valType": "color" - }, - "bordercolor": { - "description": "Sets the axis line color.", - "dflt": "#444", + "closesrc": { + "description": "Sets the source reference on plot.ly for close .", + "role": "info", + "valType": "string" + }, + "decreasing": { + "fillcolor": { + "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.", "role": "style", "valType": "color" }, - "borderwidth": { - "description": "Sets the width (in px) or the border enclosing this color bar.", - "dflt": 0, - "min": 0, - "role": "style", - "valType": "number" + "line": { + "color": { + "description": "Sets the color of line bounding the box(es).", + "dflt": "#FF4136", + "role": "style", + "valType": "color" + }, + "role": "object", + "width": { + "description": "Sets the width (in px) of line bounding the box(es).", + "dflt": 2, + "min": 0, + "role": "style", + "valType": "number" + } }, - "dtick": { - "description": "Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.", - "dflt": 1, - "role": "style", - "valType": "any" + "name": { + "description": "Sets the segment name. The segment name appear as the legend item and on hover.", + "role": "info", + "valType": "string" }, - "exponentformat": { - "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.", - "dflt": "B", + "role": "object", + "showlegend": { + "description": "Determines whether or not an item corresponding to this segment is shown in the legend.", + "dflt": true, + "role": "info", + "valType": "boolean" + } + }, + "high": { + "description": "Sets the high values.", + "dflt": [], + "role": "data", + "valType": "data_array" + }, + "highsrc": { + "description": "Sets the source reference on plot.ly for high .", + "role": "info", + "valType": "string" + }, + "hoverinfo": { + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", + "dflt": "all", + "extras": [ + "all", + "none", + "skip" + ], + "flags": [ + "x", + "y", + "z", + "text", + "name" + ], + "role": "info", + "valType": "flaglist" + }, + "increasing": { + "fillcolor": { + "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.", "role": "style", - "valType": "enumerated", - "values": [ - "none", - "e", - "E", - "power", - "SI", - "B" - ] + "valType": "color" }, - "len": { - "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.", - "dflt": 1, - "min": 0, - "role": "style", - "valType": "number" + "line": { + "color": { + "description": "Sets the color of line bounding the box(es).", + "dflt": "#3D9970", + "role": "style", + "valType": "color" + }, + "role": "object", + "width": { + "description": "Sets the width (in px) of line bounding the box(es).", + "dflt": 2, + "min": 0, + "role": "style", + "valType": "number" + } }, - "lenmode": { - "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.", - "dflt": "fraction", + "name": { + "description": "Sets the segment name. The segment name appear as the legend item and on hover.", "role": "info", - "valType": "enumerated", - "values": [ - "fraction", - "pixels" - ] + "valType": "string" }, - "nticks": { - "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.", - "dflt": 0, + "role": "object", + "showlegend": { + "description": "Determines whether or not an item corresponding to this segment is shown in the legend.", + "dflt": true, + "role": "info", + "valType": "boolean" + } + }, + "legendgroup": { + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.", + "dflt": "", + "role": "info", + "valType": "string" + }, + "line": { + "role": "object", + "width": { + "description": "Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.", + "dflt": 2, "min": 0, "role": "style", - "valType": "integer" - }, - "outlinecolor": { - "description": "Sets the axis line color.", - "dflt": "#444", - "role": "style", - "valType": "color" - }, - "outlinewidth": { - "description": "Sets the width (in px) of the axis line.", - "dflt": 1, + "valType": "number" + } + }, + "low": { + "description": "Sets the low values.", + "dflt": [], + "role": "data", + "valType": "data_array" + }, + "lowsrc": { + "description": "Sets the source reference on plot.ly for low .", + "role": "info", + "valType": "string" + }, + "name": { + "description": "Sets the trace name. The trace name appear as the legend item and on hover.", + "role": "info", + "valType": "string" + }, + "opacity": { + "description": "Sets the opacity of the trace.", + "dflt": 1, + "max": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "open": { + "description": "Sets the open values.", + "dflt": [], + "role": "data", + "valType": "data_array" + }, + "opensrc": { + "description": "Sets the source reference on plot.ly for open .", + "role": "info", + "valType": "string" + }, + "showlegend": { + "description": "Determines whether or not an item corresponding to this trace is shown in the legend.", + "dflt": true, + "role": "info", + "valType": "boolean" + }, + "stream": { + "maxpoints": { + "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, - "role": "style", + "role": "info", "valType": "number" }, "role": "object", + "token": { + "description": "The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.", + "noBlank": true, + "role": "info", + "strict": true, + "valType": "string" + } + }, + "text": { + "arrayOk": true, + "description": "Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.", + "dflt": "", + "role": "info", + "valType": "string" + }, + "textsrc": { + "description": "Sets the source reference on plot.ly for text .", + "role": "info", + "valType": "string" + }, + "type": "candlestick", + "uid": { + "dflt": "", + "role": "info", + "valType": "string" + }, + "visible": { + "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).", + "dflt": true, + "role": "info", + "valType": "enumerated", + "values": [ + true, + false, + "legendonly" + ] + }, + "whiskerwidth": { + "description": "Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).", + "dflt": 0, + "max": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "x": { + "description": "Sets the x coordinates. If absent, linear coordinate will be generated.", + "role": "data", + "valType": "data_array" + }, + "xaxis": { + "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.", + "dflt": "x", + "role": "info", + "valType": "subplotid" + }, + "xsrc": { + "description": "Sets the source reference on plot.ly for x .", + "role": "info", + "valType": "string" + }, + "yaxis": { + "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.xaxis2`, and so on.", + "dflt": "y", + "role": "info", + "valType": "subplotid" + } + }, + "description": "The candlestick is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The boxes represent the spread between the `open` and `close` values and the lines represent the spread between the `low` and `high` values Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red." + }, + "choropleth": { + "attributes": { + "autocolorscale": { + "description": "Determines whether or not the colorscale is picked using the sign of the input z values.", + "dflt": true, + "role": "style", + "valType": "boolean" + }, + "colorbar": { + "bgcolor": { + "description": "Sets the color of padded area.", + "dflt": "rgba(0,0,0,0)", + "role": "style", + "valType": "color" + }, + "bordercolor": { + "description": "Sets the axis line color.", + "dflt": "#444", + "role": "style", + "valType": "color" + }, + "borderwidth": { + "description": "Sets the width (in px) or the border enclosing this color bar.", + "dflt": 0, + "min": 0, + "role": "style", + "valType": "number" + }, + "dtick": { + "description": "Sets the step in-between ticks on this axis Use with `tick0`. If the axis `type` is *log*, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, ... set dtick to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to log_10(5), or 0.69897000433. If the axis `type` is *date*, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set `dtick` to 86400000.0.", + "dflt": 1, + "role": "style", + "valType": "any" + }, + "exponentformat": { + "description": "Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If *none*, it appears as 1,000,000,000. If *e*, 1e+9. If *E*, 1E+9. If *power*, 1x10^9 (with 9 in a super script). If *SI*, 1G. If *B*, 1B.", + "dflt": "B", + "role": "style", + "valType": "enumerated", + "values": [ + "none", + "e", + "E", + "power", + "SI", + "B" + ] + }, + "len": { + "description": "Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.", + "dflt": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "lenmode": { + "description": "Determines whether this color bar's length (i.e. the measure in the color variation direction) is set in units of plot *fraction* or in *pixels. Use `len` to set the value.", + "dflt": "fraction", + "role": "info", + "valType": "enumerated", + "values": [ + "fraction", + "pixels" + ] + }, + "nticks": { + "description": "Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to `nticks`. Has an effect only if `tickmode` is set to *auto*.", + "dflt": 0, + "min": 0, + "role": "style", + "valType": "integer" + }, + "outlinecolor": { + "description": "Sets the axis line color.", + "dflt": "#444", + "role": "style", + "valType": "color" + }, + "outlinewidth": { + "description": "Sets the width (in px) of the axis line.", + "dflt": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -7522,11 +8262,12 @@ "valType": "subplotid" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "location", @@ -7627,6 +8368,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -7790,6 +8533,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -8113,11 +8862,12 @@ "valType": "number" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -8212,6 +8962,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -8437,6 +9189,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -8721,11 +9479,12 @@ "valType": "number" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -8777,6 +9536,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -8840,6 +9601,13 @@ "role": "info", "valType": "subplotid" }, + "xgap": { + "description": "Sets the horizontal gap (in pixels) between bricks.", + "dflt": 0, + "min": 0, + "role": "style", + "valType": "number" + }, "xsrc": { "description": "Sets the source reference on plot.ly for x .", "role": "info", @@ -8871,6 +9639,13 @@ "role": "info", "valType": "subplotid" }, + "ygap": { + "description": "Sets the vertical gap (in pixels) between bricks.", + "dflt": 0, + "min": 0, + "role": "style", + "valType": "number" + }, "ysrc": { "description": "Sets the source reference on plot.ly for y .", "role": "info", @@ -9185,11 +9960,12 @@ ] }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -9316,6 +10092,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -9707,6 +10489,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -9964,6 +10748,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -10256,11 +11046,12 @@ ] }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -10339,6 +11130,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -10401,6 +11194,13 @@ "valType": "number" } }, + "xgap": { + "description": "Sets the horizontal gap (in pixels) between bricks.", + "dflt": 0, + "min": 0, + "role": "style", + "valType": "number" + }, "xsrc": { "description": "Sets the source reference on plot.ly for x .", "role": "info", @@ -10438,6 +11238,13 @@ "valType": "number" } }, + "ygap": { + "description": "Sets the vertical gap (in pixels) between bricks.", + "dflt": 0, + "min": 0, + "role": "style", + "valType": "number" + }, "ysrc": { "description": "Sets the source reference on plot.ly for y .", "role": "info", @@ -10590,6 +11397,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -10921,11 +11734,12 @@ ] }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -11047,6 +11861,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -11274,6 +12090,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -11590,11 +12412,12 @@ "valType": "boolean" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -11778,6 +12601,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -11851,30 +12676,311 @@ }, "description": "Draws sets of triangles with coordinates given by three 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha-shape algorithm or (4) the Convex-hull algorithm" }, - "pie": { + "ohlc": { "attributes": { - "direction": { - "description": "Specifies the direction at which succeeding sectors follow one another.", - "dflt": "counterclockwise", - "role": "style", - "valType": "enumerated", - "values": [ - "clockwise", - "counterclockwise" - ] + "close": { + "description": "Sets the close values.", + "dflt": [], + "role": "data", + "valType": "data_array" }, - "dlabel": { - "description": "Sets the label step. See `label0` for more info.", - "dflt": 1, + "closesrc": { + "description": "Sets the source reference on plot.ly for close .", "role": "info", - "valType": "number" + "valType": "string" }, - "domain": { + "decreasing": { + "line": { + "color": { + "description": "Sets the line color.", + "dflt": "#FF4136", + "role": "style", + "valType": "color" + }, + "dash": { + "description": "Sets the style of the lines. Set to a dash string type or a dash length in px.", + "dflt": "solid", + "role": "style", + "valType": "string", + "values": [ + "solid", + "dot", + "dash", + "longdash", + "dashdot", + "longdashdot" + ] + }, + "role": "object", + "width": { + "description": "Sets the line width (in px).", + "dflt": 2, + "min": 0, + "role": "style", + "valType": "number" + } + }, + "name": { + "description": "Sets the segment name. The segment name appear as the legend item and on hover.", + "role": "info", + "valType": "string" + }, "role": "object", - "x": { - "description": "Sets the horizontal domain of this pie trace (in plot fraction).", - "dflt": [ - 0, + "showlegend": { + "description": "Determines whether or not an item corresponding to this segment is shown in the legend.", + "dflt": true, + "role": "info", + "valType": "boolean" + } + }, + "high": { + "description": "Sets the high values.", + "dflt": [], + "role": "data", + "valType": "data_array" + }, + "highsrc": { + "description": "Sets the source reference on plot.ly for high .", + "role": "info", + "valType": "string" + }, + "hoverinfo": { + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", + "dflt": "all", + "extras": [ + "all", + "none", + "skip" + ], + "flags": [ + "x", + "y", + "z", + "text", + "name" + ], + "role": "info", + "valType": "flaglist" + }, + "increasing": { + "line": { + "color": { + "description": "Sets the line color.", + "dflt": "#3D9970", + "role": "style", + "valType": "color" + }, + "dash": { + "description": "Sets the style of the lines. Set to a dash string type or a dash length in px.", + "dflt": "solid", + "role": "style", + "valType": "string", + "values": [ + "solid", + "dot", + "dash", + "longdash", + "dashdot", + "longdashdot" + ] + }, + "role": "object", + "width": { + "description": "Sets the line width (in px).", + "dflt": 2, + "min": 0, + "role": "style", + "valType": "number" + } + }, + "name": { + "description": "Sets the segment name. The segment name appear as the legend item and on hover.", + "role": "info", + "valType": "string" + }, + "role": "object", + "showlegend": { + "description": "Determines whether or not an item corresponding to this segment is shown in the legend.", + "dflt": true, + "role": "info", + "valType": "boolean" + } + }, + "legendgroup": { + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.", + "dflt": "", + "role": "info", + "valType": "string" + }, + "line": { + "dash": { + "description": "[object Object] Note that this style setting can also be set per direction via `increasing.line.dash` and `decreasing.line.dash`.", + "dflt": "solid", + "role": "style", + "valType": "string", + "values": [ + "solid", + "dot", + "dash", + "longdash", + "dashdot", + "longdashdot" + ] + }, + "role": "object", + "width": { + "description": "[object Object] Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.", + "dflt": 2, + "min": 0, + "role": "style", + "valType": "number" + } + }, + "low": { + "description": "Sets the low values.", + "dflt": [], + "role": "data", + "valType": "data_array" + }, + "lowsrc": { + "description": "Sets the source reference on plot.ly for low .", + "role": "info", + "valType": "string" + }, + "name": { + "description": "Sets the trace name. The trace name appear as the legend item and on hover.", + "role": "info", + "valType": "string" + }, + "opacity": { + "description": "Sets the opacity of the trace.", + "dflt": 1, + "max": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "open": { + "description": "Sets the open values.", + "dflt": [], + "role": "data", + "valType": "data_array" + }, + "opensrc": { + "description": "Sets the source reference on plot.ly for open .", + "role": "info", + "valType": "string" + }, + "showlegend": { + "description": "Determines whether or not an item corresponding to this trace is shown in the legend.", + "dflt": true, + "role": "info", + "valType": "boolean" + }, + "stream": { + "maxpoints": { + "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, + "min": 0, + "role": "info", + "valType": "number" + }, + "role": "object", + "token": { + "description": "The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.", + "noBlank": true, + "role": "info", + "strict": true, + "valType": "string" + } + }, + "text": { + "arrayOk": true, + "description": "Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.", + "dflt": "", + "role": "info", + "valType": "string" + }, + "textsrc": { + "description": "Sets the source reference on plot.ly for text .", + "role": "info", + "valType": "string" + }, + "tickwidth": { + "description": "Sets the width of the open/close tick marks relative to the *x* minimal interval.", + "dflt": 0.3, + "max": 0.5, + "min": 0, + "role": "style", + "valType": "number" + }, + "type": "ohlc", + "uid": { + "dflt": "", + "role": "info", + "valType": "string" + }, + "visible": { + "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).", + "dflt": true, + "role": "info", + "valType": "enumerated", + "values": [ + true, + false, + "legendonly" + ] + }, + "x": { + "description": "Sets the x coordinates. If absent, linear coordinate will be generated.", + "role": "data", + "valType": "data_array" + }, + "xaxis": { + "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.", + "dflt": "x", + "role": "info", + "valType": "subplotid" + }, + "xsrc": { + "description": "Sets the source reference on plot.ly for x .", + "role": "info", + "valType": "string" + }, + "yaxis": { + "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.xaxis2`, and so on.", + "dflt": "y", + "role": "info", + "valType": "subplotid" + } + }, + "description": "The ohlc (short for Open-High-Low-Close) is a style of financial chart describing open, high, low and close for a given `x` coordinate (most likely time). The tip of the lines represent the `low` and `high` values and the horizontal segments represent the `open` and `close` values. Sample points where the close value is higher (lower) then the open value are called increasing (decreasing). By default, increasing candles are drawn in green whereas decreasing are drawn in red." + }, + "pie": { + "attributes": { + "direction": { + "description": "Specifies the direction at which succeeding sectors follow one another.", + "dflt": "counterclockwise", + "role": "style", + "valType": "enumerated", + "values": [ + "clockwise", + "counterclockwise" + ] + }, + "dlabel": { + "description": "Sets the label step. See `label0` for more info.", + "dflt": 1, + "role": "info", + "valType": "number" + }, + "domain": { + "role": "object", + "x": { + "description": "Sets the horizontal domain of this pie trace (in plot fraction).", + "dflt": [ + 0, 1 ], "items": [ @@ -11923,11 +13029,12 @@ "valType": "number" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "label", @@ -12069,35 +13176,269 @@ "role": "info", "valType": "string" }, - "rotation": { - "description": "Instead of the first slice starting at 12 o'clock, rotate to some other angle.", - "dflt": 0, - "max": 360, - "min": -360, + "rotation": { + "description": "Instead of the first slice starting at 12 o'clock, rotate to some other angle.", + "dflt": 0, + "max": 360, + "min": -360, + "role": "style", + "valType": "number" + }, + "scalegroup": { + "description": "If there are multiple pies that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.", + "dflt": "", + "role": "info", + "valType": "string" + }, + "showlegend": { + "description": "Determines whether or not an item corresponding to this trace is shown in the legend.", + "dflt": true, + "role": "info", + "valType": "boolean" + }, + "sort": { + "description": "Determines whether or not the sectors of reordered from largest to smallest.", + "dflt": true, + "role": "style", + "valType": "boolean" + }, + "stream": { + "maxpoints": { + "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, + "min": 0, + "role": "info", + "valType": "number" + }, + "role": "object", + "token": { + "description": "The stream id number links a data trace on a plot with a stream. See https://plot.ly/settings for more details.", + "noBlank": true, + "role": "info", + "strict": true, + "valType": "string" + } + }, + "text": { + "description": "Sets text elements associated with each sector.", + "role": "data", + "valType": "data_array" + }, + "textfont": { + "color": { + "role": "style", + "valType": "color" + }, + "description": "Sets the font used for `textinfo`.", + "family": { + "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.", + "noBlank": true, + "role": "style", + "strict": true, + "valType": "string" + }, + "role": "object", + "size": { + "min": 1, + "role": "style", + "valType": "number" + } + }, + "textinfo": { + "description": "Determines which trace information appear on the graph.", + "extras": [ + "none" + ], + "flags": [ + "label", + "text", + "value", + "percent" + ], + "role": "info", + "valType": "flaglist" + }, + "textposition": { + "arrayOk": true, + "description": "Specifies the location of the `textinfo`.", + "dflt": "auto", + "role": "info", + "valType": "enumerated", + "values": [ + "inside", + "outside", + "auto", + "none" + ] + }, + "textpositionsrc": { + "description": "Sets the source reference on plot.ly for textposition .", + "role": "info", + "valType": "string" + }, + "textsrc": { + "description": "Sets the source reference on plot.ly for text .", + "role": "info", + "valType": "string" + }, + "type": "pie", + "uid": { + "dflt": "", + "role": "info", + "valType": "string" + }, + "values": { + "description": "Sets the values of the sectors of this pie chart.", + "role": "data", + "valType": "data_array" + }, + "valuessrc": { + "description": "Sets the source reference on plot.ly for values .", + "role": "info", + "valType": "string" + }, + "visible": { + "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).", + "dflt": true, + "role": "info", + "valType": "enumerated", + "values": [ + true, + false, + "legendonly" + ] + } + }, + "description": "A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`", + "layoutAttributes": { + "hiddenlabels": { + "role": "data", + "valType": "data_array" + }, + "hiddenlabelssrc": { + "description": "Sets the source reference on plot.ly for hiddenlabels .", + "role": "info", + "valType": "string" + } + } + }, + "pointcloud": { + "attributes": { + "hoverinfo": { + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", + "dflt": "all", + "extras": [ + "all", + "none", + "skip" + ], + "flags": [ + "x", + "y", + "z", + "text", + "name" + ], + "role": "info", + "valType": "flaglist" + }, + "indices": { + "description": "A sequential value, 0..n, supply it to avoid creating this array inside plotting. If specified, it must be a typed `Int32Array` array. Its length must be equal to or greater than the number of points. For the best performance and memory use, create one large `indices` typed array that is guaranteed to be at least as long as the largest number of points during use, and reuse it on each `Plotly.restyle()` call.", + "role": "data", + "valType": "data_array" + }, + "indicessrc": { + "description": "Sets the source reference on plot.ly for indices .", + "role": "info", + "valType": "string" + }, + "legendgroup": { + "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.", + "dflt": "", + "role": "info", + "valType": "string" + }, + "marker": { + "blend": { + "description": "Determines if colors are blended together for a translucency effect in case `opacity` is specified as a value less then `1`. Setting `blend` to `true` reduces zoom/pan speed if used with large numbers of points.", + "dflt": null, + "role": "style", + "valType": "boolean" + }, + "border": { + "arearatio": { + "description": "Specifies what fraction of the marker area is covered with the border.", + "dflt": 0, + "max": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "color": { + "arrayOk": false, + "description": "Sets the stroke color. It accepts a specific color. If the color is not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning.", + "role": "style", + "valType": "color" + }, + "role": "object" + }, + "color": { + "arrayOk": false, + "description": "Sets the marker fill color. It accepts a specific color.If the color is not fully opaque and there are hundreds of thousandsof points, it may cause slower zooming and panning.", + "role": "style", + "valType": "color" + }, + "opacity": { + "arrayOk": false, + "description": "Sets the marker opacity. The default value is `1` (fully opaque). If the markers are not fully opaque and there are hundreds of thousands of points, it may cause slower zooming and panning. Opacity fades the color even if `blend` is left on `false` even if there is no translucency effect in that case.", + "dflt": 1, + "max": 1, + "min": 0, + "role": "style", + "valType": "number" + }, + "role": "object", + "sizemax": { + "description": "Sets the maximum size (in px) of the rendered marker points. Effective when the `pointcloud` shows only few points.", + "dflt": 20, + "min": 0.1, + "role": "style", + "valType": "number" + }, + "sizemin": { + "description": "Sets the minimum size (in px) of the rendered marker points, effective when the `pointcloud` shows a million or more points.", + "dflt": 0.5, + "max": 2, + "min": 0.1, + "role": "style", + "valType": "number" + } + }, + "name": { + "description": "Sets the trace name. The trace name appear as the legend item and on hover.", + "role": "info", + "valType": "string" + }, + "opacity": { + "description": "Sets the opacity of the trace.", + "dflt": 1, + "max": 1, + "min": 0, "role": "style", "valType": "number" }, - "scalegroup": { - "description": "If there are multiple pies that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.", - "dflt": "", - "role": "info", - "valType": "string" - }, "showlegend": { "description": "Determines whether or not an item corresponding to this trace is shown in the legend.", "dflt": true, "role": "info", "valType": "boolean" }, - "sort": { - "description": "Determines whether or not the sectors of reordered from largest to smallest.", - "dflt": true, - "role": "style", - "valType": "boolean" - }, "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -12112,59 +13453,9 @@ } }, "text": { - "description": "Sets text elements associated with each sector.", - "role": "data", - "valType": "data_array" - }, - "textfont": { - "color": { - "role": "style", - "valType": "color" - }, - "description": "Sets the font used for `textinfo`.", - "family": { - "description": "HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The plotly service (at https://plot.ly or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.", - "noBlank": true, - "role": "style", - "strict": true, - "valType": "string" - }, - "role": "object", - "size": { - "min": 1, - "role": "style", - "valType": "number" - } - }, - "textinfo": { - "description": "Determines which trace information appear on the graph.", - "extras": [ - "none" - ], - "flags": [ - "label", - "text", - "value", - "percent" - ], - "role": "info", - "valType": "flaglist" - }, - "textposition": { "arrayOk": true, - "description": "Specifies the location of the `textinfo`.", - "dflt": "auto", - "role": "info", - "valType": "enumerated", - "values": [ - "inside", - "outside", - "auto", - "none" - ] - }, - "textpositionsrc": { - "description": "Sets the source reference on plot.ly for textposition .", + "description": "Sets text elements associated with each (x,y) pair to appear on hover. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates.", + "dflt": "", "role": "info", "valType": "string" }, @@ -12173,22 +13464,12 @@ "role": "info", "valType": "string" }, - "type": "pie", + "type": "pointcloud", "uid": { "dflt": "", "role": "info", "valType": "string" }, - "values": { - "description": "Sets the values of the sectors of this pie chart.", - "role": "data", - "valType": "data_array" - }, - "valuessrc": { - "description": "Sets the source reference on plot.ly for values .", - "role": "info", - "valType": "string" - }, "visible": { "description": "Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).", "dflt": true, @@ -12199,20 +13480,71 @@ false, "legendonly" ] - } - }, - "description": "A data visualized by the sectors of the pie is set in `values`. The sector labels are set in `labels`. The sector colors are set in `marker.colors`", - "layoutAttributes": { - "hiddenlabels": { + }, + "x": { + "description": "Sets the x coordinates.", "role": "data", "valType": "data_array" }, - "hiddenlabelssrc": { - "description": "Sets the source reference on plot.ly for hiddenlabels .", + "xaxis": { + "description": "Sets a reference between this trace's x coordinates and a 2D cartesian x axis. If *x* (the default value), the x coordinates refer to `layout.xaxis`. If *x2*, the x coordinates refer to `layout.xaxis2`, and so on.", + "dflt": "x", + "role": "info", + "valType": "subplotid" + }, + "xbounds": { + "description": "Specify `xbounds` in the shape of `[xMin, xMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `ybounds` for the performance benefits.", + "role": "data", + "valType": "data_array" + }, + "xboundssrc": { + "description": "Sets the source reference on plot.ly for xbounds .", + "role": "info", + "valType": "string" + }, + "xsrc": { + "description": "Sets the source reference on plot.ly for x .", + "role": "info", + "valType": "string" + }, + "xy": { + "description": "Faster alternative to specifying `x` and `y` separately. If supplied, it must be a typed `Float32Array` array that represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]`", + "role": "data", + "valType": "data_array" + }, + "xysrc": { + "description": "Sets the source reference on plot.ly for xy .", + "role": "info", + "valType": "string" + }, + "y": { + "description": "Sets the y coordinates.", + "role": "data", + "valType": "data_array" + }, + "yaxis": { + "description": "Sets a reference between this trace's y coordinates and a 2D cartesian y axis. If *y* (the default value), the y coordinates refer to `layout.yaxis`. If *y2*, the y coordinates refer to `layout.xaxis2`, and so on.", + "dflt": "y", + "role": "info", + "valType": "subplotid" + }, + "ybounds": { + "description": "Specify `ybounds` in the shape of `[yMin, yMax] to avoid looping through the `xy` typed array. Use it in conjunction with `xy` and `xbounds` for the performance benefits.", + "role": "data", + "valType": "data_array" + }, + "yboundssrc": { + "description": "Sets the source reference on plot.ly for ybounds .", + "role": "info", + "valType": "string" + }, + "ysrc": { + "description": "Sets the source reference on plot.ly for y .", "role": "info", "valType": "string" } - } + }, + "description": "The data visualized as a point cloud set in `x` and `y` using the WebGl plotting engine." }, "scatter": { "attributes": { @@ -12461,11 +13793,12 @@ "valType": "color" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -12486,6 +13819,16 @@ "role": "info", "valType": "flaglist" }, + "ids": { + "description": "A list of keys for object constancy of data points during animation", + "role": "data", + "valType": "data_array" + }, + "idssrc": { + "description": "Sets the source reference on plot.ly for ids .", + "role": "info", + "valType": "string" + }, "legendgroup": { "description": "Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.", "dflt": "", @@ -12527,6 +13870,12 @@ "vhv" ] }, + "simplify": { + "description": "Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.", + "dflt": true, + "role": "info", + "valType": "boolean" + }, "smoothing": { "description": "Has an effect only if `shape` is set to *spline* Sets the amount of smoothing. *0* corresponds to no smoothing (equivalent to a *linear* shape).", "dflt": 1, @@ -12652,6 +14001,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -13396,6 +14751,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -13873,11 +15230,12 @@ } }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -14080,6 +15438,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -14606,6 +15970,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -14761,6 +16127,27 @@ }, "scattergeo": { "attributes": { + "connectgaps": { + "description": "Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.", + "dflt": false, + "role": "info", + "valType": "boolean" + }, + "fill": { + "description": "Sets the area to fill with a solid color. Use with `fillcolor` if not *none*. *toself* connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.", + "dflt": "none", + "role": "style", + "valType": "enumerated", + "values": [ + "none", + "toself" + ] + }, + "fillcolor": { + "description": "Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.", + "role": "style", + "valType": "color" + }, "geo": { "description": "Sets a reference between this trace's geospatial coordinates and a geographic map. If *geo* (the default value), the geospatial coordinates refer to `layout.geo`. If *geo2*, the geospatial coordinates refer to `layout.geo2`, and so on.", "dflt": "geo", @@ -14768,11 +16155,12 @@ "valType": "subplotid" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "lon", @@ -14969,6 +16357,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -15697,6 +17091,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -16046,11 +17442,12 @@ "valType": "color" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -16206,6 +17603,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -16656,6 +18059,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -16769,11 +18174,12 @@ "valType": "color" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "lon", @@ -16948,6 +18354,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -17324,6 +18736,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -17470,11 +18884,12 @@ "valType": "color" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "a", @@ -17657,6 +19072,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -18392,6 +19813,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -18635,6 +20058,12 @@ "valType": "number" }, "role": "object", + "separatethousands": { + "description": "If \"true\", even 4-digit integers are separated", + "dflt": false, + "role": "style", + "valType": "boolean" + }, "showexponent": { "description": "If *all*, all exponents are shown besides their significands. If *first*, only the exponent of the first tick is shown. If *last*, only the exponent of the last tick is shown. If *none*, no exponents appear.", "dflt": "all", @@ -19120,11 +20549,12 @@ "valType": "boolean" }, "hoverinfo": { - "description": "Determines which trace information appear on hover.", + "description": "Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.", "dflt": "all", "extras": [ "all", - "none" + "none", + "skip" ], "flags": [ "x", @@ -19252,6 +20682,8 @@ "stream": { "maxpoints": { "description": "Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.", + "dflt": 500, + "max": 10000, "min": 0, "role": "info", "valType": "number" @@ -19336,5 +20768,86 @@ "description": "The data the describes the coordinates of the surface is set in `z`. Data in `z` should be a {2D array}. Coordinates in `x` and `y` can either be 1D {arrays} or {2D arrays} (e.g. to graph parametric surfaces). If not provided in `x` and `y`, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the `z` values by default. For custom color scales, use `surfacecolor` which should be a {2D array}, where its bounds can be controlled using `cmin` and `cmax`." } }, - "transforms": {} + "transforms": { + "candlestick": { + "attributes": {} + }, + "filter": { + "attributes": { + "enabled": { + "description": "Determines whether this filter transform is enabled or disabled.", + "dflt": true, + "valType": "boolean" + }, + "operation": { + "description": "Sets the filter operation. *=* keeps items equal to `value` *<* keeps items less than `value` *<=* keeps items less than or equal to `value` *>* keeps items greater than `value` *>=* keeps items greater than or equal to `value` *[]* keeps items inside `value[0]` to value[1]` including both bounds` *()* keeps items inside `value[0]` to value[1]` excluding both bounds` *[)* keeps items inside `value[0]` to value[1]` including `value[0]` but excluding `value[1] *(]* keeps items inside `value[0]` to value[1]` excluding `value[0]` but including `value[1] *][* keeps items outside `value[0]` to value[1]` and equal to both bounds` *)(* keeps items outside `value[0]` to value[1]` *](* keeps items outside `value[0]` to value[1]` and equal to `value[0]` *)[* keeps items outside `value[0]` to value[1]` and equal to `value[1]` *{}* keeps items present in a set of values *}{* keeps items not present in a set of values", + "dflt": "=", + "valType": "enumerated", + "values": [ + "=", + "<", + ">=", + ">", + "<=", + "[]", + "()", + "[)", + "(]", + "][", + ")(", + "](", + ")[", + "{}", + "}{" + ] + }, + "target": { + "arrayOk": true, + "description": "Sets the filter target by which the filter is applied. If a string, *target* is assumed to be a reference to a data array in the parent trace object. To filter about nested variables, use *.* to access them. For example, set `target` to *marker.color* to filter about the marker color array. If an array, *target* is then the data array by which the filter is applied.", + "dflt": "x", + "noBlank": true, + "strict": true, + "valType": "string" + }, + "targetsrc": { + "description": "Sets the source reference on plot.ly for target .", + "role": "info", + "valType": "string" + }, + "value": { + "description": "Sets the value or values by which to filter by. Values are expected to be in the same type as the data linked to *target*. When `operation` is set to one of the inequality values (=,<,>=,>,<=) *value* is expected to be a number or a string. When `operation` is set to one of the interval value ([],(),[),(],][,)(,](,)[) *value* is expected to be 2-item array where the first item is the lower bound and the second item is the upper bound. When `operation`, is set to one of the set value ({},}{) *value* is expected to be an array with as many items as the desired set elements.", + "dflt": 0, + "valType": "any" + } + } + }, + "groupby": { + "attributes": { + "enabled": { + "description": "Determines whether this group-by transform is enabled or disabled.", + "dflt": true, + "valType": "boolean" + }, + "groups": { + "description": "Sets the groups in which the trace data will be split. For example, with `x` set to *[1, 2, 3, 4]* and `groups` set to *['a', 'b', 'a', 'b']*, the groupby transform with split in one trace with `x` [1, 3] and one trace with `x` [2, 4].", + "dflt": [], + "role": "data", + "valType": "data_array" + }, + "groupssrc": { + "description": "Sets the source reference on plot.ly for groups .", + "role": "info", + "valType": "string" + }, + "style": { + "description": "Sets each group style. For example, with `groups` set to *['a', 'b', 'a', 'b']* and `style` set to *{ a: { marker: { color: 'red' } }} marker points in group *'a'* will be drawn in red.", + "dflt": {}, + "valType": "any" + } + } + }, + "ohlc": { + "attributes": {} + } + } } \ No newline at end of file diff --git a/plotly/offline/offline.py b/plotly/offline/offline.py index 247e4821431..96645804abc 100644 --- a/plotly/offline/offline.py +++ b/plotly/offline/offline.py @@ -187,27 +187,28 @@ def _plot_html(figure_or_data, config, validate, default_width, jlayout = json.dumps(figure.get('layout', {}), cls=utils.PlotlyJSONEncoder) configkeys = ( - 'editable', - 'autosizable', - 'fillFrame', - 'frameMargins', - 'scrollZoom', - 'doubleClick', - 'showTips', - 'showLink', - 'sendData', - 'linkText', - 'showSources', - 'displayModeBar', - 'modeBarButtonsToRemove', - 'modeBarButtonsToAdd', - 'modeBarButtons', - 'displaylogo', - 'plotGlPixelRatio', - 'setBackground', - 'topojsonURL') - - config_clean = dict((k,config[k]) for k in configkeys if k in config) + 'editable', + 'autosizable', + 'fillFrame', + 'frameMargins', + 'scrollZoom', + 'doubleClick', + 'showTips', + 'showLink', + 'sendData', + 'linkText', + 'showSources', + 'displayModeBar', + 'modeBarButtonsToRemove', + 'modeBarButtonsToAdd', + 'modeBarButtons', + 'displaylogo', + 'plotGlPixelRatio', + 'setBackground', + 'topojsonURL' + ) + + config_clean = dict((k, config[k]) for k in configkeys if k in config) jconfig = json.dumps(config_clean) @@ -308,9 +309,13 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly', if not tools._ipython_imported: raise ImportError('`iplot` can only run inside an IPython Notebook.') + config = {} + config['showLink'] = show_link + config['linkText'] = link_text + plot_html, plotdivid, width, height = _plot_html( - figure_or_data, show_link, link_text, validate, - '100%', 525, global_requirejs=True) + figure_or_data, config, validate, '100%', 525, True + ) display(HTML(plot_html)) @@ -321,10 +326,10 @@ def iplot(figure_or_data, show_link=True, link_text='Export to plot.ly', ) # if image is given, and is a valid format, we will download the image script = get_image_download_script('iplot').format(format=image, - width=image_width, - height=image_height, - filename=filename, - plot_id=plotdivid) + width=image_width, + height=image_height, + filename=filename, + plot_id=plotdivid) # allow time for the plot to draw time.sleep(1) # inject code to download an image of the plot @@ -406,8 +411,12 @@ def plot(figure_or_data, "Adding .html to the end of your file.") filename += '.html' + config = {} + config['showLink'] = show_link + config['linkText'] = link_text + plot_html, plotdivid, width, height = _plot_html( - figure_or_data, show_link, link_text, validate, + figure_or_data, config, validate, '100%', '100%', global_requirejs=False) resize_script = '' diff --git a/plotly/plotly/plotly.py b/plotly/plotly/plotly.py index 437e1f360f8..1753dc9c778 100644 --- a/plotly/plotly/plotly.py +++ b/plotly/plotly/plotly.py @@ -210,7 +210,6 @@ def plot(figure_or_data, validate=True, **plot_options): """ figure = tools.return_figure_from_figure_or_data(figure_or_data, validate) - for entry in figure['data']: if ('type' in entry) and (entry['type'] == 'scattergl'): continue @@ -499,7 +498,7 @@ def heartbeat(self, reconnect_on=(200, '', 408)): "cannot write to a closed connection. " "Call `open()` on the stream to open the stream." ) - + @property def connected(self): if self._stream is None: @@ -869,7 +868,7 @@ def _fill_in_response_column_ids(cls, request_columns, for req_col in request_columns: for resp_col in response_columns: if resp_col['name'] == req_col.name: - req_col.id = '{0}/{1}'.format(grid_id, resp_col['uid']) + req_col.id = '{0}:{1}'.format(grid_id, resp_col['uid']) response_columns.remove(resp_col) @classmethod @@ -1400,9 +1399,6 @@ def add_share_key_to_url(plot_url, attempt=0): def _send_to_plotly(figure, **plot_options): - """ - - """ fig = tools._replace_newline(figure) # does not mutate figure data = json.dumps(fig['data'] if 'data' in fig else [], cls=utils.PlotlyJSONEncoder) @@ -1414,8 +1410,7 @@ def _send_to_plotly(figure, **plot_options): fileopt=plot_options['fileopt'], world_readable=plot_options['world_readable'], sharing=plot_options['sharing'], - layout=fig['layout'] if 'layout' in fig - else {}), + layout=fig['layout'] if 'layout' in fig else {}), cls=utils.PlotlyJSONEncoder) # TODO: It'd be cool to expose the platform for RaspPi and others diff --git a/plotly/tools.py b/plotly/tools.py index 86df74f55cd..5e8ed470a91 100644 --- a/plotly/tools.py +++ b/plotly/tools.py @@ -6138,10 +6138,9 @@ def create_distplot(hist_data, group_labels, data = sum(data, []) return graph_objs.Figure(data=data, layout=layout) - @staticmethod def create_dendrogram(X, orientation="bottom", labels=None, - colorscale=None, distfun=scs.distance.pdist, + colorscale=None, distfun=None, linkagefun=lambda x: sch.linkage(x, 'complete')): """ BETA function that returns a dendrogram Plotly figure object. @@ -6208,6 +6207,9 @@ def create_dendrogram(X, orientation="bottom", labels=None, if len(s) != 2: exceptions.PlotlyError("X should be 2-dimensional array.") + if distfun is None: + distfun = scs.distance.pdist + dendrogram = _Dendrogram(X, orientation, labels, colorscale, distfun=distfun, linkagefun=linkagefun) @@ -7137,7 +7139,7 @@ class _Dendrogram(FigureFactory): def __init__(self, X, orientation='bottom', labels=None, colorscale=None, width="100%", height="100%", xaxis='xaxis', yaxis='yaxis', - distfun=scs.distance.pdist, linkagefun=lambda x: sch.linkage(x, 'complete')): + distfun=None, linkagefun=lambda x: sch.linkage(x, 'complete')): # TODO: protected until #282 from plotly.graph_objs import graph_objs self.orientation = orientation @@ -7159,6 +7161,9 @@ def __init__(self, X, orientation='bottom', labels=None, colorscale=None, else: self.sign[self.yaxis] = -1 + if distfun is None: + distfun = scs.distance.pdist + (dd_traces, xvals, yvals, ordered_labels, leaves) = self.get_dendrogram_traces(X, colorscale, distfun, linkagefun)