igniteui-webcomponents-charts 3.2.3 → 3.2.4

package/lib/igc-chart-summary-description.d.ts

@@ -0,0 +1,35 @@
+import { SummaryOperand } from "igniteui-webcomponents-core";
+import { IgcProvideCalculatorEventArgs } from "igniteui-webcomponents-core";
+import { ChartSummaryDescription as ChartSummaryDescription_internal } from "./ChartSummaryDescription";
+/**
+ * Represents a summary that is applied to a datasource. Changes to this object are not observed or expected after it is initially assigned to a collection.
+*/
+export declare class IgcChartSummaryDescription {
+    protected createImplementation(): ChartSummaryDescription_internal;
+    protected _implementation: any;
+    /**
+     * @hidden
+     */
+    readonly i: ChartSummaryDescription_internal;
+    private onImplementationCreated;
+    constructor();
+    protected _provideImplementation(i: any): void;
+    field: string;
+    operand: SummaryOperand;
+    /**
+     * Gets or sets an alias for the summary. Currently only used in aggregated data situations.
+    */
+    alias: string;
+    /**
+     * Gets or sets the name to use when displaying the calculator name.
+    */
+    calculatorDisplayName: string;
+    findByName(name: string): any;
+    equals(other: any): boolean;
+    private _provideCalculator;
+    private _provideCalculator_wrapped;
+    /**
+     * Called when the summary calculator is required.
+    */
+    provideCalculator: (s: IgcChartSummaryDescription, e: IgcProvideCalculatorEventArgs) => void;
+}

package/lib/igc-data-legend-component.d.ts

@@ -113,7 +113,7 @@ export declare class IgcDataLegendComponent extends IgcHTMLElement {
     */
     valueFormatCurrencyCode: string;
     /**
-     * Gets or sets whether or not use groupping sperator, e.g, 15,000 for 15000
+     * 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
     */
     valueFormatUseGrouping: boolean;

package/lib/igc-data-tool-tip-layer-component.d.ts

@@ -133,7 +133,7 @@ export declare class IgcDataToolTipLayerComponent extends IgcAnnotationLayerComp
     */
     valueFormatCulture: string;
     /**
-     * Gets or sets whether or not use groupping sperator, e.g, 15,000 for 15000
+     * 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
     */
     valueFormatUseGrouping: boolean;

package/lib/igc-domain-chart-component.d.ts

@@ -39,6 +39,9 @@ import { IgcCalloutRenderStyleUpdatingEventArgs } from './igc-callout-render-sty
 import { DataToolTipLayerGroupingMode } from "igniteui-webcomponents-core";
 import { DataTooltipGroupedPositionX } from "igniteui-webcomponents-core";
 import { DataTooltipGroupedPositionY } from "igniteui-webcomponents-core";
+import { IgcChartSummaryDescriptionCollection } from './igc-chart-summary-description-collection';
+import { IgcChartSortDescriptionCollection } from './igc-chart-sort-description-collection';
+import { IgcFilterExpressionCollection } from "igniteui-webcomponents-core";
 export declare abstract class IgcDomainChartComponent extends IgcHTMLElement {
     protected createImplementation(): DomainChart;
     protected _implementation: any;
@@ -336,7 +339,7 @@ export declare abstract class IgcDomainChartComponent extends IgcHTMLElement {
     */
     dataToolTipValueFormatCulture: string;
     /**
-     * Gets or sets whether or not use groupping sperator, e.g, 15,000 for 15000
+     * 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
     */
     dataToolTipValueFormatUseGrouping: boolean;
@@ -549,6 +552,55 @@ export declare abstract class IgcDomainChartComponent extends IgcHTMLElement {
      * Gets the domain type of this chart
     */
     readonly 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.
+    */
+    readonly sortDescriptions: IgcChartSortDescriptionCollection;
+    readonly groupSortDescriptions: IgcChartSortDescriptionCollection;
+    /**
+     * 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.
+    */
+    readonly groupDescriptions: IgcChartSortDescriptionCollection;
+    /**
+     * Gets the current filter that is applied to the grid. Collection can be updated to modify the filter for the grid. Once filter expresisons are in this collection, the grid will no longer listen for changes on their properties.
+    */
+    readonly filterExpressions: IgcFilterExpressionCollection;
+    /**
+     * Gets the current summaries that are applied to the grid.
+    */
+    readonly summaryDescriptions: IgcChartSummaryDescriptionCollection;
+    /**
+     * Gets the initial sorts that are applied to the chart.
+    */
+    readonly initialSortDescriptions: IgcChartSortDescriptionCollection;
+    /**
+     * Gets the initial sorts that are applied to the chart after groupings and summaries are applied.
+    */
+    readonly initialGroupSortDescriptions: IgcChartSortDescriptionCollection;
+    /**
+     * Gets the initial groupings that are applied to the chart.
+    */
+    readonly initialGroupDescriptions: IgcChartSortDescriptionCollection;
+    /**
+     * Gets the initial summaries that are applied to the chart.
+    */
+    readonly initialSummaryDescriptions: IgcChartSummaryDescriptionCollection;
+    /**
+     * Gets or sets the sorts to apply to the chart. This property will become ignored if sorts are changed outside of this property.
+    */
+    initialSorts: string;
+    /**
+     * Gets or sets the sorts to apply after grouping has been applied.
+    */
+    groupSorts: string;
+    /**
+     * Gets or sets the groupings to apply to the chart. This property will become ignored if sorts are changed outside of this property.
+    */
+    initialGroups: string;
+    /**
+     * Gets or sets the summaries to apply to the chart. This property will become ignored if sorts are changed outside of this property.
+    */
+    initialSummaries: string;
     /**
      * 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.
     *
@@ -939,6 +991,10 @@ export declare abstract class IgcDomainChartComponent extends IgcHTMLElement {
      * Gets or sets whether annotations for the final value of each series is displayed on the axis.
     */
     shouldAvoidAxisAnnotationCollisions: boolean;
+    /**
+     * Gets or sets a whether the chart should pan its content when zooing in passed max zoom level.
+    */
+    shouldPanOnMaximumZoom: boolean;
     /**
      * Gets or sets whether annotations for the final value of each series is displayed on the axis.
     */
@@ -1080,6 +1136,34 @@ export declare abstract class IgcDomainChartComponent extends IgcHTMLElement {
      * Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled.
     */
     verticalViewScrollbarShouldAddAutoTrackInsets: boolean;
+    /**
+     * 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)
+    */
+    windowRectMinWidth: 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)
+    */
+    windowRectMinHeight: 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
+    */
+    windowSizeMinWidth: 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
+    */
+    windowSizeMinHeight: number;
     findByName(name: string): any;
     protected __p: string;
     protected _hasUserValues: Set<string>;

package/lib/igc-financial-chart-component.d.ts

@@ -140,6 +140,33 @@ export declare class IgcFinancialChartComponent extends IgcXYChartComponent {
     * Use the `xAxisMode` property to plot data items without any breaks in data range (Ordinal mode) or with breaks in data range (Time mode) such as weekends/holidays. Note that the Ordinal axis mode is less expensive to use in the financial chart than the Time axis mode.
     */
     xAxisMode: FinancialChartXAxisMode;
+    /**
+     * Gets or sets number of visible categories at maximum zooming level
+     * This property works only with ordinal XAxisMode and it is overridden by chart's WindowRectMinWidth property
+    */
+    xAxisZoomMaximumCategoryRange: number;
+    /**
+     * Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items
+     * This property works only with ordinal XAxisMode and it is overridden by chart's WindowRect or WindowScaleHorizontal properties
+    */
+    xAxisZoomToCategoryStart: number;
+    /**
+     * Gets or sets maximum pixel span of series item that will be visible at maximum zooming level
+     * This property ensures that series item does not get stretch above specified value.
+     * This property works only with ordinal XAxisMode and it is overridden by chart's WindowRectMinWidth property
+    */
+    xAxisZoomMaximumItemSpan: number;
+    /**
+     * Gets or sets number of categories that the chart will zoom in and fill plot area
+     * This property is overridden by chart's WindowRect or WindowScaleHorizontal properties
+    */
+    xAxisZoomToCategoryRange: number;
+    /**
+     * Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span
+     * Chart will automaticlly zoom in until series item has specified pixel span.
+     * This property works only with ordinal XAxisMode and it is overridden by chart's WindowRect or WindowScaleHorizontal properties
+    */
+    xAxisZoomToItemSpan: number;
     /**
      * The scaling mode of the Y-axis.
     *

package/lib/igc-series-component.d.ts

@@ -502,6 +502,10 @@ export declare class IgcSeriesComponent extends IgcHTMLElement {
     * ```
     */
     isHighlightingEnabled: boolean;
+    /**
+     * Gets or sets whether this series should suppress it's auto callouts
+    */
+    shouldHideAutoCallouts: boolean;
     /**
      * Gets or sets whether drop shadow should be enabled for this series.
     *

package/lib/igc-series-viewer-component.d.ts

@@ -27,6 +27,9 @@ import { IgcRectChangedEventArgs } from "igniteui-webcomponents-core";
 import { IgcRefreshCompletedEventArgs } from "./igc-refresh-completed-event-args";
 import { IgcSeriesComponent } from "./igc-series-component";
 import { SeriesViewer } from "./SeriesViewer";
+import { ToolActionInfo } from "igniteui-webcomponents-core";
+import { ToolCommand } from "igniteui-webcomponents-core";
+import { ICommandAvailabilityListener } from "igniteui-webcomponents-core";
 /**
  * Represents a control for viewing series objects.
 */
@@ -331,6 +334,7 @@ export declare abstract class IgcSeriesViewerComponent extends IgcHTMLElement {
      * 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.
     *
@@ -339,6 +343,35 @@ export declare abstract class IgcSeriesViewerComponent extends IgcHTMLElement {
     * ```
     */
     windowRectMinWidth: 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)
+    */
+    windowRectMinHeight: number;
+    /**
+     * Gets the actual minimum width that the window rect is allowed to reach before being clamped.
+    */
+    actualWindowRectMinWidth: number;
+    /**
+     * Gets the actual minimum height that the window rect is allowed to reach before being clamped.
+    */
+    actualWindowRectMinHeight: 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
+    */
+    windowSizeMinWidth: 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
+    */
+    windowSizeMinHeight: number;
     /**
      * Gets or sets the current SeriesViewer's crosshair visibility override.
     *
@@ -676,6 +709,10 @@ export declare abstract class IgcSeriesViewerComponent extends IgcHTMLElement {
     * ```
     */
     actualInteractionPixelScalingRatio: number;
+    /**
+     * Gets or sets a whether the chart should pan its content when zooing in passed max zoom level.
+    */
+    shouldPanOnMaximumZoom: boolean;
     /**
      * Gets the actual value of the window rectangle, which represents the current zoom level.
     */
@@ -708,6 +745,10 @@ export declare abstract class IgcSeriesViewerComponent extends IgcHTMLElement {
     protected _stylingParent: any;
     protected _inStyling: boolean;
     protected _styling(container: any, component: any, parent?: any): void;
+    getDesiredToolbarActions(): ToolActionInfo[];
+    onToolCommandExecuting(command: ToolCommand): void;
+    addCommandAvailabilityListener(listener: ICommandAvailabilityListener): void;
+    removeCommandAvailabilityListener(listener: ICommandAvailabilityListener): void;
     /**
      * Hides the active main tooltip, if displayed.
     
@@ -733,6 +774,16 @@ export declare abstract class IgcSeriesViewerComponent extends IgcHTMLElement {
     
     */
     clearTileZoomCache(): void;
+    /**
+     * Performs zoom in action on the chart by specified percentage of current window rect
+    
+    */
+    zoomIn(percentage: number): void;
+    /**
+     * Performs zoom out action on the chart by specified percentage of current window rect
+    
+    */
+    zoomOut(percentage: number): void;
     /**
      * Resets the zoom level to default.
     

package/lib/igc-zoom-slider-component.d.ts

@@ -103,11 +103,6 @@ export declare class IgcZoomSliderComponent extends IgcHTMLElement {
     protected _styling(container: any, component: any, parent?: any): void;
     onDetachedFromUI(): void;
     onAttachedToUI(): void;
-    /**
-     * Release any resources held by the ZoomSlider.
-    
-    */
-    destroy(): void;
     /**
      * Called by the UI framework to provide a UI container for rendering this control.
     

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "igniteui-webcomponents-charts",
-  "version": "3.2.3",
+  "version": "3.2.4",
   "description": "Ignite UI Web Components charting components for building rich data visualizations using TypeScript APIs.",
   "homepage": "https://github.com/IgniteUI/igniteui-webcomponents-charts",
   "keywords": [
@@ -24,7 +24,7 @@
     "tslib": "^2.3.1"
   },
   "peerDependencies": {
-    "igniteui-webcomponents-core": "3.2.3"
+    "igniteui-webcomponents-core": "3.2.4"
   },
   "sideEffects": false,
   "typings": "igniteui-webcomponents-charts.d.ts",

package/public_api.d.ts

@@ -165,11 +165,26 @@ export * from './lib/CategoryTrendLineManager';
 export * from './lib/FramePreparer';
 export * from './lib/CategorySeriesView';
 export * from './lib/igc-domain-chart-component';
+export * from './lib/igc-chart-group-description-collection';
+export * from './lib/igc-chart-sort-description-collection';
+export * from './lib/igc-chart-summary-description-collection';
+export * from './lib/igc-chart-group-description';
+export * from './lib/igc-chart-sort-description';
 export * from './lib/DomainChart';
 export * from './lib/XYChart';
 export * from './lib/igc-xy-chart-component';
 export * from './lib/Tooltip';
 export * from './lib/IDomainChartWidget';
+export * from './lib/ChartGroupDescription';
+export * from './lib/igc-chart-group-description-module';
+export * from './lib/ChartGroupDescriptionCollection';
+export * from './lib/ChartSortDescription';
+export * from './lib/igc-chart-sort-description-module';
+export * from './lib/ChartSortDescriptionCollection';
+export * from './lib/ChartSummaryDescription';
+export * from './lib/igc-chart-summary-description';
+export * from './lib/igc-chart-summary-description-module';
+export * from './lib/ChartSummaryDescriptionCollection';
 export * from './lib/ToolTipType';
 export * from './lib/CrosshairsDisplayMode';
 export * from './lib/DomainType';
@@ -695,6 +710,7 @@ export * from './lib/HorizontalAxisLabelPanel';
 export * from './lib/IScaler';
 export * from './lib/ICategoryScaler';
 export * from './lib/IAngleScaler';
+export * from './lib/IZoomableCategoryAxis';
 export * from './lib/ISortingAxis';
 export * from './lib/ITimeRangeSelectorAxis';
 export * from './lib/IOrdinalAxis';
@@ -747,6 +763,12 @@ export * from './lib/IHasCategoryModePreference';
 export * from './lib/IHasCategoryAxis';
 export * from './lib/igc-marker-type-collection';
 export * from './lib/MarkerTypeCollection';
+export * from './lib/AutomaticSeriesManager';
+export * from './lib/AutomaticSeriesRequestCollection';
+export * from './lib/AutomaticSeriesPurpose';
+export * from './lib/AutomaticSeriesRequest';
+export * from './lib/IDataChartToolbarProvider';
+export * from './lib/DataChartToolbarProvider';
 export * from './lib/ISeriesViewerScrollbarManager';
 export * from './lib/SeriesRenderManager';
 export * from './lib/OrderedDictionary$2';
@@ -923,6 +945,7 @@ export * from './lib/TileZoomInfo';
 export * from './lib/TileZoomTileInfo';
 export * from './lib/TileZoomTileCache';
 export * from './lib/TileZoomTile';
+export * from './lib/DataChartToolbarFactoryManager';
 export * from './lib/DataChartMouseButtonEventArgs';
 export * from './lib/igc-data-chart-mouse-button-event-args';
 export * from './lib/ChartMouseEventArgs';