igniteui-angular-wrappers
Version:
A packaged version of Ignite UI wrappers for Angular
433 lines (432 loc) • 30 kB
TypeScript
import { ElementRef, IterableDiffers, KeyValueDiffers, ChangeDetectorRef, Renderer2, OnInit } from '@angular/core';
import { IgControlBase } from '../igcontrolbase/igcontrolbase';
import * as i0 from "@angular/core";
export declare class IgDataChartComponent extends IgControlBase<IgDataChart> implements OnInit {
constructor(el: ElementRef, renderer: Renderer2, differs: IterableDiffers, kvalDiffers: KeyValueDiffers, cdr: ChangeDetectorRef);
set dataSource(value: any);
private _dataSource;
ngOnInit(): void;
option(): void;
/**
* Returns the element holding the chart.
*/
widget(): void;
/**
* Returns the ID of parent element holding the chart.
*/
id(): string;
/**
* Exports the chart to a PNG image.
*
* @param width The width of the image.
* @param height The height of the image.
*/
exportImage(width?: object, height?: object): object;
/**
* Destroys the widget.
*/
destroy(): void;
/**
* Notify the chart that styles it draws colors from may have been updated.
*/
styleUpdated(): object;
/**
* Resets the zoom level of the chart to default.
*/
resetZoom(): object;
/**
* Adds a new item to the data source and notifies the chart.
*
* @param item The item that we want to add to the data source.
* @param targetName The name of the series or axis bound to the data source.
* This is required only when the data is bound to series or axis.
* If the data is bound to dataSource of igDataChart, the second parameter should not be set.
*/
addItem(item: object, targetName: string): void;
/**
* Inserts a new item to the data source and notifies the chart.
*
* @param item the new item that we want to insert in the data source.
* @param index The index in the data source where the new item will be inserted.
* @param targetName The name of the series or axis bound to the data source.
*/
insertItem(item: object, index: number, targetName: string): void;
/**
* Deletes an item from the data source and notifies the chart.
*
* @param index The index in the data source from where the item will be been removed.
* @param targetName The name of the series or axis bound to the data source.
* This is required only when the data is bound to series or axis.
* If the data is bound to dataSource of igDataChart, the second parameter should not be set.
*/
removeItem(index: number, targetName: string): void;
/**
* Updates an item in the data source and notifies the chart.
*
* @param index The index of the item in the data source that we want to change.
* @param item The new item object that will be set in the data source.
* @param targetName The name of the series or axis bound to the data source.
*/
setItem(index: number, item: object, targetName: string): void;
/**
* Notifies the chart that an item has been set in an associated data source.
*
* @param dataSource The data source in which the change happened.
* @param index The index in the items source that has been changed.
* @param newItem the new item that has been set in the collection.
* @param oldItem the old item that has been overwritten in the collection.
*/
notifySetItem(dataSource: object, index: number, newItem: object, oldItem: object): object;
/**
* Notifies the chart that the items have been cleared from an associated data source.
* It's not necessary to notify more than one target of a change if they share the same items source.
*
* @param dataSource The data source in which the change happened.
*/
notifyClearItems(dataSource: object): object;
/**
* Notifies the target axis or series that an item has been inserted at the specified index in its data source.
* It's not necessary to notify more than one target of a change if they share the same items source.
*
* @param dataSource The data source in which the change happened.
* @param index The index in the items source where the new item has been inserted.
* @param newItem the new item that has been set in the collection.
*/
notifyInsertItem(dataSource: object, index: number, newItem: object): object;
/**
* Notifies the target axis or series that an item has been removed from the specified index in its data source.
* It's not necessary to notify more than one target of a change if they share the same items source.
*
* @param dataSource The data source in which the change happened.
* @param index The index in the items source from where the old item has been removed.
* @param oldItem the old item that has been removed from the collection.
*/
notifyRemoveItem(dataSource: object, index: number, oldItem: object): object;
/**
* Notifies the target axis or series that it should scroll the requested data item into view.
*
* @param targetName The name of the axis or series notify.
* @param item The data item to bring into view, if possible.
*/
scrollIntoView(targetName: string, item: object): object;
/**
* Notifies the target axis that it should scale the requested value into chart space from axis space.
* For example you can use this method if you want to find where value 50 of the x axis stands scaled to chart's width.
*
* @param targetName The name of the axis to notify.
* @param unscaledValue The value in axis space to translate into chart space.
*/
scaleValue(targetName: string, unscaledValue: number): number;
/**
* Notifies the target axis that it should unscale the requested value into axis space from chart space.
* For example you can use this method if you want to find what is the value of x axis unscaled from 0 width of the chart.
*
* @param targetName The name of the axis to notify.
* @param scaledValue The value in chart space to translate into axis space.
*/
unscaleValue(targetName: string, scaledValue: number): number;
/**
* For the target axis, if using enhanced interval management and precise interval fitting,
* this will reset the cached maximum label width, and recalculate using the current labels.
*
* @param targetName The name of the axis to notify.
*/
resetCachedEnhancedInterval(targetName: string): object;
/**
* Notifies the target series that something that affects its visual properties has changed and the visual output needs a repaint.
*
* @param targetName The name of the series to notify.
*/
notifyVisualPropertiesChanged(targetName: string): object;
/**
* Forces any pending deferred work to render on the chart before continuing
*/
flush(): void;
/**
* Exports visual data from the chart to aid in unit testing
*/
exportVisualData(): void;
/**
* Gets the actual minimum value of the target numeric or date time axis
*
* @param targetName The name of the axis from which to get the minimum value.
*/
getActualMinimumValue(targetName: string): void;
/**
* Gets the actual maximum value of the target numeric or date time axis
*
* @param targetName The name of the axis from which to get the maximum value.
*/
getActualMaximumValue(targetName: string): void;
/**
* Gets the actual interval of the target numeric or date time axis
*
* @param targetName The name of the axis from which to get the interval.
*/
getActualInterval(targetName: string): void;
/**
* Creates a print preview page with the chart, hiding all other elements on the page.
*/
print(): void;
/**
* Indicates that a series should render, even though no option has been modified that would normally cause it to refresh.
*
* @param targetName The name of the series to render.
* @param animate Whether the change should be animated, if possible.
*/
renderSeries(targetName: string, animate: boolean): void;
/**
* Gets the item item index associated with the specified world position.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
*/
getItemIndex(targetName: string, worldPoint: object): number;
/**
* Gets the item that is the best match for the specified world coordinates.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
*/
getItem(targetName: string, worldPoint: object): object;
/**
* For a category plotted series, gets the current width of the items within the categories.
* This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned.
*
* @param targetName The name of the series to target.
*/
getItemSpan(targetName: string): number;
/**
* If possible, will return the best available main value of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesValue(targetName: string, worldPoint: object, useInterpolation: boolean, skipUnknowns: boolean): number;
/**
* If possible, will return the best available value bounding box within the series that has the best value
* match for the world position provided.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
*/
getSeriesValueBoundingBox(targetName: string, worldPoint: object): object;
/**
* If possible, will return the best available value fine grained bounding boxes within the series that have the best value
* match for the world position provided.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
*/
getSeriesValueFineGrainedBoundingBoxes(targetName: string, worldPoint: object): object;
/**
* If possible, will return the best available main value position of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesValuePosition(targetName: string, worldPoint: object, useInterpolation: boolean, skipUnknowns: boolean): object;
/**
* If possible, will return the best available main value position of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]}
* that represents a position within the pixel space of the series.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesValuePositionFromSeriesPixel(targetName: string, seriesPoint: object, useInterpolation: boolean, skipUnknowns: boolean): object;
/**
* If possible, will return the best available main value of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} )
* that represents a position in the pixel space of the series.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesValueFromSeriesPixel(targetName: string, seriesPoint: object, useInterpolation: boolean, skipUnknowns: boolean): number;
/**
* If possible, will return the best available value bounding box within the series that has the best value
* match for the given series pixel coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} )
* that represents a position in the pixel space of the series.
*/
getSeriesValueBoundingBoxFromSeriesPixel(targetName: string, seriesPoint: object): object;
/**
* If possible, will return the best available value fine grained bounding boxes within the series that have the best value
* match for series pixel position provided.
*
* @param targetName The name of the series to target.
* @param worldPoint The series pixel position (in the form {x: [number], y: [number]} )
* that represents a position in the pixel space of the series.
*/
getSeriesValueFineGrainedBoundingBoxesFromSeriesPixel(targetName: string, worldPoint: object): object;
/**
* If possible, will return the best available high value of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesHighValue(targetName: string, worldPoint: object, useInterpolation: boolean, skipUnknowns: boolean): number;
/**
* If possible, will return the best available high value position of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesHighValuePosition(targetName: string, worldPoint: object, useInterpolation: boolean, skipUnknowns: boolean): object;
/**
* If possible, will return the best available high value position of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]}
* that represents a position within the pixel space of the series.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesHighValuePositionFromSeriesPixel(targetName: string, seriesPoint: object, useInterpolation: boolean, skipUnknowns: boolean): object;
/**
* If possible, will return the best available high value of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} )
* that represents a position in the pixel space of the series.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesHighValueFromSeriesPixel(targetName: string, seriesPoint: object, useInterpolation: boolean, skipUnknowns: boolean): number;
/**
* If possible, will return the best available low value of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesLowValue(targetName: string, worldPoint: object, useInterpolation: boolean, skipUnknowns: boolean): number;
/**
* If possible, will return the best available low value position of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param worldPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesLowValuePosition(targetName: string, worldPoint: object, useInterpolation: boolean, skipUnknowns: boolean): object;
/**
* If possible, will return the best available low value position of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]}
* that represents a position within the pixel space of the series.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesLowValuePositionFromSeriesPixel(targetName: string, seriesPoint: object, useInterpolation: boolean, skipUnknowns: boolean): object;
/**
* If possible, will return the best available low value of the series for a given world coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} )
* that represents a position in the pixel space of the series.
* @param useInterpolation If true, interpolation should be used to get in-between values,
* rather than only the actual values in the data set.
* @param skipUnknowns If true, unknown values should be skipped.
*/
getSeriesLowValueFromSeriesPixel(targetName: string, seriesPoint: object, useInterpolation: boolean, skipUnknowns: boolean): number;
/**
* Gets the item item index associated with the specified series pixel coordinate.
*
* @param targetName The name of the series to target.
* @param seriesPoint The world position (in the form {x: [number from 0 to 1], y: [number from 0 to 1]} )
* that represents a position in the space of the axes.
*/
getItemIndexFromSeriesPixel(targetName: string, seriesPoint: object): number;
/**
* Gets the item that is the best match for the specified world coordinates.
*
* @param targetName The name of the series to target.
* @param seriesPoint The series pixel position (in the form {x: [number], y: [number]} )
* that represents a position in the pixel space of the series.
*/
getItemFromSeriesPixel(targetName: string, seriesPoint: object): object;
/**
* Gets the category offset for a series, if applicable.
*
* @param targetName The name of the series to target.
*/
getSeriesOffsetValue(targetName: string): number;
/**
* Gets the category width for a series, if applicable.
*
* @param targetName The name of the series to target.
*/
getSeriesCategoryWidth(targetName: string): number;
/**
* Replays the transition in animation for a series, if applicable.
*
* @param targetName The name of the series to target.
*/
replayTransitionIn(targetName: string): object;
/**
* Simulates a hover interaction over a given point in the viewport of a series.
*
* @param targetName The name of the series to target.
* @param seriesPoint The point at which to hover. Should have an x property with type number and a y property with type number.
*/
simulateHover(targetName: string, seriesPoint: object): object;
/**
* Moves the cursor point of the target annotation layer to the desired world coordinates.
*
* @param targetName The name of the series to target.
* @param worldPoint The point to which to move the cursor.
* Should have an x property with type number and a y property with type number.
*/
moveCursorPoint(targetName: string, worldPoint: object): object;
/**
* Manually starts a tiled zoom if one isn't already running.
*/
startTiledZoomingIfNecessary(): void;
/**
* Manually ends a tiled zoom if one is running.
*/
endTiledZoomingIfRunning(): void;
/**
* Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom.
*/
clearTileZoomCache(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<IgDataChartComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<IgDataChartComponent, "ig-data-chart", never, { "widgetId": { "alias": "widgetId"; "required": false; }; "options": { "alias": "options"; "required": false; }; "changeDetectionInterval": { "alias": "changeDetectionInterval"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "create": { "alias": "create"; "required": false; }; "isPagePanningAllowed": { "alias": "isPagePanningAllowed"; "required": false; }; "syncChannel": { "alias": "syncChannel"; "required": false; }; "synchronizeVertically": { "alias": "synchronizeVertically"; "required": false; }; "synchronizeHorizontally": { "alias": "synchronizeHorizontally"; "required": false; }; "crosshairPoint": { "alias": "crosshairPoint"; "required": false; }; "windowRect": { "alias": "windowRect"; "required": false; }; "horizontalZoomable": { "alias": "horizontalZoomable"; "required": false; }; "verticalZoomable": { "alias": "verticalZoomable"; "required": false; }; "windowResponse": { "alias": "windowResponse"; "required": false; }; "windowRectMinWidth": { "alias": "windowRectMinWidth"; "required": false; }; "overviewPlusDetailPaneVisibility": { "alias": "overviewPlusDetailPaneVisibility"; "required": false; }; "crosshairVisibility": { "alias": "crosshairVisibility"; "required": false; }; "plotAreaBackground": { "alias": "plotAreaBackground"; "required": false; }; "defaultInteraction": { "alias": "defaultInteraction"; "required": false; }; "dragModifier": { "alias": "dragModifier"; "required": false; }; "panModifier": { "alias": "panModifier"; "required": false; }; "previewRect": { "alias": "previewRect"; "required": false; }; "windowPositionHorizontal": { "alias": "windowPositionHorizontal"; "required": false; }; "windowPositionVertical": { "alias": "windowPositionVertical"; "required": false; }; "windowScaleHorizontal": { "alias": "windowScaleHorizontal"; "required": false; }; "windowScaleVertical": { "alias": "windowScaleVertical"; "required": false; }; "circleMarkerTemplate": { "alias": "circleMarkerTemplate"; "required": false; }; "triangleMarkerTemplate": { "alias": "triangleMarkerTemplate"; "required": false; }; "pyramidMarkerTemplate": { "alias": "pyramidMarkerTemplate"; "required": false; }; "squareMarkerTemplate": { "alias": "squareMarkerTemplate"; "required": false; }; "diamondMarkerTemplate": { "alias": "diamondMarkerTemplate"; "required": false; }; "pentagonMarkerTemplate": { "alias": "pentagonMarkerTemplate"; "required": false; }; "hexagonMarkerTemplate": { "alias": "hexagonMarkerTemplate"; "required": false; }; "tetragramMarkerTemplate": { "alias": "tetragramMarkerTemplate"; "required": false; }; "pentagramMarkerTemplate": { "alias": "pentagramMarkerTemplate"; "required": false; }; "hexagramMarkerTemplate": { "alias": "hexagramMarkerTemplate"; "required": false; }; "topMargin": { "alias": "topMargin"; "required": false; }; "leftMargin": { "alias": "leftMargin"; "required": false; }; "rightMargin": { "alias": "rightMargin"; "required": false; }; "bottomMargin": { "alias": "bottomMargin"; "required": false; }; "autoMarginWidth": { "alias": "autoMarginWidth"; "required": false; }; "autoMarginHeight": { "alias": "autoMarginHeight"; "required": false; }; "isSquare": { "alias": "isSquare"; "required": false; }; "gridMode": { "alias": "gridMode"; "required": false; }; "brushes": { "alias": "brushes"; "required": false; }; "markerBrushes": { "alias": "markerBrushes"; "required": false; }; "outlines": { "alias": "outlines"; "required": false; }; "markerOutlines": { "alias": "markerOutlines"; "required": false; }; "width": { "alias": "width"; "required": false; }; "height": { "alias": "height"; "required": false; }; "size": { "alias": "size"; "required": false; }; "dataSource": { "alias": "dataSource"; "required": false; }; "dataSourceUrl": { "alias": "dataSourceUrl"; "required": false; }; "dataSourceType": { "alias": "dataSourceType"; "required": false; }; "responseDataKey": { "alias": "responseDataKey"; "required": false; }; "isSurfaceInteractionDisabled": { "alias": "isSurfaceInteractionDisabled"; "required": false; }; "animateSeriesWhenAxisRangeChanges": { "alias": "animateSeriesWhenAxisRangeChanges"; "required": false; }; "title": { "alias": "title"; "required": false; }; "subtitle": { "alias": "subtitle"; "required": false; }; "titleTextStyle": { "alias": "titleTextStyle"; "required": false; }; "titleTopMargin": { "alias": "titleTopMargin"; "required": false; }; "titleLeftMargin": { "alias": "titleLeftMargin"; "required": false; }; "titleRightMargin": { "alias": "titleRightMargin"; "required": false; }; "titleBottomMargin": { "alias": "titleBottomMargin"; "required": false; }; "subtitleTextStyle": { "alias": "subtitleTextStyle"; "required": false; }; "subtitleTopMargin": { "alias": "subtitleTopMargin"; "required": false; }; "subtitleLeftMargin": { "alias": "subtitleLeftMargin"; "required": false; }; "subtitleRightMargin": { "alias": "subtitleRightMargin"; "required": false; }; "subtitleBottomMargin": { "alias": "subtitleBottomMargin"; "required": false; }; "titleTextColor": { "alias": "titleTextColor"; "required": false; }; "subtitleTextColor": { "alias": "subtitleTextColor"; "required": false; }; "titleHorizontalAlignment": { "alias": "titleHorizontalAlignment"; "required": false; }; "subtitleHorizontalAlignment": { "alias": "subtitleHorizontalAlignment"; "required": false; }; "highlightingTransitionDuration": { "alias": "highlightingTransitionDuration"; "required": false; }; "useTiledZooming": { "alias": "useTiledZooming"; "required": false; }; "preferHigherResolutionTiles": { "alias": "preferHigherResolutionTiles"; "required": false; }; "pixelScalingRatio": { "alias": "pixelScalingRatio"; "required": false; }; "zoomTileCacheSize": { "alias": "zoomTileCacheSize"; "required": false; }; "contentHitTestMode": { "alias": "contentHitTestMode"; "required": false; }; "legend": { "alias": "legend"; "required": false; }; "axes": { "alias": "axes"; "required": false; }; "series": { "alias": "series"; "required": false; }; "theme": { "alias": "theme"; "required": false; }; }, { "tooltipShowing": "tooltipShowing"; "tooltipShown": "tooltipShown"; "tooltipHiding": "tooltipHiding"; "tooltipHidden": "tooltipHidden"; "browserNotSupported": "browserNotSupported"; "seriesCursorMouseMove": "seriesCursorMouseMove"; "seriesMouseLeftButtonDown": "seriesMouseLeftButtonDown"; "seriesMouseLeftButtonUp": "seriesMouseLeftButtonUp"; "seriesMouseMove": "seriesMouseMove"; "seriesMouseEnter": "seriesMouseEnter"; "seriesMouseLeave": "seriesMouseLeave"; "windowRectChanged": "windowRectChanged"; "gridAreaRectChanged": "gridAreaRectChanged"; "refreshCompleted": "refreshCompleted"; "axisRangeChanged": "axisRangeChanged"; "typicalBasedOn": "typicalBasedOn"; "progressiveLoadStatusChanged": "progressiveLoadStatusChanged"; "assigningCategoryStyle": "assigningCategoryStyle"; "assigningCategoryMarkerStyle": "assigningCategoryMarkerStyle"; }, never, ["*"], false, never>;
}