[]
【重要】2024年1月公開のアップデート「未適用」のお客様へ デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Wijmo_Grid.Column

Column クラス

グリッドの列を表します。

階層

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • new Column(options?: any): Column

  • Column クラスの新しいインスタンスを初期化します。

    引数

    • オプション options: any

      列の初期化オプション。

    戻り値 Column

プロパティ

aggregate

aggregate: Aggregate

列のグループヘッダ行に表示するAggregate を取得または設定します。

align

align: string

列または行のセルの水平方向の配置を取得または設定します。

このプロパティのデフォルト値はnullで、列のdataType に基づいて配置が自動的に選択されます （数値の場合は右揃え、ブール値の場合は中央揃え、その他の型の場合は左揃え）。

デフォルトの配置をオーバーライドする場合は、 このプロパティを'left'、'right'、'center'のいずれかに設定します。

allowDragging

allowDragging: boolean

ユーザーがマウスで列または行を新しい位置に移動できるかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はtrueです。

allowMerging

allowMerging: boolean

列または行にあるセルを結合できるかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はfalse です。

allowResizing

allowResizing: boolean

ユーザーがマウスで列または行をサイズ変更できるかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はtrueです。

allowSorting

allowSorting: boolean

ユーザーがヘッダーをクリックして列をソートできるかどうかを示す値を取得または設定します。

binding

binding: string

列がバインドされているプロパティの名前を取得または設定します。

cellTemplate

cellTemplate: string | ICellTemplateFunction

この Column のデータセルのHTMLコンテンツを生成するために使用される ICellTemplateFunction またはテンプレートの文字列を取得または設定します。

セルテンプレート文字列は、テンプレートリテラル構文を使用します。 コンテンツの文字列は、タイプICellTemplateContextのスコープを使用して生成されます。

ICellTemplateFunction 関数は、{@ link ICellTemplateContext} 型の引数を取り、セルに表示されるHTMLコンテンツを返します。

次に例を示します。

// テンプレート文字列を使用したデフォルトのレンダリング
col.cellTemplate = '${value}:${col.format}';

// テンプレート文字列を使用した条件付き書式
col.cellTemplate = '<span class=${value > 40000 ? "big-val" : "small-val"}>${text}</span>';

// ICellTemplateFunctionを使用した条件付き書式
col.cellTemplate = (ctx: ICellTemplateContext) => {
     return '<span class="{cls}">{val}</span>'
         .replace('{cls}', ctx.value > 40000 ? 'big-val' : 'small-val')
         .replace('{val}', ctx.text);
};

cellTemplate プロパティは、Wijmoの相互運用モジュールで使用できる{@ link formatItem} イベントまたはセルテンプレートよりも単純で、強力ではない代替方法を提供します。

テンプレートの文字列にはテンプレートリテラルが必要であるため、IEではサポートされていません。

セルテンプレートを使用する場合、列の binding および format プロパティを設定する必要があります。 これらは編集モードで使用され、コピー/貼り付け/エクスポート操作をサポートするために使用されます。

collectionView

collectionView: ICollectionView

この列または行にバインドされたICollectionView を取得します。

cssClass

cssClass: string

列または行のヘッダ以外のデータセルをレンダリングするときに使用するCSSクラス名を取得または設定します。

cssClassAll

cssClassAll: string

列または行内のすべてのセル（データとヘッダー）をレンダリングするときに使用するCSSクラス名を取得または設定します。

currentSort

currentSort: string

列に現在適用されているソート順序を表す文字列を取得します。 有効な値は、昇順の場合は'+'、降順の場合は'-'、列がソートされていない場合はnullです。

currentSortIndex

currentSortIndex: number

グリッドのコレクションビューのソート記述の配列内の列インデックスを取得します。

dataMap

dataMap: DataMap

生の値から列または行の表示値への変換に使用されるDataMap を取得または設定します。

デフォルトでは、データマップされたセルには、値をすばやく編集するためのドロップダウンリストがあります。列のdataMapEditorプロパティを設定して、エディターのタイプを変更できます。

デフォルトのエディタータイプ、DataMapEditor.DropDownListでは、wijmo.input moduleをロードする必要があります。

dataMapEditor

dataMapEditor: DataMapEditor

この列または行でデータマップされたセルを編集するときに使用するエディターのタイプを示す値を取得または設定します。

DataMapEditor.DropDownListが（デフォルト値）を設定すると、dataMapがあり、読み取り専用ではない列のセルにドロップダウンボタンを追加します。 ユーザーがドロップダウンボタンをクリックすると、セルの値を選択するために使用できるドロップダウンリストがグリッドに表示されます。 DataMapEditor.RadioButtonsを設定すると、グリッドは各オプションに対してラジオボタンを表示します。ラジオボタンは、マウスまたはキーボードでクリックできます（各オプションの先頭文字またはスペースキーを押して、オプションを切り替えます）。

このプロパティのデフォルト値は DataMapEditor.DropDownList です。wijmo.inputモジュールがロードされる場合のみ、ドロップダウンリストが有効になります。

dataType

dataType: DataType

列または行に格納される値の型を取得または設定します。

グリッドを編集するとき、値は適切な型に型変換されます。

describedById

describedById: string

列の説明を含む要素のIDを取得または設定します。

このIDは、列ヘッダ要素の aria-describedby 属性の値として使用されます。

dropDownCssClass

dropDownCssClass: string

この列または行のドロップダウンに追加するCSSクラス名を取得または設定します。

これらのドロップダウンボタンは、 列にdataMap が設定され、編集可能である場合にのみ表示されます。 ユーザーがドロップダウンボタンをクリックすると、 セルの値を選択するために使用できるリストがグリッドに表示されます。

セルのドロップダウンを使用するには、wijmo.inputモジュールをロードしておく必要があります。

format

format: string

未加工の値を列または行の表示値に変換するために使用される書式文字列を取得または設定します （Globalize を参照）。

grid

grid: FlexGrid

この 列または行 を所有する FlexGrid。

header: string

列ヘッダに表示されるテキストを取得または設定します。

index

index: number

列または行の親コレクション内でのインデックスを取得します。

inputType

inputType: string

この列または行の値の編集に使用されるHTML入力要素の"type"属性を取得または設定します。

デフォルトでは、このプロパティは数値列に対しては "tel"に設定され、 他のすべてのブール型以外の列に対して "text"に設定されます。"tel" 入力の型では、 モバイルデバイスはマイナス記号と小数点記号を含む数値キーパッドが表示されます。

デフォルトのままでは現在のカルチャ、デバイス、またはアプリケーションに関してうまく機能しない場合は、 このプロパティを使用してデフォルト設定を変更します。 その場合、値を"number"または"text"に変更してみてください。

isContentHtml

isContentHtml: boolean

この列または行にあるセルがプレーンテキストではなくHTMLコンテンツを含むかどうかを示す値を取得または設定します。

このプロパティは通常のセルにのみ適用されます。デフォルトでは、 行と列のヘッダーセルにプレーンテキストが含まれます。 HTMLを列ヘッダーまたは行ヘッダーに表示するには、 FlexGrid.formatItem イベントを使用してコードにセルのinnerHTMLコンテンツを設定する必要があります。

このプロパティのデフォルト値は false です。

isReadOnly

isReadOnly: boolean

列または行にあるセルを編集できるかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はtrueです。

isRequired

isRequired: boolean

この列または行の値が必須かどうかを決定する値を取得または設定します。

デフォルトでは、このプロパティはnullに設定されます。その場合、値は必須ですが、 非マスク文字列の列に空の文字列を含めることができます。

trueに設定する場合、値は必須であり、空の文字列を含めることができません。

falseに設定すると、null値と空の文字列を含めることができます。

isSelected

isSelected: boolean

列または行が選択されているかどうかを示す値を取得または設定します。

isVisible

isVisible: boolean

列または行が表示可能で、なおかつ折りたたまれていないかどうかを示す値を取得または設定します。

このプロパティは読み取り専用です。 列または行の表示/非表示設定を変更するには、代わりにvisible プロパティを使用してください。

mask

mask: string

この列または行の値の編集時に使用するマスクを取得または設定します。

マスクの書式は、wijmo.input.InputMask コントロールで使用される書式と同じです。

指定する場合、このマスクは format プロパティの値と互換性がある必要があります。 たとえば、'MM/dd/yyyy'と書式設定された 日付の入力にマスク'99/99/9999'を使用できます。

maxLength

maxLength: number

この列または行のセルに入力できる最大の項目数を取得または設定します。

デフォルトでは、このプロパティはnullに設定されます。この場合、任意の数の文字が許容されます。

maxWidth

maxWidth: number

列の最大幅をピクセル単位で取得または設定します。

デフォルトでは、このプロパティはnullに設定されます。これは、最大幅が設定されていないことを示します。

minWidth

minWidth: number

列の最小幅を取得または設定します。

デフォルトでは、このプロパティはnullに設定されます。これは、最小幅は0に設定されていることを示します。

multiLine

multiLine: boolean

この列または行にあるセルの内容が改行文字(\n).で ラップするかどうかを示す値を取得または設定します。

このプロパティのデフォルト値は false です。

name

name: string

列の名前を取得または設定します。

列名を使用して、FlexGrid.getColumn メソッドで列を取得できます。

pos

pos: number

列または行の位置を(ピクセル単位で)取得します。

quickAutoSize

quickAutoSize: boolean

この列のサイズを自動変更するときにグリッドが精度よりもパフォーマンスを最適化するかどうかを決定する値を取得または設定します。

このプロパティをfalseに設定すると、この列の自動リサイズ処理が無効になります。 このプロパティをtrueに設定すると、 グリッドのwijmo.grid.Column.quickAutoSize　プロパティの値に従って、この機能が有効になります。 null（デフォルト値）に設定すると、 プレーンテキストを表示するテンプレートを持たない列の機能が有効になります。

renderSize

renderSize: number

列または行のレンダリングサイズを取得または設定します。

表示/非表示設定、デフォルトサイズ、および最小/最大サイズを考慮したサイズが返されます。

renderWidth

renderWidth: number

列のレンダリング幅を取得します。

列の表示/非表示設定、デフォルトサイズ、および最小/最大サイズを考慮した幅が返されます。

size

size: number | null

列または行のサイズを取得または設定します。

このプロパティをnullまたは負の値に設定すると、親コレクションのデフォルトサイズが使用されます。

sortMemberPath

sortMemberPath: string

この列をソートするときに使用するプロパティの名前を取得または設定します。

このプロパティは、 binding property.プロパティによって指定されている値以外の値に基づいて ソートを実行する場合に使用します。 このプロパティをnullに設定すると、binding プロパティの値を使用して列がソートされます。

visible

visible: boolean

列または行が表示されているかどうかを示す値を取得または設定します。

visibleIndex

visibleIndex: number

非表示にした要素(isVisible　)を無視し、親コレクション内の行または列のインデックスを取得します。

width

width: any

列の幅を取得または設定します。

列の幅は、正の数値（列幅のピクセル数を設定）、nullまたは負の数値（コレクションのデフォルトの列幅を使用）、 または'{number}*'形式の文字列（スターサイズ指定）にすることができます。

スターサイズ指定オプションを使用すると、星の前の数字に比例して 列の幅が決定されるXAMLスタイルの動的なサイズ設定が実行されます。たとえば、 グリッドに3つの列があり、それぞれの幅が"100"、"*"、"3*"に設定されている場合、最初の列の幅は100ピクセルになり、 2列目は残りスペースの1/4、3列目は残りスペースの3/4を占めます。 スターサイズ指定を使用すると、使用可能な幅いっぱいに自動的に広がる列を定義できます。

たとえば、最後の列の幅を"*"に設定すると、最後の列がグリッドの幅いっぱいに 拡張されて空スペースがなくなります。また、列の minWidth プロパティを設定して列の幅が狭くなりすぎないようにすることもできます。

wordWrap

wordWrap: boolean

この列または行のセルの内容を使用可能な列幅に収まれるように ラップするかどうかを示す値を取得または設定します。

このプロパティのデフォルト値はfalse です。

メソッド

getAlignment

  • getAlignment(row?: Row): string

  • 列または行内の項目の実際の配置を取得します。

    align プロパティがnullでない場合はその値が返されます。それ以外の場合は、列のdataType に基づいて配置が選択されます。

    引数

    • オプション row: Row

      チェックされているセルを含む行。

    戻り値 string

    A string representing the cell alignment.

getIsRequired

  • getIsRequired(row?: Row): boolean

  • 列または行の値が必須かどうかを決定する値を取得します。

    isRequired プロパティがnullでない場合は、その値が返されます。 そうでない場合は、列の dataType に基づいて必須状態が判定されます。

    デフォルトでは、文字列の列は、 dataMap または mask; 値が設定されていない限り 必須ではありません。他のすべてのデータ型は必須です。

    引数

    • オプション row: Row

      チェックされているセルを含む行。

    戻り値 boolean

    True if the value is required, false otherwise.

onGridChanged

onPropertyChanged

  • onPropertyChanged(): void

  • オーナーリストをダーティとしてマークし、オーナーグリッドを更新します。

    戻り値 void

イベント

gridChanged

gridChanged: Event<RowCol, EventArgs>

grid プロパティの値が変更されたときに発生します。