Type Alias BaseQueryParams

Base parameters for locating a particular sheet or set.

type BaseQueryParams = {
    onlySetIndex?: number;
    page?: string;
    selectedIndex?: number;
}

Properties

onlySetIndex?: number

If provided, only the set at this index will be loaded. This is often used for embedding or extracting a single set.

page?: string

The page parameter, which can be a shortlink (sl|) or a BiS sheet (bis||).

selectedIndex?: number

The index of the set that should be selected by default.