igniteui-react-charts/lib/igr-range-bar-series.d.ts

Ignite UI React charting components for building rich data visualizations using TypeScript APIs.

import { IgRect } from "igniteui-react-core";
import { IgPoint } from "igniteui-react-core";
import { IgrVerticalRangeCategorySeries, IIgrVerticalRangeCategorySeriesProps } from "./igr-vertical-range-category-series";
import { RangeBarSeries } from "./RangeBarSeries";
/**
 * Represents a IgxDataChartComponent range bar series.
*/
export declare class IgrRangeBarSeries extends IgrVerticalRangeCategorySeries<IIgrRangeBarSeriesProps> {
    protected createImplementation(): RangeBarSeries;
    /**
                                 * @hidden
                                 */
    get i(): RangeBarSeries;
    constructor(props: IIgrRangeBarSeriesProps);
    /**
     * Gets whether the current series shows a bar shape.
    */
    get isBar(): boolean;
    /**
     * Overridden by derived series classes to indicate when marker-less display is preferred or not.
    */
    get isMarkerlessDisplayPreferred(): boolean;
    /**
     * Gets or sets the x-radius of the ellipse that is used to round the corners of the bar.
    */
    get radiusX(): number;
    set radiusX(v: number);
    /**
     * Gets or sets the y-radius of the ellipse that is used to round the corners of the bar.
    */
    get radiusY(): number;
    set radiusY(v: number);
    /**
     * If possible, will return the best available value bounding box within the series that has the best value match for the world position provided.
    
    * @param world  * The world coordinate for which to get a value bounding box for
    */
    getSeriesValueBoundingBox(world: IgPoint): IgRect;
    /**
     * For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.
    
    */
    getItemSpan(): number;
}
export interface IIgrRangeBarSeriesProps extends IIgrVerticalRangeCategorySeriesProps {
    /**
     * Gets or sets the x-radius of the ellipse that is used to round the corners of the bar.
    */
    radiusX?: number | string;
    /**
     * Gets or sets the y-radius of the ellipse that is used to round the corners of the bar.
    */
    radiusY?: number | string;
}