Interface LayoutRegistry

The layouts a window manager offers, in the order the shell lists them.

interface LayoutRegistry {
    get(id: string): LayoutEntry | undefined;
    list(): readonly LayoutEntry[];
    register(entry: LayoutEntry): void;
}

Index

Methods

get list register

Methods

get

get(id: string): LayoutEntry | undefined
The layout with this id, if there is one.
Parameters
- id: string
Returns LayoutEntry | undefined

list

list(): readonly LayoutEntry[]

Every layout, in registration order.

Returns readonly LayoutEntry[]

register

register(entry: LayoutEntry): void
Add a layout.
Parameters
- entry: LayoutEntry
Returns void

Throws
invalid:duplicate-layout when the id is taken.