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

Data Visualization using React

import { FC } from 'react';
import { ChartInternalShallowDataShape, Direction } from '../../common';
export interface BarTargetMarkerProps {
    /**
     * 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;
    /**
     * Parsed data shape. Set internally by `BarChart`.
     */
    data: ChartInternalShallowDataShape;
    /**
     * Color of the target marker line.
     *
     * @default '#fff'
     */
    fill: string;
    /**
     * Color of the positive delta line.
     *
     * @default '#00C49F'
     */
    positiveDeltaFill: string;
    /**
     * Color of the negative delta line.
     *
     * @default '#FF7361'
     */
    negativeDeltaFill: 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;
    /**
     * Class name to apply to the text.
     */
    className?: string;
    /**
     * Thickness of the target marker line.
     *
     * @default 2
     */
    targetStrokeWidth?: number;
    /**
     * Thickness of the difference/delta line that shows distance between target and actual value.
     *
     * @default 1
     */
    deltaStrokeWidth?: number;
}
export declare const BarTargetMarker: FC<Partial<BarTargetMarkerProps>>;
export declare const BAR_TARGET_MARKER_DEFAULT_PROPS: Partial<BarTargetMarkerProps>;