reaviz/dist/BarChart/BarSeries/BarLabel.d.ts

Data Visualization using React

import { FC } from 'react';
import { ChartInternalShallowDataShape, Direction } from '../../common/data';
import { BarType } from './Bar';
export interface BarLabelProps {
    /**
     * Text of the label. Set internally by `Bar`.
     */
    text: string;
    /**
     * Height of the bar.
     */
    height: number;
    /**
     * Width of the bar.
     */
    width: number;
    /**
     * SVG x attribute for the bar.
     */
    x: number;
    /**
     * SVG y attribute for the bar.
     */
    y: number;
    /**
     * Group index or index of the bar. Set internally by `BarSeries`.
     */
    index: number;
    /**
     * D3 scale for Axis. Set internally by `BarChart`.
     */
    scale: any;
    /**
     * Position of the label.
     *
     * @default 'top'
     */
    position: 'top' | 'center' | 'bottom';
    /**
     * Parsed data shape. Set internally by `BarChart`.
     */
    data: ChartInternalShallowDataShape;
    /**
     * Color of the text.
     *
     * @default '#000'
     */
    fill: string;
    /**
     * Number of the bars in the bar group. Set internally by `BarSeries`.
     */
    barCount: number;
    /**
     * Layout of bar chart to render. Set internally by `BarSeries`.
     *
     * @default 'vertical'
     */
    layout: Direction;
    /**
     * Whether to animate the enter/update/exit. Set internally by `BarSeries`.
     */
    animated: boolean;
    /**
     * Type of bar chart to render. Set internally by `BarSeries`.
     */
    type: BarType;
    /**
     * Font size of the text.
     *
     * @default 13
     */
    fontSize: number;
    /**
     * Font family of the text.
     *
     * @default 'sans-serif'
     */
    fontFamily: string;
    /**
     * Padding of the label.
     *
     * @default 5
     */
    padding: number;
    /**
     * Class name to apply to the text.
     */
    className?: any;
}
export declare const BarLabel: FC<Partial<BarLabelProps>>;
export declare const BAR_LABEL_DEFAULT_PROPS: Partial<BarLabelProps>;