recharts/types/cartesian/CartesianAxis.d.ts

React charts

import { ReactElement, ReactNode, Component, SVGProps } from 'react';
import { CartesianViewBox, TickItem, PresentationAttributesAdaptChildEvent } from '../util/types';
interface CartesianTickItem extends TickItem {
    tickCoord?: number;
    tickSize?: number;
    isShow?: boolean;
}
export interface CartesianAxisProps {
    className?: string;
    x?: number;
    y?: number;
    width?: number;
    height?: number;
    unit?: string | number;
    orientation?: 'top' | 'bottom' | 'left' | 'right';
    viewBox?: CartesianViewBox;
    tick?: SVGProps<SVGTextElement> | ReactElement<SVGElement> | ((props: any) => ReactElement<SVGElement>) | boolean;
    axisLine?: boolean | SVGProps<SVGLineElement>;
    tickLine?: boolean | SVGProps<SVGLineElement>;
    mirror?: boolean;
    tickMargin?: number;
    hide?: boolean;
    label?: any;
    minTickGap?: number;
    ticks?: CartesianTickItem[];
    tickSize?: number;
    tickFormatter?: (value: any, index: number) => string;
    ticksGenerator?: (props?: CartesianAxisProps) => CartesianTickItem[];
    interval?: number | 'preserveStart' | 'preserveEnd' | 'preserveStartEnd';
}
export declare type Props = Omit<PresentationAttributesAdaptChildEvent<any, SVGElement>, 'viewBox'> & CartesianAxisProps;
export declare class CartesianAxis extends Component<Props> {
    static displayName: string;
    static defaultProps: {
        x: number;
        y: number;
        width: number;
        height: number;
        viewBox: {
            x: number;
            y: number;
            width: number;
            height: number;
        };
        orientation: string;
        ticks: CartesianTickItem[];
        stroke: string;
        tickLine: boolean;
        axisLine: boolean;
        tick: boolean;
        mirror: boolean;
        minTickGap: number;
        tickSize: number;
        tickMargin: number;
        interval: string;
    };
    static getTicks(props: Props): any[];
    static getNumberIntervalTicks(ticks: CartesianTickItem[], interval: number): CartesianTickItem[];
    static getTicksStart({ ticks, tickFormatter, viewBox, orientation, minTickGap, unit }: Omit<Props, 'tickMargin'>, preserveEnd?: boolean): CartesianTickItem[];
    static getTicksEnd({ ticks, tickFormatter, viewBox, orientation, minTickGap, unit }: Omit<Props, 'tickMargin'>): CartesianTickItem[];
    shouldComponentUpdate({ viewBox, ...restProps }: Props): boolean;
    getTickLineCoord(data: CartesianTickItem): {
        line: {
            x1: number;
            y1: number;
            x2: number;
            y2: number;
        };
        tick: {
            x: number;
            y: number;
        };
    };
    getTickTextAnchor(): string;
    getTickVerticalAnchor(): string;
    renderAxisLine(): JSX.Element;
    static renderTickItem(option: Props['tick'], props: any, value: ReactNode): JSX.Element;
    renderTicks(ticks: CartesianTickItem[]): JSX.Element;
    render(): JSX.Element;
}
export {};