Interface ChartDataCsvOptions

Options for a numeric snapshot of the chart's currently loaded data.

interface ChartDataCsvOptions {
    alignment?: "source" | "display";
    comparisons?: readonly Pick<ComparisonHandle, "symbol" | "barAt">[];
    formatters?: ChartDataCsvFormatters;
    indicators?: boolean | readonly string[];
    projectTime?: (
        logicalIndex: number,
        context: Readonly<ChartDataProjectionContext>,
    ) => null | number;
    range?: ChartDataCsvRange;
}

Properties

alignment? comparisons? formatters? indicators? projectTime? range?

Properties

Optionalalignment

alignment?: "source" | "display"

Source rows by default. Display uses effective study offsets on the shared axis.

Optionalcomparisons

comparisons?: readonly Pick<ComparisonHandle, "symbol" | "barAt">[]

Override the chart's registered comparisons, for example with an explicitly managed controller's list.

Optionalformatters

formatters?: ChartDataCsvFormatters

Optionalindicators

indicators?: boolean | readonly string[]

All studies by default, false for none, or instance IDs in the requested column order. Hidden studies remain eligible.

OptionalprojectTime

projectTime?: (
    logicalIndex: number,
    context: Readonly<ChartDataProjectionContext>,
) => null | number

Resolves positions outside the captured axis. Null explicitly leaves time unknown.

Optionalrange

range?: ChartDataCsvRange

Filter rows after full installed-history calculation, without changing study warmup.

Settings

Member Visibility

On This Page

Properties