Mashup Builder > ウィジェット > アドバンスグリッド > アドバンスグリッドのプロパティ
アドバンスグリッドのプロパティ
Mashup Builder の設計ビューにおけるアドバンスグリッドおよびアドバンスツリーグリッドのプロパティは、そのグリッドを Mashup Builder から設定しているか (静的コンフィギュレーション)、サービスによって設定しているか (動的コンフィギュレーション) によって異なります。以下の表には、Mashup Builder からグリッドを設定している場合に使用可能なすべてのプロパティがリストされています。
Mashup Builder からのみ設定可能で、動的コンフィギュレーションからは設定できないプロパティには、表内でアスタリスク * が付いています。
プロパティ名
説明
ベースタイプ
デフォルト値
バインド可能 (Y/N)?
グリッドまたはツリーグリッドに適用可能?
Id*
ThingWorx によって内部で使用される一意の識別子。
INTEGER
Gridadvanced-<id> または
Treegridadvanced--<id>
N
両方
Type*
ウィジェットタイプ。
該当なし
Grid-Advanced または Tree-Grid-Advanced
N
両方
DisplayName*
表示された場合にグリッドを識別するためのユーザー定義の名前。
STRING
gridadvanced-n または treegridadvanced-n
N
両方
Description*
ユーザー定義の説明。
STRING
該当なし
N
両方
Data*
グリッドが開いたときにロードされるデータのソース。
グリッドがデータソースにバインドされている場合、塗りつぶし矢印 が表示されます。データソースがない場合、 が表示されます。
INFOTABLE
該当なし
Y
両方
ChildData*
ノードが展開されたときに動的にロードされる子データのソース。
グリッドが子データソースにバインドされている場合、塗りつぶし矢印 が表示されます。
子データソースがない場合、 が表示されます。
INFOTABLE
該当なし
Y
ツリーグリッドのみ
ParentIDFieldName
親 ID フィールド名を示します。このプロパティは階層ツリー構造を作成するときに必要です。
* 
親がない最上位の行の場合、この値はスラッシュ (/) になります。
STRING
parentId
N
ツリーグリッドのみ
IDFieldName
グリッドのプライマリキー列。この列の値は、各データ行の一意の識別子として機能します。このプロパティはアドバンスグリッドではオプションですが、ツリーグリッドでは必須です。
フィールドが 1 つも指定されていないか、指定したフィールドが存在しない場合、グリッドに独自の内部行 ID が作成されます。
* 
行 ID インデックスはインデックス値 1 から始まる必要があります。ID が "0" (ゼロ) の行が検出された場合、JavaScript コンソールにエラーが表示され、その行はグリッドに表示されません。
STRING
id
N
両方
IDPathSeparator
パスセパレータ文字を設定できます。
パスセパレータ文字は、ツリーグリッドで、グリッドによって動的にロードされているがクライアント側ではロードされていない行を選択するために使用します。 動的にロードされた行の行選択のセクションを参照してください。
STRING
:;
N
ツリーグリッドのみ
HasChildrenFieldName
行に子データがあるかどうかを示す列の名前を指定します。
行に子がないことを示すには、'0'、0、'false'、false、空文字列、または undefined のいずれかを入力します。
その他の値はすべて、その行に子があることを意味します。
STRING
hasChildren
N
ツリーグリッドのみ
Configuration*
グリッドがコンフィギュレーションサービスにバインドされている場合、塗りつぶし矢印 が表示されます。
コンフィギュレーションサービスがない場合、 が表示されます。
* 
Configuration プロパティでは「追加」を使用できます。これを使用して、開いたページに JSON を入力します。JSON を入力して「完了」をクリックし、プロパティパネルに戻ると、「追加」「編集」に変わります。
STRING
該当なし
Y
両方
IsEditable
グリッドがランタイムで表示されている場合に、グリッドセル内の値を編集可能にするかどうかを指定します。
* 
特定の列内の値を編集するには、その列も編集可能として設定しなければなりません。 コンテキストメニューからの列の設定の「セルの編集オプション」のセクションを参照してください。
BOOLEAN
False
N
両方
EnableEditButtons
編集内容を手動で保存するためにグリッドツールバーの「編集」「保存」、および「キャンセル」をアクティブ化します。
変更内容を自動的に保存する場合、前述の IsEditable プロパティを設定します。変更内容を手動で保存する場合、EnableEditButtons プロパティを設定します。
詳細については、 アドバンスグリッドでのセルの編集を参照してください。
このプロパティを設定した場合、マッシュアップのプロパティパネルに EnableAddDeleteButtons プロパティが表示されます。
BOOLEAN
False
N
両方
EnableAddDeleteButtons
このプロパティを True に設定した場合、グリッドツールバーに「追加」および「削除」が表示され、これらを使用してグリッド内の行を追加または削除できます。
* 
ランタイムで「編集」をクリックすると、ツールバーに「追加」または「削除」が表示されます。
BOOLEAN
False
N
アドバンスグリッドのみ
EditedTable
セルがランタイムで編集された場合に更新された値の出力場所を指定するバインド可能なプロパティ。更新された値を保存するには、このプロパティがインフォテーブル更新サービスにバインドされていなければなりません。たとえば、データテーブル Thing の AddOrUpdateDataTableEntries サービスにバインドします。
* 
EditedTable プロパティを使用する前に、IsEditable プロパティを設定しなければなりません。さらに、特定の列を編集可能として設定しなければなりません。 コンテキストメニューからの列の設定の「セルの編集オプション」を参照してください。
INFOTABLE
該当なし
Y
両方
DeletedTable
このプロパティは、ランタイムでグリッドから削除された行の出力場所を指定します。
更新された値を保存するには、このプロパティがインフォテーブル更新サービスにバインドされていなければなりません。たとえば、このプロパティをデータテーブル Thing の AddOrUpdateDataTableEntries サービスにバインドします。
INFOTABLE
該当なし
Y
アドバンスグリッドのみ
DefaultSelectedRows
グリッドが表示された場合にデフォルトでハイライトされる行の番号を定義します。値にはコンマ区切り数字や範囲を含めることができます。
例: 1,2,4-5
このプロパティはバインドされているサービスによって定義することもできます。サービスがバインドされている場合、 が表示されます。
サービスがない場合、 が表示されます。
* 
このプロパティは、RowSelection プロパティが none に設定されている場合には効果がありません。複数の行を選択するには、RowSelection プロパティが multi に設定されていなければなりません。
ツリーグリッドでは、デフォルトの行選択はどの行が表示されているかによって異なります。ExpandLoadedRows プロパティが設定されている場合、プリロードされているすべての行が展開され、一番上の行から親と子の両方の行がカウントされます。プリロードされている行が展開されていない場合、一番上の行から親行だけがカウントされます。
STRING
該当なし
Y
両方
SelectedRows*
INFOTABLE ソースを介して、グリッドが表示された場合にデフォルトでハイライトされる行を定義します。
ツリーグリッドで使用した場合、行選択を行うには行 ID 列だけが必要ですが、その他の列も含めることができます。
アドバンスグリッドでは、行選択はサービス内の SelectedRows パラメータの出力をグリッドの入力 SelectedRows プロパティにバインドすることによって処理されます。
このプロパティは出力方向と入力方向のどちらでもバインド可能なので、1 つのエンティティによって別のエンティティ内の行の選択を制御できます。たとえば、あるテーブルによって 2 つ目のテーブル内の行の選択を制御したり、3D イメージを使用してテーブル内の行を選択したりできます。
制御側のエンティティでは、サービスを出力 INFOTABLE としてバインドします。
制御されるエンティティでは、サービスを入力 INFOTABLE: としてバインドします。
* 
このプロパティは、RowSelection プロパティが none に設定されている場合には効果がありません。複数の行を選択するには、RowSelection プロパティが multi に設定されていなければなりません。
INFOTABLE
該当なし
Y
両方
IncludeRowExpansionParents*
子行を選択または展開する際に、プリロードされたクライアント側データに含まれていない親行を含めるかどうかを指定します。True の場合、親行は子行とともにフェッチされるので、階層を再作成できます。
* 
データの深さとサイズによっては、このプロパティを使用することでグリッドのパフォーマンスが影響を受けることがあります。 ツリーグリッドウィジェットのパフォーマンスガイドラインを参照してください。
BOOLEAN
False
N
ツリーグリッドのみ
ExpandRows*
展開する必要がある、グリッド内の最上位の行または子行の ID。展開する行を選択するには、行 ID 列のみが必要です。
INFOTABLE
該当なし
Y
ツリーグリッドのみ
ExpandLoadedRows*
グリッドが開いたときに、プリロードされているすべてのデータを自動的に展開します。
* 
複数レベルのプリロードされたデータが使用可能でなければなりません。このプロパティが設定されている場合、DefaultSelectedRows が定義された場合の行のハイライトに影響します。PreserveRowExpansion プロパティを使用するには、このプロパティがオフになっていなければなりません。
BOOLEAN
False
Y
ツリーグリッドのみ
ExpandRowOnDoubleClick
行をダブルクリックするかノードアイコンをクリックしたときに、子がある行を展開します。
JSON コンフィギュレーションサービスでのこのプロパティの名前は treeSettings.expandRowOnDoubleClick です。
BOOLEAN
False
N
ツリーグリッドのみ
PreserveRowExpansion
グリッドが再表示されたときに行展開の選択を維持します。このプロパティを使用する場合、ツリーロードデータサービス内の maxLevels プロパティが、展開するレベルより大きい値に設定されていることを確認してください。データサービスの詳細については、 ツリーグリッドデータの操作を参照してください。
* 
ExpandLoadedRows プロパティが設定されている場合、このプロパティが上書きされ、プリロードされているすべての行が展開されます。特定の行の展開を維持する場合、PreserveRowExpansion をオンにする際に ExpandLoadedRows プロパティをオフにします。行展開の値を維持するには、CookiePersistence プロパティを設定しなければなりません。
BOOLEAN
False
N
ツリーグリッドのみ
RowSelection
設定可能な行選択を制御します。オプション: nonesingle、または multi
* 
none が選択されている場合、その他の行選択プロパティは効果がなくなります。
* 
IsEditable または EnableEditButtons プロパティを設定した場合、グリッドは RowSelection プロパティの影響を受けなくなります。グリッドが編集モードでないときに行を選択できます。
STRING
None
N
グリッドのみ
AutoScroll
グリッドがサイズ変更された場合やサービスが再表示された場合に、選択されている行にグリッドが自動的にスクロールするかどうかを制御します。
BOOLEAN
False
N
両方
CookiePersistence*
特定の列設定 (順序、サイズ、表示、並べ替え順序) についてクライアント側の永続化をアクティブ化します。
BOOLEAN
True
N
両方
EnableContextMenu*
エンドユーザーが特定の列の表示/非表示を切り替えることができるグリッドコンテキストメニューのランタイムでの表示を有効または無効にします。CookiePersistence とともに使用します。
両方のプロパティが設定されている場合 - 列の表示/非表示を設定でき、その選択が永続化されます。
EnableContextMenu が設定されておらず、CookiePersistence が設定されている場合 - 列の表示/非表示は設定できませんが、以前の選択は永続化されます。
EnableContextMenu が設定されていて、CookiePersistence が設定されていない場合 - 列の表示/非表示は設定できますが、現在のリクエストにのみ使用されます。
JSON コンフィギュレーションサービスで、このプロパティを次のようにトップレベルパラメータとして設定できます。
var config = {“enableContextMenu”: false,...}
BOOLEAN
True
N
両方
EnableSorting
ヘッダーからの昇順/降順の切り替え、MultiColumnSortOrder プロパティ、並べ替えサービスのバインドなど、どのようなタイプの列並べ替えを行う場合にもこれを設定しなければなりません。このオプションが設定されている場合、プロパティパネルで次のプロパティが使用可能になります。
QueryFilter - データサービスで使用するバインド可能なフィルタクエリー
Filter - クエリーデータサービスをトリガーするバインド可能なイベントプロパティ
BOOLEAN
False
N
両方
MultiColumnSortOrder
デフォルトの列並べ替え順序を設定します。構文: <列名>:<順序>,<列名>:<順序>
例: office:asc,title:des
* 
EnableSorting を設定しないと MultiColumnSortOrder の効果はありません。
STRING
該当なし
N
両方
EnableGridSearch
グリッドのツールバーにグローバルサーチボックスを配置します。このオプションが設定されている場合、プロパティパネルで次のプロパティが使用可能になります。
QueryFilter - データサービスで使用するバインド可能なフィルタクエリー
Filter – - クエリーデータサービスをトリガーするバインド可能なイベントプロパティ
BOOLEAN
False
N
両方
GridSearchLocation
サーチボックスを配置する場所を定義します。このオプションは EnableGridSearch プロパティが設定されている場合にだけ使用可能になります。
STRING
該当なし
N
両方
QueryFilter*
クエリーサービスを入力クエリーパラメータとしてバインドしてデータの並べ替え、サーチ、フィルタを制御するときに使用する、バインド可能なクエリープロパティ。このプロパティは EnableSorting または EnableGridSearch プロパティがオンになっている場合に使用可能になります。これはプロパティパネルから、またはグリッド上のコンテキストメニューから設定できます。
マッシュアップでデータフィルタウィジェットを使用している場合、アドバンスグリッドウィジェットまたはアドバンスツリーグリッドウィジェットから出力 QueryFilter プロパティを入力クエリープロパティにバインドできます。グリッドのすべてのクエリーパラメータが結合されて単一の出力フィルタが作成され、指定したサービスにこれがバインドされます。クエリーフィルタがこのように双方向にバインドされている場合、塗りつぶし矢印 が表示されます。
データフィルタウィジェットがなく、出力方向にのみバインドされている場合、一方の矢印は塗りつぶされ、もう一方の矢印は塗りつぶされません
QUERY
該当なし
Y
両方
EnableGridReset
グリッドのツールバーに「リセット」ボタンを配置します。「リセット」をクリックすると、cookie に保存されているすべてのグリッドユーザー設定がクリアされ、グリッドがデフォルトコンフィギュレーションに戻ります。
BOOLEAN
False
N
両方
EnableFilterEventOnConfigChange*
サービスからコンフィギュレーションが更新された場合のイベント発生のオン/オフを切り替えます。
このプロパティが設定されているときに、バインドコンフィギュレーションが変更された場合、フィルタイベントが発生してデータも更新されます。このプロパティが設定されていない場合、バインドコンフィギュレーションが更新されてもフィルタイベントは発生しません。
BOOLEAN
True
N
両方
EnableFooter
グリッドのフッターセクションを有効にします。このプロパティを True に設定した場合、ほかの 2 つのプロパティ FooterData および TableFooterStyle も設定されます。
フッターセクションのデータは FooterData プロパティを使用してバインドされます。
詳細については、 アドバンスグリッドでのフッターセクションを参照してください。
BOOLEAN
False
N
両方
FooterData
グリッドのフッターに表示されるデータが含まれています。
INFOTABLE
該当なし
Y
両方
GridResetButtonLocation
グリッドのリセットボタンを配置する場所を定義します。
STRING
該当なし
N
両方
RowFormat
ダイアログボックスが開き、オプションの行ベースの規則を定義して動的な「状態のフォーマット」を適用できます。グリッドのコンテキストメニューの「グリッド列を設定」オプションを使用して、これらの行ベースの規則をセルベースの状態フォーマットによってオーバーライドできます。
STATE FORMATTING
状態のフォーマット
N
両方
TableWrapperStyle
グリッドの背景スタイルを定義します。テーブル全体の周囲に外形色が追加され、背景色が設定されます。サポートされている属性は、線の色、ウェイト、タイプ、背景色、および代替背景色です。
STYLEDEFINITION
DefaultTableWrapperStyle
N
両方
TableHeaderStyle
グリッドのヘッダースタイルを定義します。
STYLEDEFINITION
DefaultTableHeaderStyle
N
両方
FocusStyle
グリッドでフォーカスが置かれている行のスタイルを定義します。
STYLEDEFINITION
DefaultFocusStyle
N
両方
RowBackgroundStyle
行の背景スタイルを定義します。背景色、フォントの色、およびウェイトスタイルが追加されます。ただし、各行に線のスタイルは追加されません。
STYLEDEFINITION
DefaultRowBackgroundStyle
N
両方
RowAlternateBackgroundStyle
1 つおきの行に使用する 2 つ目の行背景スタイルを定義します。フォントの色とウェイトスタイルが追加されますが、線のスタイルは追加されません。
STYLEDEFINITION
DefaultRowAlternateBackgroundStyle
N
両方
RowHoverStyle
行にマウスポインタを合わせたときの行のスタイルを定義します。各セルに背景色とフォントが追加されます。線の色、ウェイト、およびタイプは、マウスポインタを合わせた行だけに適用されます。
STYLEDEFINITION
DefaultRowHoverStyle
N
両方
RowSelectedStyle
選択したときの行のスタイルを定義します。各セルに背景色とフォントが追加されます。線の色、ウェイト、およびタイプは、選択されている行だけに適用されます。
STYLEDEFINITION
DefaultRowSelectedStyle
N
両方
RowBorderStyle
行の境界スタイルを定義します。セルの横線に線の色、ウェイト、およびタイプが追加されます。
STYLEDEFINITION
DefaultRowBorderStyle
N
両方
CellBorderStyle
セルの境界スタイルを定義します。セルの縦線に線の色、ウェイト、およびタイプが追加されます。
STYLEDEFINITION
DefaultCellBorderStyle
N
両方
ToolbarStyle
ツールバーのスタイルを定義します。
STYLEDEFINITION
DefaultToolbarStyle
N
両方
TableFooterStyle
グリッドのフッターセクションのスタイルを定義します。これには背景色、境界スタイル、フォントスタイルが含まれます。
STYLE DEFINITION
DefaultGridAdvancedFooterStyle
N
両方
TooltipStyle
ツールヒントのスタイルを定義します。
STYLEDEFINITION
DefaultTooltipStyle
N
両方
SortAscendingStyle
昇順並べ替えアイコンのスタイルを定義します。
STYLEDEFINITION
DefaultSortAscendingStyle
N
両方
SortDescendingStyle
降順並べ替えアイコンのスタイルを定義します。
STYLEDEFINITION
DefaultSortDescendingStyle
N
両方
CellValidationErrorStyle
検証エラーが発生した場合のセルのスタイルを定義します。
STYLE DEFINITION
DefaultCellValidationErrorStyle
N
両方
CellValidationErrorTooltipStyle
検証エラーが発生した場合のセルのツールヒントのスタイルを定義します。
STYLE DEFINITION
DefaultCellValidationErrorTooltipStyle
N
両方
RowIconStyle
ツリーノードのフォルダアイコンのスタイルを定義します。
STYLEDEFINITION
DefaultRowIconStyle
N
ツリーグリッドのみ
RowExpansionIconStyle
ツリーノードの展開アイコンのスタイルを定義します。
STYLEDEFINITION
DefaultRowExpansionIconStyle
N
ツリーグリッドのみ
RowCollapseIconStyle
ツリーノードの折りたたみアイコンのスタイルを定義します。
STYLEDEFINITION
DefaultRowCollapseIconStyle
N
ツリーグリッドのみ
HeaderOverflow
ヘッダーセルに収まらないテキストを処理するオプションを指定します。オプション:
fitted - 単語の途中でも、列幅に合わせてテキストが折り返されます。
wrapped - 空白またはダッシュでテキストが追加の行に折り返されます。
clipped - ヘッダーセルの端でテキストが切り捨てられます。
ellipsis - テキストは切り捨てられますが、さらにテキストがあることを示すために省略記号 (...) が表示されます。
tooltip - テキストが切り捨てられて省略記号 (...) が表示され、完全なテキストがツールヒント内に表示されます。
STRING
tooltip
N
両方
DataOverflow
データセルに収まらないテキストのオプションを指定します。HeaderOverflow プロパティと同じオプションを使用できます。
STRING
clipped
N
両方
MaxHeaderHeight
ヘッダー行を垂直スクロールバーなしで表示する最大高さ (ピクセル)。これ以上拡張されると垂直スクロールバーが表示されます。
NUMBER
100
N
両方
MinRowHeight
グリッドの行の最小高さ設定 (ピクセル)。
デフォルトの最小行高さである 30 ピクセルより大きいイメージが表示されている列にイメージレンダラーを使用していないものとします。イメージが含まれているスタイルを適用する状態定義を例とした場合、イメージの高さが収まるように行の高さ設定を大きくします。
NUMBER
0
N
両方
MaxRowCacheSize
クライアント側で拡張可能なグリッドの最大行数。この上限に達した場合、警告が生成され、さらに拡張する前にノードを折りたたむ必要があります。
NUMBER
5000
N
ツリーグリッドのみ
DoubleClicked*
グリッドをダブルクリックしたときに発生する、バインド可能なイベントプロパティ。
EVENT
該当なし
Y
両方
Filter*
クエリーサービスを入力クエリーパラメータとしてバインドしてデータの並べ替え、サーチ、フィルタを制御するときに使用する、バインド可能なクエリープロパティ。このプロパティは EnableSorting または EnableGridSearch プロパティがオンになっている場合に使用可能になります。これはプロパティパネルから、またはグリッド上のコンテキストメニューから設定できます。
EVENT
該当なし
Y
両方
EditCellStarted
セルの値の編集を開始したときにトリガーされる、バインド可能なイベントプロパティ。これは IsEditable パラメータが設定されている場合にだけアクティブになります。
このイベントを使用して、編集時にマッシュアップ内のその他のウィジェットの状態を変更できます。
EVENT
該当なし
Y
両方
EditCellCompleted
セルを編集し、Enter キーまたは Tab キーを押すか、または編集中のセルの外のどこかをクリックした場合にトリガーされる、バインド可能なイベントプロパティ。Esc キーを押した場合、値は未編集のままとなります。グリッドが再表示されると、編集後の値が表示されます。
このイベントには次の 2 つの使用方法があります。
これをインフォテーブル更新サービスにバインドすることで、EditedTable インフォテーブルから編集された値が永続化されます。
マッシュアップ内の保存ボタンウィジェットを有効にするサービスにこれをバインドできます。さらに保存ボタンをインフォテーブル更新サービスにバインドすることで、EditedTable インフォテーブルから更新された値が永続化されます。
EVENT
該当なし
Y
両方
EditStarted
このイベントは、グリッドツールバーの「編集」をクリックしたときにトリガーされます。
EVENT
該当なし
Y
両方
EditCompleted
このイベントは、グリッドツールバーの「保存」をクリックしたときにトリガーされます。
EVENT
該当なし
Y
両方
EditCancelled
このイベントは、グリッドツールバーの「キャンセル」をクリックしたときにトリガーされます。
EVENT
該当なし
Y
両方
Z-index*
レイヤー状のウィジェットの順序。Z-index が小さいグリッドウィジェットが、Z-index が大きいウィジェットの後に移動します。
NUMBER
10
N
両方
Visible*
設定されている場合、グリッドはランタイムで表示されます。このプロパティは、グリッドにバインドされているサービスによって定義できます。表示サービスがグリッドにバインドされている場合、塗りつぶし矢印 が表示されます。
表示サービスがない場合、 が表示されます。
BOOLEAN
True
Y
両方
SelectedRowsChanged*
グリッドの 1 つ以上の行を選択または選択解除したときに別のウィジェットまたはサービスをトリガーするときに使用可能な、バインド可能なイベントプロパティ。
このイベントプロパティを使用するには、次の手順に従います。
RowSelection プロパティを single または multi に設定します。
SelectedRows プロパティを別のエンティティ (ウィジェットまたはサービス) にバインドします。
SeletedRowsChanged イベントを別のエンティティにバインドして、SelectedRows が変化した場合にトリガーされるようにします。
EVENT
該当なし
Y
両方
* コンフィギュレーションサービスがグリッドにバインドされている場合、Mashup Builder のプロパティパネルにはアスタリスク付きのプロパティだけが表示されます。その他すべてのプロパティは JSON サービスから渡されるので、非表示になります。
* 
グリッドスタイルは以下にリストされている順序で優先度が上がり、TableWrapperStyle が最も優先度が低く、RowHoverStyle はその他すべてをオーバーライドします。
1. TableWrapperStyle
2. RowBackground/RowAlternateBackgroundStyle
3. CellBorder/RowBorderStyle
4. FixedRowFormatter/State Definition
5. RowSelectedStyle
6. RowHoverStyle