ag-charts-enterprise/dist/types/src/series/range-area/rangeAreaProperties.d.ts

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

import type { AgMarkerShape, AgRangeAreaSeriesItemStylerParams, AgRangeAreaSeriesItemType, AgRangeAreaSeriesLabelFormatterParams, AgRangeAreaSeriesLabelPlacement, AgRangeAreaSeriesOptions, AgRangeAreaSeriesTooltipRendererParams, AgSeriesMarkerOptions, AgSeriesMarkerStyle, PixelSize, Styler } from 'ag-charts-community';
import { _ModuleSupport } from 'ag-charts-community';
import type { InternalAgColorType, SizedPoint } from 'ag-charts-core';
import { BaseProperties, InterpolationProperties } from 'ag-charts-core';
export interface RangeAreaMarkerDatum extends Omit<_ModuleSupport.CartesianSeriesNodeDatum, 'yKey' | 'yValue'> {
    readonly itemId?: never;
    readonly itemType: AgRangeAreaSeriesItemType;
    readonly index: number;
    readonly yLowKey: string;
    readonly yHighKey: string;
    readonly yLowValue: number;
    readonly yHighValue: number;
    readonly point: Readonly<SizedPoint>;
    readonly enabled: boolean;
    style?: AgSeriesMarkerStyle;
}
declare const CartesianSeriesProperties: typeof _ModuleSupport.CartesianSeriesProperties, Label: typeof _ModuleSupport.Label;
type RangeAreaSeriesItemOptions = NonNullable<AgRangeAreaSeriesOptions['item']>;
type RangeAreaSeriesLineOptions = NonNullable<RangeAreaSeriesItemOptions[AgRangeAreaSeriesItemType]>;
export type RangeAreaSeriesParams = Pick<AgRangeAreaSeriesItemStylerParams<unknown, unknown>, 'xKey' | 'yLowKey' | 'yHighKey' | 'itemType'>;
declare class RangeAreaSeriesLabel extends Label<AgRangeAreaSeriesLabelFormatterParams> {
    placement: AgRangeAreaSeriesLabelPlacement;
    spacing: PixelSize;
}
declare class RangeAreaInvertedStyle {
    enabled: boolean;
    fill?: InternalAgColorType;
    fillOpacity: number;
}
declare class RangeAreaLineStyle extends BaseProperties<RangeAreaSeriesLineOptions> {
    stroke: string;
    strokeWidth: number;
    strokeOpacity: number;
    lineDash: number[];
    lineDashOffset: number;
    readonly marker: _ModuleSupport.SeriesMarker<RangeAreaSeriesParams>;
}
declare class RangeAreaItemProperties extends BaseProperties<RangeAreaSeriesItemOptions> {
    low: RangeAreaLineStyle;
    high: RangeAreaLineStyle;
}
declare class SharedRangeAreaMarker extends BaseProperties<AgSeriesMarkerOptions<unknown, unknown, unknown>> {
    enabled?: boolean;
    shape?: AgMarkerShape;
    size?: number;
    fill?: InternalAgColorType;
    fillOpacity?: number;
    stroke?: string;
    strokeWidth?: number;
    strokeOpacity?: number;
    lineDash?: number[];
    lineDashOffset?: number;
    itemStyler?: AgSeriesMarkerOptions<unknown, unknown, unknown>['itemStyler'];
}
export declare class RangeAreaProperties extends CartesianSeriesProperties<AgRangeAreaSeriesOptions> {
    xKey: string;
    yLowKey: string;
    yHighKey: string;
    xName?: string;
    yName?: string;
    yLowName?: string;
    yHighName?: string;
    fill: InternalAgColorType;
    fillOpacity: number;
    stroke: string;
    strokeWidth: number;
    strokeOpacity: number;
    lineDash: number[];
    lineDashOffset: number;
    interpolation: InterpolationProperties;
    styler?: Styler<unknown, undefined>;
    item: RangeAreaItemProperties;
    readonly invertedStyle: RangeAreaInvertedStyle;
    readonly shadow: _ModuleSupport.DropShadow;
    readonly marker: SharedRangeAreaMarker;
    readonly label: RangeAreaSeriesLabel;
    readonly tooltip: _ModuleSupport.SeriesTooltip<Omit<AgRangeAreaSeriesTooltipRendererParams<any, unknown>, "context">>;
    connectMissingData: boolean;
}
export {};