FileMaker Data API Tools API - v1.2.0
    Preparing search index...

    Interface FmWebLayoutLoadResult

    interface FmWebLayoutLoadResult {
        layout: {
            schemaVersion: 1;
            id: string;
            name: string;
            fmLayoutName?: string;
            canvas: { width: number; height: number; gridSize: number };
            objects: (
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: {
                        top: boolean;
                        right: boolean;
                        bottom: boolean;
                        left: boolean;
                    };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToWebLayout"
                            | "goToFmLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "field";
                    fmFieldName: string;
                    displayType: "editBox"
                    | "dropdown"
                    | "checkbox"
                    | "radio";
                    format: "number" | "text" | "date";
                    label?: string;
                    labelPosition: "none" | "top" | "right" | "left";
                    required: boolean;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: {
                        top: boolean;
                        right: boolean;
                        bottom: boolean;
                        left: boolean;
                    };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToWebLayout"
                            | "goToFmLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "text";
                    text: string;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: {
                        top: boolean;
                        right: boolean;
                        bottom: boolean;
                        left: boolean;
                    };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToWebLayout"
                            | "goToFmLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "button";
                    label: string;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: {
                        top: boolean;
                        right: boolean;
                        bottom: boolean;
                        left: boolean;
                    };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToWebLayout"
                            | "goToFmLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "portal";
                    relatedContext: string;
                    rowCount: number;
                    columns: {
                        id: string;
                        fmFieldName: string;
                        label: string;
                        width: number;
                    }[];
                    scroll: boolean;
                    selectableRows: boolean;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: {
                        top: boolean;
                        right: boolean;
                        bottom: boolean;
                        left: boolean;
                    };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToWebLayout"
                            | "goToFmLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "rectangle";
                    cornerRadius: number;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: {
                        top: boolean;
                        right: boolean;
                        bottom: boolean;
                        left: boolean;
                    };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToWebLayout"
                            | "goToFmLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "image";
                    src?: string;
                    alt?: string;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: {
                        top: boolean;
                        right: boolean;
                        bottom: boolean;
                        left: boolean;
                    };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToWebLayout"
                            | "goToFmLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "tabPanel";
                    tabs: { id: string; label: string }[];
                }
            )[];
            styles: {
                colors: {
                    canvas: string;
                    surface: string;
                    text: string;
                    accent: string;
                };
                typography: { fontFamily: string; fontSize: number };
            };
        };
        source: "created"
        | "existing";
        filePath: string;
    }
    Index

    Properties

    layout: {
        schemaVersion: 1;
        id: string;
        name: string;
        fmLayoutName?: string;
        canvas: { width: number; height: number; gridSize: number };
        objects: (
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "field";
                fmFieldName: string;
                displayType: "editBox"
                | "dropdown"
                | "checkbox"
                | "radio";
                format: "number" | "text" | "date";
                label?: string;
                labelPosition: "none" | "top" | "right" | "left";
                required: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "text";
                text: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "button";
                label: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "portal";
                relatedContext: string;
                rowCount: number;
                columns: {
                    id: string;
                    fmFieldName: string;
                    label: string;
                    width: number;
                }[];
                scroll: boolean;
                selectableRows: boolean;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "rectangle";
                cornerRadius: number;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "image";
                src?: string;
                alt?: string;
            }
            | {
                id: string;
                name: string;
                x: number;
                y: number;
                width: number;
                height: number;
                zIndex: number;
                anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                style?: { token: string };
                behavior?: {
                    type?:
                        | "runScript"
                        | "goToWebLayout"
                        | "goToFmLayout"
                        | "openUrl"
                        | "showDialog";
                    scriptName?: string;
                    targetLayoutId?: string;
                    targetFmLayoutName?: string;
                    url?: string;
                    dialogId?: string;
                    parameter?: string;
                };
                type: "tabPanel";
                tabs: { id: string; label: string }[];
            }
        )[];
        styles: {
            colors: {
                canvas: string;
                surface: string;
                text: string;
                accent: string;
            };
            typography: { fontFamily: string; fontSize: number };
        };
    }
    source: "created" | "existing"
    filePath: string