ag-charts-enterprise/dist/types/src/series/util/radialUtil.d.ts

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

import type { AgColorType, AgRadialSeriesItemStylerParams, AgRadialSeriesStyle, AgRadialSeriesStylerParams, HighlightState as HighlightStateString, SelectionState as SelectionStateString, Styler } from 'ag-charts-community';
import { _ModuleSupport } from 'ag-charts-community';
import type { Callback, CallbackParam, DynamicContext, InternalAgColorType } from 'ag-charts-core';
type BaseNodeDatum = _ModuleSupport.DataModelSeriesNodeDatum;
export interface RadialSeriesStyleResult extends Required<Omit<AgRadialSeriesStyle, 'fill'>> {
    fill: InternalAgColorType;
    opacity: 1;
}
interface RadialSectorSeries<D extends BaseNodeDatum> {
    readonly id: string;
    readonly ctx: DynamicContext<_ModuleSupport.ChartRegistry>;
    readonly declarationOrder: number;
    readonly context?: {
        nodeData: D[];
    };
    readonly properties: {
        readonly angleKey: string;
        readonly radiusKey: string;
        readonly fill: InternalAgColorType;
        readonly fillOpacity: number;
        readonly stroke: string;
        readonly strokeWidth: number;
        readonly strokeOpacity: number;
        readonly lineDash: number[];
        readonly lineDashOffset: number;
        readonly cornerRadius: number;
        readonly stackGroup?: string;
        readonly styler?: Styler<AgRadialSeriesStylerParams<unknown, unknown>, AgRadialSeriesStyle>;
        readonly itemStyler?: Styler<AgRadialSeriesItemStylerParams<unknown>, AgRadialSeriesStyle>;
    };
    callWithContext<F extends Callback>(fn: F, params: CallbackParam<F>): ReturnType<F>;
    cachedCallWithContext<F extends Callback>(fn: F, params: CallbackParam<F>): ReturnType<F> | undefined;
    cachedDatumCallback<T>(id: any, fn: () => T): T | undefined;
    filterItemStylerFillParams(fill: AgColorType | undefined): InternalAgColorType | undefined;
    getDatumId(datum: D): string | number | boolean | undefined;
    getHighlightStyle(isHighlight?: boolean, datumIndex?: number, highlightState?: _ModuleSupport.HighlightState): AgRadialSeriesStyle;
    getHighlightStateString(datum: _ModuleSupport.HighlightNodeDatum | undefined, isHighlight?: boolean, datumIndex?: number): HighlightStateString;
    getSelectionStyle(datumIndex?: number, selectionState?: _ModuleSupport.SelectionState, candidateState?: _ModuleSupport.SelectionState): AgRadialSeriesStyle | undefined;
    getSelectionStateString(datumIndex: number | undefined): SelectionStateString | undefined;
    getCandidateStateString(datumIndex: number | undefined): SelectionStateString | undefined;
}
export declare function makeStylerParams(series: RadialSectorSeries<BaseNodeDatum>, highlightStateEnum: _ModuleSupport.HighlightState | undefined, selectionStateEnum: _ModuleSupport.SelectionState | undefined, candidateStateEnum: _ModuleSupport.SelectionState | undefined): AgRadialSeriesStylerParams<unknown, unknown>;
export declare function getStyle(series: RadialSectorSeries<BaseNodeDatum>, ignoreStylerCallback: boolean, highlightState: _ModuleSupport.HighlightState | undefined, selectionState: _ModuleSupport.SelectionState | undefined, candidateState: _ModuleSupport.SelectionState | undefined): RadialSeriesStyleResult;
export declare function makeItemStylerParams<D extends BaseNodeDatum, S extends RadialSectorSeries<D>>(series: S, nodeDatum: D, isHighlight: boolean, style: Required<AgRadialSeriesStyle> & {
    opacity: number;
}): {
    fill: string | import("ag-charts-community").AgPatternColor | import("ag-charts-core").InternalAgImageFill | import("ag-charts-community").AgGradientColor | import("ag-charts-community").AgColorRef;
    cornerRadius: import("ag-charts-community").PixelSize;
    fillOpacity: import("ag-charts-community").Opacity;
    stroke: import("ag-charts-community").AgCssColorOrRef;
    strokeWidth: import("ag-charts-community").PixelSize;
    strokeOpacity: import("ag-charts-community").Opacity;
    lineDash: import("ag-charts-community").PixelSize[];
    lineDashOffset: import("ag-charts-community").PixelSize;
    opacity: number;
    seriesId: string;
    datum: unknown;
    highlightState: HighlightStateString;
    selectionState: SelectionStateString | undefined;
    candidateState: SelectionStateString | undefined;
    angleKey: string;
    radiusKey: string;
};
export declare function getItemStyle<D extends BaseNodeDatum, S extends RadialSectorSeries<D>>(series: S, nodeDatum: D | undefined, isHighlight: boolean, highlightState: _ModuleSupport.HighlightState | undefined, selectionState: _ModuleSupport.SelectionState | undefined, candidateState: _ModuleSupport.SelectionState | undefined): RadialSeriesStyleResult;
export {};