Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias DisplayPreferencesDto

    Defines the display preferences for any item that supports them (usually Folders).

    type DisplayPreferencesDto = {
        Id?: string | null;
        ViewType?: string | null;
        SortBy?: string | null;
        IndexBy?: string | null;
        RememberIndexing?: boolean;
        PrimaryImageHeight?: number;
        PrimaryImageWidth?: number;
        CustomPrefs?: { [key: string]: string | null };
        ScrollDirection?: "Horizontal" | "Vertical";
        ShowBackdrop?: boolean;
        RememberSorting?: boolean;
        SortOrder?: "Ascending" | "Descending";
        ShowSidebar?: boolean;
        Client?: string | null;
    }
    Index
    Id?: string | null

    Gets or sets the user id.

    ViewType?: string | null

    Gets or sets the type of the view.

    SortBy?: string | null

    Gets or sets the sort by.

    IndexBy?: string | null

    Gets or sets the index by.

    RememberIndexing?: boolean

    Gets or sets a value indicating whether [remember indexing].

    PrimaryImageHeight?: number

    Gets or sets the height of the primary image.

    PrimaryImageWidth?: number

    Gets or sets the width of the primary image.

    CustomPrefs?: { [key: string]: string | null }

    Gets or sets the custom prefs.

    ScrollDirection?: "Horizontal" | "Vertical"

    An enum representing the axis that should be scrolled.

    ShowBackdrop?: boolean

    Gets or sets a value indicating whether to show backdrops on this item.

    RememberSorting?: boolean

    Gets or sets a value indicating whether [remember sorting].

    SortOrder?: "Ascending" | "Descending"

    An enum representing the sorting order.

    ShowSidebar?: boolean

    Gets or sets a value indicating whether [show sidebar].

    Client?: string | null

    Gets or sets the client.