フィールド表示/非表示切替
概要
指定したフィールドIDに対応するフィールド要素の表示/非表示を切り替えます。
構文
atPocket.app.record.setFieldShown(fieldId, isShown, rowIndex);
引数
| 引数名 | 型 | 説明 |
|---|---|---|
| fieldId | string | フィールドのID。明細（SubTable）の場合は列のUID |
| isShown | boolean | 表示するかどうか（省略時は非表示） |
| rowIndex | number | 明細の行インデックス（0始まり・任意）。省略して列UIDのみを指定した場合はその列の全行が対象 |
戻り値
| 対象 | 型 | 説明 |
|---|---|---|
| 通常のフィールド | なし | 同期的に適用されます |
| 明細のセル・列 | Promise<void> | 適用の完了を待つ場合は await してください |
使用可能画面
- レコード詳細画面
- レコード作成画面
- レコード編集画面
使用例
// フィールドを表示する
atPocket.app.record.setFieldShown("field_123", true);
// フィールドを非表示にする
atPocket.app.record.setFieldShown("field_123", false);
// フィールドを非表示にする（デフォルト動作）
atPocket.app.record.setFieldShown("field_123");
明細（SubTable）のセル・列を対象にする
// 1行目のセルだけを非表示にする
await atPocket.app.record.setFieldShown('field-6_1', false, 0);
// 列の全行を非表示にする
await atPocket.app.record.setFieldShown('field-6_2', false);
備考
明細のセル・列は visibility で切り替えます。列の幅は詰まらず、列ヘッダーも残ります。
明細（SubTable）に適用する場合の注意
行の追加・コピー・削除・並び替えを行うと、適用した表示状態は解除されます。行操作の change イベントで再適用してください（明細（SubTable）の操作）。