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 { /** * The date axis the drawings' points are placed on. */ xAxis: DateAxis; /** * The value axis the drawings' points are placed on. */ yAxis: ValueAxis; /** * Line color of new drawings and, when changed, of the selected ones. */ strokeColor?: Color; /** * Fill color of new drawings and, when changed, of the selected ones. */ fillColor?: Color; /** * Line opacity (`0` to `1`) of new drawings and, when changed, of the * selected ones. */ strokeOpacity?: number; /** * Fill opacity (`0` to `1`) of new drawings and, when changed, of the * selected ones. */ fillOpacity?: number; /** * Line width in pixels of new drawings and, when changed, of the selected * ones. */ strokeWidth?: number; /** * Dash pattern of the lines, such as `[4, 2]`, for new drawings and, when * changed, for the selected ones. */ strokeDasharray?: Array; /** * The series the drawings snap to with `snapToData`, usually the main * series. The drawing series also finds its [[StockChart]] through it. */ series?: XYSeries; /** * Indicates if drawings should snap to x and y values. * @ignore */ snapToData?: boolean; /** * Value of `series` that snapping, averages and regressions use: `"value"` * (the close), `"open"`, `"low"` or `"high"`. * * @default "value" */ field?: "open" | "value" | "low" | "high"; /** * Space in pixels between a selected drawing and its selection rectangle. * @default 10 */ selectorPadding?: number; } export interface IDrawingSeriesPrivate extends ILineSeriesPrivate { allowChangeSnap?: boolean; } /** * Base class for the series that hold the drawings of a [[StockChart]]. */ export declare class DrawingSeries extends LineSeries { static className: string; static classNames: Array; _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; }>; 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; protected _isSelecting: boolean; protected _isMoving: boolean; protected _pIndex: number; /** * Grips on the drawings' points, which can be dragged to reshape them. */ readonly grips: ListTemplate; /** * Inner circles of the grips. */ readonly circles: ListTemplate; /** * Outer circles of the grips. */ readonly outerCircles: ListTemplate; /** * Rectangles drawn around the selected drawings. */ readonly selectors: ListTemplate; protected _afterNew(): void; /** * Deletes the drawing at an index. * * @param index Index of the drawing * @since 5.7.7 */ disposeIndex(index: number): void; /** * Returns the index of the drawing with an ID, or `null` if there is none. * * @param id Drawing 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): void; _clearDirty(): void; /** * Deletes all drawings of the series. */ clearDrawings(): void; protected _getIndex(sprite: Sprite): number; protected _getStrokeIndex(index: number): number; /** * Makes the drawings react to the pointer, or not. * * @param value Interactive */ 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; /** * Makes the [[StockChart]] dispatch `drawingsupdated`. */ markDirtyDrawings(): void; protected _getFillTemplate(): Template; protected _getStrokeTemplate(): Template; protected _tweakBullet(_container: Container, _dataItem: DataItem): 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, point: IPoint): void; protected _handleBulletDragStart(_event: ISpritePointerEvent): void; protected _handleBulletDragStop(_event: ISpritePointerEvent): void; protected _handlePointerOver(): void; protected _handlePointerOut(): void; /** * Turns drawing on: the pointer on the plot area draws new drawings. */ enableDrawing(): void; /** * Turns erasing on: a click on a drawing deletes it. */ enableErasing(): void; /** * Turns erasing off. */ disableErasing(): void; /** * Turns drawing off. */ disableDrawing(): void; /** * Updates the drawings for drawing mode turning on or off. Here, with the * [[StockChart]] `hideDrawingGrips` on, it shows the grips only while * drawing mode is on. * * @param enabled Drawing mode on */ 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, value: number): void; protected _setXLocationReal(dataItem: DataItem, value: number): void; disposeDataItem(dataItem: DataItem): void; protected _getYValue(value: number, valueX: number, doNotConvert?: boolean): number; protected _getXValue(value: number): number; _setContext(dataItem: DataItem, 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, 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; /** * Returns the ID of the drawing at an index. * * @param index Index of the drawing * @returns Drawing ID */ indexToDrawingId(index: number): string | undefined; protected _getContext(index: number): any; /** * Returns the data context of a drawing, found by its ID. * * @param id Drawing ID * @return Data context */ getContext(id: string): any; /** * Unselects all selected drawings of the whole [[StockChart]], not only of * this series. * * @return Number of drawings unselected * @since 5.9.0 */ unselectAllDrawings(): number; /** * Unselects the selected drawings of this series. * * @return Number of drawings unselected * @since 5.9.0 */ unselectDrawings(): number; /** * Selects a drawing of this series by its ID. Works only while drawing * selection is on (`drawingSelectionEnabled` of the [[StockChart]]). * * @param id Drawing ID * @param keepSelection Keep the drawings already selected * @since 5.9.0 */ selectDrawing(id: string, keepSelection?: boolean): void; /** * Unselects a drawing of this series by its ID. * * @param id Drawing ID * @since 5.9.0 */ unselectDrawing(id: string): void; /** * Deletes the selected drawings of this series. * * @since 5.9.0 */ deleteSelected(): void; /** * Deletes a drawing of this series by its ID. * * @param id Drawing ID * @since 5.9.0 */ deleteDrawing(id: string): void; /** * Cancels the drawing in progress, deleting it. * * @since 5.9.0 */ cancelDrawing(): void; } //# sourceMappingURL=DrawingSeries.d.ts.map