Struct CustomIndicator 

pub struct CustomIndicator { /* private fields */ }

An indicator defined at runtime via a calculation closure.

Build one with new and customise it with the builder methods (with_description, with_color, with_overlay, etc.).

Implementations

impl CustomIndicator

pub fn new<F>(name: impl Into<String>, calculate_fn: F) -> Self

where F: Fn(&[Bar]) -> Vec<IndicatorValue> + Send + Sync + 'static,

Create a new custom indicator.

Arguments

• name – Display name shown in legends and tooltips.
• calculate_fn – Closure that computes indicator values from bars.

The indicator defaults to a single-line yellow overlay.

pub fn with_inputs<F>( self, inputs: Vec<StudyInput>, calculate: F, ) -> Result<Self, StudyError>

where F: Fn(&[Bar], &[StudyInput]) -> Vec<IndicatorValue> + Send + Sync + 'static,

Declare editable inputs and calculate from their current values. Ids must be unique; defaults and initial values must satisfy the same schema used by the editor and setters.

pub fn with_description(self, desc: impl Into<String>) -> Self

Set a human-readable description (used in tooltips).

pub fn with_color(self, color: Color32) -> Self

Set the line color (single-line indicators).

pub fn with_colors(self, colors: Vec<Color32>) -> Self

Set colors for a multi-line indicator.

pub fn with_overlay(self, is_overlay: bool) -> Self

Set whether this indicator is drawn on the main price chart (true) or in a separate sub-pane (false).

pub fn with_line_count(self, count: usize) -> Self

Set the number of output lines (must match the closure’s output).

pub fn with_value_format(self, format: StudyFormat) -> Self

Set the units used by every readout of this study.

pub fn with_scale(self, scale: StudyScale) -> Self

Set the value scale independently of overlay or separate-pane placement.

pub fn with_plot_types(self, types: Vec<PlotType>) -> Self

Set geometry per output; omitted outputs remain lines.

pub fn with_offsets(self, offsets: Vec<isize>) -> Self

Set displacement per output; omitted outputs stay on their source bars.

pub fn with_fills(self, fills: Vec<StudyFill>) -> Self

Set filled bands between output lines or constant levels.

pub fn with_plot_color<F>(self, color: F) -> Self

where F: Fn(usize, usize, &IndicatorValues) -> Option<Color32> + Send + Sync + 'static,

Set a per-bar colour callback. Returning None uses the plot colour.

pub fn with_line_names(self, names: Vec<String>) -> Self

Set display names for each line (used in legends).

Trait Implementations

impl Clone for CustomIndicator

fn clone(&self) -> CustomIndicator

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Indicator for CustomIndicator

fn inputs(&self) -> Vec<StudyInput>

Current editable inputs. A host study can supply the same schema as built-ins.

fn set_input(&mut self, id: &str, value: InputValue) -> Result<(), StudyError>

Change a calculation input, rejecting unknown ids with super::StudyError::UnknownInput and wrong types and invalid values with super::StudyError::InvalidInput. On success cached values are cleared; calculate again or let the chart refresh.

fn value_format(&self) -> StudyFormat

Units of this study’s values. Placement defaults preserve price overlays and numeric panes.

fn scale(&self) -> StudyScale

Scale used in the pane selected by is_overlay.

fn plot_style(&self, line: usize) -> PlotStyle

Presentation defaults for a zero-based output line. Any line is accepted: one at or past line_count, which renderers do not draw, still gets a style, so an implementation must not panic on it. The default takes the line’s colour from colors, white for a line without one, and its width from line_style.

fn plot_offset(&self, line: usize) -> isize

Horizontal displacement in bars. Positive values draw into future whitespace. Values remain indexed by their source bar; missing bars still occupy a position.

fn plot_color(&self, line: usize, bar: usize) -> Option<Color32>

Optional per-bar colour, overriding the plot colour at a source bar.

fn fills(&self) -> Vec<StudyFill>

Filled bands, painted beneath this study’s plots. Missing endpoints break a band.

fn name(&self) -> &str

Return the short display name of this indicator (e.g. "SMA", "RSI", "MACD").

fn desc(&self) -> &str

Return a human-readable description of what this indicator measures.

fn calculate(&mut self, data: &[Bar])

Compute the indicator’s output from the given bar data.

fn values(&self) -> &IndicatorValues

Return the computed output columns, with NaN for missing values.

fn colors(&self) -> Vec<Color32>

Return the plot colours and any extra palette entries used by fills or per-bar colouring.

fn set_colors(&mut self, colors: Vec<Color32>)

Replace all line colors at once.

fn is_overlay(&self) -> bool

Whether this indicator is drawn on the main price chart (overlay) or in a separate sub-pane.

fn line_count(&self) -> usize

The number of output columns this indicator plots. Renderers draw lines 0..line_count().

fn line_names(&self) -> Vec<String>

Return display names for each line, used in chart legends.

fn is_visible(&self) -> bool

Whether this indicator should currently be rendered.

fn set_visible(&mut self, visible: bool)

Show or hide this indicator.

fn clone_box(&self) -> Box<dyn Indicator>

Clone this indicator into a new Box<dyn Indicator>.

fn projections(&self) -> &[StudyProjection]

Sparse projected price bands, with fractional endpoints in future whitespace.

fn table(&self) -> Option<&StudyTable>

A labelled table of the latest study statistics, drawn independently of the plots.

fn has_settings(&self) -> bool

Whether this study stores presentation edits itself. Charts wrap other studies once.

fn projection_fill_color(&self, projection: &StudyProjection) -> Color32

Colour inside a projected price band.

fn plot_label_colors(&self, _line: usize) -> Option<(Color32, Color32)>

Optional background and text colours for captions on plotted markers.

fn marker_style(&self) -> Option<PlotStyle>

Optional presentation of crossing markers; absent uses directional triangles.

fn level_style(&self, _value: f64) -> LineStyle

Stroke pattern for a pane level at the given value.

fn level_fill_color(&self) -> Color32

Colour of the band between the outer pane levels.

fn legend_visible(&self, line: usize) -> bool

Whether output line appears in the legend. Defaults to plot visibility; a study can retain a labelled readout for a quantity excluded from its plot and scale by default.

fn plot_tagged(&self, line: usize) -> bool

Whether plot line shows its last value in a tag on the price scale while the chart shows study values. By default every plot of a study with up to four plots does and no plot of a study with more, whose values stay in the legend, so that the tags leave the scale’s tick labels readable. A study on a chart starts from this choice and keeps the user’s in StudySettings::untagged_plots.

fn plot_output(&self, line: usize) -> usize

The output whose visibility in the style tab also applies to plot line, for a plot past line_count that draws zones or candles for one of the outputs. The default is line itself.

fn provisional_after(&self, line: usize) -> Option<usize>

The last source bar whose value on a zero-based line is final. The segments after it can still move with later bars and are drawn dashed when the line is solid. None, the default, draws the whole line as styled.

fn plot_text(&self, line: usize, bar: usize) -> Option<String>

Optional text beside the shape a circle, cross or triangle plot draws at a source bar: under an upward triangle and over the other shapes, in the shape’s colour.

fn plot_value(&self, line: usize, bar: usize) -> Option<f64>

Value at a displayed bar, accounting for the plot’s displacement.

fn settings(&self) -> StudySettings

Current applied presentation, initialized from the study’s own defaults.

fn snapshot_settings(&self) -> StudySettingsSnapshot

Capture editable inputs and presentation without copying calculated values. The chart presentation wrapper also retains visibility before interval filtering. Custom presentations can use super::StudySettingsSnapshot::capture with their global visibility toggle to do the same.

fn restore_settings( &mut self, snapshot: &StudySettingsSnapshot, ) -> Result<(), StudyError>

Restore a snapshot from this study. Recalculate against current data afterwards. The default applies changed inputs and presentation through Self::apply_settings. Returns an error if the snapshot is no longer accepted.

fn apply_settings( &mut self, inputs: &[(String, InputValue)], settings: StudySettings, ) -> Result<(), StudyError>

Apply a complete edit atomically. Charts wrap studies in ConfiguredStudy, which validates inputs on a clone before replacing the calculation and presentation.

fn set_visible_range(&mut self, range: Range<usize>) -> bool

Visible source bars, end exclusive, supplied after pan, zoom and resize and before autoscaling. Returns whether values need recalculation. Direct callers may supply it too.

fn set_timeframe(&mut self, timeframe: Timeframe)

The chart’s current interval, supplied when added and when the interval changes.

fn set_bar_clock(&mut self, clock: &BarClock) -> bool

Source bar calendar, including the chart’s selected timezone and session anchor. Returns whether cached values must be recalculated. Direct callers default to UTC.

fn scale_mapping(&self) -> Option<PriceMap>

Price mapping supplied by the chart for a shared scale, independent of pane bounds. Custom presentation implementations can retain it to support shared scales.

fn set_scale_mapping(&mut self, mapping: Option<PriceMap>)

Updates the chart’s shared-scale mapping. None restores the ordinary pane mapping.

fn set_value_formatter( &mut self, formatter: Option<Arc<dyn PriceFormatter>>, ) -> bool

Replaces value formatting when supported by the presentation. None restores the declared units and precision. Returns false when this study owns its formatting.

fn format_value(&self, value: f64) -> String

Format a value using the declared units and current precision override.

fn format_plot_value(&self, line: usize, value: f64) -> String

Formats one output, including readouts whose units differ from the study’s scale. The default uses format_value.

fn precision(&self) -> Option<usize>

Decimal places for study readouts, or the format’s default precision.

fn data_requests(&self) -> Vec<StudyDataRequest>

Additional histories this study needs. The chart resolves defaults, requests history and live updates from its feed, and supplies them before recalculating the study.

fn data_start(&self, request: &StudyDataRequest) -> Option<DateTime<Utc>>

The oldest time this study reads from request, one of its data_requests. A connected feed stops loading older history of that series once it holds a bar at or before the earliest such time of the studies reading it, and loads more when that time moves earlier. None, the default, and a time before the chart’s first bar load the series back to that bar. Price-based chart types such as Renko do not use the times and always load it back to that bar.

fn update_data(&mut self, data: &[Bar], from: usize, sources: &[StudyData<'_>])

Update with requested histories. Studies using only chart bars keep the default. Pass 0 when a requested history changes; nonzero from retains the same requested histories and follows update’s unchanged-prefix contract.

fn source(&self) -> Option<StudySource>

The single price series this study reads, or None for OHLC or multi-source studies. Configured studies expose this as a Source input. Study references use chart ids and undisplaced output columns; missing or cyclic references produce missing values.

fn update_source(&mut self, data: &[Bar], from: usize, source: &[f64])

Update using an aligned source column. Missing source values remain gaps. The default substitutes the source for OHLC and retains the bar’s other fields.

fn order_flow_inputs(&self) -> &[OrderFlowInput]

Order-flow sources this study reads: OrderFlowInputs of fixed aggregations, footprints or books. A chart with a feed connects them before its updates are coalesced, gives them its instrument’s tick size, applies the trade store’s retention and the replay cutoff, and updates the study from the first bar that changed. Hosts without a feed push events through the handles and recalculate. Several studies may return the same source; it receives each event once.

fn needs_order_flow(&self) -> bool

Whether the study has results only with its order_flow_inputs, so that it cannot be calculated on the bars of another interval or symbol, whose order flow the chart does not hold. The default is whether it names any. A study that builds its results from the bars and refines them with order flow where the chart holds it returns false, and keeps its Interval input.

fn update(&mut self, data: &[Bar], from: usize)

Bring values up to date after data[from..] changed or grew, given that data[..from] is unchanged since the previous call. The values equal those of calculate on the same data, bit for bit. After bars are prepended, or after a setting of the study changed, pass 0; after bars are removed from the end pass the new length.

fn is_incremental(&self) -> bool

Whether live updates avoid recomputing unaffected history. Causal studies do work independent of the series length; studies that redraw earlier legs or periods also revisit the bars whose output changes. Earlier corrections may recompute in full. Defaults to false.

fn set_instrument(&mut self, instrument: Option<&Instrument>) -> bool

Apply the chart instrument’s time zone and trading session. Returns true if calculation settings changed and the caller must recalculate from bar 0. The chart calls this on add and before calculation after its symbol or metadata changes. None clears chart metadata and restores the study’s own settings. Studies independent of instrument metadata keep the default.

fn set_time_scale_events(&mut self, events: &[TimeScaleEvent]) -> bool

The typed events the chart holds for its symbol, those given to Chart::set_time_scale_events, in the order supplied. Returns true if calculation settings changed and the caller must recalculate from bar 0. The chart calls this on add and before calculation. Studies that read no events keep the default.

fn line_style(&self, line: usize) -> IndicatorLineStyle

Rendering style of an overlay line. Defaults to a 1 px line in its configured colour. Any line is accepted, as for plot_style.

fn candles(&self) -> &[StudyCandle]

Candle bodies and wicks, rendered in place of line plots when nonempty. Source ranges and OHLCV remain available to hosts for per-bar readouts.

fn drawings(&self) -> &[Drawing]

Drawing geometry generated by this study, styled as plot 0, empty by default. Calculations belong in calculate; use tools whose renderer needs only their anchors and settings, such as trend lines, parallel channels, Fibonacci levels and pitchforks.

fn tpo(&self) -> Option<&TPOConfig>

Market Profile settings of a study whose session profiles the chart builds with to_tpo_profiles and draws on the price pane, beside each session’s bars, as it does for the TPO chart type. None by default.

fn zones(&self) -> &[StudyZone]

Price bands painted beneath this study’s plots, stored per zone rather than per bar. Empty by default.

fn zones_cover_whole_bars(&self) -> bool

Whether each of zones spans its bars from the left edge of the first to the right edge of the last, as study candles do, rather than from the centre of the first to the centre of the last. Off by default.

fn labels(&self) -> &[StudyLabel]

Text beside study values, in order of bar. The chart draws the labels near the visible bars, in the colour of their plot, inside the plot area, so they never run under the price axis. Empty by default. Keep the text from the last calculation: it is drawn every frame.

fn labels_on_price(&self) -> bool

Draw labels on the main price chart, even when the study has its own pane. Label prices use the main series’ scale. Off by default.

fn set_label_precision(&mut self, precision: Option<usize>)

The decimal places the study’s presentation settings set for the prices in labels, None when they set none and the instrument’s decimals apply. The text is written when the study calculates, so calculate again afterwards, as a chart does after any settings edit. Studies without price labels keep the default.

fn volume_profiles(&self, visible: Range<usize>) -> Vec<StudyProfile>

Price-row volume profiles intersecting a half-open visible source-bar range. Fixed and calendar profiles include their whole selected span, even offscreen bars. Visible-range studies recompute for this range; ordinary studies return no profiles.

fn markers(&self) -> &[IndicatorMarker]

Shapes attached to study values, empty by default.

fn extend_right(&self) -> bool

Extend the last two values of each overlay line to the plot’s right edge.

fn plot_label(&self) -> Option<(usize, String)>

An annotation beside the latest value of a zero-based overlay line.

fn set_color(&mut self, line_idx: usize, color: Color32)

Set the color of a single line by its zero-based index.

fn pane(&self) -> StudyPane

Default separate-pane layout and reference levels, independent of the study name. ConfiguredStudy returns its levels where its settings place them, in their colours, and a hidden level in Color32::TRANSPARENT, which still bounds the fill.

fn set_overlay(&mut self, _overlay: bool) -> bool

Changes placement between the main chart and a separate pane. Returns whether this study supports the change. The chart’s presentation wrapper does.

fn set_scale(&mut self, _scale: StudyScale) -> bool

Changes the scale used in the study’s pane. Returns whether this study supports the change. The chart’s presentation wrapper does.

fn is_volume(&self) -> bool

Volume plots use an independent zero-based scale: up columns, down columns and MA. Renderers size columns to 80% of the bar pitch and format values as volume.