PDF Web Viewer
    Preparing search index...

    Interface ILayoutConfig

    Result object returned from PDF editor setup

    interface ILayoutConfig {
        chooseFile?: {
            create?: boolean;
            customProviders?: boolean;
            dropbox?: boolean;
            googleDrive?: boolean;
            oneDrive?: boolean;
            recents?: boolean;
        };
        dialogs?: {
            documentProperties?: {
                tabs?: {
                    description?: boolean;
                    fonts?: boolean;
                    initialView?: boolean;
                    security?: boolean;
                };
            };
        };
        header?: IHeaderConfig;
        navigationBar?: {
            controls: {
                downloadButton?: boolean;
                pageNavigationButtons?: boolean;
                pageNumberInput?: boolean;
                viewSelectButton?: boolean;
            };
            enabled?: boolean;
        };
        sidebar?: {
            content?: {
                attachments?: boolean;
                bookmarks?: boolean;
                layers?: boolean;
                preview?: boolean;
            };
            enabled?: boolean;
        };
        tabBar?: { enabled?: boolean };
        toolAreas?: ToolAreasConfig;
        topBar?: {
            controls?: {
                fileName?: boolean;
                mainMenu?: {
                    enabled?: boolean;
                    options?: {
                        close?: boolean;
                        createNew?: boolean;
                        documentProperties?: boolean;
                        open?: boolean;
                        print?: boolean;
                        printSelection?: boolean;
                        save?: boolean;
                        saveAs?: boolean;
                        saveOptimized?: boolean;
                        settings?: boolean;
                    };
                };
                print?: boolean;
                search?: boolean;
                snapshot?: boolean;
                undoRedo?: boolean;
                viewOptions?: {
                    enabled?: boolean;
                    options?: {
                        continuousView?: boolean;
                        coverPageView?: boolean;
                        enableScrolling?: boolean;
                        fitToPage?: boolean;
                        fullscreen?: boolean;
                        panTool?: boolean;
                        rotate?: boolean;
                        selectTool?: boolean;
                        singlePageView?: boolean;
                        view3D?: boolean;
                        viewSideBySide?: boolean;
                        zoomIn?: boolean;
                        zoomOut?: boolean;
                        zoomToFit?: boolean;
                    };
                };
                zoom?: boolean;
            };
            enabled?: boolean;
        };
        variant?: LayoutVariant;
    }
    Index

    Properties

    chooseFile? dialogs? header? navigationBar? sidebar? tabBar? toolAreas? topBar? variant?

    Properties

    chooseFile?: {
        create?: boolean;
        customProviders?: boolean;
        dropbox?: boolean;
        googleDrive?: boolean;
        oneDrive?: boolean;
        recents?: boolean;
    }

    Type declaration

    • Optionalcreate?: boolean
    • OptionalcustomProviders?: boolean

      Show host-owned custom cloud tabs on the home screen (requires customProviders). Default: true.

    • Optionaldropbox?: boolean

      Show the Dropbox card on the home screen (requires dropboxConfig). Default: true.

    • OptionalgoogleDrive?: boolean

      Show the Google Drive card on the home screen (requires googleDriveConfig). Default: true.

    • OptionaloneDrive?: boolean

      Show the OneDrive card on the home screen (requires oneDriveConfig). Default: true.

    • Optionalrecents?: boolean
    dialogs?: {
        documentProperties?: {
            tabs?: {
                description?: boolean;
                fonts?: boolean;
                initialView?: boolean;
                security?: boolean;
            };
        };
    }

    Optional: Dialogs configuration

    header?: IHeaderConfig

    Header configuration

    navigationBar?: {
        controls: {
            downloadButton?: boolean;
            pageNavigationButtons?: boolean;
            pageNumberInput?: boolean;
            viewSelectButton?: boolean;
        };
        enabled?: boolean;
    }

    Optional: Navigation bar controls

    sidebar?: {
        content?: {
            attachments?: boolean;
            bookmarks?: boolean;
            layers?: boolean;
            preview?: boolean;
        };
        enabled?: boolean;
    }

    Sidebar configuration

    tabBar?: { enabled?: boolean }

    Document tab bar configuration. Set enabled: false to hide the built-in tab bar. When hidden, use result.documentTabs to build your own custom tab bar. Default: true (built-in tab bar is visible).

    Type declaration

    • Optionalenabled?: boolean

      Whether to show the built-in documents tab bar. Default: true

    toolAreas?: ToolAreasConfig

    Context-sensitive tool area toolbar visibility. Floating toolbars that appear when a feature tool is active. All visible by default. Set to false to hide.

    topBar?: {
        controls?: {
            fileName?: boolean;
            mainMenu?: {
                enabled?: boolean;
                options?: {
                    close?: boolean;
                    createNew?: boolean;
                    documentProperties?: boolean;
                    open?: boolean;
                    print?: boolean;
                    printSelection?: boolean;
                    save?: boolean;
                    saveAs?: boolean;
                    saveOptimized?: boolean;
                    settings?: boolean;
                };
            };
            print?: boolean;
            search?: boolean;
            snapshot?: boolean;
            undoRedo?: boolean;
            viewOptions?: {
                enabled?: boolean;
                options?: {
                    continuousView?: boolean;
                    coverPageView?: boolean;
                    enableScrolling?: boolean;
                    fitToPage?: boolean;
                    fullscreen?: boolean;
                    panTool?: boolean;
                    rotate?: boolean;
                    selectTool?: boolean;
                    singlePageView?: boolean;
                    view3D?: boolean;
                    viewSideBySide?: boolean;
                    zoomIn?: boolean;
                    zoomOut?: boolean;
                    zoomToFit?: boolean;
                };
            };
            zoom?: boolean;
        };
        enabled?: boolean;
    }

    Optional: Top bar controls

    variant?: LayoutVariant

    Overall layout. Defaults to LayoutVariant.DEFAULT. The navigation-sidebar rail's collapsed state is user-controlled and persisted in localStorage.

    Settings

    Member Visibility

    On This Page

    Properties