mcut
@mcut/timeline

ElementTypeConfig

Generated TypeScript API reference for the public mcut SDK.

mcut SDK


mcut SDK / timeline/src / ElementTypeConfig

Interface: ElementTypeConfig

Defined in: packages/timeline/src/model.ts:319

Properties

describe?

optional describe?: (element, project) => string;

Defined in: packages/timeline/src/model.ts:327

Parameters

element

Record<string, unknown>

project

unknown

Returns

string


frameRequests?

optional frameRequests?: (project, element, timelineMs) => object[];

Defined in: packages/timeline/src/model.ts:328

Parameters

project

unknown

element

Record<string, unknown>

timelineMs

number

Returns

object[]


keyframeable?

optional keyframeable?: readonly string[];

Defined in: packages/timeline/src/model.ts:324

Fixed-effect properties this type animates (see keyframes.ts).


onSplit?

optional onSplit?: (context) => void;

Defined in: packages/timeline/src/model.ts:325

Parameters

context
element

Record<string, unknown>

left

Record<string, unknown>

offsetMs

number

Record<string, unknown>

Returns

void


shape

shape: z.ZodRawShape;

Defined in: packages/timeline/src/model.ts:322

The type's OWN fields — id/type/start/duration/keyframes/linkId/groupId are composed in.


type

type: string;

Defined in: packages/timeline/src/model.ts:320


validate?

optional validate?: (project, element) => void;

Defined in: packages/timeline/src/model.ts:326

Parameters

project

unknown

element

Record<string, unknown>

Returns

void

On this page