@mendix/extensions-api - v0.9.0
    Preparing search index...

    Interface DocumentTemplate

    A unit is a container of elements, it can not contain other units.

    interface DocumentTemplate {
        $CreationOptions?: unknown;
        $ID: string;
        $Type: "DocumentTemplates$DocumentTemplate";
        $UnitID?: string;
        canvasWidth: number;
        documentation: string;
        excluded: boolean;
        exportLevel: ExportLevel;
        footer: null | Footer;
        header: null | DocumentTemplates.Header;
        marginBottomInInch: number;
        marginLeftInInch: number;
        marginRightInInch: number;
        marginTopInInch: number;
        name: string;
        pageHeight: string;
        pageWidth: string;
        parameters: DocumentTemplateParameter[];
        ppi: number;
        showHeaderAndFooterOnFirstPage: boolean;
        style: Style;
        toplevels: DocumentTemplates.Widget[];
        addDataGrid(): Promise<DocumentTemplates.DataGrid>;
        addDataView(): Promise<DocumentTemplates.DataView>;
        addDocumentTemplateParameter(): Promise<DocumentTemplateParameter>;
        addDynamicImageViewer(): Promise<DocumentTemplates.DynamicImageViewer>;
        addDynamicLabel(): Promise<DynamicLabel>;
        addLineBreak(): Promise<LineBreak>;
        addPageBreak(): Promise<PageBreak>;
        addStaticImageViewer(): Promise<DocumentTemplates.StaticImageViewer>;
        addStaticLabel(): Promise<StaticLabel>;
        addTable(): Promise<DocumentTemplates.Table>;
        addTemplateGrid(): Promise<DocumentTemplates.TemplateGrid>;
        addTitle(): Promise<DocumentTemplates.Title>;
        getDataGrid(name: string): undefined | DocumentTemplates.DataGrid;
        getDataView(name: string): undefined | DocumentTemplates.DataView;
        getDocumentTemplateParameter(
            name: string,
        ): undefined | DocumentTemplateParameter;
        getDynamicImageViewer(
            name: string,
        ): undefined | DocumentTemplates.DynamicImageViewer;
        getDynamicLabel(name: string): undefined | DynamicLabel;
        getLineBreak(name: string): undefined | LineBreak;
        getPageBreak(name: string): undefined | PageBreak;
        getStaticImageViewer(
            name: string,
        ): undefined | DocumentTemplates.StaticImageViewer;
        getStaticLabel(name: string): undefined | StaticLabel;
        getTable(name: string): undefined | DocumentTemplates.Table;
        getTemplateGrid(name: string): undefined | DocumentTemplates.TemplateGrid;
        getTitle(name: string): undefined | DocumentTemplates.Title;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type $UnitID? canvasWidth documentation excluded exportLevel footer header marginBottomInInch marginLeftInInch marginRightInInch marginTopInInch name pageHeight pageWidth parameters ppi showHeaderAndFooterOnFirstPage style toplevels

    Methods

    addDataGrid addDataView addDocumentTemplateParameter addDynamicImageViewer addDynamicLabel addLineBreak addPageBreak addStaticImageViewer addStaticLabel addTable addTemplateGrid addTitle getDataGrid getDataView getDocumentTemplateParameter getDynamicImageViewer getDynamicLabel getLineBreak getPageBreak getStaticImageViewer getStaticLabel getTable getTemplateGrid getTitle

    Properties

    $CreationOptions?: unknown

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "DocumentTemplates$DocumentTemplate"

    The type of the element.

    $UnitID?: string
    canvasWidth: number
    documentation: string
    excluded: boolean
    exportLevel: ExportLevel
    footer: null | Footer
    header: null | DocumentTemplates.Header
    marginBottomInInch: number
    marginLeftInInch: number
    marginRightInInch: number
    marginTopInInch: number
    name: string
    pageHeight: string
    pageWidth: string
    parameters: DocumentTemplateParameter[]
    ppi: number
    showHeaderAndFooterOnFirstPage: boolean
    style: Style
    toplevels: DocumentTemplates.Widget[]

    Methods

    • Parameters

      • name: string

      Returns undefined | LineBreak

    • Parameters

      • name: string

      Returns undefined | PageBreak

    Settings

    On This Page

    Properties
    Methods