Interface ExportedDataState

Root data structure for the stored data state

interface ExportedDataState {
    blockCollections: readonly DucBlockCollection[];
    blockInstances: readonly DucBlockInstance[];
    blocks: readonly DucBlock[];
    charter: DucCharter;
    dictionary: undefined | Dictionary;
    elements: readonly DucElement[];
    files: undefined | DucExternalFiles;
    filesData: undefined | ExternalFilesData;
    globalState: DucGlobalState;
    groups: readonly DucGroup[];
    id: string;
    issues: DucIssue[];
    layers: readonly DucLayer[];
    localState: DucLocalState;
    regions: readonly DucRegion[];
    source: string;
    thumbnail: undefined | Uint8Array<ArrayBufferLike>;
    type: string;
    version: string;
    versionGraph: undefined | VersionGraph;
}

Properties

blockCollections blockInstances blocks charter dictionary elements files filesData globalState groups id issues layers localState regions source thumbnail type version versionGraph

Properties

blockCollections

blockCollections: readonly DucBlockCollection[]

blockInstances

blockInstances: readonly DucBlockInstance[]

blocks

blocks: readonly DucBlock[]

charter

charter: DucCharter

dictionary

dictionary: undefined | Dictionary

elements

elements: readonly DucElement[]

files

files: undefined | DucExternalFiles

filesData

filesData: undefined | ExternalFilesData

Revision data blobs keyed by revision id. Separated from metadata for lazy loading.

globalState

globalState: DucGlobalState

Project-wide settings that are saved with the document and shared by all users

groups

groups: readonly DucGroup[]

id

id: string

Actual file id

issues

issues: DucIssue[]

layers

layers: readonly DucLayer[]

localState

localState: DucLocalState

The user's current session state for a specific project

regions

regions: readonly DucRegion[]

source

source: string

thumbnail

thumbnail: undefined | Uint8Array<ArrayBufferLike>

type

type: string

version

version: string

versionGraph

versionGraph: undefined | VersionGraph

In case it is needed to embed the version control into the file format

Settings

Member Visibility

On This Page

Properties