UNPKG

igniteui-react-charts

Version:

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

1,445 lines 130 kB
import * as React from 'react'; import { IgRect } from "igniteui-react-core"; import { IgPoint } from "igniteui-react-core"; import { IgrSeriesCollection } from "./igr-series-collection"; import { MarkerAutomaticBehavior } from "./MarkerAutomaticBehavior"; import { SeriesHighlightingMode } from "./SeriesHighlightingMode"; import { SeriesSelectionMode } from "./SeriesSelectionMode"; import { SeriesSelectionBehavior } from "./SeriesSelectionBehavior"; import { SeriesViewerScrollbarMode } from "./SeriesViewerScrollbarMode"; import { SeriesViewerHorizontalScrollbarPosition } from "./SeriesViewerHorizontalScrollbarPosition"; import { SeriesViewerVerticalScrollbarPosition } from "./SeriesViewerVerticalScrollbarPosition"; import { SeriesHighlightingBehavior } from "./SeriesHighlightingBehavior"; import { LegendHighlightingMode } from "./LegendHighlightingMode"; import { LegendItemBadgeShape } from "igniteui-react-core"; import { LegendItemBadgeMode } from "igniteui-react-core"; import { ChartHitTestMode } from "./ChartHitTestMode"; import { WindowResponse } from "./WindowResponse"; import { Visibility } from "igniteui-react-core"; import { ZoomCoercionMode } from "./ZoomCoercionMode"; import { InteractionState } from "igniteui-react-core"; import { ModifierKeys } from "igniteui-react-core"; import { SeriesHighlightedValuesDisplayMode } from "igniteui-react-core"; import { IgrChartSelectedItemCollection } from "./igr-chart-selected-item-collection"; import { HorizontalAlignment } from "igniteui-react-core"; import { IgrUserAnnotationInformationEventArgs } from "./igr-user-annotation-information-event-args"; import { IgrUserAnnotationToolTipContentUpdatingEventArgs } from "./igr-user-annotation-tool-tip-content-updating-event-args"; import { IgrPlotAreaMouseButtonEventArgs } from "./igr-plot-area-mouse-button-event-args"; import { IgrPlotAreaMouseEventArgs } from "./igr-plot-area-mouse-event-args"; import { IgrAxisMouseEventArgs } from "./igr-axis-mouse-event-args"; import { IgrChartCursorEventArgs } from "./igr-chart-cursor-event-args"; import { IgrDataChartMouseButtonEventArgs } from "./igr-data-chart-mouse-button-event-args"; import { IgrChartMouseEventArgs } from "./igr-chart-mouse-event-args"; import { IgrChartResizeIdleEventArgs } from "./igr-chart-resize-idle-event-args"; import { IgrSeriesViewerManipulationEventArgs } from "./igr-series-viewer-manipulation-event-args"; import { IgrRectChangedEventArgs } from "igniteui-react-core"; import { IgrSeriesViewerSelectedSeriesItemsChangedEventArgs } from "./igr-series-viewer-selected-series-items-changed-event-args"; import { IgrRefreshCompletedEventArgs } from "./igr-refresh-completed-event-args"; import { IgrImageCapturedEventArgs } from "igniteui-react-core"; import { IgrUserAnnotationInformation } from "./igr-user-annotation-information"; import { IgrSeries } from "./igr-series"; import { IgrCaptureImageSettings } from "igniteui-react-core"; import { SeriesViewer } from "./SeriesViewer"; import { ContentChildrenManager } from "igniteui-react-core"; import { ToolActionInfo } from "igniteui-react-core"; import { ICommandAvailabilityListener } from "igniteui-react-core"; import { ICommandStateChangedListener } from "igniteui-react-core"; /** * Represents a control for viewing series objects. */ export declare abstract class IgrSeriesViewer<P extends IIgrSeriesViewerProps = IIgrSeriesViewerProps> extends React.Component<P, {}> { protected createImplementation(): SeriesViewer; protected _implementation: any; protected mounted: boolean; get nativeElement(): HTMLElement; /** * @hidden */ get i(): SeriesViewer; /** * @hidden */ static _createFromInternal(internal: any): IgrSeriesViewer; protected onImplementationCreated(): void; protected _contentChildrenManager: ContentChildrenManager; constructor(props: P); componentDidMount(): void; shouldComponentUpdate(nextProps: any, nextState: any): boolean; render(): any; private _fullSeries; get fullSeries(): IgrSeriesCollection; set fullSeries(v: IgrSeriesCollection); /** * Gets or sets the palette of brushes used for fill of plotted series. * These brushes are automatically assigned to series based on the index of series. */ get brushes(): string[]; set brushes(v: string[]); /** * Gets or sets the palette of brushes used for outlines of plotted series. * These outlines are automatically assigned to series based on the index of series. */ get outlines(): string[]; set outlines(v: string[]); /** * Gets or sets the palette of brushes used for fill of marker series. * These brushes are automatically assigned to markers based on the index of series. */ get markerBrushes(): string[]; set markerBrushes(v: string[]); /** * Gets or sets the palette of brushes used for outlines of plotted markers. * These outlines are automatically assigned to markers based on the index of series. */ get markerOutlines(): string[]; set markerOutlines(v: string[]); /** * Gets or sets the marker mode used for assigning a marker type to series when the marker type is automatic. */ get markerAutomaticBehavior(): MarkerAutomaticBehavior; set markerAutomaticBehavior(v: MarkerAutomaticBehavior); /** * Gets or sets the cross hair point (in world coordinates) * Either or both of the crosshair point's X and Y may be set to double.NaN, in which * case the relevant crosshair line is hidden. * * The `CrosshairPoint` property is used to gets/sets the cross hair point (in world coordinates). * * ```ts * this.chart.crosshairPoint = {x:.8,y:.2}; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * crosshairVisibility="visible" * crosshairPoint={x:.8,y:.2} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrAreaSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get crosshairPoint(): IgPoint; set crosshairPoint(v: IgPoint); /** * Gets or sets whether the series animations should be allowed when a range change has been detected on an axis. * * `AnimateSeriesWhenAxisRangeChanges` is a Boolean property to override the default behavior in which series do not animate if an axis range changes. * * ```ts * this.chart.animateSeriesWhenAxisRangeChanges = true; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * animateSeriesWhenAxisRangeChanges={true}> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrColumnSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get animateSeriesWhenAxisRangeChanges(): boolean; set animateSeriesWhenAxisRangeChanges(v: boolean); /** * Gets or sets whether the series animations should be allowed when a range change has been detected on an axis. */ get seriesValueLayerUseLegend(): boolean; set seriesValueLayerUseLegend(v: boolean); /** * Gets or sets whether initiating user annotations from the toolbar is enabled. */ get isUserAnnotationsEnabled(): boolean; set isUserAnnotationsEnabled(v: boolean); /** * Gets or sets whether to sync the vertical aspect of the window with the contained series content. This is only supported for a subset of the available series. */ get isWindowSyncedToVisibleRange(): boolean; set isWindowSyncedToVisibleRange(v: boolean); /** * Gets or sets whether calling SimulateHover should shift the crosshair point. */ get shouldSimulateHoverMoveCrosshairPoint(): boolean; set shouldSimulateHoverMoveCrosshairPoint(v: boolean); /** * Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled. */ get highlightingMode(): SeriesHighlightingMode; set highlightingMode(v: SeriesHighlightingMode); /** * Gets or sets the target opacity to fade to for fade style highlighting. */ get highlightingFadeOpacity(): number; set highlightingFadeOpacity(v: number); /** * 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 selection behavior to use for the series in the component, when supported. */ get selectionBehavior(): SeriesSelectionBehavior; set selectionBehavior(v: SeriesSelectionBehavior); /** * 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 horizontal scrollbar mode to use for the series viewer. */ get horizontalViewScrollbarMode(): SeriesViewerScrollbarMode; set horizontalViewScrollbarMode(v: SeriesViewerScrollbarMode); /** * Gets or sets the vertical scrollbar mode to use for the series viewer. */ get verticalViewScrollbarMode(): SeriesViewerScrollbarMode; set verticalViewScrollbarMode(v: SeriesViewerScrollbarMode); /** * Gets or sets the position to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarPosition(): SeriesViewerHorizontalScrollbarPosition; set horizontalViewScrollbarPosition(v: SeriesViewerHorizontalScrollbarPosition); /** * Gets or sets the position to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarPosition(): SeriesViewerVerticalScrollbarPosition; set verticalViewScrollbarPosition(v: SeriesViewerVerticalScrollbarPosition); /** * Gets or sets the fill to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarFill(): string; set horizontalViewScrollbarFill(v: string); /** * Gets or sets the outline to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarOutline(): string; set horizontalViewScrollbarOutline(v: string); /** * Gets or sets the stroke thickness to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarStrokeThickness(): number; set horizontalViewScrollbarStrokeThickness(v: number); /** * Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarMaxOpacity(): number; set horizontalViewScrollbarMaxOpacity(v: number); /** * Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarCornerRadius(): number; set horizontalViewScrollbarCornerRadius(v: number); /** * Gets or sets the height to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarHeight(): number; set horizontalViewScrollbarHeight(v: number); /** * Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarInset(): number; set horizontalViewScrollbarInset(v: number); /** * Gets or sets the track start inset to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarTrackStartInset(): number; set horizontalViewScrollbarTrackStartInset(v: number); /** * Gets or sets the track end inset to use for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarTrackEndInset(): number; set horizontalViewScrollbarTrackEndInset(v: number); /** * Gets or sets whether to use automatic track insets for the horizontal scrollbar in the component, when enabled. */ get horizontalViewScrollbarShouldAddAutoTrackInsets(): boolean; set horizontalViewScrollbarShouldAddAutoTrackInsets(v: boolean); /** * Gets or sets the fill to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarFill(): string; set verticalViewScrollbarFill(v: string); /** * Gets or sets the outline to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarOutline(): string; set verticalViewScrollbarOutline(v: string); /** * Gets or sets the stroke thickness to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarStrokeThickness(): number; set verticalViewScrollbarStrokeThickness(v: number); /** * Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarMaxOpacity(): number; set verticalViewScrollbarMaxOpacity(v: number); /** * Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarCornerRadius(): number; set verticalViewScrollbarCornerRadius(v: number); /** * Gets or sets the width to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarWidth(): number; set verticalViewScrollbarWidth(v: number); /** * Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarInset(): number; set verticalViewScrollbarInset(v: number); /** * Gets or sets the track start inset to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarTrackStartInset(): number; set verticalViewScrollbarTrackStartInset(v: number); /** * Gets or sets the track end inset to use for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarTrackEndInset(): number; set verticalViewScrollbarTrackEndInset(v: number); /** * Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled. */ get verticalViewScrollbarShouldAddAutoTrackInsets(): boolean; set verticalViewScrollbarShouldAddAutoTrackInsets(v: boolean); /** * Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled. */ get highlightingBehavior(): SeriesHighlightingBehavior; set highlightingBehavior(v: SeriesHighlightingBehavior); /** * Gets or sets the highlighting mode to use for the legend linked to the component, when supported. */ get legendHighlightingMode(): LegendHighlightingMode; set legendHighlightingMode(v: LegendHighlightingMode); /** * Gets or sets type of legend badges representing all series displayed in a legend linked to this component * This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on a series */ get legendItemBadgeShape(): LegendItemBadgeShape; set legendItemBadgeShape(v: LegendItemBadgeShape); /** * Gets or sets the mode of legend badges representing all series in this chart. * This property will be ignored when the LegendItemTemplate or LegendItemBadgeTemplate property is set on a series */ get legendItemBadgeMode(): LegendItemBadgeMode; set legendItemBadgeMode(v: LegendItemBadgeMode); /** * Gets or sets how the mouse leave event fires when a manipulation is started. */ get fireMouseLeaveOnManipulationStart(): boolean; set fireMouseLeaveOnManipulationStart(v: boolean); /** * Gets the viewport rectangle associated with the SeriesViewer, the physical dimensions of the plot area. */ get viewportRect(): IgRect; /** * Gets the EffectiveViewport rectangle, representing the effective viewport area after margins have been subtracted. * * ``ts * let viewport: IgxRect = this.chart.effectiveViewport; * * ``` * * ``` */ get effectiveViewport(): IgRect; set effectiveViewport(v: IgRect); /** * Represents the subset area within the viewport into which content should be mapped. * This is the projection of the current EffectiveViewport into the viewport at current zoom level. */ get contentViewport(): IgRect; /** * A rectangle representing the portion of the SeriesViewer currently in view. * A rectangle at X=0, Y=0 with a Height and Width of 1 implies the entire plotting area is in view. A Height and Width of .5 would imply that the view is halfway zoomed in. * * You can set the `WindowRect` to zoom in on an area of interest in the chart. * * ```ts * this.chart.windowRect = {left:0, top:1, width: .5, height: .5}; * ``` */ get windowRect(): IgRect; set windowRect(v: IgRect); /** * Gets or sets whether the series viewer should use cached tiles during zooms rather than the default live content. */ get useTiledZooming(): boolean; set useTiledZooming(v: boolean); /** * Gets or sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality. */ get preferHigherResolutionTiles(): boolean; set preferHigherResolutionTiles(v: boolean); /** * Gets or sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode. */ get zoomTileCacheSize(): number; set zoomTileCacheSize(v: number); /** * Gets or sets the duration the highlighting/de-highlighting effects. * * The `HighlightingTransitionDuration` property is used to set the time for highlighting transition in milliseconds . * * ```ts * chart.HighlightingTransitionDuration=500; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * HighlightingTransitionDuration={500} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrAreaSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get highlightingTransitionDuration(): number; set highlightingTransitionDuration(v: number); /** * Gets or sets the milliseconds before the chart will fire the resize idle event after the last resize. */ get resizeIdleMilliseconds(): number; set resizeIdleMilliseconds(v: number); /** * Gets or sets the duration the selection/de-Selection effects. */ get selectionTransitionDuration(): number; set selectionTransitionDuration(v: number); /** * Gets or sets the amount of time to delay before dismissing a selection effect. */ get selectionDismissDelayMilliseconds(): number; set selectionDismissDelayMilliseconds(v: number); /** * Gets or sets the amount of time to delay before dismissing a selection effect. */ get highlightingDismissDelayMilliseconds(): number; set highlightingDismissDelayMilliseconds(v: number); /** * Gets or sets the amount of time to delay before dismissing a selection effect. */ get focusDismissDelayMilliseconds(): number; set focusDismissDelayMilliseconds(v: number); /** * Gets or sets the duration the Focus/de-Focus effects. */ get focusTransitionDuration(): number; set focusTransitionDuration(v: number); /** * Gets or sets the duration of the scrollbar effects. */ get scrollbarsAnimationDuration(): number; set scrollbarsAnimationDuration(v: number); /** * Gets or sets the whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction. */ get isPagePanningAllowed(): boolean; set isPagePanningAllowed(v: boolean); /** * Determines the method of hit testing used when mousing over elements in the chart. * * ```ts * this.chart.contentHitTestMode = ChartHitTestMode.Computational; * ``` */ get contentHitTestMode(): ChartHitTestMode; set contentHitTestMode(v: ChartHitTestMode); /** * Resolved method of hit testing used when the pointer is over elements in the chart. * * ```ts * let actualContentHitTestMode: ChartHitTestMode =this.chart.actualContentHitTestMode; * ``` */ get actualContentHitTestMode(): ChartHitTestMode; set actualContentHitTestMode(v: ChartHitTestMode); /** * Gets or sets whether all surface interactions with the plot area should be disabled. * * The `IsSurfaceInteractionDisabled` property is used to enable/disable interactions with the plot surface. * * ```ts * chart.isSurfaceInteractionDisabled=true; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * isSurfaceInteractionDisabled={true} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrAreaSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get isSurfaceInteractionDisabled(): boolean; set isSurfaceInteractionDisabled(v: boolean); /** * Indicates if this SeriesViewer is a map. */ get isMap(): boolean; /** * The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. * * The `WindowResponse` property is used to set the response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. * The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. * * ```ts * this.chart.windowResponse="deferred"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * windowResponse="deferred"> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get windowResponse(): WindowResponse; set windowResponse(v: WindowResponse); /** * Sets or gets the minimum width that the window rect is allowed to reach before being clamped. * Decrease this value if you want to allow for further zooming into the viewer. * If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. * This property accepts values between 0.0 (max zooming) and 1.0 (no zooming) * * The `WindowRectMinWidth` property is used to set or get the minimum width that the window rect is allowed to reach before being clamped. * * ```ts * this.chart.WindowRectMinWidth=".2"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * WindowRectMinWidth=".2"> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get windowRectMinWidth(): number; set windowRectMinWidth(v: number); /** * Sets or gets the minimum height that the window rect is allowed to reach before being clamped. * Decrease this value if you want to allow for further zooming into the viewer. * If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. * This property accepts values between 0.0 (max zooming) and 1.0 (no zooming) */ get windowRectMinHeight(): number; set windowRectMinHeight(v: number); /** * Gets the actual minimum width that the window rect is allowed to reach before being clamped. */ get actualWindowRectMinWidth(): number; set actualWindowRectMinWidth(v: number); /** * Gets the actual minimum height that the window rect is allowed to reach before being clamped. */ get actualWindowRectMinHeight(): number; set actualWindowRectMinHeight(v: number); /** * Sets or gets minimum pixel width that the window is allowed to reach before being clamped. * Decrease this value if you want to allow for further zooming into the viewer. * If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. * This property is overridden by the WindowRectMinWidth property */ get windowSizeMinWidth(): number; set windowSizeMinWidth(v: number); /** * Sets or gets minimum pixel height that the window is allowed to reach before being clamped. * Decrease this value if you want to allow for further zooming into the viewer. * If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. * This property is overridden by the WindowRectMinHeight property */ get windowSizeMinHeight(): number; set windowSizeMinHeight(v: number); /** * Gets or sets the current SeriesViewer's crosshair visibility override. * * The `CrosshairVisibility` property is used to gets or sets the current Chart's crosshair visibility override. Note: setting this property does not affect the mobile browser version of the chart. * * ```ts * this.chart.crosshairVisibility = Visibility.Visible; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * crosshairVisibility="visible" * crosshairPoint={x:.8,y:.2} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrAreaSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get crosshairVisibility(): Visibility; set crosshairVisibility(v: Visibility); /** * Gets or sets the current SeriesViewer's crosshair horizontal brush override. */ get horizontalCrosshairBrush(): string; set horizontalCrosshairBrush(v: string); /** * Gets or sets the current SeriesViewer's crosshair vertical brush override. */ get verticalCrosshairBrush(): string; set verticalCrosshairBrush(v: string); /** * Gets or sets zoom is constrained to within the axes. Setting this to false is a preview feature at the present time. */ get zoomCoercionMode(): ZoomCoercionMode; set zoomCoercionMode(v: ZoomCoercionMode); /** * Gets or sets the brush used as the background for the current SeriesViewer object's plot area. * * `PlotAreaBackground` property set the background brush to the current Chart object's plot area. * * ```ts * this.chart.plotAreaBackground="#F0F8FF"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * plotAreaBackground="#F0F8FF" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get plotAreaBackground(): string; set plotAreaBackground(v: string); /** * Gets or sets whether to match the z order of the series to their positional order in the series collection, regardless of mutation. */ get shouldMatchZOrderToSeriesOrder(): boolean; set shouldMatchZOrderToSeriesOrder(v: boolean); /** * Gets or sets the DefaultInteraction property. * The default interaction state defines the SeriesViewer's response to mouse events. * * The default interaction state defines the chart's response to mouse events. * * ```ts * this.chart.defaultInteraction = InteractionState.DragPan; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * defaultInteraction="dragPan" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrAreaSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get defaultInteraction(): InteractionState; set defaultInteraction(v: InteractionState); /** * Gets or sets the InteractionOverride property. * The interaction override overrides the default interaction and modifiers keys and defines the SeriesViewer's response to mouse events. */ get interactionOverride(): InteractionState; set interactionOverride(v: InteractionState); /** * Gets or sets the RightButtonDefaultInteraction property. * The default interaction state defines the SeriesViewer's response to right button mouse events. */ get rightButtonDefaultInteraction(): InteractionState; set rightButtonDefaultInteraction(v: InteractionState); /** * Gets or sets the current SeriesViewer's DragModifier property. * * `DragModifier` is useful to enable zooming when zooming is not the default interaction. * * ```ts * this.chart.dragModifier = ModifierKeys.Alt; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * isHorizontalZoomEnabled=true * defaultInteraction="dragPan" * dragModifier="alt" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get dragModifier(): ModifierKeys; set dragModifier(v: ModifierKeys); /** * Gets or sets the current SeriesViewer's PanModifier property. * * `PanModifier` is useful to enable panning when panning is not the default interaction. * * ```ts * this.chart.panModifier = ModifierKeys.Alt; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * isHorizontalZoomEnabled=true * defaultInteraction="dragZoom" * panModifier="alt" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get panModifier(): ModifierKeys; set panModifier(v: ModifierKeys); /** * Gets or sets the current SeriesViewer's SelectionModifier property. */ get selectionModifier(): ModifierKeys; set selectionModifier(v: ModifierKeys); /** * Gets or sets the preview rectangle. * The preview rectangle may be set to Rect.Empty, in which case the visible preview * strokePath is hidden. * * `PreviewRect` can be used to highlight an area of importance. * * ```ts * this.chart.previewRect = {left:0,top:0,height:.5,width:.5}; * ``` */ get previewRect(): IgRect; set previewRect(v: IgRect); /** * Gets or sets whether and how to display highlighted values for the series by default. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse. */ get highlightedValuesDisplayMode(): SeriesHighlightedValuesDisplayMode; set highlightedValuesDisplayMode(v: SeriesHighlightedValuesDisplayMode); 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); /** * A number between 0 and 1 determining the position of the horizontal scroll. * This property is effectively a shortcut to the X position of the WindowRect property. * * ```ts * this.chart.windowPositionHorizontal = .2; * ``` */ get windowPositionHorizontal(): number; set windowPositionHorizontal(v: number); /** * A number between 0 and 1 determining the position of the vertical scroll. * This property is effectively a shortcut to the Y position of the WindowRect property. * * ```ts * this.chart.windowPositionVertical = .2; * ``` */ get windowPositionVertical(): number; set windowPositionVertical(v: number); /** * 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); /** * Text to display above the plot area. * * The `Title` property is used to set the title to display for the component. * * ```ts * this.chart.title="Items Sold"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * title="Items Sold" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get chartTitle(): string; set chartTitle(v: string); /** * Gets or sets the TitleHorizontalAlignment property. * * The `subtitleHorizontalAlignment` property is used to set horizontal alignment for the subtitle. * * ```ts * this.chart.titleHorizontalAlignment="left"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * titleHorizontalAlignment="left" * subtitleHorizontalAlignment="left" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get titleHorizontalAlignment(): HorizontalAlignment; set titleHorizontalAlignment(v: HorizontalAlignment); /** * Gets or sets the SubtitleHorizontalAlignment property. * * The `subtitleBottomMargin` property is used to set the horizontal alignment for the subtitle. * * ```ts * this.chart.subtitleHorizontalAlignment="left"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * subtitleHorizontalAlignment="left" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get subtitleHorizontalAlignment(): HorizontalAlignment; set subtitleHorizontalAlignment(v: HorizontalAlignment); /** * Font settings for the title. */ get titleTextStyle(): string; set titleTextStyle(v: string); /** * Font settings for the subtitle. */ get subtitleTextStyle(): string; set subtitleTextStyle(v: string); /** * Gets or sets the Color used for the Title Text. * * The `titleTextColor` property is used to set the title brush. * * ```ts * this.chart.titleTextColor="blue" ; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * titleTextColor="blue" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get titleTextColor(): string; set titleTextColor(v: string); /** * Gets or sets the Color used for the Subtitle Text. * * The `subtitleTextColor` property is used to set the color for the subtitle. * * ```ts * this.chart.subtitleTextColor="blue"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * title="Date of Sale: 1/1/2018" * subtitleTextColor="blue"> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get subtitleTextColor(): string; set subtitleTextColor(v: string); /** * Margin applied above the title. * * The `titleTopMargin` property is used to set the top margin for the title. * * ```ts * this.chart.titleTopMargin=10; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * titleLeftMarging= {10} * titleTopMargin= {10 } * titleRightMargin= {10} * titleBottomMargin= {20}> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get titleTopMargin(): number; set titleTopMargin(v: number); /** * Margin applied to the left of the title. * * The `titleLeftMarging` property is used to set the left margin for the title. * * ```ts * this.chart.titleLeftMarging=10; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * title="Items Sold" * titleLeftMarging={10} * titleTopMargin={10} * titleRightMargin={10} * titleBottomMargin= {20} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get titleLeftMargin(): number; set titleLeftMargin(v: number); /** * Margin applied to the right of the title. * * The `titleRightMargin` property is used to set the right margin for the title. * * ```ts * this.chart.titleRightMargin=10; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * titleLeftMarging= {10} * titleTopMargin= {10 } * titleRightMargin= {10} * titleBottomMargin= {20} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get titleRightMargin(): number; set titleRightMargin(v: number); /** * Margin applied below the title. * * The `titleBottomMargin` property is used to set the bottom margin for the title. * * ```ts * this.chart.titleBottomMargin=20; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * title="Items Sold" * titleLeftMarging= {10} * titleTopMargin= {10 } * titleRightMargin= {10} * titleBottomMargin= {20}> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get titleBottomMargin(): number; set titleBottomMargin(v: number); /** * Margin applied above the subtitle. * * The `subtitleTopMargin` property is used to set the top margin for the subtitle. * * ```ts * this.chart.subtitleTopMargin =10; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * subtitleLeftMarging= {10} * subtitleTopMargin={10} * subtitleRightMargin={10} * subtitleBottomMargin={20}> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get subtitleTopMargin(): number; set subtitleTopMargin(v: number); /** * Margin applied to the left of the subtitle. * * The `subtitleLeftMarging` property is used to set the left margin for the subtitle. * * ```ts * this.chart.subtitleLeftMarging=10; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * subtitleLeftMarging= {10} * subtitleTopMargin={10} * subtitleRightMargin={10} * subtitleBottomMargin={20}> * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get subtitleLeftMargin(): number; set subtitleLeftMargin(v: number); /** * Margin applied to the right of the subtitle. * * The `subTitleRightMargin` property is used to set the right margin for the subtitle. * * ```ts * this.chart.subtitleLeftMarging=10; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * subtitleLeftMarging= {10} * subtitleTopMargin= {10} * subtitleRightMargin={10} * subtitleBottomMargin={20} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get subtitleRightMargin(): number; set subtitleRightMargin(v: number); /** * Margin applied below the subtitle. * * The `subtitleBottomMargin` property is used to set the bottom margin for the subtitle. * * ```ts * this.chart.subtitleBottomMargin = 20; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * subtitleBottomMargin={20} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get subtitleBottomMargin(): number; set subtitleBottomMargin(v: number); /** * Gets or sets the Subtitle property. * The Title property defines the Subtitle of the chart * * The `Subtitle` property is used to display subtitle for the component. * * ```ts * this.chart.subtitle="Date of Sale: 1/1/2018"; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * subtitle="Date of Sale: 1/1/2018" > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get subtitle(): string; set subtitle(v: string); /** * Sets or gets the top margin to use around the chart content. * * The `topMargin` property is used to set the top margin. * * ```ts * this.chart.topMargin=30; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * leftMargin= {20} * rightMargin={20} * topMargin={30} * bottomMargin= {20} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get topMargin(): number; set topMargin(v: number); /** * Sets or gets the left margin to use around the chart content. * * The `LeftMargin` property is used to set the left margin. * * ```ts * this.chart.leftMargin = 20; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * leftMargin={20} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * /> * </IgrDataChart> * ``` */ get leftMargin(): number; set leftMargin(v: number); /** * Sets or gets the right margin to use around the chart content. * * The `RightMargin` property is used to set the left margin around the chart content in the canvas. * * ```ts * this.chart.rightMargin=20; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * leftMargin= {20} * rightMargin={20} * topMargin={30} * bottomMargin={20} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrLineSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" /> * </IgrDataChart> * ``` */ get rightMargin(): number; set rightMargin(v: number); /** * Sets or gets the bottom margin to use around the chart content. * * The `bottomMargin` property is used to gets/set the bottom margin around the chart content in the canvas. * * ```ts * this.chart.bottomMargin = 50; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * bottomMargin={50} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrColumnSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get bottomMargin(): number; set bottomMargin(v: number); /** * Sets or gets the automatic width to add when automatically adding margins to the chart. * * The `autoMarginWidth` propertry is used find the automatic width to add when automatically adding margins to the chart. * * ```ts * this.chart.autoMarginWidth = 50; * ``` * * ```ts * <IgrDataChart * dataSource={this.state.dataSource} * autoMarginWidth={50} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrColumnSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get autoMarginWidth(): number; set autoMarginWidth(v: number); /** * Sets or gets the automatic height to add when automatically adding margins to the chart. * * ```ts * this.chart.autoMarginHeight = 50; * ``` * * ```ts * <IgrDataChart * autoMarginHeight={50} * dataSource={this.state.dataSource} > * * <IgrNumericXAxis name="xAxis" /> * <IgrNumericYAxis name="yAxis" /> * * <IgrAreaSeries * name="series1" * xAxisName="xAxis" * yAxisName="yAxis" * valueMemberPath="Value" * brush="Gray" * outline="Black" /> * </IgrDataChart> * ``` */ get autoMarginHeight(): number; set autoMarginHeight(v: number); /** * Gets or sets the IsAntiAliasingEnabledDuringInteraction property. */ get isAntiAliasingEnabledDuringInteraction():