QuickBase JS SDK v2 - v2.2.2
    Preparing search index...

    Interface GenerateDocumentParams

    Generate a document

    interface GenerateDocumentParams {
        filename: string;
        format?: "html" | "pdf" | "docx";
        margin?: string;
        orientation?: "portrait" | "landscape";
        pageSize?: "Letter" | "Legal" | "Tabloid" | "A3" | "A4" | "A5" | "A6";
        realm?: string;
        recordId?: number;
        tableId: string;
        templateId: number;
        unit?: "in" | "cm" | "nm" | "px";
    }
    Index

    Properties

    filename format? margin? orientation? pageSize? realm? recordId? tableId templateId unit?

    Properties

    filename: string

    File name for the downloaded file

    format?: "html" | "pdf" | "docx"

    The format of the file that is returned. Default is "pdf".

    margin?: string

    Margin formatted as top right bottom left, separated by spaces. Add to override the value set in the template builder.

    orientation?: "portrait" | "landscape"

    Page orientation. Default is "portrait". Add to override the value set in the template builder.

    pageSize?: "Letter" | "Legal" | "Tabloid" | "A3" | "A4" | "A5" | "A6"

    Page size. Default is "A4". Add to override the value set in the template builder.

    realm?: string

    Your Quickbase domain, for example demo.quickbase.com

    recordId?: number

    The ID of the record

    tableId: string

    The unique identifier of the table.

    templateId: number

    This is the ID of document template.

    unit?: "in" | "cm" | "nm" | "px"

    Unit of measurement for the margin. Default is "in". Add to override the value set in the template builder.

    Settings

    Member Visibility

    On This Page

    Properties