Interface LayoutsController

Readonlystore

changed

• changed(): void

• Tell the controller the target may have changed, for a target without subscribe.

  Returns void

destroy

• destroy(): void

• Stop listening. A queued operation rejects; a pending autosave is dropped, so flush() first to keep it.

  Returns void

duplicate

• duplicate(id: string, name: string): Promise<WorkspaceDocument>

• Parameters

  • id: string
  • name: string

  Returns Promise<WorkspaceDocument>

flush

• flush(): Promise<void>

• Compare the target with its layout now, autosave if due, and wait for every queued operation.

  Returns Promise<void>

open

• open(id: string): Promise<LayoutApplyReport>

• Show a saved layout and record it as active and recent, unless it already is. A change still waiting for the quiet period is autosaved into the layout being left first; when that write fails this rejects and changes nothing, and opening again goes ahead without it. A refused apply resolves with its report and leaves the target and the held layout as they were; when the store refuses the record, the previous layout goes back on the target and this rejects. It rejects too while the target is suspended.

  Parameters

  • id: string

  Returns Promise<LayoutApplyReport>

overwrite

• overwrite(): Promise<WorkspaceDocument>

• Reload, then write the target over the held layout, whatever another session saved there.

  Returns Promise<WorkspaceDocument>

reload

• reload(): Promise<WorkspaceCatalog>

• Read the catalog again, and resolve with a copy of it. The target is not touched. A paused autosave resumes, unless the held layout conflicts. After a page load, open(catalog.activeWorkspaceId) continues on the layout that was active.

  Returns Promise<WorkspaceCatalog>

remove

• remove(id: string): Promise<void>

• Delete a saved layout. Deleting the held one leaves the target as it is, holding none.

  Parameters

  • id: string

  Returns Promise<void>

rename

• rename(id: string, name: string): Promise<void>

• Parameters

  • id: string
  • name: string

  Returns Promise<void>

save

• save(): Promise<WorkspaceDocument>

• Write the target into the held layout. Rejects when no layout is held, and while it conflicts.

  Returns Promise<WorkspaceDocument>

saveAs

• saveAs(name: string): Promise<WorkspaceDocument>

• Save the target as a new layout, which becomes the held, active one.

  Parameters

  • name: string

  Returns Promise<WorkspaceDocument>

setAutosave

• setAutosave(enabled: boolean): Promise<void>

• Parameters

  • enabled: boolean

  Returns Promise<void>

state

• state(): LayoutsState

• Returns LayoutsState

subscribe

• subscribe(listener: (state: LayoutsState) => void): () => void

• Called after the state changes. Returns the unsubscribe.

  Parameters

  • listener: (state: LayoutsState) => void

  Returns () => void