SheetItem

SheetItemクラスはアプリ項目の共通的なデータへのアクセスや操作を提供するメンバーを持っています。
各アプリ項目とサブクラスの対応はこちらをご確認ください。

継承

インスタンスプロパティ

label

項目名を示す文字列です。

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.label); // 初期値: "当日面談者"

  // 値を変更
  intervieweeItem.label = "面談対象";

  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.label); // 変更後: "面談対象"
});

originalLabel読み取り専用

labelの初期値です。

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.originalLabel); // 初期値: "当日面談者"

  // 値を変更
  intervieweeItem.label = "面談対象";

  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.originalLabel); // 変更後: "当日面談者"
});

disabled

項目の入力可否を示す真偽値です。

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.disabled); // 初期値: true

  // 値を変更
  intervieweeItem.disabled = false;

  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.disabled); // 変更後: false
});

hidden

項目の表示・非表示状態を示す真偽値です。

Important

表示・非表示に関する注意事項は項目の表示・非表示の注意点をご確認ください。

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.hidden); // 初期値: false
  
  // 値を変更
  intervieweeItem.hidden = true;
  
  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.hidden); // 変更後: true
});

インスタンスメソッド

setLabel

文字列を受け取り、入力内容を変更します。

構文

setLabel(label);

引数

label
入力内容を示す文字列です。

返値

なし

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.label); // 初期値: "当日面談者"

  // 値を変更
  intervieweeItem.setLabel("面談対象");

  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.label); // 変更後: "面談対象"
});

labelContains

指定した文字列が label に含まれているかどうかを判定します。

構文

labelContains(substring);

引数

substring
検索対象の文字列です。

返値

真偽値

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.label); // 初期値: "当日面談者"

  const containsBrain = intervieweeItem.labelContains("ブレイン");
  console.log("「ブレイン」が含まれるか:", containsBrain); // 「ブレイン」が含まれるか: false
});

labelEqualsTo

label が指定した文字列と一致するかどうかを判定します。

構文

labelEqualsTo(string);

引数

string
比較対象の文字列です。

返値

真偽値

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.label); // 初期値: "当日面談者"

  const isEqual = intervieweeItem.labelEqualsTo("当日面談者");
  console.log("「当日面談者」と一致するか:", isEqual); // 「当日面談者」と一致するか: true
});

isDisabled

項目の入力可否を判定します。

構文

isDisabled();

引数

なし

返値

真偽値

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.isDisabled(); // true
});

isHidden

項目の表示・非表示状態を判定します。

Important

表示・非表示に関する注意事項は項目の表示・非表示の注意点をご確認ください。

構文

isHidden();

引数

なし

返値

真偽値

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.isHidden(); // false
});

setDisabled

項目の入力可否を変更します。

構文

setDisabled(disabled);

引数

disabled

入力可否を示す真偽値です。

返値

なし

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.disabled); // 初期値: true

  // 値を変更
  intervieweeItem.setDisabled(false);

  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.disabled); // 変更後: false
});

setHidden

項目の表示・非表示状態を変更します。

Important

表示・非表示に関する注意事項は項目の表示・非表示の注意点をご確認ください。

構文

setHidden(isHidden);

引数

isHidden

表示・非表示状態を示す真偽値です。

返値

なし

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  // 初期値を確認
  console.log("初期値:", intervieweeItem.isHidden()); // 初期値: false

  // 値を変更
  intervieweeItem.setHidden(true);

  // 変更後の値を確認
  console.log("変更後:", intervieweeItem.isHidden()); // 変更後: true
});

setLabelColor

項目名の文字の色を変更します。

構文

setLabelColor(color);

引数

color

色を示す文字列です。

返値

なし

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.setLabelColor("red");
});

setBackgroundColor

項目の背景色を変更します。

構文

setBackgroundColor(color);

引数

color

色を示す文字列です。

返値

なし

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted(function (SheetSaveScreen) {
  const intervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");

  intervieweeItem.setBackgroundColor("red");
});

setButtonsブラウザー

項目にボタンを追加します。

Important

setButtons はSheetDetailScreenクラスのアプリ項目のみに使用することができます。
SheetSaveScreenクラスやSheetIndexScreenクラスのアプリ項目には使用することができません。

構文

setButtons([
      {
        onClick: callback,
        title: title,
      },
    ]);

引数

onClick

ボタンがクリックされたときに実行される関数です。

title

ボタンに表示される文字列です。

返値

なし

例

esmJSPlugin.screen.sheetDetail("businessplan").onEntered(function (screen) {
  const businessplanNameItem = screen.getSheetItem("businessplans.businessplan.businessplan_name"); 

  businessplanNameItem.onMounted(function () {
    // クリックされたタイミングで関数を実行するボタンを追加する
    businessplanNameItem.setButtons([
      {
        onClick: () => {
          alert("clicked");
        },
        title: "カスタムボタン",
      },
    ]);
  });
});

アプリ項目とクラスの対応

各アプリ項目とクラスの対応は以下で確認できます。

基本項目

一般的な項目型については、型によって対応するクラスが決まります。

項目型	クラス
プルダウン型	SingleSelectItem
ラジオボタン型	SingleSelectItem
チェックボックス型	MultiSelectItem
数値型	NumberItem
日付型	DateItem
時間型	TimeItem
日時型	DatetimeItem
テキスト型	StringItem
テキスト型(マスキング形式)	PasswordItem
テキスト(複数行)型	MemoItem
ファイル型	FileItem
リンク型	URLItem
電話番号型	StringItem
住所型	AddressItem
メールアドレス型	EmailItem
演算(文字)型	StringItem
演算(数値)型	NumberItem
紐づけ型	RelationItem
日付型(タスク)	TaskItem
日付型(スケジュール)	ScheduleItem

特殊項目

一般的でない（各アプリに固有の）項目については、以下でそれぞれの項目とクラスの対応を確認できます。

アプリ名	項目名	クラス
顧客	顧客タイプ	TreeViewItem
顧客	自社担当者	ResponsibleEmployeeItem
顧客	自社担当部署	ResponsibleDepartmentItem
顧客	自社担当グループ	ResponsibleGroupItem
顧客	顧客コンタクト先	ContactItem
顧客	顧客シナリオ	ScenarioItem
名刺	受取人	ReceiverItem
名刺	紹介元	IntroductionSourceItem
案件	自社担当者	ResponsibleEmployeeItem
案件	自社担当部署	ResponsibleDepartmentItem
案件	自社担当グループ	ResponsibleGroupItem
案件	案件コンタクト先	ContactItem
案件	案件シナリオ	ScenarioItem
取引	自社担当者	ResponsibleEmployeeItem
取引	自社担当部署	ResponsibleDepartmentItem
取引	自社担当グループ	ResponsibleGroupItem
活動	活動時間	ActivityTimeItem
活動	当日面談者	IntervieweeItem
商品	所属カテゴリ	TreeViewItem
社員	担当業務	ResponsibilityItem
社員	部署名	TreeViewItem
スケジュール	日時	ScheduleTimeItem
スケジュール	参加者	ParticipantItem
スケジュール	設備・備品	FacilityItem
スケジュール	当日面談者	IntervieweeItem
タスク	担当者	TaskAssigneeItem
タスク	社外担当者	IntervieweeItem

項目の表示・非表示の注意点

Important

登録・変更・詳細画面における項目の表示・非表示の注意点

システム必須項目については、非表示設定にしても項目は表示されます。
紐付け先アプリの項目に関しては、紐付け先アプリ側でシステム必須項目に該当する場合、非表示設定にしても項目は表示されます。
代表項目5番・6番の項目については、非表示設定にしても項目は表示されます。
任意で必須設定をしている項目については、非表示設定にすることが可能です。
非表示時は空き領域を左詰め、行全体が空行であれば上詰めになります。
代表項目エリアは非表示にしても左詰めになりません。
非表示にした項目の値は保持され、演算型項目などの参照元として利用可能です。

登録・変更画面における項目の表示・非表示の注意点

必須項目を非表示にした場合、その項目が未入力であっても登録・変更処理は可能です。
非表示にした項目の値は保持され、登録・変更処理が行われます。
未入力であることによるもの以外のエラー（例：数値型項目に文字列を入力する）は、非表示状態でも表示されます。