SheetIndexScreen

SheetIndexScreenクラスは一覧ページに対して操作を行うためのメンバーを持っています。

継承

• Screen

インスタンスメソッド

onHeaderMounted

Headerインスタンスが初期化されたタイミングで関数を実行するeventHookを登録します。

構文

onHeaderMounted(callback);
onHeaderMounted(callback, group);

引数

callback

Headerインスタンスが初期化されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen
  .sheetIndex("customer")
  .onHeaderMounted(function (screen) {
    const header = screen.getHeader();
    // ボタンが追加されます
    header.setButtons([
      {
        onClick: () => {
          console.log("clicked");
        },
        iconProps: {
          imgSrc: "./icon/icon.png",
          title: "カスタムボタン",
        },
      },
    ]);
  });

onLocalToolMountedブラウザー

LocalToolインスタンスが初期化されたタイミングで関数を実行するeventHookを登録します。

構文

onLocalToolMounted(callback);
onLocalToolMounted(callback, group);

引数

callback

LocalToolインスタンスが初期化されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen
  .sheetIndex("customer")
  .onLocalToolMounted(function (screen) {
    const localTool = screen.getLocalTool();
    // ボタンが追加されます
    localTool.setButtons([
      {
        onClick: () => {
          console.log("clicked");
        },
        title: "カスタムボタン",
      },
    ]);
  });

onSelectOptionsMountedモバイルアプリ

ListSelectOptionsインスタンスが初期化されたタイミングで関数を実行するeventHookを登録します。

構文

onSelectOptionsMounted(callback);
onSelectOptionsMounted(callback, group);

引数

callback

ListSelectOptionsインスタンスが初期化されたタイミングで実行する関数です。

group

指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。

返値

登録したeventHookを解除する関数を返します。

例

esmJSPlugin.screen
  .sheetIndex("customer")
  .onSelectOptionsMounted(function (screen) {
    const selectOptions = screen.getSelectOptions();
    // ボタンが追加されます
    selectOptions.setSelectionToolButtons([
      {
        onClick: () => {
          console.log("clicked");
        },
        title: "カスタムボタン",
      },
    ]);
  });

getHeader

ヘッダーを表すHeaderインスタンスを返します。

構文

getHeader();

引数

なし

返値

ヘッダーを表すHeaderインスタンスです。

例

esmJSPlugin.screen
  .sheetIndex("businessplan")
  .onHeaderMounted(function (screen) {
    const header = screen.getHeader();
    // ボタンが追加されます
    header.setButtons([
      {
        onClick: () => {
          console.log("clicked");
        },
        iconProps: {
          imgSrc: "./icon/icon.png",
          title: "カスタムボタン",
        },
      },
    ]);
  });

getLocalToolブラウザー

ローカルツールを表すLocalToolインスタンスを返します。

構文

getLocalTool();

引数

なし

返値

ローカルツールLocalToolインスタンスです。

例

esmJSPlugin.screen.sheetIndex("customer").onLocalToolMounted(function (screen) {
  const localTool = screen.getLocalTool();
  // ボタンが追加されます
  localTool.setButtons([
      {
        onClick: () => {
          console.log("clicked");
        },
        title: "カスタムボタン",
      },
    ]);
});

getSelectOptionsモバイルアプリ

レコード一覧画面の選択モードの選択肢を表すListSelectOptionsインスタンスを返します。

構文

getSelectOptions();

引数

なし

返値

レコード一覧画面の選択モードの選択肢ListSelectOptionsインスタンスです。

例

esmJSPlugin.screen.sheetIndex("customer").onSelectOptionsMounted(function (screen) {
  const selectOptions = screen.getSelectOptions();
  // ボタンが追加されます
  selectOptions.setSelectionToolButtons([
      {
        onClick: () => {
          console.log("clicked");
        },
        title: "カスタムボタン",
      },
    ]);
});

getSelectedSheetIds

選択されているレコードのIDを返します。

構文

getSelectedSheetIds();

引数

なし

返値

選択されているレコードのIDが、数値型の配列で返されます。

例

esmJSPlugin.screen.sheetIndex("customer").onLocalToolMounted(function (screen) {
 const localTool = screen.getLocalTool();
 localTool.setSelectionToolButtons([
    {
      title: "カスタムボタン",
      onClick: () => {
        const selectedRecordIds = screen.getSelectedSheetIds();
        // 選択されたレコードのIDが、数値型の配列で出力されます。
        console.log('選択されたレコードのID:', selectedRecordIds);     
      }
    }
 ])
});

Info

一覧画面で全て選択のチェックが入っている場合、レコードのIDを取得することができません。

関連情報

• Header
• LocalTool