ScribbleManager • tldraw Docs

Table of contents

Methods

class ScribbleManager {}

Constructor

Constructs a new instance of the ScribbleManager class

Parameters

Name	Description
`editor`	`Editor;`

Methods

addPoint( )

Add a point to a scribble. Searches all sessions.

addPoint(id: string, x: number, y: number, z?: number): ScribbleItem;

Parameters

Name	Description
`id`	`string;` The scribble id
`x`	`number;` X coordinate
`y`	`number;` Y coordinate
`z`	`number;` Z coordinate (pressure)

Returns

ScribbleItem;

addPointToSession( )

Add a point to a scribble in a session.

addPointToSession(
  sessionId: string,
  scribbleId: string,
  x: number,
  y: number,
  z?: number,
): ScribbleItem;

Parameters

Name	Description
`sessionId`	`string;` The session ID
`scribbleId`	`string;` The scribble ID
`x`	`number;` X coordinate
`y`	`number;` Y coordinate
`z`	`number;` Z coordinate (pressure)

Returns

ScribbleItem;

addScribble( )

Add a scribble using the default self-consuming behavior. Creates an implicit session for the scribble.

addScribble(scribble: Partial<TLScribble>, id?: string): ScribbleItem;

Parameters

Name	Description
`scribble`	`Partial<TLScribble>;` Partial scribble properties
`id`	`string;` Optional scribble id

Returns

ScribbleItem;

The created scribble item

addScribbleToSession( )

Add a scribble to a session.

addScribbleToSession(
  sessionId: string,
  scribble: Partial<TLScribble>,
  scribbleId?: string,
): ScribbleItem;

Parameters

Name	Description
`sessionId`	`string;` The session ID
`scribble`	`Partial<TLScribble>;` Partial scribble properties
`scribbleId`	`string;` Optional scribble ID

Returns

ScribbleItem;

clearSession( )

Clear all scribbles in a session immediately.

clearSession(sessionId: string): void;

Parameters

Name	Description
`sessionId`	`string;` The session ID

Returns

void;

complete( )

Mark a scribble as complete (done being drawn but not yet fading). Searches all sessions.

complete(id: string): ScribbleItem;

Parameters

Name	Description
`id`	`string;` The scribble id

Returns

ScribbleItem;

extendSession( )

Extend a session, resetting its idle timeout.

extendSession(sessionId: string): void;

Parameters

Name	Description
`sessionId`	`string;` The session ID

Returns

void;

isSessionActive( )

Check if a session is active.

isSessionActive(sessionId: string): boolean;

Parameters

Name	Description
`sessionId`	`string;` The session ID

Returns

boolean;

reset( )

Stop and remove all sessions.

reset(): void;

startSession( )

Start a new session for grouping scribbles. Returns a session ID that can be used with other session methods.

startSession(options?: ScribbleSessionOptions): string;

Parameters

Name	Description
`options`	`ScribbleSessionOptions;` Session configuration

Returns

string;

Session ID

stop( )

Stop a scribble. Searches all sessions.

stop(id: string): ScribbleItem;

Parameters

Name	Description
`id`	`string;` The scribble id

Returns

ScribbleItem;

stopSession( )

Stop a session, triggering fade-out.

stopSession(sessionId: string): void;

Parameters

Name	Description
`sessionId`	`string;` The session ID

Returns

void;

tick( )

Update on each animation frame.

tick(elapsed: number): void;

Parameters

Name	Description
`elapsed`	`number;` The number of milliseconds since the last tick.

Returns

void;