5.20221.842
wijmo.grid.xlsx Interface IFlexGridXlsxOptions Wijmo API インターフェイス

IFlexGridXlsxOptions インターフェイス

FlexGrid Xlsx変換オプション

階層

  • IFlexGridXlsxOptions

プロパティ

オプション activeWorksheet

activeWorksheet: string | number

エクスポートのみ。

xlsxファイル内のアクティブなシートのインデックスまたは名前。

このオプションのデフォルト値はundefinedです。これは、アクティブなシートが設定されていないことを意味します。

オプション convertHtmlEntities

convertHtmlEntities: HtmlEntityConversion

エクスポートのみ。

エクスポートする時に「"」、 「<」、 「>」、および 「&」などのHTMLエンティティの変換動作を定義します。

デフォルト値はHtmlEntityConversion.Autoです。

オプション formatItem

formatItem: Object

エクスポートのみ。

エクスポートされたセルごとに呼び出されるオプションのコールバック。 エクスポートされたセルの値およびスタイルの 変換を行うことができます。 コールバックは、IFlexGridXlsxOptions.includeStylesオプションの値にかかわらず呼び出されます。 ソースグリッドセルに関する情報とエクスポートされるファイルでの表現を定義するIWorkbookCell オブジェクトを提供する XlsxFormatItemEventArgs 型の単一のパラメータがあります。

オプション includeCellStyles

includeCellStyles: boolean

エクスポートのみ。

セルのスタイル設定を生成されたXLSXァイルに含める必要があるかどうかを示します。 このオプションは非推奨になりました。 代わりにIFlexGridXlsxOptions.includeStylesオプションを使用してください。

このオプションのデフォルト値はtrueです。

オプション includeColumnHeaders

includeColumnHeaders: boolean

生成されるxlsxファイルの最初の行に列ヘッダーを表示するかどうかを示します。

このオプションのデフォルト値はtrueです。

オプション includeColumns

includeColumns: Object

エクスポートのみ。

エクスポートする際に、FlexGridでどの列を含めるか除外する必要があるかを示すコールバック。

For example:

// このサンプルコードでは、'country'列をエクスポートから除外します。
 
// JavaScript
wijmo.grid.xlsx.FlexGridXlsxConverter.save(grid, {
  includeColumns: function(column) {
     return column.binding !== 'country';
  }
}

オプション includeRowHeaders

includeRowHeaders: boolean

生成されるxlsxファイルの最初の行に列ヘッダーを表示するかどうかを示します。

このオプションのデフォルト値はfalseです。

オプション includeStyles

includeStyles: boolean

インポート時に、スタイルをxlsxファイルからWorkbookインスタンスにインポートする必要があるかどうかを示します。

エクスポート時に、、生成されるxlsxファイルにセルのスタイル設定を含めるかどうかを示します。

このオプションのデフォルト値はtrueです。 なお、includeStyles=trueにした場合でもインポートしたExcelセルのスタイルはグリッドのセルには反映されません。

オプション quickCellStyles

quickCellStyles: boolean

エクスポートのみ。

有効にすると、 IFlexGridXlsxOptions.includeStyles オプションが有効になっている場合、セルスタイルのキャッシュをアクティブ化してエクスポート時間を短縮します。 通常のシナリオでは、エクスポート時間を数分の1に短縮できます。

セルのインラインスタイル固有のプロパティ、独自のCSSクラス、およびセルを含む行のCSSクラスの組み合わせがキャッシュタグとして使用されます。 セルスタイルが計算される前に、キャッシュが最初にチェックされ、 タグに関連付けられたスタイルが見つかった場合、そこから取得され、再計算されません。

このモードを使用すると、多くのセルにCSSクラスとインラインスタイルの一意のセットがある場合、 描画が遅くなる可能性があります。 また、:first-childや:nth-childなどの疑似クラスを使用してセルや行のスタイルを設定すると、セルのスタイルが誤って決定されます。

このオプションのデフォルト値はtrueです。

オプション sheetIndex

sheetIndex: number

インポートのみ。

インポートするシートのインデックスを指定します。

このオプションのデフォルト値は0です。

オプション sheetName

sheetName: string

インポートするときに、インポートするシートの名前を指定します。 両方のオプションが設定されている場合、sheetNamesheetIndexオプションよりも優先されます。

エクスポートするときに、エクスポートするシートの名前を設定します。

このオプションのデフォルト値はundefinedです。

オプション sheetVisible

sheetVisible: boolean

エクスポートのみ。

シートが表示されているかどうかを示します。

Caveat:このオプションは注意して使用する必要があります。非表示のシートが1枚だけを持つxlsxファイルを生成する場合、ファイルをExcelで開くことはできません。 複数のエクスポートアクションで、カスタムのコードを使用して複数シートのブックを作成する場合は、このオプションをfalseに設定する必要があります。

このオプションのデフォルト値は**trueです。