igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
1,665 lines (1,659 loc) • 42.6 kB
JavaScript
import { HorizontalAlignment_$type } from "igniteui-react-core";
import { VerticalAlignment_$type } from "igniteui-react-core";
import { Visibility_$type } from "igniteui-react-core";
import { YAxisLabelLocation_$type } from "./YAxisLabelLocation";
import { XAxisLabelLocation_$type } from "./XAxisLabelLocation";
import { IgrDomainChart } from "./igr-domain-chart";
import { brushToString, stringToBrush, ensureBool, ensureEnum, arrayFindByName } from "igniteui-react-core";
/**
* Represents a base class for domain charts with X/Y axes
*/
export class IgrXYChart extends IgrDomainChart {
/**
* @hidden
*/
get i() {
return this._implementation;
}
constructor(props) {
super(props);
}
/**
* Gets or sets function which takes an context object and returns a formatted label for the X-axis.
*
* To customize the text of the x-axis label, set `XAxisFormatLabel` to a single-parameter function. The argument passed to that function will be your data item.
*
* ```ts
* formatX(item: any): string {
* return "[ " + item.label + "! ]";
* }
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisFormatLabel="formatX"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisFormatLabel() {
return this.i.aa3;
}
set xAxisFormatLabel(v) {
this.i.aa3 = v;
}
/**
* Gets or sets function which takes a context object and returns a formatted label for the Y-axis.
*
* To customize the text of the y-axis label, set `YAxisFormatLabel` to a single-parameter function. The argument passed to that function will be the numeric value corresponding to a position on the y-axis.
*
* ```ts
* formatY(value: any): string {
* return "[ " + value+ "! ]";
* }
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisFormatLabel="formatY"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisFormatLabel() {
return this.i.aa4;
}
set yAxisFormatLabel(v) {
this.i.aa4 = v;
}
/**
* Gets or sets the left margin of labels on the X-axis
*
* Use the `XAxisLabelLeftMargin` property to apply a margin left of the x-axis labels.
*
* ```ts
* this.chart.xAxisLabelLeftMargin ="100";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelLeftMargin={100}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelLeftMargin() {
return this.i.aco;
}
set xAxisLabelLeftMargin(v) {
this.i.aco = +v;
}
/**
* Gets or sets the top margin of labels on the X-axis
*
* Use the `XAxisLabelTopMargin` property to apply a margin above the x-axis labels.
*
* ```ts
* this.chart.xAxisTitleTopMargin="250";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleTopMargin ={250}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelTopMargin() {
return this.i.acq;
}
set xAxisLabelTopMargin(v) {
this.i.acq = +v;
}
/**
* Gets or sets the right margin of labels on the X-axis
*
* Use the `XAxisLabelRightMargin` property to apply a margin right of the x-axis labels.
*
* ```ts
* this.chart.xAxisLabelRightMargin="100";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelRightMargin={250}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelRightMargin() {
return this.i.acp;
}
set xAxisLabelRightMargin(v) {
this.i.acp = +v;
}
/**
* Gets or sets the bottom margin of labels on the X-axis
*
* Use the `XAxisLabelBottomMargin` property to apply a margin below the x-axis labels.
*
* ```ts
* this.chart.xAxisLabelBottomMargin ="100";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelBottomMargin={100}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelBottomMargin() {
return this.i.acn;
}
set xAxisLabelBottomMargin(v) {
this.i.acn = +v;
}
/**
* Gets or sets the left margin of labels on the Y-axis
*
* Use the `YAxisLabelLeftMargin` property to apply a margin left of the y-axis labels.
*
* ```ts
* this.chart. yAxisLabelLeftMargin="250";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelLeftMargin={250}
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelLeftMargin() {
return this.i.ac7;
}
set yAxisLabelLeftMargin(v) {
this.i.ac7 = +v;
}
/**
* Gets or sets the top margin of labels on the Y-axis
*
* Use the `YAxisLabelTopMargin` property to apply a margin above the y-axis labels.
*
* ```ts
* this.chart.yAxisLabelTopMargin="250";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelTopMargin ={250}
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelTopMargin() {
return this.i.ac9;
}
set yAxisLabelTopMargin(v) {
this.i.ac9 = +v;
}
/**
* Gets or sets the right margin of labels on the Y-axis
*
* Use the `YAxisLabelRightMargin` property to apply a margin right of the y-axis labels.
*
* ```ts
* this.chart.yAxisLabelRightMargin="250";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelRightMargin={250}
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelRightMargin() {
return this.i.ac8;
}
set yAxisLabelRightMargin(v) {
this.i.ac8 = +v;
}
/**
* Gets or sets the bottom margin of labels on the Y-axis
*
* Use the `YAxisLabelBottomMargin` property to apply a margin below the y-axis labels.
*
* ```ts
* this.chart.yAxisLabelBottomMargin="250";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelBottomMargin={250}
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelBottomMargin() {
return this.i.ac6;
}
set yAxisLabelBottomMargin(v) {
this.i.ac6 = +v;
}
/**
* Gets or sets color of labels on the X-axis
*
* To change the color of x-axis labels, set the `XAxisLabelTextColor` property to a color string.
*
* ```ts
* this.chart.xAxisLabelTextColor="green";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelTextColor="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelTextColor() {
return brushToString(this.i.ahk);
}
set xAxisLabelTextColor(v) {
this.i.ahk = stringToBrush(v);
}
/**
* Gets or sets color of labels on the Y-axis
*
* To change the color of y-axis labels, set the `YAxisLabelTextColor` property to a color string.
*
* ```ts
* this.chart.yAxisLabelTextColor="green";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelTextColor="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelTextColor() {
return brushToString(this.i.ahr);
}
set yAxisLabelTextColor(v) {
this.i.ahr = stringToBrush(v);
}
/**
* Gets the actual color of labels on the X-axis
*/
get actualXAxisLabelTextColor() {
return brushToString(this.i.ahi);
}
set actualXAxisLabelTextColor(v) {
this.i.ahi = stringToBrush(v);
}
/**
* Gets the actual color of labels on the Y-axis
*/
get actualYAxisLabelTextColor() {
return brushToString(this.i.ahj);
}
set actualYAxisLabelTextColor(v) {
this.i.ahj = stringToBrush(v);
}
/**
* Gets or sets the margin around a title on the X-axis
*
* Use the `XAxisTitleMargin` property to set a margin around the y-axis title.
*/
get xAxisTitleMargin() {
return this.i.ac1;
}
set xAxisTitleMargin(v) {
this.i.ac1 = +v;
}
/**
* Gets or sets the margin around a title on the Y-axis
*
* Use the `YAxisTitleMargin` property to set a margin around the y-axis title.
*/
get yAxisTitleMargin() {
return this.i.adk;
}
set yAxisTitleMargin(v) {
this.i.adk = +v;
}
/**
* Gets or sets the left margin of a title on the X-axis
*
* Use the `XAxisTitleLeftMargin` property to apply a margin left of the x-axis title.
*
* ```ts
* this.chart.xAxisTitleLeftMargin="150";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleLeftMargin={150}
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisTitleLeftMargin() {
return this.i.ac0;
}
set xAxisTitleLeftMargin(v) {
this.i.ac0 = +v;
}
/**
* Gets or sets the left margin of a title on the Y-axis
*
* Use the `YAxisTitleLeftMargin` property to apply a margin left of the y-axis title.
*
* ```ts
* this.chart.yAxisTitleLeftMargin="150";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleLeftMargin={150}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleLeftMargin() {
return this.i.adj;
}
set yAxisTitleLeftMargin(v) {
this.i.adj = +v;
}
/**
* Gets or sets the top margin of a title on the X-axis
*
* Use the `XAxisTitleTopMargin` property to apply a margin above the x-axis title.
*
* ```ts
* this.chart.xAxisTitleTopMargin="150";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleTopMargin ={150}
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get xAxisTitleTopMargin() {
return this.i.ac3;
}
set xAxisTitleTopMargin(v) {
this.i.ac3 = +v;
}
/**
* Gets or sets the top margin of a title on the Y-axis
*
* Use the `YAxisTitleTopMargin` property to apply a margin above the y-axis title.
*
* ```ts
* this.chart.yAxisTitleTopMargin="150";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleTopMargin ={150}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleTopMargin() {
return this.i.adm;
}
set yAxisTitleTopMargin(v) {
this.i.adm = +v;
}
/**
* Gets or sets the right margin of a title on the X-axis
*
* Use the `XAxisTitleRightMargin` property to apply a margin right of the x-axis title.
*
* ```ts
* this.chart.xAxisTitleRightMargin="100";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleRightMargin="100"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisTitleRightMargin() {
return this.i.ac2;
}
set xAxisTitleRightMargin(v) {
this.i.ac2 = +v;
}
/**
* Gets or sets the right margin of a title on the Y-axis
*
* Use the `YAxisTitleRightMargin` property to apply a margin right of the y-axis title.
*
* ```ts
* this.chart.yAxisTitleRightMargin="150";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleRightMargin={150}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleRightMargin() {
return this.i.adl;
}
set yAxisTitleRightMargin(v) {
this.i.adl = +v;
}
/**
* Gets or sets the bottom margin of a title on the X-axis
*
* Use the `XAxisTitleBottomMargin` property to apply a margin below the x-axis title.
*
* ```ts
* this.chart.xAxisTitleBottomMargin="150";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleBottomMargin={250}
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisTitleBottomMargin() {
return this.i.acz;
}
set xAxisTitleBottomMargin(v) {
this.i.acz = +v;
}
/**
* Gets or sets the bottom margin of a title on the Y-axis
*
* Use the `YAxisTitleBottomMargin` property to apply a margin below the y-axis title.
*
* ```ts
* this.chart.yAxisTitleBottomMargin="150";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleBottomMargin ={150}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleBottomMargin() {
return this.i.adi;
}
set yAxisTitleBottomMargin(v) {
this.i.adi = +v;
}
/**
* Gets or sets color of title on the X-axis
*
* To change the color of the x-axis title, set the `XAxisTitleTextColor` property to a color string.
*
* ```ts
* this.chart.xAxisTitleTextColor="green";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleTextColor="green"
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get xAxisTitleTextColor() {
return brushToString(this.i.ahq);
}
set xAxisTitleTextColor(v) {
this.i.ahq = stringToBrush(v);
}
/**
* Gets or sets color of title on the Y-axis
*
* To change the color of the y-axis title, set the `YAxisTitleTextColor` property to a color string.
*
* ```ts
* this.chart.yAxisTitleTextColor="green";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleTextColor="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleTextColor() {
return brushToString(this.i.ahx);
}
set yAxisTitleTextColor(v) {
this.i.ahx = stringToBrush(v);
}
/**
* Gets or sets CSS font property for labels on X-axis
*
* To change the font of x-axis labels, set the `XAxisLabelTextStyle` property.
*
* ```ts
* this.chart.xAxisLabelTextStyle="italic 15px arial, sans-serif";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelTextStyle="italic 15px arial, sans-serif"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelTextStyle() {
return this.i.aeg;
}
set xAxisLabelTextStyle(v) {
this.i.aeg = v;
}
/**
* Gets or sets CSS font property for labels on Y-axis
*
* To change the font of x-axis labels, set the `YAxisLabelTextStyle` property.
*
* ```ts
* this.chart. yAxisLabelTextStyle="italic 15px arial, sans-serif";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelTextStyle="italic 15px arial, sans-serif"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get yAxisLabelTextStyle() {
return this.i.afn;
}
set yAxisLabelTextStyle(v) {
this.i.afn = v;
}
/**
* Gets or sets CSS font property for title on X-axis
*
* To change the font of the x-axis title, set the `XAxisTitleTextStyle` property.
*
* ```ts
* this.chart.xAxisTitleTextStyle="italic 15px arial, sans-serif";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleTextStyle="italic 15px arial, sans-serif"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisTitleTextStyle() {
return this.i.ae6;
}
set xAxisTitleTextStyle(v) {
this.i.ae6 = v;
}
/**
* Gets or sets CSS font property for title on Y-axis
*
* To change the font of the x-axis title, set the `YAxisTitleTextStyle` property.
*
* ```ts
* this.chart.yAxisTitleTextStyle="italic 15px arial, sans-serif";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleTextStyle="italic 15px arial, sans-serif"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleTextStyle() {
return this.i.agd;
}
set yAxisTitleTextStyle(v) {
this.i.agd = v;
}
/**
* Gets or sets the format for labels along the X-axis.
*/
get xAxisLabel() {
return this.i.adp;
}
set xAxisLabel(v) {
this.i.adp = v;
}
/**
* Gets or sets the property or string from which the labels are derived.
*/
get yAxisLabel() {
return this.i.adq;
}
set yAxisLabel(v) {
this.i.adq = v;
}
/**
* Gets or sets the color to apply to major gridlines along the X-axis.
*
* Set `XAxisMajorStroke` to control the color of major gridlines extending vertically from the x-axis.
*
* ```ts
* this.chart.xAxisMajorStroke="green";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisMajorStroke="green"
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get xAxisMajorStroke() {
return brushToString(this.i.ahl);
}
set xAxisMajorStroke(v) {
this.i.ahl = stringToBrush(v);
}
/**
* Gets or sets the color to apply to major gridlines along the Y-axis.
*
* Set `YAxisMajorStroke` to control the color of major gridlines extending horizontally from the y-axis.
*
* ```ts
* this.chart.yAxisMajorStroke="green";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisMajorStroke="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisMajorStroke() {
return brushToString(this.i.ahs);
}
set yAxisMajorStroke(v) {
this.i.ahs = stringToBrush(v);
}
/**
* Gets or sets the thickness to apply to major gridlines along the X-axis.
*
* Set `XAxisMajorStrokeThickness` to control the thickness of major gridlines extending vertically from the x-axis.
*
* ```ts
* this.chart.xAxisMajorStrokeThickness="3" ;
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisMajorStrokeThickness="3"
* xAxisExtent ={250}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisMajorStrokeThickness() {
return this.i.acr;
}
set xAxisMajorStrokeThickness(v) {
this.i.acr = +v;
}
/**
* Gets or sets the thickness to apply to major gridlines along the Y-axis.
*
* Set `YAxisMajorStrokeThickness` to control the thickness of major gridlines extending horizontally from the y-axis.
*
* ```ts
* this.chart.yAxisMajorStrokeThickness="2";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisMajorStrokeThickness={2}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisMajorStrokeThickness() {
return this.i.ada;
}
set yAxisMajorStrokeThickness(v) {
this.i.ada = +v;
}
/**
* Gets or sets the thickness to apply to minor gridlines along the X-axis.
*
* Set `XAxisMinorStrokeThickness` to control the thickness of minor gridlines extending vertically from the x-axis.
*
* ```ts
* this.chart.xAxisMinorStrokeThickness="3";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisMinorStrokeThickness="3"
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get xAxisMinorStrokeThickness() {
return this.i.acu;
}
set xAxisMinorStrokeThickness(v) {
this.i.acu = +v;
}
/**
* Gets or sets the thickness to apply to minor gridlines along the Y-axis.
*
* Set `YAxisMinorStrokeThickness` to control the thickness of minor gridlines extending horizontally from the y-axis.
*
* ```ts
* this.chart.yAxisMinorStrokeThickness="3";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisMinorStrokeThickness={3}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisMinorStrokeThickness() {
return this.i.add;
}
set yAxisMinorStrokeThickness(v) {
this.i.add = +v;
}
/**
* Gets or sets the color to apply to stripes along the X-axis.
*
* Set `XAxisStrip` to control the alternating color of stripes extending vertically from the x-axis.
*
* ```ts
* this.chart.xAxisStrip="green";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisStrip="green"
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get xAxisStrip() {
return brushToString(this.i.ahn);
}
set xAxisStrip(v) {
this.i.ahn = stringToBrush(v);
}
/**
* Gets or sets the color to apply to stripes along the Y-axis.
*
* Set `YAxisStrip` to control the alternating color of stripes extending horizontally from the y-axis.
*
* ```ts
* this.chart.yAxisStrip="green";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisStrip="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisStrip() {
return brushToString(this.i.ahu);
}
set yAxisStrip(v) {
this.i.ahu = stringToBrush(v);
}
/**
* Gets or sets the color to apply to the X-axis line.
*
* Set `XAxisStroke` to control the color of the x-axis line.
*
* ```ts
* this.chart.xAxisStroke="green"";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisStroke="green"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisStroke() {
return brushToString(this.i.aho);
}
set xAxisStroke(v) {
this.i.aho = stringToBrush(v);
}
/**
* Gets or sets the color to apply to the Y-axis line.
*
* Set `YAxisStroke` to control the color of the y-axis line.
*
* ```ts
* this.chart.yAxisStroke="green";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisStroke="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisStroke() {
return brushToString(this.i.ahv);
}
set yAxisStroke(v) {
this.i.ahv = stringToBrush(v);
}
/**
* Gets or sets the thickness to apply to the X-axis line.
*
* Set `XAxisStrokeThickness` to control the thickness of the x-axis line.
*
* ```ts
* this.chart.xAxisStrokeThickness="2";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisStrokeThickness={2}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisStrokeThickness() {
return this.i.acv;
}
set xAxisStrokeThickness(v) {
this.i.acv = +v;
}
/**
* Gets or sets the thickness to apply to the Y-axis line.
*
* Set `YAxisStrokeThickness` to control the thickness of the y-axis line.
*
* ```ts
* this.chart. yAxisStrokeThickness="2";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisStrokeThickness={2}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisStrokeThickness() {
return this.i.ade;
}
set yAxisStrokeThickness(v) {
this.i.ade = +v;
}
/**
* Gets or sets the length of tickmarks along the X-axis.
*
* Set `XAxisTickLength` to control the length of tickmarks extending vertically from the x-axis line.
*
* ```ts
* this.chart.xAxisTickLength="25";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTickLength ={25}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisTickLength() {
return this.i.acw;
}
set xAxisTickLength(v) {
this.i.acw = +v;
}
/**
* Gets or sets the length of tickmarks along the Y-axis.
*
* Set `YAxisTickLength` to control the length of tickmarks extending horizontally from the y-axis line.
*
* ```ts
* this.chart.yAxisTickLength="25";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTickLength ={25}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTickLength() {
return this.i.adf;
}
set yAxisTickLength(v) {
this.i.adf = +v;
}
/**
* Gets or sets the color to apply to tickmarks along the X-axis.
*
* Set `XAxisTickStroke` to control the color of tickmarks extending vertically from the x-axis line.
*
* ```ts
* this.chart. xAxisTickStroke="green";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTickStroke="green"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisTickStroke() {
return brushToString(this.i.ahp);
}
set xAxisTickStroke(v) {
this.i.ahp = stringToBrush(v);
}
/**
* Gets or sets the color to apply to tickmarks along the Y-axis.
*
* Set `YAxisTickStroke` to control the color of tickmarks extending horizontally from the y-axis line.
*
* ```ts
* this.chart.yAxisTickStroke="green";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTickStroke="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTickStroke() {
return brushToString(this.i.ahw);
}
set yAxisTickStroke(v) {
this.i.ahw = stringToBrush(v);
}
/**
* Gets or sets the thickness to apply to tickmarks along the X-axis.
*
* Set `XAxisTickStrokeThickness` to control the thickness of tickmarks extending vertically from the x-axis line.
*
* ```ts
* this.chart.xAxisTickStrokeThickness="20";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTickStrokeThickness={20}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisTickStrokeThickness() {
return this.i.acx;
}
set xAxisTickStrokeThickness(v) {
this.i.acx = +v;
}
/**
* Gets or sets the thickness to apply to tickmarks along the Y-axis.
*
* Set `YAxisTickStrokeThickness` to control the thickness of tickmarks extending vertically from the y-axis line.
*
* ```ts
* this.chart.yAxisTickStrokeThickness="25";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTickStrokeThickness ={25}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTickStrokeThickness() {
return this.i.adg;
}
set yAxisTickStrokeThickness(v) {
this.i.adg = +v;
}
/**
* Gets or sets the Text to display below the X-axis.
*
* Set `XAxisTitle` to display a label adjacent to the x-axis.
*
* ```ts
* this.chart. xAxisTitle="x axis";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitle="x axis"
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get xAxisTitle() {
return this.i.aex;
}
set xAxisTitle(v) {
this.i.aex = v;
}
/**
* Gets or sets the Text to display to the left of the Y-axis.
*
* Set `YAxisTitle` to display a label adjacent to the y-axis.
*
* ```ts
* this.chart.yAxisTitle="y axis";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitle="y axis"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitle() {
return this.i.af4;
}
set yAxisTitle(v) {
this.i.af4 = v;
}
/**
* Gets or sets the color to apply to minor gridlines along the X-axis.
*
* Set `XAxisMinorStroke` to control the color of minor gridlines extending vertically from the x-axis.
*
* ```ts
* this.chart.xAxisExtent="250";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisMinorStroke="green"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisMinorStroke() {
return brushToString(this.i.ahm);
}
set xAxisMinorStroke(v) {
this.i.ahm = stringToBrush(v);
}
/**
* Gets or sets the color to apply to minor gridlines along the Y-axis.
*
* Set `YAxisMinorStroke` to control the color of minor gridlines extending horizontally from the y-axis.
*
* ```ts
* this.chart.yAxisMinorStroke="green";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisMinorStroke="green"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisMinorStroke() {
return brushToString(this.i.aht);
}
set yAxisMinorStroke(v) {
this.i.aht = stringToBrush(v);
}
/**
* Gets or sets the angle of rotation for labels along the X-axis.
*
* To control the rotation of labels on the x-axis, set the `XAxisLabelAngle` property to a number of rotational degrees.
*
* ```ts
* this.chart.xAxisLabelAngle="45";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelAngle={45}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelAngle() {
return this.i.acm;
}
set xAxisLabelAngle(v) {
this.i.acm = +v;
}
/**
* Gets or sets the angle of rotation for labels along the Y-axis.
*
* To control the rotation of labels on the y-axis, set the `YAxisLabelAngle` property to a number of rotational degrees.
*
* ```ts
* this.chart.yAxisLabelAngle="25";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelAngle ={25}
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelAngle() {
return this.i.ac5;
}
set yAxisLabelAngle(v) {
this.i.ac5 = +v;
}
/**
* Gets or sets the distance between the X-axis and the bottom of the chart.
*
* To allocate space between the x-axis and the edge of the chart, set the `XAxisExtent` property.
*
* ```ts
* this.chart.xAxisExtent="250";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisExtent ={250}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisExtent() {
return this.i.acl;
}
set xAxisExtent(v) {
this.i.acl = +v;
}
/**
* Gets or sets the distance between the Y-axis and the left edge of the chart.
*
* To allocate space between the x-axis and the edge of the chart, set the `XAxisExtent` property.
*
* ```ts
* this.chart.xAxisExtent="250";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisExtent ={250}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisExtent() {
return this.i.ac4;
}
set yAxisExtent(v) {
this.i.ac4 = +v;
}
/**
* Gets or sets the distance between the X-axis and the bottom of the chart.
*/
get xAxisMaximumExtent() {
return this.i.acs;
}
set xAxisMaximumExtent(v) {
this.i.acs = +v;
}
/**
* Gets or sets the distance between the Y-axis and the left edge of the chart.
*/
get yAxisMaximumExtent() {
return this.i.adb;
}
set yAxisMaximumExtent(v) {
this.i.adb = +v;
}
/**
* Gets or sets the distance between the X-axis and the bottom of the chart.
*/
get xAxisMaximumExtentPercentage() {
return this.i.act;
}
set xAxisMaximumExtentPercentage(v) {
this.i.act = +v;
}
/**
* Gets or sets the distance between the Y-axis and the left edge of the chart.
*/
get yAxisMaximumExtentPercentage() {
return this.i.adc;
}
set yAxisMaximumExtentPercentage(v) {
this.i.adc = +v;
}
/**
* Gets or sets the angle of rotation for the X-axis title.
*
* Set `XAxisTitleAngle` to control the rotation of the x-axis title.
*
* ```ts
* this.chart.xAxisTitleAngle="50";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleAngle ={50}
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisTitleAngle() {
return this.i.acy;
}
set xAxisTitleAngle(v) {
this.i.acy = +v;
}
/**
* Gets or sets the angle of rotation for the Y-axis title.
*
* Set `YAxisTitleAngle` to control the rotation of the y-axis title.
*
* ```ts
* this.chart.yAxisTitleAngle="25";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleAngle ={24}
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleAngle() {
return this.i.adh;
}
set yAxisTitleAngle(v) {
this.i.adh = +v;
}
/**
* Gets or sets whether to invert the direction of the X-axis by placing the first data items on the right side of the chart.
*
* To reverse the direction of items along the x-axis, set the `XAxisInverted` property to true.
*
* ```ts
* this.chart.XAxisInverted="True";
* ```
*
* ```ts
* <IgrCategoryChart
* XAxisInverted="True"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisInverted() {
return this.i.abd;
}
set xAxisInverted(v) {
this.i.abd = ensureBool(v);
}
/**
* Gets or sets whether to invert the direction of the Y-axis by placing the minimum numeric value at the top of the chart.
*
* You can use `YAxisInverted` to invert the scale of the y axis like this:
*
* ```ts
* this.chart.yAxisInverted="true";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisInverted="true"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*
* The default value of `YAxisInverted` is false.
*/
get yAxisInverted() {
return this.i.abe;
}
set yAxisInverted(v) {
this.i.abe = ensureBool(v);
}
/**
* Gets or sets Horizontal alignment of the X-axis title.
*
* Set `XAxisTitleAlignment` to control the horizontal alignment of the x-axis title.
*
* ```ts
* this.chart.xAxisTitleAlignment="right";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisTitleAlignment="right"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisTitleAlignment() {
return this.i.ag0;
}
set xAxisTitleAlignment(v) {
this.i.ag0 = ensureEnum(HorizontalAlignment_$type, v);
}
/**
* Gets or sets Vertical alignment of the Y-axis title.
*
* Set `YAxisTitleAlignment` to control the vertical alignment of the x-axis title.
*
* ```ts
* this.chart.yAxisTitleAlignment="bottom";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisTitleAlignment="bottom"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisTitleAlignment() {
return this.i.ah3;
}
set yAxisTitleAlignment(v) {
this.i.ah3 = ensureEnum(VerticalAlignment_$type, v);
}
/**
* Gets or sets Horizontal alignment of X-axis labels.
*/
get xAxisLabelHorizontalAlignment() {
return this.i.agz;
}
set xAxisLabelHorizontalAlignment(v) {
this.i.agz = ensureEnum(HorizontalAlignment_$type, v);
}
/**
* Gets or sets Horizontal alignment of Y-axis labels.
*
* Set the `YAxisLabelHorizontalAlignment` property to change the horizontal alignment of y-axis labels.
*/
get yAxisLabelHorizontalAlignment() {
return this.i.ag1;
}
set yAxisLabelHorizontalAlignment(v) {
this.i.ag1 = ensureEnum(HorizontalAlignment_$type, v);
}
/**
* Gets or sets Vertical alignment of X-axis labels.
*
* Use the `XAxisLabelVerticalAlignment` property to change the vertical position of x-axis labels.
*
* ```ts
* this.chart.xAxisLabelVerticalAlignment="bottom";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelVerticalAlignment="bottom"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get xAxisLabelVerticalAlignment() {
return this.i.ah1;
}
set xAxisLabelVerticalAlignment(v) {
this.i.ah1 = ensureEnum(VerticalAlignment_$type, v);
}
/**
* Gets or sets Vertical alignment of Y-axis labels.
*/
get yAxisLabelVerticalAlignment() {
return this.i.ah2;
}
set yAxisLabelVerticalAlignment(v) {
this.i.ah2 = ensureEnum(VerticalAlignment_$type, v);
}
/**
* Gets or sets Visibility of X-axis labels.
*
* To hide the x-axis labels, set `XAxisLabelVisibility` to collapsed.
*
* ```ts
* this.chart.xAxisLabelVisibility="collapsed";
* ```
*
* ```ts
* <IgrCategoryChart
* xAxisLabelVisibility="collapsed"
* dataSource={this.state.data}>
* </IgrCategoryChart>
* ```
*/
get xAxisLabelVisibility() {
return this.i.ah6;
}
set xAxisLabelVisibility(v) {
this.i.ah6 = ensureEnum(Visibility_$type, v);
}
/**
* Gets or sets Visibility of Y-axis labels.
*
* To hide the y-axis labels, set `YAxisLabelVisibility` to collapsed.
*
* ```ts
* this.chart.yAxisLabelVisibility="collapsed"";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelVisibility="collapsed"
* dataSource={this.state.data}
* chartType="stepArea" >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelVisibility() {
return this.i.ah7;
}
set yAxisLabelVisibility(v) {
this.i.ah7 = ensureEnum(Visibility_$type, v);
}
/**
* Gets or sets location of Y-axis labels, relative to the plot area.
*
* Set the `YAxisLabelLocation` property to change the location of the y-axis and its labels.
*
* ```ts
* this.chart.yAxisLabelLocation="outsideRight";
* ```
*
* ```ts
* <IgrCategoryChart
* yAxisLabelLocation="outsideRight"
* dataSource={this.state.data} >
* </IgrCategoryChart>
* ```
*/
get yAxisLabelLocation() {
return this.i.aba;
}
set yAxisLabelLocation(v) {
this.i.aba = ensureEnum(YAxisLabelLocation_$type, v);
}
/**
* Gets or sets location of X-axis labels, relative to the plot area.
*/
get xAxisLabelLocation() {
return this.i.aa8;
}
set xAxisLabelLocation(v) {
this.i.aa8 = ensureEnum(XAxisLabelLocation_$type, v);
}
/**
* Gets or sets the format string for the X axis label.
*/
get xAxisLabelFormat() {
return this.i.ad7;
}
set xAxisLabelFormat(v) {
this.i.ad7 = v;
}
/**
* Gets or sets the format specifiers to use with the XAxisLabelFormat string.
*/
get xAxisLabelFormatSpecifiers() {
return this.i.aax;
}
set xAxisLabelFormatSpecifiers(v) {
if (v && !Array.isArray(v) && typeof (v) == "string") {
const re = /\s*(?:,|\s|$)\s*/gm;
v = v.split(re);
}
this.i.aax = v;
}
/**
* Gets or sets the format string for the Y axis label.
*/
get yAxisLabelFormat() {
return this.i.afe;
}
set yAxisLabelFormat(v) {
this.i.afe = v;
}
/**
* Gets or sets the format specifiers to use with the YAxisLabelFormat string.
*/
get yAxisLabelFormatSpecifiers() {
return this.i.aay;
}
set yAxisLabelFormatSpecifiers(v) {
if (v && !Array.isArray(v) && typeof (v) == "string") {
const re = /\s*(?:,|\s|$)\s*/gm;
v = v.split(re);
}
this.i.aay = v;
}
findByName(name) {
var baseResult = super.findByName(name);
if (baseResult) {
return baseResult;
}
if (this.xAxisLabelFormatSpecifiers != null && arrayFindByName(this.xAxisLabelFormatSpecifiers, name)) {
return arrayFindByName(this.xAxisLabelFormatSpecifiers, name);
}
if (this.yAxisLabelFormatSpecifiers != null && arrayFindByName(this.yAxisLabelFormatSpecifiers, name)) {
return arrayFindByName(this.yAxisLabelFormatSpecifiers, name);
}
return null;
}
/**
* Called by the UI framework to provide a UI container for rendering this control.
* @param container * The UI container element.
*/
provideContainer(container) {
this.i.provideContainer(container);
}
/**
* Converts the given visual location to a data value.
* @param unscaledValue * The x-coordinate of the location to scale.
*/
getScaledValueX(unscaledValue) {
let iv = this.i.ach(unscaledValue);
return (iv);
}
/**
* Converts the given data value to a visual location.
* @param scaledValue * The data value to un-scale.
*/
getUnscaledValueX(scaledValue) {
let iv = this.i.acj(scaledValue);
return (iv);
}
/**
* Converts the given visual location to a data value.
* @param unscaledValue * The y-coordinate of the location to scale.
*/
getScaledValueY(unscaledValue) {
let iv = this.i.aci(unscaledValue);
return (iv);
}
/**
* Converts the given data value to a visual location.
* @param scaledValue * The data value to un-scale.
*/
getUnscaledValueY(scaledValue) {
let iv = this.i.ack(scaledValue);
return (iv);
}
}