Interface LayoutTarget

The widget or grid a controller saves and restores. A grid is { capture: () => grid.getWorkspace(), apply: p => grid.applyWorkspace(p) }.

interface LayoutTarget {
    apply(payload: WorkspacePayload): LayoutApplyReport;
    capture(): WorkspacePayload;
    subscribe(listener: () => void): () => void;
    suspended(): boolean;
}

Index

Methods

apply capture subscribe? suspended?

Methods

apply

apply(payload: WorkspacePayload): LayoutApplyReport
Show a saved layout, or change nothing and say why. The controller also puts the previous layout back through it when the store refuses to record the new one, so a refused apply must leave the target untouched.
Parameters
- payload: WorkspacePayload
Returns LayoutApplyReport
- Defined in src/widget/layouts.ts:31

capture

capture(): WorkspacePayload
The target as it stands, as a portable workspace payload.

Returns WorkspacePayload
- Defined in src/widget/layouts.ts:25

`Optional`subscribe

subscribe(listener: () => void): () => void
Called on each change the user makes. Without it the host calls changed(). Returns the unsubscribe.
Parameters
- listener: () => void
Returns () => void
- Defined in src/widget/layouts.ts:33

`Optional`suspended

suspended(): boolean
True while the target shows something other than the layout the user is building, as a chart does during a replay: its bars stop at a moment in the past and a replay may change the view on every step. Autosave waits and open is refused until it turns false, which the target announces through its subscribe listener (or the host through changed()). A save the user asks for still goes through. Since 2.5.10.

Returns boolean
- Defined in src/widget/layouts.ts:42