FacilityItem
FacilityItem クラスは設備・備品に対して操作を行うためのメンバーを持っています。
継承
インスタンスプロパティ
length
追加されている全ての設備・備品の数を示す数値です。
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.length); // 4
});
entityIds
追加されている全ての設備・備品の ID を示す数値の配列です。
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.entityIds); // [1,2,3,4]
});
entityNames
追加されている全ての設備・備品の名前を示す文字列の配列です。
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.entityNames); // ["会議室A", "会議室B"]
});
インスタンスメソッド
entityNamesInclude
設備・備品に指定した名前が含まれているかどうかを判定します。
構文
entityNamesInclude(name);
引数
name
設備・備品の名前を示す文字列です。
返値
真偽値
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.entityNames); // ["会議室A", "会議室B"]
console.log(facilityItem.entityNamesInclude("会議室A")); // true
});
entityIdsInclude
設備備品に指定した ID が含まれているかどうかを判定します。
構文
entityIdsInclude(ID);
引数
ID
設備・備品のIDを示す数値です。
返値
真偽値
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.entityIds); // [1,2,3]
console.log(facilityItem.entityNamesInclude(1)); // true
});
onFacilityAdded
設備・備品が追加された後に呼び出されるeventHookを登録します。
構文
onFacilityAdded(callback);
onFacilityAdded(callback, group);
引数
callback
設備・備品が追加されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
なし
例
esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
const unlisten = FacilityItem.onFacilityAdded(function () {
console.log("FacilityAdded");
unlisten(); // 解除
});
});
onFacilityRemoved
設備・備品が削除された後に呼び出されるeventHookを登録します。
構文
onFacilityRemoved(callback);
onFacilityRemoved(callback, group);
引数
callback
設備・備品が削除されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
なし
例
esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
const unlisten = FacilityItem.onFacilityRemoved(function () {
console.log("FacilityRemoved");
unlisten(); // 解除
});
});
onFacilitiesUpdated
設備・備品が更新された後に呼び出されるeventHookを登録します。
構文
onFacilitiesUpdated(callback);
onFacilitiesUpdated(callback, group);
引数
callback
設備・備品が更新されたタイミングで実行する関数です。
group
指定された値でeventHookをグルーピングします。
Listenable.unlistenGroupを利用して、ここで指定したgroupに属するeventHookを全て解除することができます。
返値
なし
例
esmJSPlugin.screen.sheetSave("schedule").onEntered(function (screen) {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
// entitiesが初期化されたタイミングで関数を実行
const unlisten = FacilityItem.onFacilitiesUpdated(function () {
console.log("FacilitiesUpdated");
unlisten(); // 解除
});
});
getFacilities
Facilitiesクラスのインスタンスを返します。
構文
getFacilities();
引数
なし
返値
Facilitiesクラスのインスタンス
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.length);
});
getFacilityBy
指定した ID のFacilityクラスのインスタンスを返します。
構文
getFacilities(ID);
引数
ID
設備・備品の ID を示す数値です。
返値
Facilityクラスのインスタンス
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
const facility = facilityItem.getFacilityBy(1);
console.log(facility.entityId);
// 1
});
getFacilityByIndex
指定した行のFacilityクラスのインスタンスを返します。
構文
getFacilityByIndex(index);
引数
index
設備・備品が何行目かを示す数値です。
返値
Facilityクラスのインスタンス
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
const facility = facilityItem.getFacilityByIndex(1);
console.log(facility.entityId);
// 1
});
setFacilityRemoved
指定した entityId の設備・備品を削除します。
構文
setFacilityRemoved(entityId);
引数
entityId
設備・備品の entityId を示す数値です。
返値
なし
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.length);
// 3
FacilityItem.setFacilityRemoved(1);
console.log(facilityItem.length);
// 2
});
setFacilityRemovedByName
指定した entityname の設備・備品を削除します。
構文
setFacilityRemovedByName(entityName);
引数
entityName
設備・備品の名前を示す文字列です。
返値
なし
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.length);
// 3
FacilityItem.setFacilityRemovedByName("会議室A");
console.log(facilityItem.length);
// 2
});
setFacilityRemovedByIndex
指定した index の設備・備品を削除します。
構文
setFacilityRemovedByIndex(index);
引数
index
何行目かの設備・備品を示す数値です。
返値
なし
例
esmJSPlugin.sheetSave("schedule").onSheetItemsMounted((screen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
console.log(facilityItem.length);
// 3
FacilityItem.setFacilityRemovedByIndex(1);
console.log(facilityItem.length);
// 2
});
lengthIsEqualsTo
lengthが指定した数値と同じかどうかを判定します。
構文
lengthIsEqualsTo(number);
引数
number
比較対象の数値です。
返値
真偽値
例
esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
facilityItem.onUpdated(function () {
// 値を確認
console.log("値:", facilityItem.length); // 値: 7
const result = facilityItem.lengthIsEqualsTo(7);
console.log("設備備品数が7と同じか:", result); // 設備備品数が7と同じか: true
});
});
lengthIsGreaterThan
lengthが指定した数値より大きいかどうかを判定します。
構文
lengthIsGreaterThan(number);
引数
number
比較対象の数値です。
返値
真偽値
例
esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
facilityItem.onUpdated(function () {
// 値を確認
console.log("値:", facilityItem.length); // 値: 7
const result = facilityItem.lengthIsGreaterThan(6);
console.log("設備備品数が6より大きいか:", result); // 設備備品数が6より大きいか: true
});
});
lengthIsGreaterThanOrEqual
lengthが指定した数値以上かどうかを判定します。
構文
lengthIsGreaterThanOrEqual(number);
引数
number
比較対象の数値です。
返値
真偽値
例
esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
facilityItem.onUpdated(function () {
// 値を確認
console.log("値:", facilityItem.length); // 値: 7
const result = facilityItem.lengthIsGreaterThanOrEqual(6);
console.log("設備備品数が6以上か:", result); // 設備備品数が6以上か: true
});
});
lengthIsLessThan
lengthが指定した数値より小さいかどうかを判定します。
構文
lengthIsLessThan(number);
引数
number
比較対象の数値です。
返値
真偽値
例
esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
facilityItem.onUpdated(function () {
// 値を確認
console.log("値:", facilityItem.length); // 値: 7
const result = facilityItem.lengthIsLessThan(10);
console.log("設備備品数が10未満か:", result); // 設備備品数が10未満か: true
});
});
lengthIsLessThanOrEqual
lengthが指定した数値以下かどうかを判定します。
構文
lengthIsLessThanOrEqual(number);
引数
number
比較対象の数値です。
返値
真偽値
例
esmJSPlugin.sheetEntry("schedule").onEntered((SheetSaveScreen) => {
const facilityItem = screen.getSheetItemByLabel("設備・備品");
facilityItem.onUpdated(function () {
// 値を確認
console.log("値:", facilityItem.length); // 値: 7
const result = facilityItem.lengthIsLessThanOrEqual(8);
console.log("設備備品数が8以下か:", result); // 設備備品数が8以下か: true
});
});