igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
154 lines (151 loc) • 5.05 kB
TypeScript
import { IgRect } from "igniteui-angular-core";
import { IgPoint } from "igniteui-angular-core";
import { IgxHorizontalRangeCategorySeriesComponent } from "./igx-horizontal-range-category-series-component";
import { RangeColumnSeries } from "./RangeColumnSeries";
import * as i0 from "@angular/core";
/**
* Represents a IgxDataChartComponent range column series.
*
* The `RangeColumnSeries` class represents range column series of the IgxDataChartComponent.
*
* ```html
* <igx-data-chart #chart
* [dataSource]="data">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* minimumValue="0"
* #yAxis>
* </igx-numeric-y-axis>
* <igx-range-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* highMemberPath="high"
* lowMemberPath="low">
* </igx-range-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* let series = new IgxRangeColumnSeriesComponent();
* series.xAxis = this.xAxis;
* series.yAxis = this.yAxis;
* series.highMemberPath = "high";
* series.lowMemberPath = "low";
* this.chart.series.add(series);
* ```
*/
export declare class IgxRangeColumnSeriesComponent extends IgxHorizontalRangeCategorySeriesComponent {
protected createImplementation(): RangeColumnSeries;
/**
* @hidden
*/
get i(): RangeColumnSeries;
constructor();
/**
* Gets whether the current series shows a column shape.
*/
get isColumn(): boolean;
static ngAcceptInputType_isColumn: boolean | string;
/**
* Overridden by derived series classes to indicate when marker-less display is preferred or not.
*/
get isMarkerlessDisplayPreferred(): boolean;
static ngAcceptInputType_isMarkerlessDisplayPreferred: boolean | string;
/**
* Gets or sets the x-radius of the ellipse that is used to round the corners of the column.
*
* Use the `RadiusX` property to round the corners of the column.
*
* ```html
* <igx-data-chart #chart
* [dataSource]="data"
* >
* <igx-category-x-axis
* label="label"
* #xAxis
* >
* </igx-category-x-axis>
* <igx-numeric-y-axis
* minimumValue="0"
* #yAxis>
* </igx-numeric-y-axis>
* <igx-range-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* highMemberPath="high"
* lowMemberPath="low"
* radiusX="10">
* </igx-range-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* series.radiusX=10;
* ```
*/
get radiusX(): number;
set radiusX(v: number);
static ngAcceptInputType_radiusX: number | string;
/**
* Gets or sets the y-radius of the ellipse that is used to round the corners of the column.
*
* Use the `RadiusY` property for the y-radius of the ellipse that is used to round the corners of the column.
*
* ```html
* <igx-data-chart #chart
* [dataSource]="data"
* >
* <igx-category-x-axis
* label="label"
* #xAxis
* >
* </igx-category-x-axis>
* <igx-numeric-y-axis
* minimumValue="0"
* #yAxis>
* </igx-numeric-y-axis>
* <igx-range-column-series
*
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* highMemberPath="high"
* lowMemberPath="low"
* radiusY= "10">
* </igx-range-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* series.radiusY=10;
* ```
*/
get radiusY(): number;
set radiusY(v: number);
static ngAcceptInputType_radiusY: number | string;
/**
* 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
*
* The `GetSeriesValueBoundingBox` method return the best available value of the bounding box within the series.
*
* ```ts
* series.getSeriesValueBoundingBox(world :IgxPoint) : IgxRect
* ```
*/
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.
*
* The `GetItemSpan` method returns the current width of the items within the categories.
*
* ```ts
* var x =series.getItemSpan();
* ```
*/
getItemSpan(): number;
static ɵfac: i0.ɵɵFactoryDeclaration<IgxRangeColumnSeriesComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgxRangeColumnSeriesComponent, "igx-range-column-series", never, { "radiusX": "radiusX"; "radiusY": "radiusY"; }, {}, never, never>;
}