scichart
Version:
Fast WebGL JavaScript Charting Library and Framework
143 lines (142 loc) • 7.1 kB
TypeScript
import { ChartModifierBase2D, IChartModifierBaseOptions } from "../Charting/ChartModifiers/ChartModifierBase2D";
import { ICursorModifierOptions } from "../Charting/ChartModifiers/CursorModifier";
import { IDataPointSelectionModifierOptions } from "../Charting/ChartModifiers/DataPointSelectionModifier";
import { ILegendModifierOptions } from "../Charting/ChartModifiers/LegendModifier";
import { IMouseWheelZoomModifierOptions } from "../Charting/ChartModifiers/MouseWheelZoomModifier";
import { IRangeSelectionModifierOptions } from "../Charting/ChartModifiers/OverviewRangeSelectionModifier";
import { IPinchZoomModifierOptions } from "../Charting/ChartModifiers/PinchZoomModifier";
import { IRolloverModifierOptions } from "../Charting/ChartModifiers/RolloverModifier";
import { IVerticalSliceOptions } from "../Charting/ChartModifiers/VerticalSliceModifier";
import { IRubberBandXyZoomModifierOptions } from "../Charting/ChartModifiers/RubberBandXyZoomModifier";
import { ISeriesSelectionModifierOptions } from "../Charting/ChartModifiers/SeriesSelectionModifier";
import { IXAxisDragModifierOptions } from "../Charting/ChartModifiers/XAxisDragModifier";
import { IYAxisDragModifierOptions } from "../Charting/ChartModifiers/YAxisDragModifier";
import { IZoomExtentsModifierOptions } from "../Charting/ChartModifiers/ZoomExtentsModifier";
import { IZoomPanModifierOptions } from "../Charting/ChartModifiers/ZoomPanModifier";
import { EChart2DModifierType, EChart3DModifierType } from "../types/ChartModifierType";
import { IAnnotationHoverModifierOptions } from "../Charting/ChartModifiers/AnnotationHoverModifier";
import { IPolarArcZoomModifierOptions } from "../Charting/ChartModifiers/Polar/PolarArcZoomModifier";
import { IPolarCursorModifierOptions } from "../Charting/ChartModifiers/Polar/PolarCursorModifier";
import { IPolarDataPointSelectionModifierOptions } from "../Charting/ChartModifiers/Polar/PolarDataPointSelectionModifier";
import { IPolarSeriesSelectionModifierOptions } from "../Charting/ChartModifiers/Polar/PolarSeriesSelectionModifier";
import { IPolarLegendModifierOptions } from "../Charting/ChartModifiers/Polar/PolarLegendModifier";
import { IPolarMouseWheelZoomModifierOptions } from "../Charting/ChartModifiers/Polar/PolarMouseWheelZoomModifier";
import { IPolarZoomExtentsModifierOptions } from "../Charting/ChartModifiers/Polar/PolarZoomExtentsModifier";
import { IPolarPanModifierOptions } from "../Charting/ChartModifiers/Polar/PolarPanModifier";
import { IMouseWheelZoomModifier3DOptions } from "../Charting3D/ChartModifiers/MouseWheelZoomModifier3D";
import { IPinchZoomModifier3DOptions } from "../Charting3D/ChartModifiers/PinchZoomModifier3D";
import { IOrbitModifier3DOptions } from "../Charting3D/ChartModifiers/OrbitModifier3D";
import { ITooltipModifier3DOptions } from "../Charting3D/ChartModifiers/TooltipModifier3D";
import { IResetCamera3DOptions } from "../Charting3D/ChartModifiers/ResetCamera3DModifier";
import { ChartModifierBase3D, IChartModifierBase3DOptions } from "../Charting3D/ChartModifiers/ChartModifierBase3D";
import { ILegendModifier3DOptions } from "../Charting3D/ChartModifiers/LegendModifier3D";
/** Definition of a 2d chart modifier, comprising a {@link EChart2DModifierType} and the relevant options */
export declare type TModifierDefinition = {
type: EChart2DModifierType.Cursor;
options?: ICursorModifierOptions;
} | {
type: EChart2DModifierType.PolarCursor;
options?: IPolarCursorModifierOptions;
} | {
type: EChart2DModifierType.DataPointSelection;
options?: IDataPointSelectionModifierOptions;
} | {
type: EChart2DModifierType.PolarDataPointSelection;
options?: IPolarDataPointSelectionModifierOptions;
} | {
type: EChart2DModifierType.PolarSeriesSelection;
options?: IPolarSeriesSelectionModifierOptions;
} | {
type: EChart2DModifierType.Legend;
options?: ILegendModifierOptions;
} | {
type: EChart2DModifierType.PolarLegend;
options?: IPolarLegendModifierOptions;
} | {
type: EChart2DModifierType.MouseWheelZoom;
options?: IMouseWheelZoomModifierOptions;
} | {
type: EChart2DModifierType.PolarMouseWheelZoom;
options?: IPolarMouseWheelZoomModifierOptions;
} | {
type: EChart2DModifierType.PinchZoom;
options?: IPinchZoomModifierOptions;
} | {
type: EChart2DModifierType.Rollover;
options?: IRolloverModifierOptions;
} | {
type: EChart2DModifierType.VerticalSlice;
options?: IVerticalSliceOptions;
} | {
type: EChart2DModifierType.RubberBandXYZoom;
options?: IRubberBandXyZoomModifierOptions;
} | {
type: EChart2DModifierType.PolarArcZoom;
options?: IPolarArcZoomModifierOptions;
} | {
type: EChart2DModifierType.SeriesSelection;
options?: ISeriesSelectionModifierOptions;
} | {
type: EChart2DModifierType.AnnotationHover;
options?: IAnnotationHoverModifierOptions;
} | {
type: EChart2DModifierType.XAxisDrag;
options?: IXAxisDragModifierOptions;
} | {
type: EChart2DModifierType.YAxisDrag;
options?: IYAxisDragModifierOptions;
} | {
type: EChart2DModifierType.ZoomExtents;
options?: IZoomExtentsModifierOptions;
} | {
type: EChart2DModifierType.PolarZoomExtents;
options?: IPolarZoomExtentsModifierOptions;
} | {
type: EChart2DModifierType.ZoomPan;
options?: IZoomPanModifierOptions;
} | {
type: EChart2DModifierType.PolarPan;
options?: IPolarPanModifierOptions;
} | {
type: EChart2DModifierType.OverviewRangeSelection;
options?: IRangeSelectionModifierOptions;
} | {
type: EChart2DModifierType.Custom;
customType?: string;
options?: IChartModifierBaseOptions;
};
export declare type TModifier3DDefinition = {
type: EChart3DModifierType.MouseWheelZoom;
options?: IMouseWheelZoomModifier3DOptions;
} | {
type: EChart3DModifierType.Orbit;
options?: IOrbitModifier3DOptions;
} | {
type: EChart3DModifierType.PinchZoom;
options?: IPinchZoomModifier3DOptions;
} | {
type: EChart3DModifierType.Tooltip;
options?: ITooltipModifier3DOptions;
} | {
type: EChart3DModifierType.ZoomExtents;
options?: IResetCamera3DOptions;
} | {
type: EChart3DModifierType.Legend;
options?: ILegendModifier3DOptions;
} | {
type: EChart3DModifierType.Custom;
customType?: string;
options?: IChartModifierBase3DOptions;
};
/**
* Build one or more chart modifiers from a definition that can be pure data.
* @param definition One or an array of {@link TModifierDefinition}
* @returns An array of modifiers
*/
export declare const buildModifiers: (definition: TModifierDefinition | TModifierDefinition[]) => ChartModifierBase2D[];
/**
* Build one or more 3D chart modifiers from a definition that can be pure data.
* @param definition One or an array of {@link TModifier3DDefinition}
* @returns An array of modifiers
*/
export declare const buildModifiers3D: (definition: TModifier3DDefinition | TModifier3DDefinition[]) => ChartModifierBase3D[];