igniteui-react-charts
Version:
Ignite UI React charting components for building rich data visualizations using TypeScript APIs.
1,265 lines • 154 kB
TypeScript
import * as React from 'react';
import { IgRect } from "igniteui-react-core";
import { HorizontalAlignment } from "igniteui-react-core";
import { UnknownValuePlotting } from "igniteui-react-core";
import { TrendLineType } from "igniteui-react-core";
import { IgrChartSeriesEventArgs } from './igr-chart-series-event-args';
import { DomainChart } from "./DomainChart";
import { IgrDomainChartSeriesPointerEventArgs } from './igr-domain-chart-series-pointer-event-args';
import { IgrMarkerTypeCollection } from './igr-marker-type-collection';
import { ToolTipType } from "./ToolTipType";
import { CrosshairsDisplayMode } from "./CrosshairsDisplayMode";
import { IgrCalloutStyleUpdatingEventArgs } from "./igr-callout-style-updating-event-args";
import { IChartTooltipProps } from "igniteui-react-core";
import { ComputedPlotAreaMarginMode } from './ComputedPlotAreaMarginMode';
import { SeriesHighlightingMode } from './SeriesHighlightingMode';
import { SeriesHighlightingBehavior } from './SeriesHighlightingBehavior';
import { LegendHighlightingMode } from './LegendHighlightingMode';
import { SeriesOutlineMode } from './SeriesOutlineMode';
import { MarkerOutlineMode } from './MarkerOutlineMode';
import { MarkerFillMode } from './MarkerFillMode';
import { MarkerAutomaticBehavior } from './MarkerAutomaticBehavior';
import { LegendItemBadgeMode } from "igniteui-react-core";
import { LegendItemBadgeShape } from "igniteui-react-core";
import { DomainType } from "./DomainType";
import { DataAbbreviationMode } from "igniteui-react-core";
import { DataLegendValueMode } from "igniteui-react-core";
import { DataLegendHeaderDateMode } from "igniteui-react-core";
import { DataLegendHeaderTimeMode } from "igniteui-react-core";
import { DataLegendUnitsMode } from "igniteui-react-core";
import { DataLegendLabelMode } from "igniteui-react-core";
import { DataLegendSummaryType } from "igniteui-react-core";
import { SeriesPlotAreaMarginHorizontalMode } from './SeriesPlotAreaMarginHorizontalMode';
import { SeriesPlotAreaMarginVerticalMode } from './SeriesPlotAreaMarginVerticalMode';
import { IgrCalloutPlacementPositionsCollection } from './igr-callout-placement-positions-collection';
import { SeriesViewerScrollbarMode } from './SeriesViewerScrollbarMode';
import { SeriesViewerHorizontalScrollbarPosition } from './SeriesViewerHorizontalScrollbarPosition';
import { SeriesViewerVerticalScrollbarPosition } from './SeriesViewerVerticalScrollbarPosition';
import { IgrCalloutRenderStyleUpdatingEventArgs } from './igr-callout-render-style-updating-event-args';
import { DataToolTipLayerGroupingMode } from "igniteui-react-core";
import { DataTooltipGroupedPositionX } from "igniteui-react-core";
import { DataTooltipGroupedPositionY } from "igniteui-react-core";
import { IgrChartSummaryDescriptionCollection } from './igr-chart-summary-description-collection';
import { IgrChartSortDescriptionCollection } from './igr-chart-sort-description-collection';
import { IgrFilterExpressionCollection } from "igniteui-react-core";
import { ICommandAvailabilityListener } from "igniteui-react-core";
import { ICommandStateChangedListener } from "igniteui-react-core";
import { IgrValueModeCollection } from './igr-value-mode-collection';
import { ToolActionInfo } from "igniteui-react-core";
import { IgrFilterStringErrorsParsingEventArgs } from './igr-filter-string-errors-parsing-event-args';
import { SeriesHighlightedValuesDisplayMode } from "igniteui-react-core";
import { SeriesSelectionMode } from './SeriesSelectionMode';
import { SeriesSelectionBehavior } from './SeriesSelectionBehavior';
import { IgrSeriesViewerSelectedSeriesItemsChangedEventArgs } from "./igr-series-viewer-selected-series-items-changed-event-args";
import { IgrChartSelectedItemCollection } from "./igr-chart-selected-item-collection";
import { CalloutCollisionMode } from "igniteui-react-core";
import { Visibility } from "igniteui-react-core";
import { IgrDomainChartPlotAreaPointerEventArgs } from './igr-domain-chart-plot-area-pointer-event-args';
import { IgrTrendLineTypeCollection } from './igr-trend-line-type-collection';
export declare abstract class IgrDomainChart<P extends IIgrDomainChartProps = IIgrDomainChartProps> extends React.Component<P, {}> {
protected createImplementation(): DomainChart;
protected _implementation: any;
get i(): DomainChart;
private onImplementationCreated;
constructor(props: P);
componentDidMount(): void;
shouldComponentUpdate(nextProps: any, nextState: any): boolean;
render(): any;
/**
* Sets or gets the template reference to use for tooltips for all the series.
*
*
*/
get tooltipTemplate(): React.FunctionComponent<IChartTooltipProps> | React.Component<IChartTooltipProps>;
set tooltipTemplate(v: React.FunctionComponent<IChartTooltipProps> | React.Component<IChartTooltipProps>);
/**
* Sets or gets the template references to use for tooltips for all the series, in order.
*
*
*/
get tooltipTemplates(): (React.FunctionComponent<IChartTooltipProps> | React.Component<IChartTooltipProps>)[];
set tooltipTemplates(v: (React.FunctionComponent<IChartTooltipProps> | React.Component<IChartTooltipProps>)[]);
get legend(): any;
set legend(v: any);
private _calloutsDataSource;
set calloutsDataSource(value: any[]);
get calloutsDataSource(): any[];
bindCalloutsData(): void;
/**
* Gets or sets the scaling value used to affect the pixel density of the control.
* A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control
* to appear blurry.
*/
get pixelScalingRatio(): number;
set pixelScalingRatio(v: number);
/**
* Gets or sets the left margin of chart title
*
* Use `titleLeftMargin` property for the left margin of chart title.
*
* ```ts
* this.chart.titleLeftMargin = 10;
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* titleLeftMargin={20}>
* </IgrCategoryChart>
* ```
*/
get titleLeftMargin(): number;
set titleLeftMargin(v: number);
/**
* Gets or sets the right margin of chart title
*
* Use `titleLeftMargin` property for the right margin of chart title.
*
* ```ts
* this.chart.titleRightMargin = 10;
* ```
*
* ```ts
* <IgrCategoryChart
* dataSource={this.state.data}
* titleRightMargin = 10>
* </IgrCategoryChart>
* ```
*/
get titleRightMargin(): number;
set titleRightMargin(v: number);
/**
* Gets or sets the top margin of chart title
*
* Use `titleTopMargin` property for the top margin of chart title.
*
* ```ts
* this.chart.titleTopMargin = 10;
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* titleTopMargin={10} />
* ```
*/
get titleTopMargin(): number;
set titleTopMargin(v: number);
/**
* Gets or sets the bottom margin of chart title
*
* Use `titleBottomMargin` property for the bottom margin of chart title.
*
* ```ts
* this.chart.titleBottomMargin = 5;
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"
* subtitleAlignment="Right"
* titleBottomMargin={5}/>
* ```
*/
get titleBottomMargin(): number;
set titleBottomMargin(v: number);
/**
* Gets or sets the left margin of chart subtitle
*
* Use `subtitleLeftMargin` property for the left margin of chart subtitle.
*
* ```ts
* this.chart.subtitleLeftMargin = 20 ;
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"
* subtitleLeftMargin= {20}/>
* ```
*/
get subtitleLeftMargin(): number;
set subtitleLeftMargin(v: number);
/**
* Gets or sets the top margin of chart subtitle
*
* Use `subtitleTopMargin` property for the top margin of chart subtitle.
*
* ```ts
* this.chart.subtitleTopMargin = 10;
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"
* subtitleTopMargin= {10}/>
* ```
*/
get subtitleTopMargin(): number;
set subtitleTopMargin(v: number);
/**
* Gets or sets the right margin of chart subtitle
*
* Use `subtitleRightMargin` property for the right margin of chart subtitle.
*
* ```ts
* this.chart.subtitleRightMargin = 20 ;
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"
* subtitleAlignment="Right"
* subtitleRightMargin ={20}/>
* ```
*/
get subtitleRightMargin(): number;
set subtitleRightMargin(v: number);
/**
* Gets or sets the bottom margin of chart subtitle
*
* Use `subtitleBottomMargin` property for the bottom margin of chart subtitle.
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"
* subtitleBottomMargin= {10}/>
* ```
*
* ```ts
* this.chart.subtitleBottomMargin = 10 ;
* ```
*/
get subtitleBottomMargin(): number;
set subtitleBottomMargin(v: number);
/**
* Gets or sets color of chart subtitle
*
* Use `subtitleTextColor` property to color the subtitle.
*
* ```ts
* this.chart.subtitleTextColor = "#ff0000" ;
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"
* subtitleTextColor="#ff0000"/>
* ```
*/
get subtitleTextColor(): string;
set subtitleTextColor(v: string);
/**
* Gets or sets color of chart title
*
* Use `titleTextColor` property to color the chart title
*
* ```ts
* this.chart.titleTextColor="red" ;
* ```
*
* ```ts
* <IgrCategoryChart
* dataSource={this.state.data}
* width="700px"
* height="500px"
* xAxisTitle="Countries"
* titleTextColor="Red" />
*
* ```
*/
get titleTextColor(): string;
set titleTextColor(v: string);
/**
* Gets or sets the left margin of the chart content.
*
* Use the 'leftMargin' property for the left margin of the chart content.
*
* ```ts
* this.chart.leftMargin = 20;
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* leftMargin= {20}/>
* ```
*/
get leftMargin(): number;
set leftMargin(v: number);
/**
* Gets or sets the top margin of the chart content.
*
* Use `topMargin` property for the margin of the chart content.
*
* ```ts
* this.chart.topMargin=20;
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* topMargin={10} />
* ```
*/
get topMargin(): number;
set topMargin(v: number);
/**
* Gets or sets the right margin of the chart content.
*
* Use `rightMargin` property for the right margin of the chart content.
*
* ```ts
* this.chart.rightMargin = 20 ;
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* markerTypes={this.state.markersTypes}
* dataSource={this.categoryData}
* rightMargin= {4}/>
* ```
*/
get rightMargin(): number;
set rightMargin(v: number);
/**
* Gets or sets the bottom margin around the chart content.
*
* Use the `bottomMargin` property for the bottom margin around the chart content.
*
* ```ts
* this.chart.bottomMargin=20;
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* bottomMargin= 20 />
* ```
*/
get bottomMargin(): number;
set bottomMargin(v: number);
/**
* Gets or sets the duration used for animating series plots when the data is changing
*
* Use the `TransitionDuration` property to animating between data values.
*
* ```ts
* this.chart.transitionDuratio= 500;
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* transitionDuratio={500} />
* ```
*/
get transitionDuration(): number;
set transitionDuration(v: number);
/**
* Gets or sets the easing function used for animating series plots when the data is changing.
* This can be set to one of the known values "linear" or "cubic," or it can be set to an easing function which takes a single numeric parameter and returns a number.
*
* The 'transitionInEasingFunction' property used for easing function for animating series plots when the chart is loading into view.
*
* ```ts
* this.chart.transitionInEasingFunction= this.cubicFunc;
*
* cubicFunc(time: number) : number
* {
* return time;
* }
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* transitionInEasingFunction="cubic" />
* ```
*/
get transitionEasingFunction(): (time: number) => number;
set transitionEasingFunction(v: (time: number) => number);
/**
* Gets or sets the duration used for animating highlighting changes
*/
get highlightingTransitionDuration(): number;
set highlightingTransitionDuration(v: number);
/**
* Gets or sets the duration used for animating Selection changes
*/
get selectionTransitionDuration(): number;
set selectionTransitionDuration(v: number);
/**
* Gets or sets the duration used for animating Focus changes
*/
get focusTransitionDuration(): number;
set focusTransitionDuration(v: number);
/**
* Gets or sets CSS font property for the chart subtitle
*
* Use `subtitleTextStyle` property for the CSS font of the chart subtitle.
*
* ```ts
* this.chart.subtitleTextStyle= "16pt Verdona";
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitleTextStyle="16pt Verdona"/>
* ```
*/
get subtitleTextStyle(): string;
set subtitleTextStyle(v: string);
/**
* Gets or sets CSS font property for the chart title
*
* Use `titleTextStyle` property for the CSS font property of the chart title
*
* ```ts
* this.chart.xAxisTitleTextStyle = "24pt Verdona";
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* width="700px"
* height="500px"
* xAxisTitle="Countries"
* xAxisTitleTextColor="gray"
* xAxisTitleTextStyle="12pt Verdana"
* xAxisTitleAngle={0}
* yAxisTitle="Trillions of Watt-hours (TWh)"
* yAxisTitleTextStyle="12pt Verdana"
* yAxisTitleTextColor="gray"
* yAxisTitleAngle={90}
* yAxisTitleLeftMargin={5}>
* </IgrCategoryChart>
* ```
*/
get titleTextStyle(): string;
set titleTextStyle(v: string);
get isDetached(): boolean;
get dataToolTipGroupingMode(): DataToolTipLayerGroupingMode;
set dataToolTipGroupingMode(v: DataToolTipLayerGroupingMode);
/**
* Gets or sets the offset of the tooltip layer on the X axis.
*/
get dataToolTipPositionOffsetX(): number;
set dataToolTipPositionOffsetX(v: number);
/**
* Gets or sets the offset of the tooltip layer on the Y axis.
*/
get dataToolTipPositionOffsetY(): number;
set dataToolTipPositionOffsetY(v: number);
/**
* Gets or sets the offset of the tooltip layer on the X axis.
*/
get dataToolTipDefaultPositionOffsetX(): number;
set dataToolTipDefaultPositionOffsetX(v: number);
/**
* Gets or sets the offset of the tooltip layer on the Y axis.
*/
get dataToolTipDefaultPositionOffsetY(): number;
set dataToolTipDefaultPositionOffsetY(v: number);
/**
* Gets or sets the tooltip position mode on the X axis for grouped series.
*/
get dataToolTipGroupedPositionModeX(): DataTooltipGroupedPositionX;
set dataToolTipGroupedPositionModeX(v: DataTooltipGroupedPositionX);
/**
* Gets or sets the tooltip position mode on the Y axis for grouped series.
*/
get dataToolTipGroupedPositionModeY(): DataTooltipGroupedPositionY;
set dataToolTipGroupedPositionModeY(v: DataTooltipGroupedPositionY);
/**
* Gets or sets whether the data legend should update when the series data is mutated.
*/
get dataToolTipShouldUpdateWhenSeriesDataChanges(): boolean;
set dataToolTipShouldUpdateWhenSeriesDataChanges(v: boolean);
/**
* Gets or sets indexes, titles, or names of series to include in displaying in the data tooltip, e.g. "0, 1" or "Series1 Title, Series2 Title"
* The DataToolTipExcludedSeries property takes precedence over values of DataToolTipIncludedSeries property
*/
get dataToolTipIncludedSeries(): string[];
set dataToolTipIncludedSeries(v: string[]);
/**
* Gets or sets indexes, titles, or names of series to exclude from displaying in the data tooltip, e.g. "0, 1" or "Series1 Title, Series2 Title"
* The DataToolTipExcludedSeries property takes precedence over values of DataToolTipIncludedSeries property
*/
get dataToolTipExcludedSeries(): string[];
set dataToolTipExcludedSeries(v: string[]);
/**
* Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L"
* The DataToolTipExcludedColumns property takes precedence over values of DataToolTipIncludedColumns property
*/
get dataToolTipIncludedColumns(): string[];
set dataToolTipIncludedColumns(v: string[]);
/**
* Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L"
* The DataToolTipExcludedColumns property takes precedence over values of DataToolTipIncludedColumns property
*/
get dataToolTipExcludedColumns(): string[];
set dataToolTipExcludedColumns(v: string[]);
/**
* Gets or sets mode for abbreviating large numbers displayed in the legend
* This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
*/
get dataToolTipValueFormatAbbreviation(): DataAbbreviationMode;
set dataToolTipValueFormatAbbreviation(v: DataAbbreviationMode);
/**
* Gets or sets maximum digits for formatting numbers displayed in the legend
* This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
*/
get dataToolTipValueFormatMaxFractions(): number;
set dataToolTipValueFormatMaxFractions(v: number);
/**
* Gets or sets minimum digits for formatting numbers displayed in the legend
* This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
*/
get dataToolTipValueFormatMinFractions(): number;
set dataToolTipValueFormatMinFractions(v: number);
/**
* Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500)
*/
get dataToolTipValueFormatMode(): DataLegendValueMode;
set dataToolTipValueFormatMode(v: DataLegendValueMode);
/**
* Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode
* This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
*/
get dataToolTipValueFormatCulture(): string;
set dataToolTipValueFormatCulture(v: string);
/**
* Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000
* This property is ignored when setting ValueFormatSpecifiers or ValueFormatString properties
*/
get dataToolTipValueFormatUseGrouping(): boolean;
set dataToolTipValueFormatUseGrouping(v: boolean);
/**
* Gets or sets the format string for values displayed in the data legend.
*/
get dataToolTipValueFormatString(): string;
set dataToolTipValueFormatString(v: string);
/**
* Gets or sets the format specifiers to use with the ValueFormatString string.
*/
get dataToolTipValueFormatSpecifiers(): any[];
set dataToolTipValueFormatSpecifiers(v: any[]);
get dataToolTipValueRowMarginBottom(): number;
set dataToolTipValueRowMarginBottom(v: number);
get dataToolTipValueRowMarginLeft(): number;
set dataToolTipValueRowMarginLeft(v: number);
get dataToolTipValueRowMarginRight(): number;
set dataToolTipValueRowMarginRight(v: number);
get dataToolTipValueRowMarginTop(): number;
set dataToolTipValueRowMarginTop(v: number);
ensureDataToolTipValueRowMargin(): void;
/**
* Gets or sets whether to show series rows.
*/
get dataToolTipValueRowVisible(): boolean;
set dataToolTipValueRowVisible(v: boolean);
/**
* Gets or sets text displayed when data column is missing a value, e.g. "no data"
*/
get dataToolTipValueTextWhenMissingData(): string;
set dataToolTipValueTextWhenMissingData(v: string);
/**
* Gets or sets whether to use series colors when displaying values in the legend
*/
get dataToolTipValueTextUseSeriesColors(): boolean;
set dataToolTipValueTextUseSeriesColors(v: boolean);
get dataToolTipValueTextMarginBottom(): number;
set dataToolTipValueTextMarginBottom(v: number);
get dataToolTipValueTextMarginLeft(): number;
set dataToolTipValueTextMarginLeft(v: number);
get dataToolTipValueTextMarginRight(): number;
set dataToolTipValueTextMarginRight(v: number);
get dataToolTipValueTextMarginTop(): number;
set dataToolTipValueTextMarginTop(v: number);
ensureDataToolTipValueTextMargin(): void;
/**
* Gets or sets the units text color.
*/
get dataToolTipValueTextColor(): string;
set dataToolTipValueTextColor(v: string);
/**
* Gets or Sets the style to use for the units text.
*/
get dataToolTipValueTextStyle(): string;
set dataToolTipValueTextStyle(v: string);
/**
* Gets or sets the format string for header text displayed in the data legend.
*/
get dataToolTipHeaderFormatString(): string;
set dataToolTipHeaderFormatString(v: string);
/**
* Gets or sets the format specifiers to use with the HeaderFormatString string.
*/
get dataToolTipHeaderFormatSpecifiers(): any[];
set dataToolTipHeaderFormatSpecifiers(v: any[]);
/**
* Gets or sets globalization culture when displaying header as date time
* This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties
*/
get dataToolTipHeaderFormatCulture(): string;
set dataToolTipHeaderFormatCulture(v: string);
/**
* Gets or sets date format for the header
* This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties
*/
get dataToolTipHeaderFormatDate(): DataLegendHeaderDateMode;
set dataToolTipHeaderFormatDate(v: DataLegendHeaderDateMode);
/**
* Gets or sets time format for the header
* This property is ignored when setting HeaderFormatSpecifiers or HeaderFormatString properties
*/
get dataToolTipHeaderFormatTime(): DataLegendHeaderTimeMode;
set dataToolTipHeaderFormatTime(v: DataLegendHeaderTimeMode);
/**
* Gets or sets the HeaderText for the data legend.
*/
get dataToolTipHeaderText(): string;
set dataToolTipHeaderText(v: string);
/**
* Gets or sets the header text color.
*/
get dataToolTipHeaderTextColor(): string;
set dataToolTipHeaderTextColor(v: string);
get dataToolTipHeaderTextMarginBottom(): number;
set dataToolTipHeaderTextMarginBottom(v: number);
get dataToolTipHeaderTextMarginLeft(): number;
set dataToolTipHeaderTextMarginLeft(v: number);
get dataToolTipHeaderTextMarginRight(): number;
set dataToolTipHeaderTextMarginRight(v: number);
get dataToolTipHeaderTextMarginTop(): number;
set dataToolTipHeaderTextMarginTop(v: number);
ensureDataToolTipHeaderTextMargin(): void;
get dataToolTipHeaderRowMarginBottom(): number;
set dataToolTipHeaderRowMarginBottom(v: number);
get dataToolTipHeaderRowMarginLeft(): number;
set dataToolTipHeaderRowMarginLeft(v: number);
get dataToolTipHeaderRowMarginRight(): number;
set dataToolTipHeaderRowMarginRight(v: number);
get dataToolTipHeaderRowMarginTop(): number;
set dataToolTipHeaderRowMarginTop(v: number);
ensureDataToolTipHeaderRowMargin(): void;
/**
* Gets or sets whether to show Header row.
*/
get dataToolTipHeaderRowVisible(): boolean;
set dataToolTipHeaderRowVisible(v: boolean);
/**
* Gets or Sets the style to use for the header text.
*/
get dataToolTipHeaderTextStyle(): string;
set dataToolTipHeaderTextStyle(v: string);
/**
* Gets or sets the Group text color.
*/
get dataToolTipGroupTextColor(): string;
set dataToolTipGroupTextColor(v: string);
get dataToolTipGroupTextMarginBottom(): number;
set dataToolTipGroupTextMarginBottom(v: number);
get dataToolTipGroupTextMarginLeft(): number;
set dataToolTipGroupTextMarginLeft(v: number);
get dataToolTipGroupTextMarginRight(): number;
set dataToolTipGroupTextMarginRight(v: number);
get dataToolTipGroupTextMarginTop(): number;
set dataToolTipGroupTextMarginTop(v: number);
ensureDataToolTipGroupTextMargin(): void;
get dataToolTipGroupRowMarginBottom(): number;
set dataToolTipGroupRowMarginBottom(v: number);
get dataToolTipGroupRowMarginLeft(): number;
set dataToolTipGroupRowMarginLeft(v: number);
get dataToolTipGroupRowMarginRight(): number;
set dataToolTipGroupRowMarginRight(v: number);
get dataToolTipGroupRowMarginTop(): number;
set dataToolTipGroupRowMarginTop(v: number);
ensureDataToolTipGroupRowMargin(): void;
/**
* Gets or sets whether to show Group row.
*/
get dataToolTipGroupRowVisible(): boolean;
set dataToolTipGroupRowVisible(v: boolean);
/**
* Gets or Sets the style to use for the Group text.
*/
get dataToolTipGroupTextStyle(): string;
set dataToolTipGroupTextStyle(v: string);
/**
* Gets or sets the summary text color.
*/
get dataToolTipSummaryTitleTextColor(): string;
set dataToolTipSummaryTitleTextColor(v: string);
/**
* Gets or Sets the style to use for the summary text.
*/
get dataToolTipSummaryTitleTextStyle(): string;
set dataToolTipSummaryTitleTextStyle(v: string);
/**
* Gets or sets the SummaryType for the data legend.
*/
get dataToolTipSummaryType(): DataLegendSummaryType;
set dataToolTipSummaryType(v: DataLegendSummaryType);
/**
* Gets or sets the SummaryTitleText for the data legend.
*/
get dataToolTipSummaryTitleText(): string;
set dataToolTipSummaryTitleText(v: string);
get dataToolTipSummaryTitleTextMarginBottom(): number;
set dataToolTipSummaryTitleTextMarginBottom(v: number);
get dataToolTipSummaryTitleTextMarginLeft(): number;
set dataToolTipSummaryTitleTextMarginLeft(v: number);
get dataToolTipSummaryTitleTextMarginRight(): number;
set dataToolTipSummaryTitleTextMarginRight(v: number);
get dataToolTipSummaryTitleTextMarginTop(): number;
set dataToolTipSummaryTitleTextMarginTop(v: number);
ensureDataToolTipSummaryTitleTextMargin(): void;
get dataToolTipSummaryRowMarginBottom(): number;
set dataToolTipSummaryRowMarginBottom(v: number);
get dataToolTipSummaryRowMarginLeft(): number;
set dataToolTipSummaryRowMarginLeft(v: number);
get dataToolTipSummaryRowMarginRight(): number;
set dataToolTipSummaryRowMarginRight(v: number);
get dataToolTipSummaryRowMarginTop(): number;
set dataToolTipSummaryRowMarginTop(v: number);
ensureDataToolTipSummaryRowMargin(): void;
/**
* Gets or sets the units text color.
*/
get dataToolTipSummaryValueTextColor(): string;
set dataToolTipSummaryValueTextColor(v: string);
/**
* Gets or Sets the style to use for the units text.
*/
get dataToolTipSummaryValueTextStyle(): string;
set dataToolTipSummaryValueTextStyle(v: string);
/**
* Gets or sets the units text for the data legend.
*/
get dataToolTipSummaryLabelText(): string;
set dataToolTipSummaryLabelText(v: string);
/**
* Gets or sets the units text color.
*/
get dataToolTipSummaryLabelTextColor(): string;
set dataToolTipSummaryLabelTextColor(v: string);
/**
* Gets or Sets the style to use for the units text.
*/
get dataToolTipSummaryLabelTextStyle(): string;
set dataToolTipSummaryLabelTextStyle(v: string);
/**
* Gets or sets the units text for the data legend.
*/
get dataToolTipSummaryUnitsText(): string;
set dataToolTipSummaryUnitsText(v: string);
/**
* Gets or sets the units text color.
*/
get dataToolTipSummaryUnitsTextColor(): string;
set dataToolTipSummaryUnitsTextColor(v: string);
/**
* Gets or Sets the style to use for the units text.
*/
get dataToolTipSummaryUnitsTextStyle(): string;
set dataToolTipSummaryUnitsTextStyle(v: string);
get dataToolTipBadgeMarginBottom(): number;
set dataToolTipBadgeMarginBottom(v: number);
get dataToolTipBadgeMarginLeft(): number;
set dataToolTipBadgeMarginLeft(v: number);
get dataToolTipBadgeMarginRight(): number;
set dataToolTipBadgeMarginRight(v: number);
get dataToolTipBadgeMarginTop(): number;
set dataToolTipBadgeMarginTop(v: number);
ensureDataToolTipBadgeMargin(): void;
/**
* Gets or sets the BadgeShape for the data legend.
*/
get dataToolTipBadgeShape(): LegendItemBadgeShape;
set dataToolTipBadgeShape(v: LegendItemBadgeShape);
/**
* Gets or sets the UnitsMode for the data legend.
*/
get dataToolTipUnitsDisplayMode(): DataLegendUnitsMode;
set dataToolTipUnitsDisplayMode(v: DataLegendUnitsMode);
/**
* Gets or sets the units text for the data legend.
*/
get dataToolTipUnitsText(): string;
set dataToolTipUnitsText(v: string);
/**
* Gets or sets the units text color.
*/
get dataToolTipUnitsTextColor(): string;
set dataToolTipUnitsTextColor(v: string);
get dataToolTipUnitsTextMarginBottom(): number;
set dataToolTipUnitsTextMarginBottom(v: number);
get dataToolTipUnitsTextMarginLeft(): number;
set dataToolTipUnitsTextMarginLeft(v: number);
get dataToolTipUnitsTextMarginRight(): number;
set dataToolTipUnitsTextMarginRight(v: number);
get dataToolTipUnitsTextMarginTop(): number;
set dataToolTipUnitsTextMarginTop(v: number);
ensureDataToolTipUnitsTextMargin(): void;
/**
* Gets or Sets the style to use for the units text.
*/
get dataToolTipUnitsTextStyle(): string;
set dataToolTipUnitsTextStyle(v: string);
get dataToolTipTitleTextMarginBottom(): number;
set dataToolTipTitleTextMarginBottom(v: number);
get dataToolTipTitleTextMarginLeft(): number;
set dataToolTipTitleTextMarginLeft(v: number);
get dataToolTipTitleTextMarginRight(): number;
set dataToolTipTitleTextMarginRight(v: number);
get dataToolTipTitleTextMarginTop(): number;
set dataToolTipTitleTextMarginTop(v: number);
ensureDataToolTipTitleTextMargin(): void;
/**
* Gets or sets the display text color.
*/
get dataToolTipTitleTextColor(): string;
set dataToolTipTitleTextColor(v: string);
/**
* Gets or Sets the style to use for the display text.
*/
get dataToolTipTitleTextStyle(): string;
set dataToolTipTitleTextStyle(v: string);
/**
* Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series
*/
get dataToolTipLabelDisplayMode(): DataLegendLabelMode;
set dataToolTipLabelDisplayMode(v: DataLegendLabelMode);
/**
* Gets or sets the units text color.
*/
get dataToolTipLabelTextColor(): string;
set dataToolTipLabelTextColor(v: string);
get dataToolTipLabelTextMarginBottom(): number;
set dataToolTipLabelTextMarginBottom(v: number);
get dataToolTipLabelTextMarginLeft(): number;
set dataToolTipLabelTextMarginLeft(v: number);
get dataToolTipLabelTextMarginRight(): number;
set dataToolTipLabelTextMarginRight(v: number);
get dataToolTipLabelTextMarginTop(): number;
set dataToolTipLabelTextMarginTop(v: number);
ensureDataToolTipLabelTextMargin(): void;
/**
* Gets or Sets the style to use for the units text.
*/
get dataToolTipLabelTextStyle(): string;
set dataToolTipLabelTextStyle(v: string);
/**
* Gets the domain type of this chart
*/
get domainType(): DomainType;
/**
* Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties.
*/
get sortDescriptions(): IgrChartSortDescriptionCollection;
get groupSortDescriptions(): IgrChartSortDescriptionCollection;
/**
* Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties.
*/
get groupDescriptions(): IgrChartSortDescriptionCollection;
/**
* Gets the current filter that is applied to the chart. Collection can be updated to modify the filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties.
*/
get filterExpressions(): IgrFilterExpressionCollection;
/**
* Gets the current highlight filter that is applied to the chart. Collection can be updated to modify the highlight filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties.
*/
get highlightFilterExpressions(): IgrFilterExpressionCollection;
/**
* Gets the current summaries that are applied to the grid.
*/
get summaryDescriptions(): IgrChartSummaryDescriptionCollection;
/**
* Gets or sets the selection mode to use for the series in the component, when supported.
*/
get selectionMode(): SeriesSelectionMode;
set selectionMode(v: SeriesSelectionMode);
/**
* Gets or sets the focus mode to use for the series in the component, when supported.
*/
get focusMode(): SeriesSelectionMode;
set focusMode(v: SeriesSelectionMode);
/**
* Gets or sets the selection brush to use for the series.
*/
get selectionBrush(): string;
set selectionBrush(v: string);
/**
* Gets or sets the focus brush to use for the series.
*/
get focusBrush(): string;
set focusBrush(v: string);
/**
* Gets or sets the selection behavior to use for the series in the component, when supported.
*/
get selectionBehavior(): SeriesSelectionBehavior;
set selectionBehavior(v: SeriesSelectionBehavior);
private _selectedSeriesItems;
/**
* Gets the currently selected data items. Adding or removing data items from this collection will
* select or deselect the visuals associated with those items.
*/
get selectedSeriesItems(): IgrChartSelectedItemCollection;
set selectedSeriesItems(v: IgrChartSelectedItemCollection);
private _focusedSeriesItems;
/**
* Gets the currently focused data items. Adding or removing data items from this collection will
* focus or blur the visuals associated with those items.
*/
get focusedSeriesItems(): IgrChartSelectedItemCollection;
set focusedSeriesItems(v: IgrChartSelectedItemCollection);
/**
* Gets the initial sorts that are applied to the chart.
*/
get initialSortDescriptions(): IgrChartSortDescriptionCollection;
/**
* Gets the initial sorts that are applied to the chart after groupings and summaries are applied.
*/
get initialGroupSortDescriptions(): IgrChartSortDescriptionCollection;
/**
* Gets the initial groupings that are applied to the chart.
*/
get initialGroupDescriptions(): IgrChartSortDescriptionCollection;
/**
* Gets the initial filters that are applied to the chart.
*/
get initialFilterExpressions(): IgrFilterExpressionCollection;
/**
* Gets the initial highlight filters that are applied to the chart.
*/
get initialHighlightFilterExpressions(): IgrFilterExpressionCollection;
/**
* Gets the initial summaries that are applied to the chart.
*/
get initialSummaryDescriptions(): IgrChartSummaryDescriptionCollection;
/**
* Gets or sets the sorts to apply to the chart. This property will become ignored if sorts are changed outside of this property.
*/
get initialSorts(): string;
set initialSorts(v: string);
/**
* Gets or sets the sorts to apply after grouping has been applied.
*/
get groupSorts(): string;
set groupSorts(v: string);
/**
* Gets or sets the groupings to apply to the chart. This property will become ignored if sorts are changed outside of this property.
*/
get initialGroups(): string;
set initialGroups(v: string);
/**
* Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.
*/
get initialFilter(): string;
set initialFilter(v: string);
/**
* Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property.
*/
get initialHighlightFilter(): string;
set initialHighlightFilter(v: string);
/**
* Gets or sets the summaries to apply to the chart. This property will become ignored if sorts are changed outside of this property.
*/
get initialSummaries(): string;
set initialSummaries(v: string);
/**
* Gets or sets a collection of data items used to generate the chart.
* The HighlightedItemsSource of this chart can be a list of objects containing one or more numeric properties.
* Additionally, if the objects in the list implement the IEnumerable interface,
* the Chart will attempt to delve into the sub-collections when reading through the data source.
* Data binding can be further configured by attributing the data item classes
* with the DataSeriesMemberIntentAttribute.
*/
get highlightedDataSource(): any;
set highlightedDataSource(v: any);
/**
* Gets or sets a set of property paths that should be included for consideration by the category chart, leaving the remainder excluded. If null, all properties will be considered.
*
* The `IncludedProperties` property used to include the properties for the consideration of the category chart.
*
* ```ts
* this.chart.includedProperties = ["ProductName", "Cost"];
* ```
*
* ```ts
* <IgrCategoryChart
* chartType="Line"
* markerTypes={this.state.markersTypes}
* dataSource={this.categoryData}
* excludedProperties="value" />
* ```
*/
get includedProperties(): string[];
set includedProperties(v: string[]);
/**
* Gets or sets a set of property paths that should be excluded from consideration by the category chart.
*
* The `ExcludedProperties` property used for the property paths that should be excluded from consideration by the category chart.
*
* ```ts
* this.chart.excludedProperties = ["ID", "Discount"];
* ```
*
* ```ts
* <IgrCategoryChart
* chartType="Line"
* markerTypes={this.state.markersTypes}
* dataSource={this.categoryData}
* excludedProperties="value" />
* ```
*/
get excludedProperties(): string[];
set excludedProperties(v: string[]);
/**
* Gets or sets the palette of brushes to use for coloring the chart series.
* The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection
*
* Use the `Brushes` property to set the brushes.
*
* ```ts
* this.chart.brushes = ["#ff0000","#00ff00"];
* ```
*/
get brushes(): string[];
set brushes(v: string[]);
/**
* Gets or sets the palette of brushes to use for outlines on the chart series.
* The value provided should be an array of CSS color strings or JavaScript objects defining gradients. Optionally the first element can be a string reading "RGB" or "HSV" to specify the interpolation mode of the collection
*
* Use the `Outlines` property to sets the palette of brushes to use for outlines on the chart series
*
* ```ts
* <IgrCategoryChart
* chartType="Line"
* outlines= "#ff0000"
* dataSource={this.categoryData}/>
* ```
*/
get outlines(): string[];
set outlines(v: string[]);
/**
* Gets the actual palette of brushes to use for coloring the chart series.
*/
get actualBrushes(): string[];
set actualBrushes(v: string[]);
/**
* Gets the actual palette of brushes to use for outlines on the chart series.
*/
get actualOutlines(): string[];
set actualOutlines(v: string[]);
/**
* Gets or sets whether the chart can be horizontally zoomed through user interactions.
*
* Use the `IsHorizontalZoomEnabled` property to allow chart horizontally zoomed .
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* width="700px"
* height="500px"
* xAxisLabelTextStyle="10pt Verdana"
* xAxisLabelTopMargin={5}
* xAxisLabelTextColor="gray"
* yAxisLabelTextStyle="10pt Verdana"
* yAxisLabelRightMargin={5}
* yAxisLabelTextColor="gray"
* isHorizontalZoomEnabled= true/>
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* IsHorizontalZoomEnabled= true />
* ```
*
* ```ts
* this.chart.isHorizontalZoomEnabled = true;
* ```
*/
get isHorizontalZoomEnabled(): boolean;
set isHorizontalZoomEnabled(v: boolean);
/**
* Gets or sets whether the chart can be vertically zoomed through user interactions.
*
* Use the `IsVerticalZoomEnabled` property to allow chart zoom vertically.
*
* ```ts
* this.chart.isVerticalZoomEnabled = true;
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* isVerticalZoomEnabled= "true"/>
* ```
*/
get isVerticalZoomEnabled(): boolean;
set isVerticalZoomEnabled(v: boolean);
/**
* Gets or sets whether the chart should display mock data when the data source has not been provided, if supported for this type of chart.
*/
get shouldDisplayMockData(): boolean;
set shouldDisplayMockData(v: boolean);
/**
* Gets or sets whether the chart should use a faded skeleton style for mock data.
*/
get shouldUseSkeletonStyleForMockData(): boolean;
set shouldUseSkeletonStyleForMockData(v: boolean);
/**
* Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse.
* This property applies to Category Chart and Financial Chart controls.
*/
get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode;
set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode);
/**
* Gets or sets whether the chart can highlight series through user interactions.
* This property applies to Category Chart and Financial Chart controls.
*/
get isSeriesHighlightingEnabled(): boolean;
set isSeriesHighlightingEnabled(v: boolean);
/**
* Gets or sets whether the chart can highlight series through user interactions.
* This property applies to Category Chart and Financial Chart controls.
*/
get highlightedLegendItemVisibility(): Visibility;
set highlightedLegendItemVisibility(v: Visibility);
/**
* Gets or sets whether to show the legend items for the series.
*/
get legendItemVisibility(): Visibility;
set legendItemVisibility(v: Visibility);
/**
* Gets or sets the rectangle representing the current scroll and zoom state of the chart.
* WindowRect is expressed as a Rectangle with coordinates and sizes between 0 and 1.
*
* Use `WindowRect` property representing the current scroll and zoom state of the chart.
*
* ```ts
* this.chart.windowRect =[0,0,1,1];
* ```
*
* ```ts
* <IgrCategoryChart dataSource={this.state.data}
* WindowRect={1,0,1,1} />
* ```
*/
get windowRect(): IgRect;
set windowRect(v: IgRect);
/**
* Gets a rectangle representing the bounds of the plot area.
*
* `viewport` property representing the bounds of the plot area.
*
* ```ts
* let viewport:Rect = this.chart.viewport;
* ```
*/
get viewport(): IgRect;
/**
* Gets or sets text to display above the plot area.
*
* Use the `Title` property to display the text above the plot area.
*
* ```ts
* this.chart.title= "This is a Title";
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* title= "CategoryChart Subtitle" />
* ```
*/
get chartTitle(): string;
set chartTitle(v: string);
/**
* Gets or sets text to display below the Title, above the plot area.
*
* Use the `Subtitle` property to display the text below and above the plot area.
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"/>
* ```
*
* ```ts
* this.chart.subtitle ="CategoryChart Subtitle" ;
* ```
*/
get subtitle(): string;
set subtitle(v: string);
/**
* Gets or sets horizontal alignment which determines the title position, relative to the left and right edges of the control.
*
* Use the `TitleAlignment` property for the horizontal alignment of the title.
*
* ```ts
* this.chart.titleAlignment = HorizontalAlignment.Center;
* ```
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* titleAlignment= "Center"/>
* ```
*/
get titleAlignment(): HorizontalAlignment;
set titleAlignment(v: HorizontalAlignment);
/**
* Gets or sets horizontal alignment which determines the subtitle position, relative to the left and right edges of the control.
*
* Use the `SubtitleAlignment` property to Gets or sets horizontal alignment.
*
* ```ts
* <IgrCategoryChart
* width="100%"
* height="100%"
* chartType="Line"
* dataSource={this.categoryData}
* subtitle= "CategoryChart Subtitle"
* subtitleAlignment="Right"/>
* ```
*
* ```ts
* this.chart.subtitleAlignment = HorizontalAlignment.Right;
* ```
*/
get subtitleAlignment(): HorizontalAlignment;
set subtitleAlignment(v: HorizontalA