|
13 | 13 | colref_type = "str or int or Series or array-like" |
14 | 14 | colref_desc = "Either a name of a column in `data_frame`, or a pandas Series or array_like object." |
15 | 15 | colref_list_type = "list of str or int, or Series or array-like" |
16 | | -colref_list_desc = "Either names of columns in `data_frame`, or pandas Series, or array_like objects" |
| 16 | +colref_list_desc = ( |
| 17 | + "Either names of columns in `data_frame`, or pandas Series, or array_like objects" |
| 18 | +) |
17 | 19 |
|
18 | 20 | docs = dict( |
19 | 21 | data_frame=[ |
|
22 | 24 | "Array-like and dict are tranformed internally to a pandas DataFrame.", |
23 | 25 | ], |
24 | 26 | x=[ |
25 | | - colref_type, colref_desc, |
| 27 | + colref_type, |
| 28 | + colref_desc, |
26 | 29 | "Values from this column or array_like are used to position marks along the x axis in cartesian coordinates.", |
27 | 30 | "For horizontal `histogram`s, these values are used as inputs to `histfunc`.", |
28 | 31 | ], |
29 | 32 | y=[ |
30 | | - colref_type, colref_desc, |
| 33 | + colref_type, |
| 34 | + colref_desc, |
31 | 35 | "Values from this column or array_like are used to position marks along the y axis in cartesian coordinates.", |
32 | 36 | "For vertical `histogram`s, these values are used as inputs to `histfunc`.", |
33 | 37 | ], |
34 | 38 | z=[ |
35 | | - colref_type, colref_desc, |
| 39 | + colref_type, |
| 40 | + colref_desc, |
36 | 41 | "Values from this column or array_like are used to position marks along the z axis in cartesian coordinates.", |
37 | 42 | "For `density_heatmap` and `density_contour` these values are used as the inputs to `histfunc`.", |
38 | 43 | ], |
39 | 44 | a=[ |
40 | | - colref_type, colref_desc, |
| 45 | + colref_type, |
| 46 | + colref_desc, |
41 | 47 | "Values from this column or array_like are used to position marks along the a axis in ternary coordinates.", |
42 | 48 | ], |
43 | 49 | b=[ |
44 | | - colref_type, colref_desc, |
| 50 | + colref_type, |
| 51 | + colref_desc, |
45 | 52 | "Values from this column or array_like are used to position marks along the b axis in ternary coordinates.", |
46 | 53 | ], |
47 | 54 | c=[ |
48 | | - colref_type, colref_desc, |
| 55 | + colref_type, |
| 56 | + colref_desc, |
49 | 57 | "Values from this column or array_like are used to position marks along the c axis in ternary coordinates.", |
50 | 58 | ], |
51 | 59 | r=[ |
52 | | - colref_type, colref_desc, |
| 60 | + colref_type, |
| 61 | + colref_desc, |
53 | 62 | "Values from this column or array_like are used to position marks along the radial axis in polar coordinates.", |
54 | 63 | ], |
55 | 64 | theta=[ |
56 | | - colref_type, colref_desc, |
| 65 | + colref_type, |
| 66 | + colref_desc, |
57 | 67 | "Values from this column or array_like are used to position marks along the angular axis in polar coordinates.", |
58 | 68 | ], |
59 | 69 | lat=[ |
60 | | - colref_type, colref_desc, |
| 70 | + colref_type, |
| 71 | + colref_desc, |
61 | 72 | "Values from this column or array_like are used to position marks according to latitude on a map.", |
62 | 73 | ], |
63 | 74 | lon=[ |
64 | | - colref_type, colref_desc, |
| 75 | + colref_type, |
| 76 | + colref_desc, |
65 | 77 | "Values from this column or array_like are used to position marks according to longitude on a map.", |
66 | 78 | ], |
67 | 79 | locations=[ |
68 | | - colref_type, colref_desc, |
| 80 | + colref_type, |
| 81 | + colref_desc, |
69 | 82 | "Values from this column or array_like are to be interpreted according to `locationmode` and mapped to longitude/latitude.", |
70 | 83 | ], |
71 | 84 | dimensions=[ |
72 | 85 | "list of str", |
73 | 86 | "Names of columns in `data_frame` to be used in multidimensional visualization.", |
74 | 87 | ], |
75 | 88 | error_x=[ |
76 | | - colref_type, colref_desc, |
| 89 | + colref_type, |
| 90 | + colref_desc, |
77 | 91 | "Values from this column or array_like are used to size x-axis error bars.", |
78 | 92 | "If `error_x_minus` is `None`, error bars will be symmetrical, otherwise `error_x` is used for the positive direction only.", |
79 | 93 | ], |
80 | 94 | error_x_minus=[ |
81 | | - colref_type, colref_desc, |
| 95 | + colref_type, |
| 96 | + colref_desc, |
82 | 97 | "Values from this column or array_like are used to size x-axis error bars in the negative direction.", |
83 | 98 | "Ignored if `error_x` is `None`.", |
84 | 99 | ], |
85 | 100 | error_y=[ |
86 | | - colref_type, colref_desc, |
| 101 | + colref_type, |
| 102 | + colref_desc, |
87 | 103 | "Values from this column or array_like are used to size y-axis error bars.", |
88 | 104 | "If `error_y_minus` is `None`, error bars will be symmetrical, otherwise `error_y` is used for the positive direction only.", |
89 | 105 | ], |
90 | 106 | error_y_minus=[ |
91 | | - colref_type, colref_desc, |
| 107 | + colref_type, |
| 108 | + colref_desc, |
92 | 109 | "Values from this column or array_like are used to size y-axis error bars in the negative direction.", |
93 | 110 | "Ignored if `error_y` is `None`.", |
94 | 111 | ], |
95 | 112 | error_z=[ |
96 | | - colref_type, colref_desc, |
| 113 | + colref_type, |
| 114 | + colref_desc, |
97 | 115 | "Values from this column or array_like are used to size z-axis error bars.", |
98 | 116 | "If `error_z_minus` is `None`, error bars will be symmetrical, otherwise `error_z` is used for the positive direction only.", |
99 | 117 | ], |
100 | 118 | error_z_minus=[ |
101 | | - colref_type, colref_desc, |
| 119 | + colref_type, |
| 120 | + colref_desc, |
102 | 121 | "Values from this column or array_like are used to size z-axis error bars in the negative direction.", |
103 | 122 | "Ignored if `error_z` is `None`.", |
104 | 123 | ], |
105 | 124 | color=[ |
106 | | - colref_type, colref_desc, |
| 125 | + colref_type, |
| 126 | + colref_desc, |
107 | 127 | "Values from this column or array_like are used to assign color to marks.", |
108 | 128 | ], |
109 | 129 | opacity=["float", "Value between 0 and 1. Sets the opacity for markers."], |
110 | 130 | line_dash=[ |
111 | | - colref_type, colref_desc, |
| 131 | + colref_type, |
| 132 | + colref_desc, |
112 | 133 | "Values from this column or array_like are used to assign dash-patterns to lines.", |
113 | 134 | ], |
114 | 135 | line_group=[ |
115 | | - colref_type, colref_desc, |
| 136 | + colref_type, |
| 137 | + colref_desc, |
116 | 138 | "Values from this column or array_like are used to group rows of `data_frame` into lines.", |
117 | 139 | ], |
118 | 140 | symbol=[ |
119 | | - colref_type, colref_desc, |
| 141 | + colref_type, |
| 142 | + colref_desc, |
120 | 143 | "Values from this column or array_like are used to assign symbols to marks.", |
121 | 144 | ], |
122 | 145 | size=[ |
123 | | - colref_type, colref_desc, |
| 146 | + colref_type, |
| 147 | + colref_desc, |
124 | 148 | "Values from this column or array_like are used to assign mark sizes.", |
125 | 149 | ], |
126 | 150 | hover_name=[ |
127 | | - colref_type, colref_desc, |
| 151 | + colref_type, |
| 152 | + colref_desc, |
128 | 153 | "Values from this column or array_like appear in bold in the hover tooltip.", |
129 | 154 | ], |
130 | 155 | hover_data=[ |
131 | | - colref_list_type, colref_list_desc, |
| 156 | + colref_list_type, |
| 157 | + colref_list_desc, |
132 | 158 | "Values from these columns appear as extra data in the hover tooltip.", |
133 | 159 | ], |
134 | 160 | custom_data=[ |
135 | | - colref_list_type, colref_list_desc, |
| 161 | + colref_list_type, |
| 162 | + colref_list_desc, |
136 | 163 | "Values from these columns are extra data, to be used in widgets or Dash callbacks for example. This data is not user-visible but is included in events emitted by the figure (lasso selection etc.)", |
137 | 164 | ], |
138 | 165 | text=[ |
139 | | - colref_type, colref_desc, |
| 166 | + colref_type, |
| 167 | + colref_desc, |
140 | 168 | "Values from this column or array_like appear in the figure as text labels.", |
141 | 169 | ], |
142 | 170 | locationmode=[ |
|
145 | 173 | "Determines the set of locations used to match entries in `locations` to regions on the map.", |
146 | 174 | ], |
147 | 175 | facet_row=[ |
148 | | - colref_type, colref_desc, |
| 176 | + colref_type, |
| 177 | + colref_desc, |
149 | 178 | "Values from this column or array_like are used to assign marks to facetted subplots in the vertical direction.", |
150 | 179 | ], |
151 | 180 | facet_col=[ |
152 | | - colref_type, colref_desc, |
| 181 | + colref_type, |
| 182 | + colref_desc, |
153 | 183 | "Values from this column or array_like are used to assign marks to facetted subplots in the horizontal direction.", |
154 | 184 | ], |
155 | 185 | animation_frame=[ |
156 | | - colref_type, colref_desc, |
| 186 | + colref_type, |
| 187 | + colref_desc, |
157 | 188 | "Values from this column or array_like are used to assign marks to animation frames.", |
158 | 189 | ], |
159 | 190 | animation_group=[ |
160 | | - colref_type, colref_desc, |
| 191 | + colref_type, |
| 192 | + colref_desc, |
161 | 193 | "Values from this column or array_like are used to provide object-constancy across animation frames: rows with matching `animation_group`s will be treated as if they describe the same object in each frame.", |
162 | 194 | ], |
163 | 195 | symbol_sequence=[ |
|
0 commit comments