|
| 1 | +import _plotly_utils.basevalidators |
| 2 | + |
| 3 | + |
| 4 | +class BarValidator(_plotly_utils.basevalidators.CompoundValidator): |
| 5 | + |
| 6 | + def __init__(self, plotly_name='bar', parent_name='', **kwargs): |
| 7 | + super(BarValidator, self).__init__( |
| 8 | + plotly_name=plotly_name, |
| 9 | + parent_name=parent_name, |
| 10 | + data_class_str='Bar', |
| 11 | + data_docs=""" |
| 12 | + base |
| 13 | + Sets where the bar base is drawn (in position |
| 14 | + axis units). In *stack* or *relative* barmode, |
| 15 | + traces that set *base* will be excluded and |
| 16 | + drawn in *overlay* mode instead. |
| 17 | + basesrc |
| 18 | + Sets the source reference on plot.ly for base |
| 19 | + . |
| 20 | + cliponaxis |
| 21 | + Determines whether the text nodes are clipped |
| 22 | + about the subplot axes. To show the text nodes |
| 23 | + above axis lines and tick labels, make sure to |
| 24 | + set `xaxis.layer` and `yaxis.layer` to *below |
| 25 | + traces*. |
| 26 | + constraintext |
| 27 | + Constrain the size of text inside or outside a |
| 28 | + bar to be no larger than the bar itself. |
| 29 | + customdata |
| 30 | + Assigns extra data each datum. This may be |
| 31 | + useful when listening to hover, click and |
| 32 | + selection events. Note that, *scatter* traces |
| 33 | + also appends customdata items in the markers |
| 34 | + DOM elements |
| 35 | + customdatasrc |
| 36 | + Sets the source reference on plot.ly for |
| 37 | + customdata . |
| 38 | + dx |
| 39 | + Sets the x coordinate step. See `x0` for more |
| 40 | + info. |
| 41 | + dy |
| 42 | + Sets the y coordinate step. See `y0` for more |
| 43 | + info. |
| 44 | + error_x |
| 45 | + plotly.graph_objs.bar.ErrorX instance or dict |
| 46 | + with compatible properties |
| 47 | + error_y |
| 48 | + plotly.graph_objs.bar.ErrorY instance or dict |
| 49 | + with compatible properties |
| 50 | + hoverinfo |
| 51 | + Determines which trace information appear on |
| 52 | + hover. If `none` or `skip` are set, no |
| 53 | + information is displayed upon hovering. But, if |
| 54 | + `none` is set, click and hover events are still |
| 55 | + fired. |
| 56 | + hoverinfosrc |
| 57 | + Sets the source reference on plot.ly for |
| 58 | + hoverinfo . |
| 59 | + hoverlabel |
| 60 | + plotly.graph_objs.bar.Hoverlabel instance or |
| 61 | + dict with compatible properties |
| 62 | + hovertext |
| 63 | + Sets hover text elements associated with each |
| 64 | + (x,y) pair. If a single string, the same string |
| 65 | + appears over all the data points. If an array |
| 66 | + of string, the items are mapped in order to the |
| 67 | + this trace's (x,y) coordinates. To be seen, |
| 68 | + trace `hoverinfo` must contain a *text* flag. |
| 69 | + hovertextsrc |
| 70 | + Sets the source reference on plot.ly for |
| 71 | + hovertext . |
| 72 | + ids |
| 73 | + Assigns id labels to each datum. These ids for |
| 74 | + object constancy of data points during |
| 75 | + animation. Should be an array of strings, not |
| 76 | + numbers or any other type. |
| 77 | + idssrc |
| 78 | + Sets the source reference on plot.ly for ids . |
| 79 | + insidetextfont |
| 80 | + Sets the font used for `text` lying inside the |
| 81 | + bar. |
| 82 | + legendgroup |
| 83 | + Sets the legend group for this trace. Traces |
| 84 | + part of the same legend group hide/show at the |
| 85 | + same time when toggling legend items. |
| 86 | + marker |
| 87 | + plotly.graph_objs.bar.Marker instance or dict |
| 88 | + with compatible properties |
| 89 | + name |
| 90 | + Sets the trace name. The trace name appear as |
| 91 | + the legend item and on hover. |
| 92 | + offset |
| 93 | + Shifts the position where the bar is drawn (in |
| 94 | + position axis units). In *group* barmode, |
| 95 | + traces that set *offset* will be excluded and |
| 96 | + drawn in *overlay* mode instead. |
| 97 | + offsetsrc |
| 98 | + Sets the source reference on plot.ly for |
| 99 | + offset . |
| 100 | + opacity |
| 101 | + Sets the opacity of the trace. |
| 102 | + orientation |
| 103 | + Sets the orientation of the bars. With *v* |
| 104 | + (*h*), the value of the each bar spans along |
| 105 | + the vertical (horizontal). |
| 106 | + outsidetextfont |
| 107 | + Sets the font used for `text` lying outside the |
| 108 | + bar. |
| 109 | + r |
| 110 | + For legacy polar chart only.Please switch to |
| 111 | + *scatterpolar* trace type.Sets the radial |
| 112 | + coordinates. |
| 113 | + rsrc |
| 114 | + Sets the source reference on plot.ly for r . |
| 115 | + selected |
| 116 | + plotly.graph_objs.bar.Selected instance or dict |
| 117 | + with compatible properties |
| 118 | + selectedpoints |
| 119 | + Array containing integer indices of selected |
| 120 | + points. Has an effect only for traces that |
| 121 | + support selections. Note that an empty array |
| 122 | + means an empty selection where the `unselected` |
| 123 | + are turned on for all points, whereas, any |
| 124 | + other non-array values means no selection all |
| 125 | + where the `selected` and `unselected` styles |
| 126 | + have no effect. |
| 127 | + showlegend |
| 128 | + Determines whether or not an item corresponding |
| 129 | + to this trace is shown in the legend. |
| 130 | + stream |
| 131 | + plotly.graph_objs.bar.Stream instance or dict |
| 132 | + with compatible properties |
| 133 | + t |
| 134 | + For legacy polar chart only.Please switch to |
| 135 | + *scatterpolar* trace type.Sets the angular |
| 136 | + coordinates. |
| 137 | + text |
| 138 | + Sets text elements associated with each (x,y) |
| 139 | + pair. If a single string, the same string |
| 140 | + appears over all the data points. If an array |
| 141 | + of string, the items are mapped in order to the |
| 142 | + this trace's (x,y) coordinates. If trace |
| 143 | + `hoverinfo` contains a *text* flag and |
| 144 | + *hovertext* is not set, these elements will be |
| 145 | + seen in the hover labels. |
| 146 | + textfont |
| 147 | + Sets the font used for `text`. |
| 148 | + textposition |
| 149 | + Specifies the location of the `text`. *inside* |
| 150 | + positions `text` inside, next to the bar end |
| 151 | + (rotated and scaled if needed). *outside* |
| 152 | + positions `text` outside, next to the bar end |
| 153 | + (scaled if needed). *auto* positions `text` |
| 154 | + inside or outside so that `text` size is |
| 155 | + maximized. |
| 156 | + textpositionsrc |
| 157 | + Sets the source reference on plot.ly for |
| 158 | + textposition . |
| 159 | + textsrc |
| 160 | + Sets the source reference on plot.ly for text |
| 161 | + . |
| 162 | + tsrc |
| 163 | + Sets the source reference on plot.ly for t . |
| 164 | + uid |
| 165 | +
|
| 166 | + unselected |
| 167 | + plotly.graph_objs.bar.Unselected instance or |
| 168 | + dict with compatible properties |
| 169 | + visible |
| 170 | + Determines whether or not this trace is |
| 171 | + visible. If *legendonly*, the trace is not |
| 172 | + drawn, but can appear as a legend item |
| 173 | + (provided that the legend itself is visible). |
| 174 | + width |
| 175 | + Sets the bar width (in position axis units). |
| 176 | + widthsrc |
| 177 | + Sets the source reference on plot.ly for width |
| 178 | + . |
| 179 | + x |
| 180 | + Sets the x coordinates. |
| 181 | + x0 |
| 182 | + Alternate to `x`. Builds a linear space of x |
| 183 | + coordinates. Use with `dx` where `x0` is the |
| 184 | + starting coordinate and `dx` the step. |
| 185 | + xaxis |
| 186 | + Sets a reference between this trace's x |
| 187 | + coordinates and a 2D cartesian x axis. If *x* |
| 188 | + (the default value), the x coordinates refer to |
| 189 | + `layout.xaxis`. If *x2*, the x coordinates |
| 190 | + refer to `layout.xaxis2`, and so on. |
| 191 | + xcalendar |
| 192 | + Sets the calendar system to use with `x` date |
| 193 | + data. |
| 194 | + xsrc |
| 195 | + Sets the source reference on plot.ly for x . |
| 196 | + y |
| 197 | + Sets the y coordinates. |
| 198 | + y0 |
| 199 | + Alternate to `y`. Builds a linear space of y |
| 200 | + coordinates. Use with `dy` where `y0` is the |
| 201 | + starting coordinate and `dy` the step. |
| 202 | + yaxis |
| 203 | + Sets a reference between this trace's y |
| 204 | + coordinates and a 2D cartesian y axis. If *y* |
| 205 | + (the default value), the y coordinates refer to |
| 206 | + `layout.yaxis`. If *y2*, the y coordinates |
| 207 | + refer to `layout.xaxis2`, and so on. |
| 208 | + ycalendar |
| 209 | + Sets the calendar system to use with `y` date |
| 210 | + data. |
| 211 | + ysrc |
| 212 | + Sets the source reference on plot.ly for y .""", |
| 213 | + **kwargs |
| 214 | + ) |
0 commit comments