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

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

import { IgPoint } from "igniteui-react-core";
import { IgrNumericXAxis } from "./igr-numeric-x-axis";
import { IgrCategoryAxisBase } from "./igr-category-axis-base";
import { IgrRangeCategorySeries, IIgrRangeCategorySeriesProps } from "./igr-range-category-series";
import { VerticalRangeCategorySeries } from "./VerticalRangeCategorySeries";
import { IgrAxis } from "./igr-axis";
/**
 * Base class for ranged category series with a numeric X-axis and a category Y-axis.
*/
export declare abstract class IgrVerticalRangeCategorySeries<P extends IIgrVerticalRangeCategorySeriesProps = IIgrVerticalRangeCategorySeriesProps> extends IgrRangeCategorySeries<P> {
    /**
                                 * @hidden
                                 */
    get i(): VerticalRangeCategorySeries;
    constructor(props: P);
    /**
     * Gets or sets the effective x-axis for the current CategorySeries object.
    */
    get xAxis(): IgrNumericXAxis;
    set xAxis(v: IgrNumericXAxis);
    private _xAxisName;
    /**
    * Gets or sets the name to use to resolve xAxis from markup.
    */
    get xAxisName(): string;
    set xAxisName(v: string);
    /**
     * Gets or sets the effective y-axis for the current CategorySeries object.
    */
    get yAxis(): IgrCategoryAxisBase;
    set yAxis(v: IgrCategoryAxisBase);
    private _yAxisName;
    /**
    * Gets or sets the name to use to resolve yAxis from markup.
    */
    get yAxisName(): string;
    set yAxisName(v: string);
    /**
     * Gets whether or not the current series is vertical series
    */
    get isVertical(): boolean;
    /**
     * Checks if this series is a range series
    */
    get isRange(): boolean;
    /**
     * Gets or sets the label displayed before series' Low value in the Data Legend.
    */
    get lowMemberAsLegendLabel(): string;
    set lowMemberAsLegendLabel(v: string);
    /**
     * Gets or sets the label displayed before series' High value in the Data Legend.
    */
    get highMemberAsLegendLabel(): string;
    set highMemberAsLegendLabel(v: string);
    /**
     * Gets or sets the unit displayed after series' Low value in the Data Legend.
    */
    get lowMemberAsLegendUnit(): string;
    set lowMemberAsLegendUnit(v: string);
    /**
     * Gets or sets the unit displayed after series' High value in the Data Legend.
    */
    get highMemberAsLegendUnit(): string;
    set highMemberAsLegendUnit(v: string);
    bindAxes(axes: IgrAxis[]): void;
    findByName(name: string): any;
    protected _styling(container: any, component: any, parent?: any): void;
    /**
     * Returns the offset value for this series if grouped on a category axis.
    
    */
    getOffsetValue(): number;
    /**
     * Returns the width of the category grouping this series is in.
    
    */
    getCategoryWidth(): number;
    /**
     * Gets the precise item index using the vertical (Y-based) category axis.
     * The base implementation uses the horizontal interaction manager which reads world.X;
     * vertical series must read world.Y instead.
    
    */
    getExactItemIndex(world: IgPoint): number;
    /**
     * Gets the index of the item that resides at the provided world coordinates (vertical orientation).
    
    */
    getItemIndex(world: IgPoint): number;
    /**
     * Gets the item that is the best match for the specified world coordinates (vertical orientation).
    
    */
    getItem(world: IgPoint): any;
    getNextOrExactIndex(world: IgPoint, skipUnknowns: boolean): number;
    getPreviousOrExactIndex(world: IgPoint, skipUnknowns: boolean): number;
    getSeriesValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number;
    getSeriesLowValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number;
    getSeriesHighValue(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): number;
    getSeriesHighValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint;
    getSeriesLowValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint;
    getSeriesValuePosition(world: IgPoint, useInterpolation: boolean, skipUnknowns: boolean): IgPoint;
    /**
     * Determine if object can be used as YAxis
    
    * @param axis  * The object to check
    */
    canUseAsYAxis(axis: any): boolean;
    /**
     * Determine if object can be used as XAxis
    
    * @param axis  * The object to check
    */
    canUseAsXAxis(axis: any): boolean;
}
export interface IIgrVerticalRangeCategorySeriesProps extends IIgrRangeCategorySeriesProps {
    /**
     * Gets or sets the effective x-axis for the current CategorySeries object.
    */
    xAxis?: IgrNumericXAxis;
    /**
    * Gets or sets the name to use to resolve xAxis from markup.
    */
    xAxisName?: string;
    /**
     * Gets or sets the effective y-axis for the current CategorySeries object.
    */
    yAxis?: IgrCategoryAxisBase;
    /**
    * Gets or sets the name to use to resolve yAxis from markup.
    */
    yAxisName?: string;
    /**
     * Gets or sets the label displayed before series' Low value in the Data Legend.
    */
    lowMemberAsLegendLabel?: string;
    /**
     * Gets or sets the label displayed before series' High value in the Data Legend.
    */
    highMemberAsLegendLabel?: string;
    /**
     * Gets or sets the unit displayed after series' Low value in the Data Legend.
    */
    lowMemberAsLegendUnit?: string;
    /**
     * Gets or sets the unit displayed after series' High value in the Data Legend.
    */
    highMemberAsLegendUnit?: string;
}