Skip to main content

Interface: DocumentFile

Defined in: src/lib/document/schema.ts:114

A document as a file (JSON): images are PNG data URLs

Extends​

Properties​

@type​

@type: "PaintCanvas/Document"

Defined in: src/lib/document/schema.ts:116


$schema​

$schema: string

Defined in: src/lib/document/schema.ts:115


activeLayer​

activeLayer: string

Defined in: src/lib/document/schema.ts:104

ID of the selected layer

Inherited from​

DocumentOf.activeLayer


author​

author: AssetAuthorDetails[]

Defined in: src/lib/document/schema.ts:60

Who made it: whoever started it, then everyone who saved it since

Inherited from​

DocumentOf.author


dateCreated​

dateCreated: string

Defined in: src/lib/document/schema.ts:62

When it was started (ISO 8601 date and time)

Inherited from​

DocumentOf.dateCreated


dateOpened​

dateOpened: string

Defined in: src/lib/document/schema.ts:64

When it was last opened (ISO 8601 date and time); opening it doesn't count as changing it

Inherited from​

DocumentOf.dateOpened


external​

external: DocumentSheet<string>[]

Defined in: src/lib/document/schema.ts:106

Drawings from elsewhere, top first

Inherited from​

DocumentOf.external


height​

height: number

Defined in: src/lib/document/schema.ts:100

Inherited from​

DocumentOf.height


id​

id: string

Defined in: src/lib/document/schema.ts:57

A UUID

Inherited from​

DocumentOf.id


layers​

layers: DocumentLayer<string>[]

Defined in: src/lib/document/schema.ts:102

The user's layers, top first

Inherited from​

DocumentOf.layers


name​

name: string

Defined in: src/lib/document/schema.ts:58

Inherited from​

DocumentOf.name


thumbnail?​

optional thumbnail?: DocumentThumbnail<string>

Defined in: src/lib/document/schema.ts:107

Inherited from​

DocumentOf.thumbnail


updatedAt?​

optional updatedAt?: string

Defined in: src/lib/document/schema.ts:69

When it was last changed (ISO 8601 date and time): its layers, size or details. Documents from before 1.1.0 have none (the canvas uses dateCreated for them).

Inherited from​

DocumentOf.updatedAt


width​

width: number

Defined in: src/lib/document/schema.ts:99

Inherited from​

DocumentOf.width