Class Layout<T>

constructor

• new Layout<T extends LayoutInterface>(
      database: DatabaseBase,
      name: string,
  ): Layout<T>

  Type Parameters

  • T extends LayoutInterface

  Parameters

  • database: DatabaseBase
  • name: string

  Returns Layout<T>

Readonlydatabase

metadata

Readonlyname

Readonlyrecords

endpoint

• get endpoint(): string

  Base endpoint for this layout on FileMaker Data API.

  Returns string

getLayoutMeta

• getLayoutMeta(): Promise<
      {
          fieldMetaData: {
              autoEnter: boolean;
              displayType: | "calendar"
              | "editText"
              | "popupList"
              | "checkBox"
              | "radioButtons"
              | "selectionList"
              | "secureText";
              fourDigitYear: boolean;
              global: boolean;
              maxCharacters: number;
              maxRepeat: number;
              name: string;
              notEmpty: boolean;
              numeric: boolean;
              repetitionEnd: number;
              repetitionStart: number;
              result: "number"
              | "time"
              | "container"
              | "text"
              | "date"
              | "timeStamp";
              timeOfDay: boolean;
              type: "normal" | "summary" | "calculation";
              valueList?: string;
          }[];
          portalMetaData: Record<
              string,
              {
                  autoEnter: boolean;
                  displayType: | "calendar"
                  | "editText"
                  | "popupList"
                  | "checkBox"
                  | "radioButtons"
                  | "selectionList"
                  | "secureText";
                  fourDigitYear: boolean;
                  global: boolean;
                  maxCharacters: number;
                  maxRepeat: number;
                  name: string;
                  notEmpty: boolean;
                  numeric: boolean;
                  repetitionEnd: number;
                  repetitionStart: number;
                  result: "number"
                  | "time"
                  | "container"
                  | "text"
                  | "date"
                  | "timeStamp";
                  timeOfDay: boolean;
                  type: "normal" | "summary" | "calculation";
                  valueList?: string;
              }[],
          >;
          valueLists?: {
              name: string;
              type: string;
              values: { displayName: string; value: string }[];
          }[];
      },
  >

  Retrieves the layout metadata

  Returns Promise<
      {
          fieldMetaData: {
              autoEnter: boolean;
              displayType: | "calendar"
              | "editText"
              | "popupList"
              | "checkBox"
              | "radioButtons"
              | "selectionList"
              | "secureText";
              fourDigitYear: boolean;
              global: boolean;
              maxCharacters: number;
              maxRepeat: number;
              name: string;
              notEmpty: boolean;
              numeric: boolean;
              repetitionEnd: number;
              repetitionStart: number;
              result: "number"
              | "time"
              | "container"
              | "text"
              | "date"
              | "timeStamp";
              timeOfDay: boolean;
              type: "normal" | "summary" | "calculation";
              valueList?: string;
          }[];
          portalMetaData: Record<
              string,
              {
                  autoEnter: boolean;
                  displayType: | "calendar"
                  | "editText"
                  | "popupList"
                  | "checkBox"
                  | "radioButtons"
                  | "selectionList"
                  | "secureText";
                  fourDigitYear: boolean;
                  global: boolean;
                  maxCharacters: number;
                  maxRepeat: number;
                  name: string;
                  notEmpty: boolean;
                  numeric: boolean;
                  repetitionEnd: number;
                  repetitionStart: number;
                  result: "number"
                  | "time"
                  | "container"
                  | "text"
                  | "date"
                  | "timeStamp";
                  timeOfDay: boolean;
                  type: "normal" | "summary" | "calculation";
                  valueList?: string;
              }[],
          >;
          valueLists?: {
              name: string;
              type: string;
              values: { displayName: string; value: string }[];
          }[];
      },
  >

  The layout metadata.

  Throws

  If an error occurs during the API request.

runScript

• runScript(script: Script): Promise<ScriptResult>

  Executes a FileMaker script on this layout asynchronously and returns the result.

  Parameters

  • script: Script

    The script to be executed.

  Returns Promise<ScriptResult>

  • A promise that resolves to the script result or rejects with an error.