ag-charts-community/dist/types/src/chart/chartAxis.d.ts

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

import type { AxisID, ChartAnimationPhase, ChartAxisDirection, ChartUpdateType, DomainWithMetadata, DynamicContext, NormalisedBaseAxisOptions, Padding, Scale } from 'ag-charts-core';
import type { AgAxisLabelFormatterParams, AgAxisLabelStylerParams, AgBaseAxisLabelStyleOptions, AgCartesianAxisPosition, Padding as AgPadding, AgTimeAxisFormattableLabelUnitFormat, AgTimeIntervalUnit, FormatterParams, RichFormatter, Styler, TextOptions, TextWrap } from 'ag-charts-types';
import type { AxisLayout } from '../core/eventsHub';
import type { AxisContext, AxisFormattableLabel } from '../module/axisContext';
import type { ChartAxisRegistry } from '../module/moduleContext';
import type { ModuleMap } from '../module/moduleMap';
import type { BBox } from '../scene/bbox';
import type { Group } from '../scene/group';
import type { AxisPrimaryTickCount } from '../util/secondaryAxisTicks';
import type { ScrollbarLayoutMap } from './layout/layoutManager';
import type { DatumIndexType, ISeries, ISeriesProperties } from './series/seriesTypes';
export type ChartAxisLabelFlipFlag = 1 | -1;
interface AxisLayoutConstraints {
    stacked: boolean;
    align: 'justify' | 'start' | 'center' | 'end';
    width: number;
    unit: 'percent' | 'px';
}
export interface AxisGroups {
    axisNode: Group;
    gridNode: Group;
    labelNode: Group;
    /**
     * Three z-index-ordered overlay slots that follow the axis transform. Used by axis plugins
     * (currently {@link CrossLinesPlugin}) to render content scoped to the axis area without
     * the axis itself needing to know what the plugin draws. Slot order, low to high, matches
     * the previous `crossLine{Range,Line,Label}Node` zones — kept stable so existing z-index
     * relationships (cross-lines below series labels, etc.) are preserved.
     */
    overlayLowNode: Group;
    overlayMidNode: Group;
    overlayHighNode: Group;
}
export type FormatDatumParams = Omit<FormatterParams<any>, 'type' | 'value'>;
export interface ChartLayout {
    padding: Padding;
    sizeLimit: number;
    scrollbars?: ScrollbarLayoutMap;
}
export interface ChartAxis<TOptions extends NormalisedBaseAxisOptions = NormalisedBaseAxisOptions> {
    attachAxis(opts: AxisGroups): void;
    calculateLayout(primaryTickCount?: AxisPrimaryTickCount, chartLayout?: ChartLayout): {
        primaryTickCount?: AxisPrimaryTickCount;
        bbox?: BBox;
    };
    clipGrid(x: number, y: number, width: number, height: number): void;
    clipTickLines(x: number, y: number, width: number, height: number): void;
    createAxisContext(): AxisContext;
    createModuleContext(): DynamicContext<ChartAxisRegistry<AxisContext>>;
    destroy(): void;
    detachAxis(): void;
    formatDatum(contextProvider: {
        context?: unknown;
    }, value: any, source: 'tooltip' | 'series-label', seriesId: string, legendItemName: string | undefined, datum: any, key: string, domain?: undefined, label?: undefined, params?: undefined, allowNull?: boolean): string;
    formatDatum<Params extends object>(contextProvider: {
        context?: unknown;
    } | undefined, value: any, source: 'crosshair' | 'annotation-label', seriesId: undefined, legendItemName: undefined, datum: undefined, key: undefined, domain: undefined, label: AxisFormattableLabel<Params>, params: Params, allowNull?: boolean): string;
    formatDatum<Params extends object>(contextProvider: {
        context?: unknown;
    } | undefined, value: any, source: 'tooltip' | 'series-label', seriesId: string, legendItemName: string | undefined, datum: any, key: string, domain: any[], label: AxisFormattableLabel<Params>, params: Params, allowNull?: boolean): string;
    getBBox(): BBox;
    getLayoutState(): AxisLayout;
    getModuleMap(): ModuleMap;
    getUpdateTypeOnResize(): ChartUpdateType;
    inRange(x: number, tolerance?: number): boolean;
    isReversed(): boolean;
    resetAnimation(chartAnimationPhase: ChartAnimationPhase): unknown;
    processData(): void;
    update(animated?: boolean): void;
    applyOptions(options: TOptions): void;
    setDomains(...domains: DomainWithMetadata<unknown>[]): void;
    isCategoryLike(): boolean;
    boundSeries: ISeries<DatumIndexType, unknown, ISeriesProperties>[];
    dataDomain: {
        domain: any[];
        clipped: boolean;
    };
    direction: ChartAxisDirection;
    gridLength: number;
    gridPadding: number;
    id: AxisID;
    interactionEnabled: boolean;
    layoutConstraints: AxisLayoutConstraints;
    nice: boolean;
    options: TOptions;
    mirrored: boolean;
    parallel: boolean;
    position?: AgCartesianAxisPosition;
    range: [number, number];
    requiredRange?: number;
    scale: Scale<any, any, any>;
    seriesAreaPadding: number;
    minimumTimeGranularity?: AgTimeIntervalUnit;
    translation: {
        x: number;
        y: number;
    };
    type: string;
    visibleRange: [number, number];
}
export interface ChartAxisLabel extends TextOptions {
    fontSize: number;
    autoRotate?: boolean;
    autoRotateAngle?: number;
    avoidCollisions: boolean;
    border?: {
        enabled?: boolean;
        stroke?: string;
    };
    enabled: boolean;
    format?: string | Record<string, string> | AgTimeAxisFormattableLabelUnitFormat;
    formatter?: RichFormatter<AgAxisLabelFormatterParams>;
    itemStyler?: Styler<AgAxisLabelStylerParams, AgBaseAxisLabelStyleOptions>;
    minSpacing?: number;
    spacing: number;
    padding?: AgPadding;
    rotation?: number;
    truncate?: boolean;
    wrapping?: TextWrap;
}
export {};