packages/driver/api-report.api.md
Do not edit this file. It is a report generated by API Extractor.
import { Editor } from '@tldraw/editor';
import { RotateCorner } from '@tldraw/editor';
import { SelectionHandle } from '@tldraw/editor';
import { TLArrowShape } from '@tldraw/editor';
import { TLContent } from '@tldraw/editor';
import { TLKeyboardEventInfo } from '@tldraw/editor';
import { TLPageId } from '@tldraw/editor';
import { TLPinchEventInfo } from '@tldraw/editor';
import { TLPointerEventInfo } from '@tldraw/editor';
import { TLShape } from '@tldraw/editor';
import { TLShapeId } from '@tldraw/editor';
import { TLWheelEventInfo } from '@tldraw/editor';
import { Vec } from '@tldraw/editor';
import { VecLike } from '@tldraw/editor';
// @public
export class Driver {
constructor(editor: Editor);
click(x?: number, y?: number, options?: PointerEventInit_2, modifiers?: EventModifiers): this;
clipboard: null | TLContent;
copy(ids?: TLShapeId[]): this;
createPageID(id: string): TLPageId;
createShapeID(id: string): TLShapeId;
cut(ids?: TLShapeId[]): this;
dispose(): void;
doubleClick(x?: number, y?: number, options?: PointerEventInit_2, modifiers?: EventModifiers): this;
// (undocumented)
readonly editor: Editor;
forceTick(count?: number): this;
getArrowsBoundTo(shapeId: TLShapeId): TLArrowShape[];
getLastCreatedShape<T extends TLShape>(): T;
getLastCreatedShapes(count?: number): TLShape[];
getPageCenter(shape: TLShape): null | Vec;
getPageRotation(shape: TLShape): number;
getPageRotationById(id: TLShapeId): number;
getSelectionPageCenter(): null | Vec;
getViewportPageCenter(): Vec;
keyDown(key: string, options?: Partial<Omit<TLKeyboardEventInfo, "key">>): this;
keyPress(key: string, options?: Partial<Omit<TLKeyboardEventInfo, "key">>): this;
keyRepeat(key: string, options?: Partial<Omit<TLKeyboardEventInfo, "key">>): this;
keyUp(key: string, options?: Partial<Omit<TLKeyboardEventInfo, "key">>): this;
pan(offset: VecLike): this;
paste(point?: VecLike): this;
pinchEnd(x: number | undefined, y: number | undefined, z: number, dx: number, dy: number, dz: number, options?: Partial<Omit<TLPinchEventInfo, "delta" | "offset" | "point">>): this;
pinchStart(x: number | undefined, y: number | undefined, z: number, dx: number, dy: number, dz: number, options?: Partial<Omit<TLPinchEventInfo, "delta" | "offset" | "point">>): this;
pinchTo(x: number | undefined, y: number | undefined, z: number, dx: number, dy: number, dz: number, options?: Partial<Omit<TLPinchEventInfo, "delta" | "offset" | "point">>): this;
pointerDown(x?: number, y?: number, options?: PointerEventInit_2, modifiers?: EventModifiers): this;
pointerMove(x?: number, y?: number, options?: PointerEventInit_2, modifiers?: EventModifiers): this;
pointerUp(x?: number, y?: number, options?: PointerEventInit_2, modifiers?: EventModifiers): this;
resizeSelection(scale: {
scaleX?: number | undefined;
scaleY?: number | undefined;
} | undefined, handle: SelectionHandle, options?: Partial<TLPointerEventInfo>): this;
rightClick(x?: number, y?: number, options?: PointerEventInit_2, modifiers?: EventModifiers): this;
rotateSelection(angleRadians: number, options?: {
handle?: RotateCorner;
shiftKey?: boolean;
}): this;
translateSelection(dx: number, dy: number, options?: Partial<TLPointerEventInfo>): this;
wheel(dx: number, dy: number, options?: Partial<Omit<TLWheelEventInfo, "delta">>): this;
}
// @public
export type EventModifiers = Partial<Pick<TLPointerEventInfo, 'altKey' | 'ctrlKey' | 'shiftKey'>>;
// @public
type PointerEventInit_2 = Partial<TLPointerEventInfo> | TLShapeId;
export { PointerEventInit_2 as PointerEventInit }
// (No @packageDocumentation comment for this package)