@amcharts/amcharts5
Version:
amCharts 5
263 lines • 9.71 kB
TypeScript
import type { IDisposer } from "../../../core/util/Disposer";
import type { IPoint } from "../../../core/util/IPoint";
import type { Color } from "../../../core/util/Color";
import type { ValueAxis } from "../../xy/axes/ValueAxis";
import type { DateAxis } from "../../xy/axes/DateAxis";
import type { AxisRenderer } from "../../xy/axes/AxisRenderer";
import type { Sprite } from "../../../core/render/Sprite";
import type { DataItem } from "../../../core/render/Component";
import type { XYSeries } from "../../xy/series/XYSeries";
import type { StockChart } from "../StockChart";
import type { ISpritePointerEvent } from "../../../core/render/Sprite";
import type { Graphics } from "../../../core/render/Graphics";
import { LineSeries, ILineSeriesSettings, ILineSeriesPrivate, ILineSeriesDataItem } from "../../xy/series/LineSeries";
import { Circle } from "../../../core/render/Circle";
import { Rectangle } from "../../../core/render/Rectangle";
import { Container } from "../../../core/render/Container";
import { Template } from "../../../core/util/Template";
import { ListTemplate } from "../../../core/util/List";
export interface IDrawingSeriesDataItem extends ILineSeriesDataItem {
}
export interface IDrawingSeriesSettings extends ILineSeriesSettings {
/**
* X-Axis.
*/
xAxis: DateAxis<AxisRenderer>;
/**
* Y-axis.
*/
yAxis: ValueAxis<AxisRenderer>;
/**
* Color of the lines/borders.
*/
strokeColor?: Color;
/**
* Color of the fills.
*/
fillColor?: Color;
/**
* Opacity of the lines/borders (0-1).
*/
strokeOpacity?: number;
/**
* Opacity of the fills (0-1).
*/
fillOpacity?: number;
/**
* Width of the lines/borders in pixels.
*/
strokeWidth?: number;
/**
* Dash information for lines/borders.
*/
strokeDasharray?: Array<number>;
/**
* [[XYSeries]] used for drawing.
*/
series?: XYSeries;
/**
* Indicates if drawings should snap to x and y values.
* @ignore
*/
snapToData?: boolean;
/**
* Value field to use when snapping data or calculating averages/regressions/etc.
*
* @default "value"
*/
field?: "open" | "value" | "low" | "high";
/**
* Padding of a selector rectangle (how many pixels will be added to each side around the drawing when it's selected)
* @default 5
*/
selectorPadding?: number;
}
export interface IDrawingSeriesPrivate extends ILineSeriesPrivate {
allowChangeSnap?: boolean;
}
export declare class DrawingSeries extends LineSeries {
static className: string;
static classNames: Array<string>;
_settings: IDrawingSeriesSettings;
_privateSettings: IDrawingSeriesPrivate;
_dataItemSettings: IDrawingSeriesDataItem;
protected _clickDp?: IDisposer;
protected _moveDp?: IDisposer;
protected _downDp?: IDisposer;
protected _upDp?: IDisposer;
protected _drawingEnabled: boolean;
protected _clickPointerPoint?: IPoint;
protected _movePointerPoint?: IPoint;
protected _isDrawing: boolean;
protected _isPointerDown: boolean;
_index: number;
_drawingId?: string;
protected _canceled: boolean;
protected _di: Array<{
[index: string]: DataItem<IDrawingSeriesDataItem>;
}>;
protected _dragStartPX: number;
protected _dragStartY: number;
protected _dvpX: Array<{
[index: string]: number | undefined;
}>;
protected _dvY: Array<{
[index: string]: number | undefined;
}>;
protected _isHover: boolean;
protected _erasingEnabled: boolean;
protected _tag?: string;
protected _movePoint: IPoint;
protected selectorContainer: Container;
protected _selected: Array<number>;
protected _isSelecting: boolean;
protected _isMoving: boolean;
protected _pIndex: number;
readonly grips: ListTemplate<Container>;
readonly circles: ListTemplate<Circle>;
readonly outerCircles: ListTemplate<Circle>;
readonly selectors: ListTemplate<Rectangle>;
protected _afterNew(): void;
/**
* Disposes a drawing with the specified index.
*
* @param index Index
* @since 5.7.7
*/
disposeIndex(index: number): void;
/**
* Returns index of a drawing with the specific ID, or `null` if not found.
*
* @param id ID
* @return Index
* @since 5.8.4
*/
getIndex(id: string): number | null;
protected _disposeIndex(index: number): void;
protected _afterDataChange(): void;
protected _createElements(_index: number, _dataItem?: DataItem<IDrawingSeriesDataItem>): void;
_clearDirty(): void;
clearDrawings(): void;
protected _getIndex(sprite: Sprite): number;
protected _getStrokeIndex(index: number): number;
setInteractive(value: boolean): void;
enableDrawingSelection(value: boolean): void;
protected _showSegmentBullets(index: number): void;
protected _hideResizer(sprite?: Sprite): void;
/**
* @ignore
*/
startDragItem(event: ISpritePointerEvent, index: number): void;
/**
* @ignore
*/
stopDragItem(event: ISpritePointerEvent, index: number): void;
protected _handleFillDragStart(event: ISpritePointerEvent, index: number): void;
_dragStart(event: ISpritePointerEvent): void;
_dragStop(event: ISpritePointerEvent): void;
protected _handleFillDragStop(event: ISpritePointerEvent, index: number): void;
protected _updateSegment(_index: number): void;
_updateChildren(): void;
/**
* @ignore
*/
isDrawing(value: boolean): void;
protected _applySettings(_index: number, _settings?: {
[index: string]: any;
}): void;
protected _updateElements(): void;
markDirtyDrawings(): void;
protected _getFillTemplate(): Template<any>;
protected _getStrokeTemplate(): Template<any>;
protected _tweakBullet(_container: Container, _dataItem: DataItem<IDrawingSeriesDataItem>): void;
protected _dispatchStockEvent(type: any, drawingId?: string, index?: number): void;
protected _addBulletInteraction(sprite: Sprite): void;
_increaseIndex(): void;
_generateId(): string;
protected _handlePointerClick(event: ISpritePointerEvent): void;
_placeBulletsContainer(): void;
protected _handleBulletDragged(event: ISpritePointerEvent): void;
protected _handleBulletDraggedReal(dataItem: DataItem<this["_dataItemSettings"]>, point: IPoint): void;
protected _handleBulletDragStart(_event: ISpritePointerEvent): void;
protected _handleBulletDragStop(_event: ISpritePointerEvent): void;
protected _handlePointerOver(): void;
protected _handlePointerOut(): void;
enableDrawing(): void;
enableErasing(): void;
disableErasing(): void;
disableDrawing(): void;
toggleDrawing(enabled?: boolean): void;
protected _handlePointerMove(event: ISpritePointerEvent): void;
protected _handlePointerDown(_event: ISpritePointerEvent): void;
protected _handlePointerUp(_event: ISpritePointerEvent): void;
startIndex(): number;
endIndex(): number;
protected _setXLocation(dataItem: DataItem<this["_dataItemSettings"]>, value: number): void;
protected _setXLocationReal(dataItem: DataItem<this["_dataItemSettings"]>, value: number): void;
disposeDataItem(dataItem: DataItem<this["_dataItemSettings"]>): void;
protected _getYValue(value: number, valueX: number, doNotConvert?: boolean): number;
protected _getXValue(value: number): number;
_setContext(dataItem: DataItem<IDrawingSeriesDataItem>, key: any, value: any, working?: boolean): void;
protected _snap(value: number, realValue: number, key: string, series: XYSeries): number;
protected _getStockChart(): StockChart;
protected _getSprite(sprites: ListTemplate<any>, index: number): Graphics | undefined;
_selectDrawing(index: number, keepSelection?: boolean, force?: boolean): void;
protected _unselectDrawing(index: number): void;
protected _updateSelectors(): void;
protected _updateSelector(selector: Graphics, index: number): void;
/**
*
* @param index returns drawingId
* @returns
*/
indexToDrawingId(index: number): string | undefined;
protected _getContext(index: number): any;
getContext(id: string): any;
/**
* Unselects all currently selected drawings on this series.
*
* @since 5.9.0
*/
unselectAllDrawings(): number;
/**
* Unselects all currently selected drawings of this series.
*
* @since 5.9.0
*/
unselectDrawings(): number;
/**
* Selects series' drawing by its ID.
*
* @param id Drawing ID
* @param keepSelection Keep existing selections
* @since 5.9.0
*/
selectDrawing(id: string, keepSelection?: boolean): void;
/**
* Unselects series' drawing by its ID.
*
* @param id Drawing ID
* @since 5.9.0
*/
unselectDrawing(id: string): void;
/**
* Deletes all currently selected drawings on this series.
*
* @since 5.9.0
*/
deleteSelected(): void;
/**
* Deletes a series' drawing by ids ID.
*
* @param id Drawing ID
* @since 5.9.0
*/
deleteDrawing(id: string): void;
/**
* Cancels current drawing
*
* @since 5.9.0
*/
cancelDrawing(): void;
}
//# sourceMappingURL=DrawingSeries.d.ts.map