a774ac673a
Some checks failed
Deploy analytics worker / Deploy analytics worker to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
i18n upload strings / Upload latest strings (push) Failing after 1s
Deploy bemo / Deploy bemo to ${{ (github.ref == 'refs/heads/bemo-production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Failing after 1s
Deploy grafana resources / ${{ github.event_name == 'push' && 'Deploy grafana resources' || 'Validate grafana resources (dry run)' }} (push) Failing after 0s
End to end tests (dotcom) / Check for relevant changes (push) Failing after 0s
End to end tests (examples) / Check for relevant changes (push) Failing after 0s
End to end tests (mermaid readability) / Check for relevant changes (push) Failing after 1s
End to end tests (perf) / Check for relevant changes (push) Failing after 0s
Publish editor extensions / Publish editor extensions (push) Failing after 1s
Publish SDK packages / Remove the publish-packages label (push) Has been skipped
Checks / Tests & checks (push) Has been cancelled
Checks / Build all projects (push) Has been cancelled
Deploy templates / Deploy templates (push) Has been cancelled
End to end tests (dotcom) / End to end tests (dotcom) (push) Has been cancelled
End to end tests (mermaid readability) / End to end tests (mermaid readability) (push) Has been cancelled
End to end tests (perf) / End to end tests (perf) (push) Has been cancelled
Deploy .com / Deploy dotcom to ${{ (github.ref == 'refs/heads/production' && 'production') || (github.ref == 'refs/heads/main' && 'staging') || 'preview' }} (push) Has been cancelled
End to end tests (examples) / End to end tests (examples) (push) Has been cancelled
Publish SDK packages / Publish SDK packages (push) Has been cancelled
Publish SDK packages / Tell user released version (push) Has been cancelled
Publish SDK packages / Publishes code templates to separate repositories (push) Has been cancelled
Publish SDK packages / Deploys the template demos with the new SDK version (push) Has been cancelled
79 lines
3.8 KiB
Markdown
79 lines
3.8 KiB
Markdown
## API Report File for "@tldraw/driver"
|
|
|
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
|
|
```ts
|
|
|
|
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/tlschema';
|
|
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;
|
|
scaleY?: number;
|
|
} | 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)
|
|
|
|
```
|