Trilium Frontend API
    Preparing search index...

    Interface DownloadOptions

    interface DownloadOptions {
        autoTable?: {} | ((doc: any) => any);
        bom?: boolean;
        compress?: boolean;
        delimiter?: string;
        documentProcessing?: (input: any) => any;
        jsPDF?: any;
        orientation?: "portrait" | "landscape";
        rowCalcStyles?: any;
        rowGroupStyles?: any;
        sheetName?: string;
        style?: boolean;
        test?: {};
        title?: string;
        writeOptions?: Record<string, unknown>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoTable? bom? compress? delimiter? documentProcessing? jsPDF? orientation? rowCalcStyles? rowGroupStyles? sheetName? style? test? title? writeOptions?

    Properties

    autoTable?: {} | ((doc: any) => any)
    bom?: boolean

    If you need the output CSV to include a byte order mark (BOM) to ensure that output with UTF-8 characters can be correctly interpreted across different applications, you should set the bom option to true.

    compress?: boolean
    delimiter?: string

    By default CSV files are created using a comma (,) delimiter. If you need to change this for any reason the you can pass the options object with a delimiter property to the download function which will then use this delimiter instead of the comma.

    documentProcessing?: (input: any) => any

    An optional callback documentProcessing can be set on the download config object, that is passed the jsPDF document object after the auto-table creation to allow full customization of the PDF

    jsPDF?: any
    orientation?: "portrait" | "landscape"
    rowCalcStyles?: any
    rowGroupStyles?: any
    sheetName?: string

    The sheet name must be a valid Excel sheet name, and cannot include any of the following characters , /, *, [, ], :,

    style?: boolean

    By default the HTML output is a simple un-styled table. if you would like to match the current table styling you can set the style property to true.

    test?: {}
    title?: string
    writeOptions?: Record<string, unknown>

    Settings

    Member Visibility

    On This Page

    Properties