esmDevelopers
JSプラグイン
esm API
JSプラグイン
esm API
  • SheetItem

SheetItem

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

継承

Item

インスタンスプロパティ

label

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

例

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

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

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

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

originalLabel読み取り専用

labelの初期値です。

例

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

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

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

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

disabled

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

例

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

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

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

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

インスタンスメソッド

setLabel

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

構文

setLabel(label);
引数

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

返値

なし

例

esmJSPlugin.screen.sheetSave("activity").onSheetItemsMounted((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((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((SheetSaveScreen) => {
  const IntervieweeItem = SheetSaveScreen.getSheetItemByLabel("当日面談者");
  // 初期値を確認
  console.log("初期値:", intervieweeItem.label); // 初期値: "当日面談者"

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

isDisabled

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

構文

isDisabled();
引数

なし

返値

真偽値

例

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

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

setDisabled

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

構文

isDisabled(disabled);
引数

disabled

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

返値

なし

例

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

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

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

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

setLabelColor

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

構文

setLabelColor(color);
引数

color

色を示す文字列です。

返値

なし

例

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

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

setBackgroundColor

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

構文

setBackgroundColor(color);
引数

color

色を示す文字列です。

返値

なし

例

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

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

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

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

基本項目

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

項目型クラス
プルダウン型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

関連情報

  • ActivityTimeItem
  • AddressItem
  • ContactItem
  • DateItem
  • DatetimeItem
  • EmailItem
  • FacilityItem
  • FileItem
  • IntervieweeItem
  • IntroductionSourceItem
  • MemoItem
  • MultiSelectItem
  • NumberItem
  • ParticipantItem
  • PasswordItem
  • ReceiverItem
  • RelationItem
  • ResponsibilityItem
  • ResponsibleDepartmentItem
  • ResponsibleEmployeeItem
  • ResponsibleGroupItem
  • ScenarioItem
  • ScheduleItem
  • ScheduleTimeItem
  • SingleSelectItem
  • StringItem
  • TaskAssigneeItem
  • TaskItem
  • TimeItem
  • TreeViewItem
  • URLItem