reaviz/dist/common/Axis/LinearAxis/LinearAxis.d.ts

Data Visualization using React

import { FC, ReactElement } from 'react';
import { ChartDataTypes } from '../../data';
import { LinearAxisLine, LinearAxisLineProps } from './LinearAxisLine';
import { LinearAxisTickSeries, LinearAxisTickSeriesProps } from './LinearAxisTickSeries';
export interface LinearAxisDimensionChanged {
    height?: number;
    width?: number;
}
export interface LinearAxisProps {
    /**
     * Height of the axis. Set internally by the parent chart.
     */
    height?: number;
    /**
     * Width of the axis. Set internally by the parent chart.
     */
    width?: number;
    /**
     * Explicit domain to use for the axis.
     */
    domain?: ChartDataTypes[];
    /**
     * Whether the axis is already scaled.
     *
     * @default false
     */
    scaled?: boolean;
    /**
     * Whether to round the domain values.
     *
     * @default false
     */
    roundDomains?: boolean;
    /**
     * Type of the axis.
     */
    type?: 'value' | 'time' | 'category' | 'duration';
    /**
     * Position of the axis relative to the chart area.
     */
    position?: 'start' | 'end' | 'center';
    /**
     * The tick series component for the axis.
     */
    tickSeries?: ReactElement<LinearAxisTickSeriesProps, typeof LinearAxisTickSeries>;
    /**
     * The axis line component.
     *
     * @default `<LinearAxisLine />`
     */
    axisLine?: ReactElement<LinearAxisLineProps, typeof LinearAxisLine> | null;
    /**
     * D3 scale for the axis. Set internally by the parent chart.
     */
    scale?: any;
    /**
     * Visibility of the axis.
     *
     * @default 'visible'
     */
    visibility?: 'visible' | 'hidden';
    /**
     * Orientation of the axis.
     */
    orientation?: 'horizontal' | 'vertical';
    /**
     * Fires when the axis dimensions change.
     */
    onDimensionsChange?: (event: LinearAxisDimensionChanged) => void;
}
export declare const LinearAxis: FC<Partial<LinearAxisProps>>;
export declare const LINEAR_AXIS_DEFAULT_PROPS: {
    scaled: boolean;
    roundDomains: boolean;
    axisLine: import("react/jsx-runtime").JSX.Element;
    onDimensionsChange: () => any;
};