@mk7s/holochart-traces-basic
Interfaces
| Interface | Description |
|---|---|
| BarCalc | Bar calcdata. Index-aligned typed arrays, one entry per bar. |
| BarTraceErrorX | Error bars along the x axis. |
| BarTraceErrorY | Error bars along the y axis. |
| BarTraceInsidetextfont | Font of labels inside bars. Defaults to textfont, with a color contrasting the bar fill. |
| BarTraceMarker | Bar style. |
| BarTraceMarkerLine | Bar outline. |
| BarTraceMarkerPattern | Hatch pattern of the bar fill (drawn in screen px, for print and grayscale). |
| BarTraceOutsidetextfont | Font of labels outside bars. Defaults to textfont. |
| BarTraceSelected | Style of selected bars while a selection is active. |
| BarTraceSelectedMarker | Marker style of selected bars. |
| BarTraceSelectedTextfont | Text style of selected bars. |
| BarTraceTextfont | Font of bar labels. Defaults to layout.font. |
| BarTraceUnselected | Style of unselected bars while a selection is active. |
| BarTraceUnselectedMarker | Marker style of unselected bars. |
| BarTraceUnselectedTextfont | Text style of unselected bars. |
| BubbleSizerefOptions | Options for bubbleSizeref. |
| Colorbar | The colorbar of this colorscale (plan E5.3). |
| ColorbarTickfont | Tick-label font. Defaults to layout.font. |
| ColorbarTitle | Colorbar title. |
| ColorbarTitleFont | Title font. Defaults to layout.font with the tick-label family and 1.2 × its size. |
| PieCalc | Calcdata of a pie trace. |
| PieLayout | Placement of a pie in container px (top-left origin), set by crossTraceLayout. |
| PieSlice | One slice: every data point with the same label (Plotly's calcdata point). |
| PieTraceInsidetextfont | Font of labels inside slices. Defaults to textfont, with a color contrasting the slice. |
| PieTraceMarker | Slice style. |
| PieTraceMarkerLine | Slice outlines. |
| PieTraceMarkerPattern | Hatch pattern of the slice fill (drawn in screen px, for print and grayscale). |
| PieTraceOutsidetextfont | Font of labels outside slices. Defaults to textfont. |
| PieTraceTextfont | Font of slice labels. Defaults to layout.font. |
| PieTraceTitle | The pie title. |
| PieTraceTitleFont | Title font. Defaults to layout.font. |
| ScatterCalc | Scatter calcdata: linear coordinates per point (NaN where a point cannot be placed). |
| ScatterLink | A trace's place among the scatter traces of its subplot (E9.4), set by crossTraceCalc. |
| ScatterStack | A stacked trace's cross-trace calc (E9.4), written by crossTraceCalc: the x / y of the calc then hold each point's stacked position. |
| ScatterTraceErrorX | Error bars along the x axis. |
| ScatterTraceErrorY | Error bars along the y axis. |
| ScatterTraceFillgradient | A color gradient drawn instead of fillcolor (which still colors hover labels). |
| ScatterTraceFillpattern | Hatch pattern of the area fill (drawn in screen px, for print and grayscale). |
| ScatterTraceLine | Line style (mode lines). shape and smoothing also shape fills. |
| ScatterTraceMarker | Marker style (mode markers). |
| ScatterTraceMarkerLine | Marker outline. |
| ScatterTraceSelected | Style of selected points while a selection is active (box/lasso select, selectedpoints). |
| ScatterTraceSelectedMarker | Marker style of selected points. |
| ScatterTraceSelectedTextfont | Text style of selected points. |
| ScatterTraceTextfont | Font of the text labels (mode text). Defaults to layout.font. |
| ScatterTraceUnselected | Style of unselected points while a selection is active (box/lasso select, selectedpoints). |
| ScatterTraceUnselectedMarker | Marker style of unselected points. |
| ScatterTraceUnselectedTextfont | Text style of unselected points. |
| StackOutput | What layoutBars computes for one input. Arrays are index-aligned with the input. |
| TableCalc | Calcdata of a table. |
| TableColumn | One column, in data order. |
| TableTraceCells | The cells, scrolled with the wheel, by dragging, or with the scrollbar. |
| TableTraceCellsFill | Cell background. |
| TableTraceCellsFont | Font of the cells text. Defaults to layout.font. |
| TableTraceCellsLine | Cell outlines. |
| TableTraceHeader | The header: fixed above the scrolling cells; drag a header cell to reorder columns. |
| TableTraceHeaderFill | Cell background. |
| TableTraceHeaderFont | Font of the header text. Defaults to layout.font. |
| TableTraceHeaderLine | Cell outlines. |
| TimelineFigure | The figure built by timeline: pass it to createChart or adjust it first. |
| TimelineFigureOptions | Options of timeline: the camelCase counterparts of px.timeline's parameters. |
Type Aliases
| Type Alias | Description |
|---|---|
| BarExtruder | Draws a bar trace with depth extruded (render's extrudeRects; see the module comment). |
| BaseBarTrace | Bar: rectangles from a base to a value, vertical or horizontal. |
| BasePieTrace | Pie or donut: slices of a circle proportional to their values. |
| BaseScatterTrace | Scatter: markers, lines, text labels and filled or stacked areas at x/y positions. |
| TableTrace | Table: a grid of formatted values with a fixed header, placed by domain. Only the visible rows are laid out and drawn, so large tables scroll smoothly. |
| TimelineData | Rows ([{ task, start, end }, …]) or columns ({ task: [...], start: [...], end: [...] }). |
| TracesBasic | Any trace of @mk7s/holochart-traces-basic, discriminated on type. Type a partial bundle's figures with it: FigureInput<TracesBasic>. |
Variables
| Variable | Description |
|---|---|
| bar | - |
| barAttributes | The bar schema. Common trace attributes (name, opacity, xaxis, …) come from core. |
| basicTraces | Every trace module in this package, in registration order (the full bundle registers these). |
| colorbarAttributes | The colorbar container of a colorscaled container with showscale (marker.colorbar, layout.coloraxisN.colorbar), following Plotly's colorbar attributes: size and placement, outline, border and background, the axis tick API (the colorbar is a linear axis over [cmin, cmax]) and a title. |
| pie | - |
| pieAttributes | The pie schema. |
| scatter | - |
| scatterAttributes | The scatter schema. Common trace attributes (name, opacity, xaxis, …) come from core. |
| table | - |
| tableAttributes | The table schema. |
Functions
| Function | Description |
|---|---|
| bubbleSizeref | The marker.sizeref that draws the largest of sizes as a bubble maxPx CSS px across, so data of any magnitude maps to a readable range of marker sizes. For sizemode: 'area' (the usual bubble setting) this is Plotly's documented 2 · max(size) / maxPx²; for 'diameter' it is max(size) / maxPx. |
| setBarExtruder | Install (or remove) the extruder of bars with depth (plan E9.10). The full bundle (@mk7s/holochart) installs render's extrudeRects and registers bar with the depth, bevel and material attributes (core withExtrusion); partial bundles opt in the same way. |
| timeline | Build a Gantt chart figure from a table, like plotly.py's px.timeline: one horizontal bar trace per color group, base = the start dates (as given), x = durations in ms, barmode: 'overlay' and a date x axis. Rows whose start or end is not a valid date are skipped. Differences from px: rows read top-down by default (reverseY), colors come from the template's colorway unless colorDiscreteMap / colorDiscreteSequence is given, and hover dates show the time of day only when some start or end has one. |