Open/High/Low/Close marks. Data Attributes --------------- Attributes ---------- x: numpy.ndarray abscissas of the data points (1d array) y: numpy.ndarrays Open/High/Low/Close ordinates of the data points (2d array) Style Attributes ----------------
| 1259 | |
| 1260 | @register_mark('bqplot.OHLC') |
| 1261 | class OHLC(Mark): |
| 1262 | |
| 1263 | """Open/High/Low/Close marks. |
| 1264 | |
| 1265 | Data Attributes |
| 1266 | --------------- |
| 1267 | |
| 1268 | Attributes |
| 1269 | ---------- |
| 1270 | x: numpy.ndarray |
| 1271 | abscissas of the data points (1d array) |
| 1272 | y: numpy.ndarrays |
| 1273 | Open/High/Low/Close ordinates of the data points (2d array) |
| 1274 | |
| 1275 | Style Attributes |
| 1276 | ---------------- |
| 1277 | |
| 1278 | Attributes |
| 1279 | ---------- |
| 1280 | icon: string (class-level attribute) |
| 1281 | font-awesome icon for that mark |
| 1282 | name: string (class-level attribute) |
| 1283 | user-friendly name of the mark |
| 1284 | marker: {'candle', 'bar'} |
| 1285 | marker type |
| 1286 | stroke: color (default: None) |
| 1287 | stroke color of the marker |
| 1288 | stroke_width: float (default: 1.0) |
| 1289 | stroke width of the marker |
| 1290 | colors: List of colors (default: ['limegreen', 'red']) |
| 1291 | fill colors for the markers (up/down) |
| 1292 | opacities: list of floats (default: []) |
| 1293 | Opacities for the markers of the OHLC mark. Defaults to 1 when |
| 1294 | the list is too short, or the element of the list is set to None. |
| 1295 | format: string (default: 'ohlc') |
| 1296 | description of y data being passed |
| 1297 | supports all permutations of the strings 'ohlc', 'oc', and 'hl' |
| 1298 | |
| 1299 | !!! Note |
| 1300 | - The fields which can be passed to the default tooltip are: |
| 1301 | - **x**: the x value associated with the bar/candle |
| 1302 | - **open**: open value for the bar/candle |
| 1303 | - **high**: high value for the bar/candle |
| 1304 | - **low**: low value for the bar/candle |
| 1305 | - **close**: close value for the bar/candle |
| 1306 | - **index**: index of the bar/candle being hovered on |
| 1307 | """ |
| 1308 | |
| 1309 | # Mark decoration |
| 1310 | icon = 'fa-birthday-cake' |
| 1311 | name = 'OHLC chart' |
| 1312 | |
| 1313 | # Scaled attributes |
| 1314 | x = Array([]).tag(sync=True, scaled=True, |
| 1315 | rtype='Number', atype='bqplot.Axis', |
| 1316 | **array_serialization)\ |
| 1317 | .valid(array_squeeze, array_dimension_bounds(1, 1)) |
| 1318 | y = Array([[]]).tag(sync=True, scaled=True, |
nothing calls this directly
no test coverage detected
searching dependent graphs…