igniteui-angular-charts
Version:
Ignite UI Angular charting components for building rich data visualizations for modern web apps.
1,246 lines • 89 kB
TypeScript
import { EventEmitter, OnInit } from '@angular/core';
import { IgRect } from "igniteui-angular-core";
import { IgPoint } from "igniteui-angular-core";
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-angular-core";
import { LegendItemBadgeMode } from "igniteui-angular-core";
import { ChartHitTestMode } from "./ChartHitTestMode";
import { WindowResponse } from "./WindowResponse";
import { Visibility } from "igniteui-angular-core";
import { ZoomCoercionMode } from "./ZoomCoercionMode";
import { InteractionState } from "igniteui-angular-core";
import { ModifierKeys } from "igniteui-angular-core";
import { SeriesHighlightedValuesDisplayMode } from "igniteui-angular-core";
import { IgxChartSelectedItemCollection } from "./igx-chart-selected-item-collection";
import { HorizontalAlignment } from "igniteui-angular-core";
import { IgxPlotAreaMouseButtonEventArgs } from "./igx-plot-area-mouse-button-event-args";
import { IgxPlotAreaMouseEventArgs } from "./igx-plot-area-mouse-event-args";
import { IgxChartCursorEventArgs } from "./igx-chart-cursor-event-args";
import { IgxDataChartMouseButtonEventArgs } from "./igx-data-chart-mouse-button-event-args";
import { IgxChartMouseEventArgs } from "./igx-chart-mouse-event-args";
import { IgxSeriesViewerManipulationEventArgs } from "./igx-series-viewer-manipulation-event-args";
import { IgxRectChangedEventArgs } from "igniteui-angular-core";
import { IgxSeriesViewerSelectedSeriesItemsChangedEventArgs } from "./igx-series-viewer-selected-series-items-changed-event-args";
import { IgxRefreshCompletedEventArgs } from "./igx-refresh-completed-event-args";
import { IgxImageCapturedEventArgs } from "igniteui-angular-core";
import { IgxSeriesComponent } from "./igx-series-component";
import { IgxCaptureImageSettings } from "igniteui-angular-core";
import { SeriesViewer } from "./SeriesViewer";
import { ToolActionInfo } from "igniteui-angular-core";
import { ICommandAvailabilityListener } from "igniteui-angular-core";
import { ICommandStateChangedListener } from "igniteui-angular-core";
import * as i0 from "@angular/core";
/**
* Represents a control for viewing series objects.
*/
export declare abstract class IgxSeriesViewerComponent implements OnInit {
protected createImplementation(): SeriesViewer;
ngOnInit(): void;
protected _implementation: any;
/**
* @hidden
*/
get i(): SeriesViewer; /**
* @hidden
*/
static _createFromInternal(internal: any): IgxSeriesViewerComponent;
private onImplementationCreated;
constructor();
/**
* 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[]);
static ngAcceptInputType_brushes: string[] | 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[]);
static ngAcceptInputType_outlines: string[] | 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[]);
static ngAcceptInputType_markerBrushes: string[] | 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[]);
static ngAcceptInputType_markerOutlines: string[] | 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);
static ngAcceptInputType_markerAutomaticBehavior: MarkerAutomaticBehavior | string;
/**
* 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).
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* crosshairVisibility="visible"
* crosshairPoint={x:.8,y:.2}>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.crosshairPoint = {x:.8,y:.2};
* ```
*/
get crosshairPoint(): IgPoint;
set crosshairPoint(v: IgPoint);
static ngAcceptInputType_crosshairPoint: IgPoint | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* animateSeriesWhenAxisRangeChanges=true>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value"
* transitionInMode="accordionFromBottom"
* isTransitionInEnabled=true
* transitionInSpeedType="indexScaled"
* transitionDuration=1000>
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.animateSeriesWhenAxisRangeChanges = true;
* ```
*/
get animateSeriesWhenAxisRangeChanges(): boolean;
set animateSeriesWhenAxisRangeChanges(v: boolean);
static ngAcceptInputType_animateSeriesWhenAxisRangeChanges: boolean | string;
/**
* 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);
static ngAcceptInputType_seriesValueLayerUseLegend: boolean | string;
/**
* 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);
static ngAcceptInputType_isWindowSyncedToVisibleRange: boolean | string;
/**
* Gets or sets whether calling SimulateHover should shift the crosshair point.
*/
get shouldSimulateHoverMoveCrosshairPoint(): boolean;
set shouldSimulateHoverMoveCrosshairPoint(v: boolean);
static ngAcceptInputType_shouldSimulateHoverMoveCrosshairPoint: boolean | string;
/**
* 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);
static ngAcceptInputType_highlightingMode: SeriesHighlightingMode | string;
/**
* Gets or sets the selection mode to use for the series in the component, when supported.
*/
get selectionMode(): SeriesSelectionMode;
set selectionMode(v: SeriesSelectionMode);
static ngAcceptInputType_selectionMode: SeriesSelectionMode | string;
/**
* Gets or sets the selection behavior to use for the series in the component, when supported.
*/
get selectionBehavior(): SeriesSelectionBehavior;
set selectionBehavior(v: SeriesSelectionBehavior);
static ngAcceptInputType_selectionBehavior: SeriesSelectionBehavior | string;
/**
* Gets or sets the focus mode to use for the series in the component, when supported.
*/
get focusMode(): SeriesSelectionMode;
set focusMode(v: SeriesSelectionMode);
static ngAcceptInputType_focusMode: SeriesSelectionMode | string;
/**
* Gets or sets the horizontal scrollbar mode to use for the series viewer.
*/
get horizontalViewScrollbarMode(): SeriesViewerScrollbarMode;
set horizontalViewScrollbarMode(v: SeriesViewerScrollbarMode);
static ngAcceptInputType_horizontalViewScrollbarMode: SeriesViewerScrollbarMode | string;
/**
* Gets or sets the vertical scrollbar mode to use for the series viewer.
*/
get verticalViewScrollbarMode(): SeriesViewerScrollbarMode;
set verticalViewScrollbarMode(v: SeriesViewerScrollbarMode);
static ngAcceptInputType_verticalViewScrollbarMode: SeriesViewerScrollbarMode | string;
/**
* Gets or sets the position to use for the horizontal scrollbar in the component, when enabled.
*/
get horizontalViewScrollbarPosition(): SeriesViewerHorizontalScrollbarPosition;
set horizontalViewScrollbarPosition(v: SeriesViewerHorizontalScrollbarPosition);
static ngAcceptInputType_horizontalViewScrollbarPosition: SeriesViewerHorizontalScrollbarPosition | string;
/**
* Gets or sets the position to use for the vertical scrollbar in the component, when enabled.
*/
get verticalViewScrollbarPosition(): SeriesViewerVerticalScrollbarPosition;
set verticalViewScrollbarPosition(v: SeriesViewerVerticalScrollbarPosition);
static ngAcceptInputType_verticalViewScrollbarPosition: SeriesViewerVerticalScrollbarPosition | string;
/**
* 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);
static ngAcceptInputType_horizontalViewScrollbarStrokeThickness: number | string;
/**
* Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled.
*/
get horizontalViewScrollbarMaxOpacity(): number;
set horizontalViewScrollbarMaxOpacity(v: number);
static ngAcceptInputType_horizontalViewScrollbarMaxOpacity: number | string;
/**
* Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled.
*/
get horizontalViewScrollbarCornerRadius(): number;
set horizontalViewScrollbarCornerRadius(v: number);
static ngAcceptInputType_horizontalViewScrollbarCornerRadius: number | string;
/**
* Gets or sets the height to use for the horizontal scrollbar in the component, when enabled.
*/
get horizontalViewScrollbarHeight(): number;
set horizontalViewScrollbarHeight(v: number);
static ngAcceptInputType_horizontalViewScrollbarHeight: number | string;
/**
* Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled.
*/
get horizontalViewScrollbarInset(): number;
set horizontalViewScrollbarInset(v: number);
static ngAcceptInputType_horizontalViewScrollbarInset: number | string;
/**
* 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);
static ngAcceptInputType_horizontalViewScrollbarTrackStartInset: number | string;
/**
* 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);
static ngAcceptInputType_horizontalViewScrollbarTrackEndInset: number | string;
/**
* 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);
static ngAcceptInputType_horizontalViewScrollbarShouldAddAutoTrackInsets: boolean | string;
/**
* 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);
static ngAcceptInputType_verticalViewScrollbarStrokeThickness: number | string;
/**
* Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled.
*/
get verticalViewScrollbarMaxOpacity(): number;
set verticalViewScrollbarMaxOpacity(v: number);
static ngAcceptInputType_verticalViewScrollbarMaxOpacity: number | string;
/**
* Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled.
*/
get verticalViewScrollbarCornerRadius(): number;
set verticalViewScrollbarCornerRadius(v: number);
static ngAcceptInputType_verticalViewScrollbarCornerRadius: number | string;
/**
* Gets or sets the width to use for the vertical scrollbar in the component, when enabled.
*/
get verticalViewScrollbarWidth(): number;
set verticalViewScrollbarWidth(v: number);
static ngAcceptInputType_verticalViewScrollbarWidth: number | string;
/**
* Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled.
*/
get verticalViewScrollbarInset(): number;
set verticalViewScrollbarInset(v: number);
static ngAcceptInputType_verticalViewScrollbarInset: number | string;
/**
* 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);
static ngAcceptInputType_verticalViewScrollbarTrackStartInset: number | string;
/**
* 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);
static ngAcceptInputType_verticalViewScrollbarTrackEndInset: number | string;
/**
* 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);
static ngAcceptInputType_verticalViewScrollbarShouldAddAutoTrackInsets: boolean | string;
/**
* 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);
static ngAcceptInputType_highlightingBehavior: SeriesHighlightingBehavior | string;
/**
* Gets or sets the highlighting mode to use for the legend linked to the component, when supported.
*/
get legendHighlightingMode(): LegendHighlightingMode;
set legendHighlightingMode(v: LegendHighlightingMode);
static ngAcceptInputType_legendHighlightingMode: LegendHighlightingMode | string;
/**
* 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);
static ngAcceptInputType_legendItemBadgeShape: LegendItemBadgeShape | string;
/**
* 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);
static ngAcceptInputType_legendItemBadgeMode: LegendItemBadgeMode | string;
/**
* Gets the viewport rectangle associated with the SeriesViewer, the physical dimensions of the plot area.
*
* ```ts
* let viewPortRect: IgxRect = this.chart.viewportRect;
* ```
*/
get viewportRect(): IgRect;
static ngAcceptInputType_viewportRect: IgRect | string;
/**
* 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);
static ngAcceptInputType_effectiveViewport: IgRect | string;
/**
* 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.
*
* ```ts
* let contentViewport: IgxRect = this.chart.contentViewport;
* ```
*/
get contentViewport(): IgRect;
static ngAcceptInputType_contentViewport: IgRect | string;
/**
* 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);
static ngAcceptInputType_windowRect: IgRect | string;
/**
* 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);
static ngAcceptInputType_useTiledZooming: boolean | string;
/**
* 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);
static ngAcceptInputType_preferHigherResolutionTiles: boolean | string;
/**
* 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);
static ngAcceptInputType_zoomTileCacheSize: number | string;
/**
* Gets or sets the duration the highlighting/de-highlighting effects.
*
* The `HighlightingTransitionDuration` property is used to set the time for highlighting transition in milliseconds .
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* HighlightingTransitionDuration=500 >
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value" >
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* chart.HighlightingTransitionDuration=500;
* ```
*/
get highlightingTransitionDuration(): number;
set highlightingTransitionDuration(v: number);
static ngAcceptInputType_highlightingTransitionDuration: number | string;
/**
* Gets or sets the duration the selection/de-Selection effects.
*/
get selectionTransitionDuration(): number;
set selectionTransitionDuration(v: number);
static ngAcceptInputType_selectionTransitionDuration: number | string;
/**
* Gets or sets the duration the Focus/de-Focus effects.
*/
get focusTransitionDuration(): number;
set focusTransitionDuration(v: number);
static ngAcceptInputType_focusTransitionDuration: number | string;
/**
* Gets or sets the duration of the scrollbar effects.
*/
get scrollbarsAnimationDuration(): number;
set scrollbarsAnimationDuration(v: number);
static ngAcceptInputType_scrollbarsAnimationDuration: number | string;
/**
* 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);
static ngAcceptInputType_isPagePanningAllowed: boolean | string;
/**
* 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);
static ngAcceptInputType_contentHitTestMode: ChartHitTestMode | string;
/**
* 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);
static ngAcceptInputType_actualContentHitTestMode: ChartHitTestMode | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* isSurfaceInteractionDisabled=true>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* chart.isSurfaceInteractionDisabled=true;
* ```
*/
get isSurfaceInteractionDisabled(): boolean;
set isSurfaceInteractionDisabled(v: boolean);
static ngAcceptInputType_isSurfaceInteractionDisabled: boolean | string;
/**
* Indicates if this SeriesViewer is a map.
*/
get isMap(): boolean;
static ngAcceptInputType_isMap: boolean | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* isHorizontalZoomEnabled=true
* windowResponse="deferred">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.windowResponse="deferred";
* ```
*/
get windowResponse(): WindowResponse;
set windowResponse(v: WindowResponse);
static ngAcceptInputType_windowResponse: WindowResponse | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* isHorizontalZoomEnabled=true
* windowRectMinWidth=.2>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.WindowRectMinWidth=".2";
* ```
*/
get windowRectMinWidth(): number;
set windowRectMinWidth(v: number);
static ngAcceptInputType_windowRectMinWidth: number | string;
/**
* 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);
static ngAcceptInputType_windowRectMinHeight: number | string;
/**
* Gets the actual minimum width that the window rect is allowed to reach before being clamped.
*/
get actualWindowRectMinWidth(): number;
set actualWindowRectMinWidth(v: number);
static ngAcceptInputType_actualWindowRectMinWidth: number | string;
/**
* Gets the actual minimum height that the window rect is allowed to reach before being clamped.
*/
get actualWindowRectMinHeight(): number;
set actualWindowRectMinHeight(v: number);
static ngAcceptInputType_actualWindowRectMinHeight: number | string;
/**
* 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);
static ngAcceptInputType_windowSizeMinWidth: number | string;
/**
* 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);
static ngAcceptInputType_windowSizeMinHeight: number | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* crosshairVisibility="visible">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.crosshairVisibility = Visibility.Visible;
* ```
*/
get crosshairVisibility(): Visibility;
set crosshairVisibility(v: Visibility);
static ngAcceptInputType_crosshairVisibility: Visibility | string;
/**
* 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);
static ngAcceptInputType_zoomCoercionMode: ZoomCoercionMode | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* plotAreaBackground="#F0F8FF">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.plotAreaBackground="#F0F8FF";
* ```
*/
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);
static ngAcceptInputType_shouldMatchZOrderToSeriesOrder: boolean | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* isHorizontalZoomEnabled=true
* defaultInteraction="dragPan">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.defaultInteraction = InteractionState.DragPan;
* ```
*/
get defaultInteraction(): InteractionState;
set defaultInteraction(v: InteractionState);
static ngAcceptInputType_defaultInteraction: InteractionState | string;
/**
* 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);
static ngAcceptInputType_interactionOverride: InteractionState | string;
/**
* 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);
static ngAcceptInputType_rightButtonDefaultInteraction: InteractionState | string;
/**
* Gets or sets the current SeriesViewer's DragModifier property.
*
* `DragModifier` is useful to enable zooming when zooming is not the default interaction.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* isHorizontalZoomEnabled=true
* defaultInteraction="dragPan"
* dragModifier="alt">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.dragModifier = ModifierKeys.Alt;
* ```
*/
get dragModifier(): ModifierKeys;
set dragModifier(v: ModifierKeys);
static ngAcceptInputType_dragModifier: ModifierKeys | string;
/**
* Gets or sets the current SeriesViewer's PanModifier property.
*
* `PanModifier` is useful to enable panning when panning is not the default interaction.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* isHorizontalZoomEnabled=true
* defaultInteraction="dragZoom"
* panModifier="alt">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-line-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-line-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.panModifier = ModifierKeys.Alt;
* ```
*/
get panModifier(): ModifierKeys;
set panModifier(v: ModifierKeys);
static ngAcceptInputType_panModifier: ModifierKeys | string;
/**
* Gets or sets the current SeriesViewer's SelectionModifier property.
*/
get selectionModifier(): ModifierKeys;
set selectionModifier(v: ModifierKeys);
static ngAcceptInputType_selectionModifier: ModifierKeys | string;
/**
* 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);
static ngAcceptInputType_previewRect: IgRect | string;
/**
* 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);
static ngAcceptInputType_highlightedValuesDisplayMode: SeriesHighlightedValuesDisplayMode | string;
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(): IgxChartSelectedItemCollection;
set selectedSeriesItems(v: IgxChartSelectedItemCollection);
static ngAcceptInputType_selectedSeriesItems: IgxChartSelectedItemCollection | string;
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(): IgxChartSelectedItemCollection;
set focusedSeriesItems(v: IgxChartSelectedItemCollection);
static ngAcceptInputType_focusedSeriesItems: IgxChartSelectedItemCollection | string;
/**
* 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);
static ngAcceptInputType_windowPositionHorizontal: number | string;
/**
* 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);
static ngAcceptInputType_windowPositionVertical: number | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.title="Items Sold";
* ```
*/
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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* subtitle="date of sale: 1/1/2018"
* titleHorizontalAlignment="left"
* subtitleHorizontalAlignment="left">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.titleHorizontalAlignment="left";
* ```
*/
get titleHorizontalAlignment(): HorizontalAlignment;
set titleHorizontalAlignment(v: HorizontalAlignment);
static ngAcceptInputType_titleHorizontalAlignment: HorizontalAlignment | string;
/**
* Gets or sets the SubtitleHorizontalAlignment property.
*
* The `subtitleBottomMargin` property is used to set the horizontal alignment for the subtitle.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* subtitle="Date of Sale: 1/1/2018"
* titleHorizontalAlignment="left"
* subtitleHorizontalAlignment="left">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.subtitleHorizontalAlignment="left";
* ```
*/
get subtitleHorizontalAlignment(): HorizontalAlignment;
set subtitleHorizontalAlignment(v: HorizontalAlignment);
static ngAcceptInputType_subtitleHorizontalAlignment: HorizontalAlignment | string;
/**
* 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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* subtitle="date of sale: 1/1/2018"
* titleTextColor="blue">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.titleTextColor="blue" ;
* ```
*/
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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* subtitle="Date of Sale: 1/1/2018"
* subtitleTextColor="blue">
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.subtitleTextColor="blue";
* ```
*/
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.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* titleLeftMarging=10
* titleTopMargin=10
* titleRightMargin=10
* titleBottomMargin=20>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.titleTopMargin=10;
* ```
*/
get titleTopMargin(): number;
set titleTopMargin(v: number);
static ngAcceptInputType_titleTopMargin: number | string;
/**
* Margin applied to the left of the title.
*
* The `titleLeftMarging` property is used to set the left margin for the title.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* titleLeftMarging=10
* titleTopMargin=10
* titleRightMargin=10
* titleBottomMargin=20>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.titleLeftMarging=10;
* ```
*/
get titleLeftMargin(): number;
set titleLeftMargin(v: number);
static ngAcceptInputType_titleLeftMargin: number | string;
/**
* Margin applied to the right of the title.
*
* The `titleRightMargin` property is used to set the right margin for the title.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* titleLeftMarging=10
* titleTopMargin=10
* titleRightMargin=10
* titleBottomMargin=20>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.titleRightMargin=10;
* ```
*/
get titleRightMargin(): number;
set titleRightMargin(v: number);
static ngAcceptInputType_titleRightMargin: number | string;
/**
* Margin applied below the title.
*
* The `titleBottomMargin` property is used to set the bottom margin for the title.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* titleLeftMarging=10
* titleTopMargin=10
* titleRightMargin=10
* titleBottomMargin=20>
* <igx-category-x-axis
* label="label"
* #xAxis>
* </igx-category-x-axis>
* <igx-numeric-y-axis
* #yAxis>
* </igx-numeric-y-axis>
* <igx-column-series
* [xAxis]="xAxis"
* [yAxis]="yAxis"
* valueMemberPath="value">
* </igx-column-series>
* </igx-data-chart>
* ```
*
* ```ts
* this.chart.titleBottomMargin=20;
* ```
*/
get titleBottomMargin(): number;
set titleBottomMargin(v: number);
static ngAcceptInputType_titleBottomMargin: number | string;
/**
* Margin applied above the subtitle.
*
* The `subtitleTopMargin` property is used to set the top margin for the subtitle.
*
* ```html
* <igx-data-chart
* [dataSource]="data"
* title="Items Sold"
* subtitle="date of sale: 1/1/2018"
* subtitleLeftMarging=10
* subtitleTopMargin=10
* subtitleRightMargin=10
* subtitleBottomMargin=20>
* <igx-category-x-axis
* label="la