ag-charts-types/dist/types/src/series/cartesian/rangeAreaOptions.d.ts

Advanced Charting / Charts supporting Javascript / Typescript / React / Angular / Vue

import type { ContextCallbackParams, DatumItemCallbackParams, HighlightState, SeriesCallbackParams, Styler } from '../../chart/callbackOptions';
import type { AgDropShadowOptions } from '../../chart/dropShadowOptions';
import type { AgChartLabelOptions } from '../../chart/labelOptions';
import type { AgSeriesTooltip } from '../../chart/tooltipOptions';
import type { ContextDefault, CssColor, DatumDefault, DatumKey, Opacity, PixelSize } from '../../chart/types';
import type { AgInterpolationType } from '../interpolationOptions';
import type { AgSeriesMarkerOptions, AgSeriesMarkerStyle } from '../markerOptions';
import type { AgBaseCartesianThemeableOptions, AgBaseSeriesOptions, AgHighlightStyleOptions, AgMultiSeriesHighlightOptions, AgSeriesSegmentation, AgSeriesShapeSegmentOptions } from '../seriesOptions';
import type { AgCartesianSeriesTooltipRendererParams } from './cartesianSeriesTooltipOptions';
import type { AgBaseCartesianSeriesAxisOptions, FillOptions, LineDashOptions, StrokeOptions } from './commonOptions';
export interface AgRangeAreaSeriesStylerParams<TDatum, TContext> extends SeriesCallbackParams<HighlightState>, ContextCallbackParams<TContext>, AgRangeAreaSeriesOptionsKeys<TDatum>, Required<AgRangeAreaSeriesStyle> {
}
export interface AgRangeAreaSeriesLineStyle extends StrokeOptions, LineDashOptions {
    /** Styling for the markers used in the item.  */
    marker?: AgSeriesMarkerStyle;
}
export interface AgRangeAreaSeriesStyleItems {
    /** Configuration for the `yLowKey` line. */
    low?: AgRangeAreaSeriesLineStyle;
    /** Configuration for the `yHighKey` line. */
    high?: AgRangeAreaSeriesLineStyle;
}
export interface AgRangeAreaSeriesStyle extends FillOptions {
    /** Configuration used for the range area series low and high lines. */
    item?: AgRangeAreaSeriesStyleItems;
}
export type AgRangeAreaSeriesItemType = 'low' | 'high';
export interface AgRangeAreaSeriesTooltipRendererParams<TDatum = DatumDefault, TContext = ContextDefault> extends Omit<AgCartesianSeriesTooltipRendererParams<TDatum, TContext>, 'xKey' | 'xName' | 'yKey' | 'yName'>, AgRangeAreaSeriesOptionsKeys<TDatum>, AgRangeAreaSeriesOptionsNames, Omit<AgSeriesMarkerStyle, 'shape'> {
    /** The type of datum. This can be `high` or `low`. */
    itemType: AgRangeAreaSeriesItemType;
}
export interface AgRangeAreaSeriesItemStylerParams<TDatum, TContext> extends AgRangeAreaSeriesOptionsKeys<TDatum>, DatumItemCallbackParams<AgRangeAreaSeriesItemType, TDatum, HighlightState>, ContextCallbackParams<TContext>, Required<AgSeriesMarkerStyle> {
    /** The type of datum. This can be `high` or `low`. */
    itemType: AgRangeAreaSeriesItemType;
}
export interface AgRangeAreaSeriesLabelOptions<TDatum, TParams, TContext = ContextDefault> extends AgChartLabelOptions<TDatum, TParams, TContext> {
    /** Where to render series labels relative to the area. */
    placement?: AgRangeAreaSeriesLabelPlacement;
    /** Spacing in pixels between the label and the edge of the marker. */
    spacing?: PixelSize;
}
export type AgRangeAreaSeriesLabelPlacement = 'inside' | 'outside';
export type AgRangeAreaSeriesLabelFormatterParams<TDatum = DatumDefault> = AgRangeAreaSeriesOptionsKeys<TDatum> & AgRangeAreaSeriesOptionsNames;
export interface AgRangeAreaMarker<TDatum, TContext> extends AgSeriesMarkerOptions<TDatum, AgRangeAreaSeriesItemStylerParams<TDatum, TContext>, TContext> {
    /** Function used to return formatting for individual markers, based on the supplied information.*/
    itemStyler?: Styler<AgRangeAreaSeriesItemStylerParams<TDatum, TContext>, AgSeriesMarkerStyle>;
}
export interface AgRangeAreaSeriesLineThemeableOptions<TDatum, TContext> extends StrokeOptions, LineDashOptions {
    /** Styling configuration for the markers used in the series.  */
    marker?: AgRangeAreaMarker<TDatum, TContext>;
}
export interface AgRangeAreaSeriesItemMarker<TDatum, TContext> extends Omit<AgSeriesMarkerOptions<TDatum, never, TContext>, 'itemStyler'> {
}
export interface AgRangeAreaSeriesItemLineThemeableOptions<TDatum, TContext> extends StrokeOptions, LineDashOptions {
    /** Styling configuration for the markers used in the series.  */
    marker?: AgRangeAreaSeriesItemMarker<TDatum, TContext>;
}
export interface AgRangeAreaSeriesItemThemeableOptions<TDatum, TContext> {
    /** Configuration for the `yLowKey` line. */
    low?: AgRangeAreaSeriesItemLineThemeableOptions<TDatum, TContext>;
    /** Configuration for `yHighKey` line. */
    high?: AgRangeAreaSeriesItemLineThemeableOptions<TDatum, TContext>;
}
export interface AgRangeAreaSeriesThemeableOptions<TDatum = DatumDefault, TContext = ContextDefault> extends FillOptions, AgBaseCartesianThemeableOptions<TDatum, TContext> {
    /** Configuration for the markers used in the series.  */
    marker?: AgRangeAreaMarker<TDatum, TContext>;
    /** The colour for the stroke. */
    stroke?: CssColor;
    /** The width of the stroke in pixels. */
    strokeWidth?: PixelSize;
    /** The opacity of the stroke colour. */
    strokeOpacity?: Opacity;
    /** An array specifying the length in pixels of alternating dashes and gaps for the stroke. */
    lineDash?: PixelSize[];
    /** The initial offset of the dashed line in pixels. */
    lineDashOffset?: PixelSize;
    /** Configuration used for distinct styling of the low and high lines. */
    item?: AgRangeAreaSeriesItemThemeableOptions<TDatum, TContext>;
    /** Configuration for the line used in the series. */
    interpolation?: AgInterpolationType;
    /** Configuration for the labels shown on top of data points. */
    label?: AgRangeAreaSeriesLabelOptions<TDatum, AgRangeAreaSeriesLabelFormatterParams<TDatum>, TContext>;
    /** Configuration for the shadow used behind the series items. */
    shadow?: AgDropShadowOptions;
    /** Series-specific tooltip configuration. */
    tooltip?: AgSeriesTooltip<AgRangeAreaSeriesTooltipRendererParams<TDatum, TContext>>;
    /** Set to `true` to connect across missing data points. */
    connectMissingData?: boolean;
    /** Function used to return formatting for entire series, based on the given parameters.*/
    styler?: Styler<AgRangeAreaSeriesStylerParams<TDatum, TContext>, AgRangeAreaSeriesStyle>;
    /** Configuration for highlighting when a series or legend item is hovered over. */
    highlight?: AgMultiSeriesHighlightOptions<AgHighlightStyleOptions, AgHighlightStyleOptions>;
    /** Configuration for styling series as separate segments. */
    segmentation?: AgSeriesSegmentation<AgSeriesShapeSegmentOptions>;
    /** Style options for the fill of areas where the `yHigh` line is below the `yLow` line. */
    invertedStyle?: AgRangeAreaSeriesInvertedStyle;
}
export type AgRangeAreaSeriesInvertedStyle = FillOptions & {
    enabled?: boolean;
};
export interface AgRangeAreaSeriesOptionsKeys<TDatum = DatumDefault> {
    /** The key to use to retrieve x-values from the data. */
    xKey: DatumKey<TDatum>;
    /** The key to use to retrieve y-low-values from the data. */
    yLowKey: DatumKey<TDatum>;
    /** The key to use to retrieve y-high-values from the data. */
    yHighKey: DatumKey<TDatum>;
}
export interface AgRangeAreaSeriesOptionsNames {
    /** A human-readable description of the x-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. */
    xName?: string;
    /** A human-readable description of the y-low-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. */
    yLowName?: string;
    /** A human-readable description of the y-high-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. */
    yHighName?: string;
    /** A human-readable description of the y-values. If supplied, this will be shown in the default tooltip and passed to the tooltip renderer as one of the parameters. */
    yName?: string;
    /** Human-readable description of the y-values. If supplied, matching items with the same value will be toggled together. */
    legendItemName?: string;
}
export interface AgRangeAreaSeriesOptions<TDatum = DatumDefault, TContext = ContextDefault> extends Omit<AgBaseSeriesOptions<TDatum, TContext>, 'highlight'>, AgBaseCartesianSeriesAxisOptions, AgRangeAreaSeriesOptionsKeys<TDatum>, AgRangeAreaSeriesOptionsNames, AgRangeAreaSeriesThemeableOptions<TDatum, TContext> {
    /** Configuration for the Range Area Series. */
    type: 'range-area';
}