igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
75 lines (72 loc) • 2.56 kB
TypeScript
import { IgrNumericAxisBase, IIgrNumericAxisBaseProps } from "./igr-numeric-axis-base";
import { NumericRadiusAxis } from "./NumericRadiusAxis";
/**
* Represents a IgxDataChartComponent radius axis for polar and radial series.
*
* ```ts
* <IgrDataChart
* dataSource={this.state.dataSource} >
*
* <IgrCategoryAngleAxis name="angleAxis" label="Department" />
* <IgrNumericRadiusAxis name="radiusAxis" />
*
* </IgrDataChart>
* ```
*
* ```ts
* this.series1.angleAxisName = "AngleAxis";
* this.series1.valueAxisName = "numericYAxis";
* ```
*/
export declare class IgrNumericRadiusAxis extends IgrNumericAxisBase<IIgrNumericRadiusAxisProps> {
protected createImplementation(): NumericRadiusAxis;
/**
* @hidden
*/
get i(): NumericRadiusAxis;
constructor(props: IIgrNumericRadiusAxisProps);
/**
* Checks if the axis is of radial axis type
*
* ```ts
* let isRadial: boolean = this.series.isRadial;
* ```
*/
get isRadial(): boolean;
/**
* Defines the percentage of the maximum radius extent to use as the maximum radius. Should be
* a value between 0.0 and 1.0.
*/
get radiusExtentScale(): number;
set radiusExtentScale(v: number);
/**
* Defines the percentage of the maximum radius extent to leave blank at the center of the chart. Should be
* a value between 0.0 and 1.0.
*/
get innerRadiusExtentScale(): number;
set innerRadiusExtentScale(v: number);
/**
* Returns a world coordinates radius length (0 - 0.5) from a raw axis value.
* @param unscaledValue * The raw axis value.
*/
getScaledValue(unscaledValue: number): number;
/**
* Returns a raw axis value from the world coordinates radius length provided.
* @param scaledValue * The scaled world coordinates radius length.
*
* Class containing several properties which are used as parameters passed to scaling operations in a `SeriesViewer`.
*/
getUnscaledValue(scaledValue: number): number;
}
export interface IIgrNumericRadiusAxisProps extends IIgrNumericAxisBaseProps {
/**
* Defines the percentage of the maximum radius extent to use as the maximum radius. Should be
* a value between 0.0 and 1.0.
*/
radiusExtentScale?: number | string;
/**
* Defines the percentage of the maximum radius extent to leave blank at the center of the chart. Should be
* a value between 0.0 and 1.0.
*/
innerRadiusExtentScale?: number | string;
}