Skip to content

@mk7s/holochart-traces-finance ​

Interfaces ​

InterfaceDescription
CandlestickTraceDecreasingStyle of falling candles: candles whose close is below their open (an unchanged candle compares its close with the previous close).
CandlestickTraceDecreasingLineOutline and wick style of falling candles.
CandlestickTraceHoverlabelHover label style for this trace. Unset fields fall back to layout.hoverlabel (so there are no trace-level defaults).
CandlestickTraceIncreasingStyle of rising candles: candles whose close is above their open (an unchanged candle compares its close with the previous close).
CandlestickTraceIncreasingLineOutline and wick style of rising candles.
CandlestickTraceLineOutline and wick style of every candle.
FunnelareaCalcFunnelarea calcdata: pie-shaped (so pie's labels and hover read it) plus the stage shapes.
FunnelareaSliceOne stage: pie's slice (angles unused) plus its trapezoid, set by the cross-trace layout.
FunnelareaTraceMarkerStage style.
FunnelareaTraceMarkerLineStage outlines.
FunnelareaTraceMarkerPatternHatch pattern of the stage fill (drawn in screen px, for print and grayscale).
FunnelareaTraceTitleThe funnel area title.
FunnelCalcFunnel calcdata: bar's calc (bars centered on zero) plus the stage percentages.
FunnelTraceConnectorRegions connecting each stage to the next.
FunnelTraceConnectorLineThe lines along the edges of the connector regions.
FunnelTraceMarkerBar style.
IndicatorCalcThe value of an indicator and its difference to the delta reference.
IndicatorTraceDeltaThe delta (mode with delta).
IndicatorTraceDeltaDecreasingStyle of a negative delta.
IndicatorTraceDeltaFontFont of the delta. Defaults to layout.font, at half the number font size (or the number font size without a number).
IndicatorTraceDeltaIncreasingStyle of a positive delta.
IndicatorTraceGaugeThe gauge (mode with gauge).
IndicatorTraceGaugeAxisThe gauge axis: its range, ticks and tick labels.
IndicatorTraceGaugeAxisTickfontTick-label font. Defaults to layout.font.
IndicatorTraceGaugeAxisTickformatstopOne item of tickformatstops.
IndicatorTraceGaugeBarThe bar from the start of the axis to the value. Default thickness 0.5 (0.25 on a bullet gauge) of the gauge's.
IndicatorTraceGaugeBarLineOutline of the value bar.
IndicatorTraceGaugeStepOne item of steps.
IndicatorTraceGaugeStepLineOutline of the step.
IndicatorTraceGaugeThresholdA line marking a threshold value on the gauge.
IndicatorTraceGaugeThresholdLineThe threshold line.
IndicatorTraceNumberThe number (mode with number).
IndicatorTraceNumberFontFont of the number. Defaults to layout.font; without a size, the number (and the delta) scale to fit the domain.
IndicatorTraceTitleThe indicator title.
IndicatorTraceTitleFontTitle font. Defaults to layout.font at a quarter of the number font size.
OhlcTraceDecreasingStyle of falling bars: bars whose close is below their open (an unchanged bar compares its close with the previous close).
OhlcTraceDecreasingLineLine style of falling bars.
OhlcTraceHoverlabelHover label style for this trace. Unset fields fall back to layout.hoverlabel (so there are no trace-level defaults).
OhlcTraceIncreasingStyle of rising bars: bars whose close is above their open (an unchanged bar compares its close with the previous close).
OhlcTraceIncreasingLineLine style of rising bars.
OhlcTraceLineLine style of every bar.
PriceCalcCalcdata of an ohlc or candlestick trace. Index-aligned with the data (length).
PriceSlotWhere the bars of a trace sit around their positions, in x linear units. ohlc and candlestick fill it from their own cross-trace calc.
WaterfallCalcWaterfall calcdata: bar's calc (sizes are running totals) plus the waterfall values.
WaterfallTraceConnectorLines connecting each bar to the next.
WaterfallTraceConnectorLineThe connector lines.
WaterfallTraceDecreasingStyle of falling bars (relative measures below zero).
WaterfallTraceDecreasingMarkerStyle of falling bars (relative measures below zero).
WaterfallTraceDecreasingMarkerLineOutline of falling bars (relative measures below zero).
WaterfallTraceIncreasingStyle of rising bars (relative measures at or above zero).
WaterfallTraceIncreasingMarkerStyle of rising bars (relative measures at or above zero).
WaterfallTraceIncreasingMarkerLineOutline of rising bars (relative measures at or above zero).
WaterfallTraceTotalsStyle of sum bars (total and absolute measures).
WaterfallTraceTotalsMarkerStyle of sum bars (total and absolute measures).
WaterfallTraceTotalsMarkerLineOutline of sum bars (total and absolute measures).

Type Aliases ​

Type AliasDescription
BaseFunnelTraceFunnel: stages of a process as bars centered on the value axis, with connector regions between them.
BaseWaterfallTraceWaterfall: bars showing how a running total is built from positive and negative changes, with sum bars and connector lines.
CandlestickTraceCandlestick: the open, high, low and close of each period as a body from open to close with wicks to the high and low, colored by direction.
FunnelareaTraceFunnel area: stages of a process as stacked trapezoids with areas proportional to their values.
IndicatorTraceA single value as a big number, its delta to a reference, and / or a gauge (angular or bullet) with colored steps and a threshold.
OhlcTraceOHLC: the open, high, low and close of each period as a vertical line from low to high with an open tick on the left and a close tick on the right, colored by direction.
TracesFinanceAny trace of @mk7s/holochart-traces-finance, discriminated on type. Type a partial bundle's figures with it: FigureInput<TracesFinance>.

Variables ​

VariableDescription
candlestick-
candlestickAttributesThe candlestick schema. Common trace attributes (name, opacity, xaxis, …) come from core.
financeTracesEvery financial trace module, for register(...financeTraces).
funnel-
funnelarea-
funnelareaAttributesThe funnelarea schema.
funnelAttributesThe funnel schema. Common trace attributes (name, opacity, xaxis, …) come from core.
indicator-
indicatorAttributesThe indicator schema.
ohlc-
ohlcAttributesThe ohlc schema. Common trace attributes (name, opacity, xaxis, …) come from core.
waterfall-
waterfallAttributesThe waterfall schema. Common trace attributes (name, opacity, xaxis, …) come from core.

Released under the MIT License.