対象とする人

JasperReportのプロパティの設定方法を理解している人
英語の公式プロパティを読むのが嫌な人

元ネタ

JasperReports - Configuration Reference (version 6.9.0)
本記事は元ネタの英語解説部分を和訳したものです。
毎回Google翻訳をかけるのが面倒だったので全部翻訳しました。

設定

Scope	説明	設定例
Global	??
Context	??
Report	レポートファイル全体への設定	レポート全体選択での詳細プロパティから設定
Element	部品（要素）への設定	テキストフィールドの詳細プロパティから設定

デフォルト表示設定系

net.sf.jasperreports.export.xls.shrink.to.fit

セル内のテキスト全体を表示し続けるために、テキストのフォントサイズを小さくする必要があるかどうかを示すフラグプロパティ。 trueに設定すると、セルの折り返しテキスト設定が自動的に無効になります（net.sf.jasperreports.export.xls.wrap.textを参照）。
通常、このプロパティはnet.sf.jasperreports.print.keep.full.textと連動して機能し、エクスポート時にテキストコンテンツ全体を保持します。

このプロパティの値は、Excelエクスポート構成設定isShrinkToFit（）のデフォルトとして使用されます。
グローバルレベルの設定は、レポートレベルの設定によって上書きされます。レポートレベルの設定は、要素レベルの設定によって上書きされます。

API: PROPERTY_SHRINK_TO_FIT
Default: false
Scope: Global | Context | Report | Element
Since: 6.0.2

net.sf.jasperreports.export.xls.font.size.fix.enabled

テキストが指定したセルの高さに収まるようにフォントサイズを小さくする必要があるかどうかを示すフラグプロパティ。
その値は、isFontSizeFixEnabled（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_FONT_SIZE_FIX_ENABLED
Default: false
Scope: Global | Context | Report
Since: 2.0.1

net.sf.jasperreports.export.xls.ignore.cell.background

生成されたドキュメントでセルの背景色を無視するかどうかを指定するプロパティ。
その値は、isIgnoreCellBackground（）Excelエクスポート構成設定のデフォルトとして使用されます。
プロパティが要素レベルで設定されている場合、その値はその要素を含むシートにのみ適用されます。ドキュメント内の他のシートは影響を受けません。

注：v.6.2.0以降、このプロパティはレポート要素ごとにも設定できます。

API: PROPERTY_IGNORE_CELL_BACKGROUND
Default: false
Scope: Global | Context | Report | Element
Since: 3.6.2

net.sf.jasperreports.export.xls.ignore.cell.border

生成されたドキュメントでセルの境界線を無視するかどうかを指定するプロパティ。
その値は、Excelエクスポート構成設定isIgnoreCellBorder（）のデフォルトとして使用されます。
プロパティが要素レベルで設定されている場合、その値はその要素を含むシートにのみ適用されます。ドキュメント内の他のシートは影響を受けません。

注：v.6.2.0以降、このプロパティはレポート要素ごとにも設定できます。

API: PROPERTY_IGNORE_CELL_BORDER
Default: false
Scope: Global | Context | Report | Element
Since: 2.0.1

net.sf.jasperreports.export.xls.ignore.graphics

グラフィック要素を無視し、テキスト要素のみをエクスポートするかどうかを指定するプロパティ。
その値は、Excelエクスポート構成設定isIgnoreGraphics（）のデフォルトとして使用されます。

API: PROPERTY_IGNORE_GRAPHICS
Default: false
Scope: Global | Context | Report
Since: 2.0.1

net.sf.jasperreports.export.xls.ignore.hyperlink

このプロパティは、特定のハイパーリンクをアクティブにするかどうかを決定するものです。XLS、XLSX、およびODS形式でエクスポートする際に使用できます。このフラグは、同じ名前のhyperlinkパラメーターを使用して、ハイパーリンク宣言レベルで制御できます。

API: PROPERTY_IGNORE_HYPERLINK
Default: N/A
Scope: Global | Context | Report | Hyperlink
Since: 5.1.2

net.sf.jasperreports.export.xls.ignore.text.formatting

エクスポート時に結果のExcelドキュメントでテキストの書式設定（テキストの色、背景色、太字、斜体、下線など）を無視するかどうかを指定するプロパティ。
その値は、isIgnoreTextFormatting（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_IGNORE_TEXT_FORMATTING
Default: false
Scope: Global | Context | Report | Text Element
Since: 6.0.4

net.sf.jasperreports.export.xls.image.anchor.type

画像のアンカータイプを指定するプロパティ。可能な値は次のとおりです。

MoveSize -
- 画像はセルに合わせて移動およびサイズ変更されます
MoveNoSize -
- 画像はセルに合わせて移動しますが、セルに合わせてサイズは変更しません
NoMoveNoSize -
- 画像はセルに合わせて移動したりサイズが変更したりしません

グローバル設定は、レポートレベルの設定によって上書きされます。レポートレベルの設定は、要素レベルの設定によって上書きされます。
その値は、getImageAnchorType（）Excelエクスポート構成設定のデフォルトとして使用されます。

net.sf.jasperreports.export.xls.image.border.fix.enabled

画像がセルの境界線を隠す状況を回避するために、最小画像パディングを1ピクセルに強制するかどうかを指定するフラグプロパティ。
その値は、isImageBorderFixEnabled（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_IMAGE_BORDER_FIX_ENABLED
Default: false
Scope: Global | Context | Report
Since: 3.0.0

net.sf.jasperreports.export.xls.remove.empty.space.between.columns

空のスペース列を削除するかどうかを指定するプロパティ。
その値は、isRemoveEmptySpaceBetweenColumns（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_COLUMNS
Default: false
Scope: Global | Context | Report
Since: 2.0.1

net.sf.jasperreports.export.xls.remove.empty.space.between.rows

空のスペース行を削除するかどうかを指定するプロパティ。その値は、isRemoveEmptySpaceBetweenRows（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_REMOVE_EMPTY_SPACE_BETWEEN_ROWS
Default: false
Scope: Global | Context | Report
Since: 2.0.1

net.sf.jasperreports.export.xls.auto.filter

この要素レベルのプロパティは、現在のシートのオートフィルターデータ範囲の境界を示すために使用されます。許可される値は次のとおりです。

Start -

現在のセルは自動フィルターの見出しセルとしてマークされ、このセルの下/右の列データは自動フィルターデータ範囲の一部と見なすことができます。オートフィルターデータ範囲の開始点は、現在のセルの下にある次のセルになります（つまり、現在のセル参照がB4の場合、オートフィルター範囲は「B5」セル参照で始まります：「B5：M20」）。
同じシートで複数のオートフィルター開始値が見つかった場合、最後の値のみが考慮されます。開始値が存在するが、シートに終了値が見つからない場合、現在の列のみがデータ範囲として考慮されます。
オートフィルターの開始値がオートフィルターの終了値と同じ行に設定されている場合、データ範囲には、開始列と終了列の間に配置されたこの見出し行の下のすべてのデータが含まれます。

End -

現在のセルはオートフィルターの終了セルとしてマークされ、このセルおよび左上/左の列データはオートフィルターデータ範囲の一部と見なすことができます。データ範囲の終了セルは現在のセル参照です（つまり、現在のセル参照がM20の場合、オートフィルターの範囲は「M20」：「B5：M20」で終了します）。現在の列の見出しセルは、オートフィルターの開始値を含む行の同じ列に配置されます。

注意

オートフィルターの開始値がシートに見つからない場合、オートフィルターの終了値は代わりに開始値と見なされます。
複数のオートフィルター終了値が同じシートで見つかった場合、最後の値のみが考慮されます。
オートフィルターの開始値がオートフィルターの終了値と同じ行に設定されている場合、データ範囲には、開始列と終了列の間に配置されたこの見出し行の下のすべてのデータが含まれます。

API: PROPERTY_AUTO_FILTER
Default: N/A
Scope: Element
Since: 4.1.3

net.sf.jasperreports.export.xls.auto.fit.column

Excelが現在の列幅を自動調整するかどうかを示すフラグプロパティ。
許可される値は次のとおりです。

true
false

API: PROPERTY_AUTO_FIT_COLUMN
Default: false
Scope: Element
Since: 4.5.1

net.sf.jasperreports.export.xls.auto.fit.page.height

isAutoFitPageHeight（）エクスポート設定のデフォルト値を提供するフラグプロパティ。 trueに設定すると、エクスポーターはシートの印刷高さをそのシートでエクスポートされたJasperPrintページの数に自動的に適合させます
許可される値は次のとおりです。

true
false

API: PROPERTY_AUTO_FIT_PAGE_HEIGHT
Default: false
Scope: Global | Context | Report
Since: 6.0.2

net.sf.jasperreports.export.xls.auto.fit.row

Excelが現在の行の高さを自動調整するかどうかを示すフラグプロパティ。
許可される値は次のとおりです。

true
false

API: PROPERTY_AUTO_FIT_ROW
Default: false
Scope: Element
Since: 4.5.1

net.sf.jasperreports.export.xls.cell.hidden

保護されたシートの数式バーでセルの内容を非表示にするか公開するかを指定するプロパティ。
その値は、isCellHidden（）Excelエクスポート構成設定のデフォルトとして使用されます。
デフォルトでは、プロパティは設定されておらず（false）、セルのコンテンツは非表示になっていません。
このプロパティは、シートが保護されている場合にのみ効果があります。

API: PROPERTY_CELL_HIDDEN
Default: false
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.cell.locked

保護されたシート内でセルコンテンツがロックされている（読み取り専用）かどうかを指定するプロパティ。
その値は、isCellLocked（）Excelエクスポート構成設定のデフォルトとして使用されます。
既定では、プロパティは（true）と見なされますが、シートが保護されている場合にのみ有効です。

API: PROPERTY_CELL_LOCKED
Default: true
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.collapse.row.span

行のスパンを折りたたむか、行全体のセルの結合を禁止するかどうかを指定するプロパティ。
その値は、Excelエクスポート構成設定isCollapseRowSpan（）のデフォルトとして使用されます。

API: PROPERTY_COLLAPSE_ROW_SPAN
Default: false
Scope: Global | Context | Report
Since: 2.0.1

net.sf.jasperreports.export.xls.column.name

メタデータベースのExcelエクスポートに表示される列の名前を表します。提供される場合、net.sf.jasperreports.export.xls.column.names。{suffix}に格納されている列名のいずれかでなければなりません。

API: PROPERTY_COLUMN_NAME
Default: N/A
Scope: Element
Since: 4.0.2

net.sf.jasperreports.export.xls.column.names.{arbitrary_name}

「net.sf.jasperreports.export.xls.column.names」のプロパティプレフィックスには、メタデータベースのExcelエクスポートで使用されるコンマ区切りの列名のリストが含まれます。
これらのプロパティの列名は、getColumnNames（）Excelメタデータエクスポート構成設定の値のデフォルトリストとして使用されます。
列の順序は重要であり、正確な結果を得るには、元の列と同じ順序にする必要があります。

API: PROPERTY_COLUMN_NAMES_PREFIX
Default: N/A
Scope: Report
Since: 4.0.2

net.sf.jasperreports.export.xls.column.width

列幅がExcelで標準スタイルのデフォルト文字幅単位で測定されることを考慮して、列幅をExcel出力に適した値に調整するために使用される要素レベルのプロパティ。ピクセルから文字への幅の変換は、デフォルトの標準スタイルの文字幅に依存するため、常に正確に適合するとは限りません。この場合、ピクセルで測定される整数値でこのプロパティを設定することにより、現在の列幅を調整できます。 JRエンジンは、要素の幅属性の代わりにこの値を使用して、ピクセルから文字への幅マッピングを実行します。
定義されている場合、このプロパティは現在の列のPROPERTY_COLUMN_WIDTH_RATIO値をオーバーライドします

API: PROPERTY_COLUMN_WIDTH
Default: N/A
Scope: Element
Since: 4.1.3

net.sf.jasperreports.export.xls.column.width.ratio

Excel出力に適した列幅の値を取得するために、同じ幅比でドキュメントまたはシートのすべての列幅を調整するために使用されるプロパティ。通常、列幅はExcelによって標準スタイルのデフォルトの文字幅単位で測定されますが、JRエンジンはピクセルをデフォルトのサイズ単位として使用します。レポートをExcel出力形式にエクスポートする場合、ピクセルから文字への幅の変換は、Excelインスタンスによって提供される通常のスタイルのデフォルトの文字幅に依存するため、常に正確に適合するとは限りません。この場合、調整比率を表す浮動小数点値をこのプロパティに設定することにより、生成された列幅を変更できます。プロパティを設定できます。

グローバル-globally
- その後、Excel出力形式にエクスポートされたすべてのドキュメントのすべての列が同じ幅比で調整されます
レポートレベル-at report level
- 文書内のすべての列が同じ幅比で調整されます
要素レベル-at element level
- 現在のシートのすべての列が同じ幅比で調整されます

注意

グローバル設定はレポートレベル設定によって上書きされ、レポートレベル設定は要素レベル設定によって上書きされます。存在する場合、PROPERTY_COLUMN_WIDTHプロパティは、その列のみのPROPERTY_COLUMN_WIDTH_RATIO値をオーバーライドします。

API: PROPERTY_COLUMN_WIDTH_RATIO
Default: N/A
Scope: Global | Context | Report | Element
Since: 4.1.3

net.sf.jasperreports.export.xls.create.custom.palette

XLSの結果が元のレポートの色を使用するように標準カラーパレットをカスタマイズするかどうかを指定するフラグプロパティ。
その値は、isCreateCustomPalette（）Excelエクスポート構成設定のデフォルトとして使用されます。
結果のXLSで使用される色は、次の方法で決定されます。

このフラグが設定されていない場合、標準のXLSパレットから最も近い色がレポートの色として選択されます。
フラグが設定されている場合、パレットから最も近い未変更の色が選択され、レポートの色と正確に一致するように変更されます。パレットのすべての色が変更されている場合（パレットのサイズが固定されている場合）、さらにレポートの色としてパレットから最も近い色が選択されます。

このプロパティはデフォルトでは設定されていません（false）。

API: PROPERTY_CREATE_CUSTOM_PALETTE
Default: false
Scope: Global | Context | Report
Since: 2.0.0

net.sf.jasperreports.export.xls.data

メタデータベースのExcelエクスポートでPROPERTY_COLUMN_NAMEに関連付けられたセルに配置する値を指定するプロパティ。
このプロパティを使用する場合、数字を千単位の区切り文字なしで、ピリオドを小数として使用して記述する必要があります。たとえば、1,000,000は「1000000」と記述し、2,000.45は「2000.45」と記述します。日付は、ISO 8601標準「yyyy-MM-dd'T'HH：mm：ss」に従って記述する必要があります。
デフォルトでは、この値は、このプロパティが割り当てられているレポート要素に保存されている値で表されます。

API: PROPERTY_DATA
Default: N/A
Scope: Text Element
Since: 4.0.2

net.sf.jasperreports.export.xls.defined.names.{arbitrary_name}

生成されたExcelブックの定義名を格納する一連のプロパティを識別するために使用されるプロパティプレフィックス。
これらのプロパティの定義名は、Excelエクスポート構成設定getDefinedNames（）のデフォルトとして使用されます。
各プロパティサフィックス（{arbitrary_name}部分）は名前識別子として機能し、次の規則に従う必要があります（Excelで定義された名前の規則を参照）。

名前の最初の文字は、文字、アンダースコアまたはバックスラッシュでなければなりません
残りの文字は、文字、数字、ピリオド、またはアンダースコアです。スペースは使用できません
名前はセル参照を表すことはできません（「A10」、「$ A $ 10」、「R2C5」などの名前は無効です）
名前は255文字を超えることはできません
名前では大文字と小文字は区別されません。「name1」、「Name1」、「NAME1」は同じ名前を表します
名前識別子は、エクスポート時に適切に収集されるように、特定のレポート内で一意である必要があります

このようなプロパティの値には、パイプ（ "|"）記号で区切られた2つの異なる部分が含まれます。

最初の部分は必須であり、以下を表す場合があります。

特定のシートのセル参照（「Sheet_1！$ A $ 10」、「Sheet_1！A10」、または「 'Sheet 1'！$ A $ 10」など）。「A10」セル参照は相対的ですが、「$ A $ 10」は絶対的です
特定のシート内のセル範囲参照（「Sheet_1！A10：C20」、「Sheet_1！$ A $ 10：$ C $ 20」、「 'Sheet 1'！$ A $ 10：$ C $ 20」など）
数式（「SUM（ 'Sheet 1'！$ A $ 10：$ C $ 20）」など）

注：R1C1 Excel参照スタイルは、セル参照、セル範囲、または数式ではサポートされていません。
オプションの2番目の部分は、定義された名前のスコープを表します。シート名、またはワークブック全体を表す「ワークブック」リテラル定数のいずれかです。この2番目の部分が欠落している場合、デフォルトで関連付けられるスコープはワークブック全体になります。

例えば:

<property name="net.sf.jasperreports.export.xls.defined.names.test_sum" value="SUM(Sheet_1!$A$10:$C$20)|SecondSheet"/>

「test_sum」として識別されるこの名前は、「SecondSheet」という名前のシートでのみ表示され、「Sheet_1」という名前のシートに属するセル範囲[$ A $ 10：$ C $ 20]の合計を計算する式に関連付けられます。

<property name="net.sf.jasperreports.export.xls.defined.names.test_range" value="'Sheet 1'!$A$10:$C$20"/>

「test_range」として識別されるこの名前は、ブック全体で表示され、「シート1」という名前のシートのセル範囲[$ A $ 10：$ C $ 20]に関連付けられています。

<property name="net.sf.jasperreports.export.xls.defined.names.test_sum_1" value="SUM(Sheet_1!$A$10:$C$20)|Sheet_1"/>
<property name="net.sf.jasperreports.export.xls.defined.names.test_sum_all" value="Sheet_1!test_sum_1"/>

この場合、test_sum_1という名前は、Sheet_1という名前のシートでのみ表示されます。

test_sum_allという名前はワークブック全体に表示され、Sheet_1に定義されているtest_sum_1名を参照します。

注：可視性/スコープが制限されている他の名前を参照する名前（上記のtest_sum_allなど）は、XLS（Excel 2003）エクスポート形式ではサポートされていません。 XLSX（Excel 2007以降）エクスポーターでのみ機能します。 XLSにエクスポートするときは、ブック全体に表示される名前のみを使用することをお勧めします。

API: PROPERTY_DEFINED_NAMES_PREFIX
Default: N/A
Scope: Report | Element
Since: 6.4.3

net.sf.jasperreports.export.xls.detect.cell.type

エクスポーターが元のテキストフィールド式のタイプを考慮し、それに応じてセルタイプと値を設定するかどうかを指定するプロパティ。
その値は、isDetectCellType（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_DETECT_CELL_TYPE
Default: false
Scope: Global | Context | Report
Since: 2.0.1

印刷設定系

net.sf.jasperreports.export.xls.first.page.number

ページ設定ダイアログの最初のページ番号を指定するプロパティ。
その値は、getFirstPageNumber（）Excelエクスポート構成設定のデフォルトとして使用されます。
プロパティを要素レベルで設定すると、現在のシートの最初のページ番号を設定するために使用できます。
グローバル設定は、レポートレベルの設定によって上書きされます。レポートレベルの設定は、要素（シート）レベルの設定によって上書きされます。

API: PROPERTY_FIRST_PAGE_NUMBER
Default: N/A
Scope: Global | Context | Report | Element
Since: 4.6.0

net.sf.jasperreports.export.xls.fit.height

印刷時に使用して、シートに収まる高さのページ数を示すプロパティ。
その値は、Excelエクスポート構成設定getFitHeight（）のデフォルトとして使用されます。
Excelの特定のシートの印刷ページは、レポートの最初のページ区切りに関係なく、[印刷]メニューの[用紙サイズ]設定に従って生成されます。この場合、JasperReport印刷ページとExcelのページに違いが生じる可能性があります。
通常、特定のシートのコンテンツは、単一のページに印刷されると見なされます。
しかし、シートに含まれる行が多すぎると、それらすべてを1ページに含めると、印刷文書が読めなくなる可能性があります。この場合、シートは複数の印刷ページに分割する必要があります。 JasperReportsでは、このページ数はnet.sf.jasperreports.export.xls.fit.heightプロパティで設定できます。

注：このプロパティが値（たとえば、n）に設定されている場合、Excelは、フォント設定と行の高さを変更せずに、nページでシートの高さ全体をカバーできるかどうかを推定します。ページ数が少なすぎる場合は、コンテンツ全体のスペースを確保するために、フォントと行の高さの調整が実行されます。印刷されたドキュメントは、関連するシートで公開されているものよりも小さなフォントと薄い行で出力されます。
net.sf.jasperreports.export.xls.fit.widthプロパティも参照してください。

API: PROPERTY_FIT_HEIGHT
Default: N/A
Scope: Global | Context | Report
Since: 3.7.5

net.sf.jasperreports.export.xls.fit.width

印刷時に使用され、シートが収まるページ幅の数を示すプロパティ。
その値は、Excelエクスポート構成設定getFitWidth（）のデフォルトとして使用されます。
Excelの特定のシートの印刷ページは、レポートの最初のページ区切りに関係なく、[印刷]メニューの[用紙サイズ]設定に従って生成されます。この場合、JasperReport印刷ページとExcelのページに違いが生じる可能性があります。
ほとんどの場合、特定のシートのコンテンツは1ページに印刷されることになっています。
ただし、シートに含まれる行や列が多すぎて、印刷されたページが読めなくなると、問題が発生する可能性があります。列が多すぎる場合は、コンテンツを読みやすくするために、シートの幅を複数の印刷ページに分割できます。 JasperReportsでは、このページ数はnet.sf.jasperreports.export.xls.fit.widthプロパティで設定できます。

注：このプロパティが値（たとえば、n）に設定されている場合、Excelはnページがシート幅全体をカバーするのに十分かどうかを推定し、フォント設定と列幅を変更しません。ページ数が少なすぎる場合、コンテンツ全体を使用可能なページに含めるために、フォントと列幅の調整が実行されます。印刷されたドキュメントは、関連するシートで公開されているものよりも小さなフォントと薄い列で表示されます。
net.sf.jasperreports.export.xls.fit.heightプロパティも参照してください。

API: PROPERTY_FIT_WIDTH
Default: N/A
Scope: Global | Context | Report
Since: 3.7.5

net.sf.jasperreports.export.xls.page.scale

印刷プレビュー枠で、ページコンテンツを通常サイズの特定の割合に調整するために使用されるプロパティ。
その値は、getPageScale（）Excelエクスポート構成設定のデフォルトとして使用されます。
許可される値は10〜400の正の整数で、通常のサイズのパーセントを表します。
プロパティが要素レベルで設定されている場合、シートごとのページスケールの設定に使用できます。
グローバル設定は、レポートレベルの設定によって上書きされます。レポートレベルの設定は、要素（シート）レベルの設定によって上書きされます。
このプロパティは、PROPERTY_FIT_WIDTHおよびPROPERTY_FIT_HEIGHT値をオーバーライドします。
このプロパティはデフォルトでは設定されていません（null）。

API: PROPERTY_PAGE_SCALE
Default: N/A
Scope: Global | Context | Report | Element
Since: 4.6.0

net.sf.jasperreports.export.xls.print.footer.margin

Excelシートのフッダーの余白をピクセル単位で保存するカスタムプロパティ。その値は、関連するgetPrintFooterMargin（）Excelエクスポート構成設定のデフォルトとして使用されます。このプロパティをグローバルまたはレポートごとに設定すると、生成されたドキュメントのすべてのシートに同じフッターマージンが設定されます。これらのマージンがシートごとに異なる場合、上記のプロパティを要素レベルで設定して、シートのフッターマージンがこのプロパティを含むシートの要素から読み取られるようにすることができます。シート内の複数の要素がフッターマージンプロパティを提供する場合、フッターマージンの最大値が考慮されます。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。このプロパティのデフォルト値は0です。

API: PROPERTY_PRINT_FOOTER_MARGIN
Default: 0
Scope: Global | Context | Report | Element
Since: 6.4.3

net.sf.jasperreports.export.xls.print.header.margin

Excelシートのヘッダーの余白をピクセル単位で保存するカスタムプロパティ。その値は、関連するgetPrintHeaderMargin（）Excelエクスポート構成設定のデフォルトとして使用されます。このプロパティをグローバルまたはレポートごとに設定すると、生成されたドキュメント内のすべてのシートに同じヘッダーマージンが設定されます。これらのマージンがシートごとに異なる場合、要素レベルで上記のプロパティを設定して、シートのヘッダーのマージンがこのプロパティを含むシートの要素から読み取られるようにすることができます。シート内の複数の要素がヘッダーマージンプロパティを提供する場合、ヘッダーマージンの最大値が考慮されます。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。このプロパティのデフォルト値は0です。

API: PROPERTY_PRINT_HEADER_MARGIN
Default: 0
Scope: Global | Context | Report | Element
Since: 6.4.3

net.sf.jasperreports.export.xls.print.page.bottom.margin

Excelシートの下部ページ余白をピクセル単位で設定するカスタムプロパティ。その値は、関連するgetPrintPageBottomMargin（）Excelエクスポート構成設定のデフォルトとして使用されます。
このプロパティをグローバルに設定するか、レポートレベルごとに設定すると、生成されたドキュメントのすべてのシートに同じ下部ページマージンが設定されます。これらのマージンがシートごとに異なる場合は、要素レベルで上記のプロパティを設定して、シートの下部ページのマージンがこのプロパティを含むシートの要素から読み取られるようにすることができます。シート内の複数の要素が下部ページのマージンプロパティを提供する場合、関連するマージンの最大値が考慮されます。このプロパティのデフォルト値は0です。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_PRINT_PAGE_BOTTOM_MARGIN
Default: 0
Scope: Global | Context | Report | Element
Since: 6.4.3

net.sf.jasperreports.export.xls.print.page.height

印刷プレビューペインのページの高さをピクセル単位で指定するカスタムプロパティ。その値は、関連するgetPrintPageHeight（）Excelエクスポート構成設定のデフォルトとして使用されます。このプロパティをグローバルに、またはレポートごとに設定すると、生成されたドキュメント内のすべてのシートのページの高さが同じになります。このページの高さがシートごとに異なる場合、要素レベルで上記のプロパティを設定して、シートのページの高さがこのプロパティを含むシートの要素から読み取られるようにすることができます。シート内の複数の要素がページの高さプロパティを提供する場合、ページの高さの最大値が考慮されます。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。このプロパティはデフォルトでは設定されていません。

API: PROPERTY_PRINT_PAGE_HEIGHT
Default: N/A
Scope: Global | Context | Report | Element
Since: 6.6.0

net.sf.jasperreports.export.xls.print.page.left.margin

Excelシートの左ページ余白をピクセル単位で保存するカスタムプロパティ。その値は、関連するgetPrintPageLeftMargin（）Excelエクスポート構成設定のデフォルトとして使用されます。
このプロパティをグローバルまたはレポートレベルごとに設定すると、生成されたドキュメント内のすべてのシートに同じ左ページ余白が設定されます。これらのマージンがシートごとに異なる場合、上記のプロパティを要素レベルで設定し、シートの左ページのマージンがこのプロパティを含むシートの要素から読み取られるようにすることができます。シート内の複数の要素が左ページのマージンプロパティを提供する場合、関連するマージンの最大値が考慮されます。このプロパティのデフォルト値は0です。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_PRINT_PAGE_LEFT_MARGIN
Default: 0
Scope: Global | Context | Report | Element
Since: 6.4.3

net.sf.jasperreports.export.xls.print.page.right.margin

Excelシートの右ページ余白をピクセル単位で保存するカスタムプロパティ。その値は、関連するgetPrintPageRightMargin（）Excelエクスポート構成設定のデフォルトとして使用されます。
このプロパティをグローバルまたはレポートレベルごとに設定すると、生成されたドキュメントのすべてのシートに同じ右ページ余白が設定されます。これらの余白がシートごとに異なる場合は、要素レベルで上記のプロパティを設定して、このプロパティを含むシートの要素からシートの右ページ余白を読み取ることができます。シート内の複数の要素が適切なページマージンプロパティを提供する場合、関連するマージンの最大値が考慮されます。このプロパティのデフォルト値は0です。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_PRINT_PAGE_RIGHT_MARGIN
Default: 0
Scope: Global | Context | Report | Element
Since: 6.4.3

net.sf.jasperreports.export.xls.print.page.top.margin

Excelシートのページ上部余白をピクセル単位で設定するカスタムプロパティ。その値は、関連するgetPrintPageTopMargin（）Excelエクスポート構成設定のデフォルトとして使用されます。
このプロパティをグローバルに設定するか、レポートレベルごとに設定すると、生成されたドキュメント内のすべてのシートに同じトップページマージンが設定されます。これらのマージンがシートごとに異なる場合、要素レベルで上記のプロパティを設定し、シートのトップページマージンがこのプロパティを含むシートの要素から読み取られるようにします。シート内の複数の要素がトップページのマージンプロパティを提供する場合、関連するマージンの最大値が考慮されます。このプロパティのデフォルト値は0です。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_PRINT_PAGE_TOP_MARGIN
Default: 0
Scope: Global | Context | Report | Element
Since: 6.4.3

net.sf.jasperreports.export.xls.print.page.width

印刷プレビュー枠のページ幅をピクセル単位で指定するカスタムプロパティ。その値は、関連するgetPrintPageWidth（）Excelエクスポート構成設定のデフォルトとして使用されます。このプロパティをグローバルまたはレポートごとに設定すると、生成されたドキュメントのすべてのシートに同じページ幅が設定されます。このページ幅がシートごとに異なる場合は、要素レベルで上記のプロパティを設定して、シート内のページ幅がこのプロパティを含むシート内の要素から読み取られるようにすることができます。シート内の複数の要素がページ幅プロパティを提供する場合、ページの高さの最大値が考慮されます。
要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。このプロパティはデフォルトでは設定されていません。

API: PROPERTY_PRINT_PAGE_WIDTH
Default: N/A
Scope: Global | Context | Report | Element
Since: 6.6.0

改ページ関連

net.sf.jasperreports.export.xls.force.page.breaks

isForcePageBreaks（）エクスポート設定のデフォルト値を提供するフラグプロパティ。 trueに設定すると、エクスポーターは現在のシートにエクスポートされた各ページの最後に改ページを自動的に追加します。
許可される値は次のとおりです。

true
false

API: PROPERTY_FORCE_PAGE_BREAKS
Default: false
Scope: Global | Context | Report
Since: 6.0.2

net.sf.jasperreports.export.xls.break.after.row

その要素を表示する行の後に改シートするかどうかを指定するカスタム要素プロパティ。特に、各レポートのグループを別々のシートに表示する場合に非常に便利です。

API: PROPERTY_BREAK_AFTER_ROW
Default: false
Scope: Element
Since: 3.0.0

net.sf.jasperreports.export.xls.break.before.row

その要素を表示する行の前でシートが分割されるかどうかを指定するカスタム要素プロパティ。特に、各レポートのグループを別々のシートに表示する場合に非常に便利です。

API: PROPERTY_BREAK_BEFORE_ROW
Default: false
Scope: Element
Since: 3.0.0

セルの固定

net.sf.jasperreports.export.xls.freeze.column

ドキュメントのシートの最初のロック解除された列の名前を示します。この列の左側の列はすべて「固定」されます。許可される値は、A、B、AB、ACなど、Excelで有効な列名を表す文字または文字の組み合わせです。ドキュメント内のすべてのシートが同じ列名を持つ場合、このプロパティを使用する必要があります。
このプロパティは以下で利用可能です：

JRXlsExporter
JRXlsMetadataExporter
JRXlsxExporter

API: PROPERTY_FREEZE_COLUMN
Default: N/A
Scope: Global | Context | Report
Since: 4.1.1

net.sf.jasperreports.export.xls.freeze.column.edge

現在のセルを基準にして、固定する垂直方向の端を示すプロパティ。設定されている場合、PROPERTY_FREEZE_COLUMN値をオーバーライドします。
許可される値は次のとおりです。

Left -
- 現在の列は、シートの最初のロックされていない列です。左側の列はすべて「固定」されます。
Right -
- 現在の列は、シートの最後の「固定」列です。右側の列はすべてロック解除されています。

シート内の複数の要素にこのプロパティが含まれている場合、固定する端の位置は、列インデックスが最大の要素から値を選択します。
このプロパティは以下で利用可能です：

JRXlsExporter
JRXlsMetadataExporter
JRXlsxExporter (since 6.2.0)

API: PROPERTY_FREEZE_COLUMN_EDGE
Default: N/A
Scope: Element
Since: 4.1.1

net.sf.jasperreports.export.xls.freeze.row

ドキュメントのシートの最初のロック解除された行のインデックスを指定します。これより上のすべての行は「固定」されます。許可される値は、1..65536の範囲の正の整数で表されます。負の値は考慮されません。このプロパティは、ドキュメント内のすべてのシートに同じ固定行インデックスがある場合に使用する必要があります。
このプロパティは以下で利用可能です：

JRXlsExporter
JRXlsMetadataExporter
JRXlsxExporter

API: PROPERTY_FREEZE_ROW
Default: N/A
Scope: Global | Context | Report
Since: 4.1.1

net.sf.jasperreports.export.xls.freeze.row.edge

現在のセルを基準にして、固定位置の水平方向の端を示すプロパティ。設定すると、PROPERTY_FREEZE_ROW値が上書きされます。
許可される値は次のとおりです。

Top -
- 現在の行は、シートの最初のロック解除された行です。上記のすべての行は「固定」されています。
Bottom -
- 現在の行は、シートの最後の「固定」行です。以下のすべての行がロック解除されます。

シート内の複数の要素にこのプロパティが含まれている場合、固定位置の端は、行インデックスが最大の要素からその値を選択します。
このプロパティは以下で利用可能です：

JRXlsExporter
JRXlsMetadataExporter
JRXlsxExporter (since 6.2.0)

API: PROPERTY_FREEZE_ROW_EDGE
Default: N/A
Scope: Element
Since: 4.1.1

net.sf.jasperreports.export.xls.ignore.anchors

要素をExcelにエクスポートするときにローカルアンカーを無視するかどうかを示すフラグプロパティ。
その値は、Excelエクスポート構成設定isIgnoreAnchors（）のデフォルトとして使用されます。
trueに設定すると、ローカルアンカーはエクスポートから除外されます。それ以外の場合は、それらが属する要素とともにエクスポートされます。

API: PROPERTY_IGNORE_ANCHORS
Default: false
Scope: Global | Context | Report
Since: 4.6.0

シート設定系

net.sf.jasperreports.export.xls.max.rows.per.sheet

同じシートにエクスポートできる行の最大数を指定するプロパティ。負の値またはゼロは、制限が設定されていないことを意味します。
その値は、getMaxRowsPerSheet（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_MAXIMUM_ROWS_PER_SHEET
Default: 0
Scope: Global | Context | Report
Since: 2.0.1

net.sf.jasperreports.export.xls.one.page.per.sheet

各レポートページを異なるXLSシートに書き込むかどうかを指定するプロパティ。
その値は、isOnePagePerSheet（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_ONE_PAGE_PER_SHEET
Default: false
Scope: Global | Context | Report
Since: 2.0.1

net.sf.jasperreports.export.xls.sheet.direction

このプロパティは、シートの向きが左から右か右から左かを示します。可能な値は次のとおりです。

LTR
RTL

その値は、getSheetDirection（）Excelエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_SHEET_DIRECTION
Default: LTR
Scope: Global | Context | Report
Since: 3.7.5

net.sf.jasperreports.export.xls.sheet.footer.center

Excelシートの中央フッターのテキストコンテンツを格納するカスタムプロパティ。その値は、関連するgetSheetFooterCenter（）Excelエクスポート構成設定のデフォルトとして使用されます。 Excelセンターのフッターのテキストコンテンツは255文字に制限されています。通常のプレーンテキストの場合もあれば、通常Excelアプリによってヘッダー/フッターの動的設定として解釈される特殊文字シーケンスが含まれている場合もあります。

&P - 現在のページ番号
&N - 総ページ数
&D - 現在の日付
&T - 現在の時刻
&A - シート名
&F - ファイル名
&Z - ファイルのフルネーム

注：特殊なXML文字であるため、＆は &としてエスケープする必要があります。
たとえば、 'Page of <n>'構造を含む中央フッタープロパティは、次のように設定する必要があります。

<property name="net.sf.jasperreports.export.xls.sheet.footer.center" value="Page &amp;P of &amp;N"/>

v.6.4.3以降、このプロパティは要素レベルでも設定でき、各シートのヘッダー/フッターを個別に制御できます。シート内の複数の要素に同じ中央フッタープロパティが含まれている場合、シート内の最後の要素の値が考慮されます。要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_SHEET_FOOTER_CENTER
Default: N/A
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.sheet.footer.left

Excelシートの左フッターのテキストコンテンツを格納するカスタムプロパティ。その値は、関連するgetSheetFooterLeft（）Excelエクスポート構成設定のデフォルトとして使用されます。 Excelの左フッターのテキストコンテンツは255文字に制限されています。通常のプレーンテキストの場合もあれば、通常Excelアプリによってヘッダー/フッターの動的設定として解釈される特殊文字シーケンスが含まれている場合もあります。

&P - 現在のページ番号
&N - 総ページ数
&D - 現在の日付
&T - 現在の時刻
&A - シート名
&F - ファイル名
&Z - ファイルのフルネーム

注：特殊なXML文字であるため、＆は &としてエスケープする必要があります。
たとえば、「Page of <n>」構造を含む左フッタープロパティは、次のように設定する必要があります。

<property name="net.sf.jasperreports.export.xls.sheet.footer.left" value="Page &amp;P of &amp;N"/>

v.6.4.3以降、このプロパティは要素レベルでも設定でき、各シートのヘッダー/フッターを個別に制御できます。シート内の複数の要素に同じ左フッタープロパティが含まれている場合、シート内の最後の要素の値が考慮されます。要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_SHEET_FOOTER_LEFT
Default: N/A
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.sheet.footer.right

Excelシートの右フッターのテキストコンテンツを格納するカスタムプロパティ。その値は、関連するgetSheetFooterRight（）Excelエクスポート構成設定のデフォルトとして使用されます。 Excelの右フッターのテキストコンテンツは255文字に制限されています。通常のプレーンテキストの場合もあれば、通常Excelアプリによってヘッダー/フッターの動的設定として解釈される特殊文字シーケンスが含まれている場合もあります。

&P - 現在のページ番号
&N - 総ページ数
&D - 現在の日付
&T - 現在の時刻
&A - シート名
&F - ファイル名
&Z - ファイルのフルネーム

注：特殊なXML文字であるため、＆は &としてエスケープする必要があります。
たとえば、'Page of <n>'構造を含む右フッタープロパティは、次のように設定する必要があります。

<property name="net.sf.jasperreports.export.xls.sheet.footer.right" value="Page &amp;P of &amp;N"/>

v.6.4.3以降、このプロパティは要素レベルでも設定でき、各シートのヘッダー/フッターを個別に制御できます。シート内の複数の要素に同じ右フッタープロパティが含まれている場合、シート内の最後の要素の値が考慮されます。要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_SHEET_FOOTER_RIGHT
Default: N/A
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.sheet.header.center

Excelシートセンターヘッダーのテキストコンテンツを格納するカスタムプロパティ。その値は、関連するgetSheetHeaderCenter（）Excelエクスポート構成設定のデフォルトとして使用されます。 Excelセンターヘッダーのテキストコンテンツは255文字に制限されています。通常のプレーンテキストの場合もあれば、通常Excelアプリによってヘッダー/フッターの動的設定として解釈される特殊文字シーケンスが含まれている場合もあります。

&P - 現在のページ番号
&N - 総ページ数
&D - 現在の日付
&T - 現在の時刻
&A - シート名
&F - ファイル名
&Z - ファイルのフルネーム

注：特殊なXML文字であるため、＆は &としてエスケープする必要があります。
たとえば、'Page of <n>'構造を含む中央ヘッダープロパティは、次のように設定する必要があります。

<property name="net.sf.jasperreports.export.xls.sheet.header.center" value="Page &amp;P of &amp;N"/>

v.6.4.3以降、このプロパティは要素レベルでも設定でき、各シートのヘッダー/フッターを個別に制御できます。シートの複数の要素に同じ中央ヘッダープロパティが含まれている場合、シートの最後の要素の値が考慮されます。要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_SHEET_HEADER_CENTER
Default: N/A
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.sheet.header.left

Excelシートの左ヘッダーのテキストコンテンツを格納するカスタムプロパティ。その値は、関連するgetSheetHeaderLeft（）Excelエクスポート構成設定のデフォルトとして使用されます。 Excelの左ヘッダーのテキストコンテンツは255文字に制限されています。通常のプレーンテキストの場合もあれば、通常Excelアプリによってヘッダー/フッターの動的設定として解釈される特殊文字シーケンスが含まれている場合もあります。

&P - 現在のページ番号
&N - 総ページ数
&D - 現在の日付
&T - 現在の時刻
&A - シート名
&F - ファイル名
&Z - ファイルのフルネーム

注：特殊なXML文字であるため、＆は &としてエスケープする必要があります。
たとえば、'Page of <n>'構造を含む左ヘッダープロパティは、次のように設定する必要があります。

<property name="net.sf.jasperreports.export.xls.sheet.header.left" value="Page &amp;P of &amp;N"/>

v.6.4.3以降、このプロパティは要素レベルでも設定でき、各シートのヘッダー/フッターを個別に制御できます。シート内の複数の要素に同じ左ヘッダープロパティが含まれている場合、シート内の最後の要素の値が考慮されます。要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_SHEET_HEADER_LEFT
Default: N/A
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.sheet.header.right

Excelシートの右ヘッダーのテキストコンテンツを格納するカスタムプロパティ。その値は、関連するExcelエクスポート構成設定のgetSheetHeaderRight（）のデフォルトとして使用されます。 Excelの右ヘッダーのテキストコンテンツは255文字に制限されています。通常のプレーンテキストの場合もあれば、通常Excelアプリによってヘッダー/フッターの動的設定として解釈される特殊文字シーケンスが含まれている場合もあります。

&P - 現在のページ番号
&N - 総ページ数
&D - 現在の日付
&T - 現在の時刻
&A - シート名
&F - ファイル名
&Z - ファイルのフルネーム

注：特殊なXML文字であるため、＆は &としてエスケープする必要があります。
たとえば、'Page of <n>'構造を含む右ヘッダープロパティは次のように設定する必要があります。

<property name="net.sf.jasperreports.export.xls.sheet.header.right" value="Page &amp;P of &amp;N"/>

v.6.4.3以降、このプロパティは要素レベルでも設定でき、各シートのヘッダー/フッターを個別に制御できます。シート内の複数の要素に同じ右ヘッダープロパティが含まれている場合、シート内の最後の要素の値が考慮されます。要素レベルで設定されたプロパティは、グローバルまたはレポートレベルごとに設定されたプロパティよりも優先されます。

API: PROPERTY_SHEET_HEADER_RIGHT
Default: N/A
Scope: Global | Context | Report | Element
Since: 3.7.5

net.sf.jasperreports.export.xls.sheet.name

特定の要素を含むシートの名前を設定するために使用されるプロパティ。その値は、シート名のレポートレベルの設定を上書きします。
シート内の複数の要素にこのプロパティが含まれている場合、エンジンは最後にエクスポートされた要素のプロパティの値を考慮します。

API: PROPERTY_SHEET_NAME
Default: N/A
Scope: Element
Since: 4.1.3

net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name}

ユーザー定義のシート名を保持するために追加された一連のレポートカスタムプロパティ（エクスポーターヒント）。これは、jrxmlテンプレートでシート名が必要であることを示すときに非常に便利です。
これらのプロパティのシート名は、getSheetNames（）Excelエクスポート構成設定のデフォルトとして使用されます。
これらのプロパティは、net.sf.jasperreports.export.xls.sheet.namesで始まる必要があります。プレフィックス、および任意のサフィックスで終了する必要があります。それらのいずれも、スラッシュ（「/」）区切り文字で区切られた1つまたは複数のシート名を保持できます。値は、jrxmlテンプレートで列挙されているのと同じ順序で収集されるため、jrxmlを編集するときはその順序に注意する必要があります。末尾のサフィックスは重要ではありませんが、順序は非常に重要です。
たとえば、特定のレポートに3つの結果シートがある場合、jrxmlテンプレート内でシート名を定義する方法は複数あります。

1）各シート名に単一のプロパティを設定するには：

<property name="net.sf.jasperreports.export.xls.sheet.names.sheet1" value="First sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.second.sheet.name" value="Second sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.3" value="Third sheet" />

すると、結果3つのシートに次のように名前が付けられます。

First sheet
Second sheet
Third sheet

2）「/」区切り文字で区切られたすべてのシート名を含む単一のプロパティを作成するには：

<property name="net.sf.jasperreports.export.xls.sheet.names.all" value="First sheet/Second sheet/Third sheet" />

すると、結果3つのシートに次のように名前が付けられます。

First sheet
Second sheet
Third sheet

上に示すように、順序は非常に重要です。

1）と2）の任意の組み合わせを使用するには：

<property name="net.sf.jasperreports.export.xls.sheet.names.first" value="First sheet" />
<property name="net.sf.jasperreports.export.xls.sheet.names.others" value="Second sheet/Third sheet" />

すると、結果3つのシートに次のように名前が付けられます。

First sheet
Second sheet
Third sheet

最後に、ユーザーがシート数より少ないシート名（たとえばx）を設定すると、エクスポーターはドキュメントの最初のxシートにカスタムユーザーシート名を使用し、残りのシートはデフォルトで「Page y (y=現在のページ番号)」となります。
これらのプロパティはデフォルトでは設定されていません。

API: PROPERTY_SHEET_NAMES_PREFIX
Default: N/A
Scope: Report
Since: 3.5.2

net.sf.jasperreports.export.xls.sheet.tab.color

XLSXおよびODS出力形式で特定のシートのタブの色を設定するために使用される値を持つプロパティ。レポートレベルで設定すると、ドキュメント内のすべてのシートのタブは同じ色になります。レポート要素レベルで設定され、シート内の複数の要素がこのプロパティを提供する場合、最後に読み取られた値が考慮されます。

通常、その値は＃プレフィックスのCSSカラーとして表現できます。
レポートレベルの設定は、このプロパティの要素レベルの設定によって上書きされます。シート内の複数の要素にこのプロパティが含まれている場合、エンジンは最後にエクスポートされた要素のプロパティの値を考慮します。

注：このプロパティは、XLS出力形式ではサポートされていません。

API: PROPERTY_SHEET_TAB_COLOR
Default: N/A
Scope: Global | Context | Report | Element
Since: 6.2.0

メタデータ設定関連

net.sf.jasperreports.export.xls.metadata.application

生成されたXLSメタデータに使用するアプリケーション情報を含めるプロパティ。
その値は、getMetadataApplication（）XLSエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_METADATA_APPLICATION
Default: N/A
Scope: Global | Context | Report
Since: 6.3.1

net.sf.jasperreports.export.xls.metadata.author

生成されたXLSメタデータに使用する作成者情報を含めるプロパティ。
その値は、getMetadataAutor（）XLSエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_METADATA_AUTHOR
Default: N/A
Scope: Global | Context | Report
Since: 6.3.1

net.sf.jasperreports.export.xls.metadata.keywords

生成されたXLSメタデータに使用するキーワードを含めるプロパティ。
その値は、XLSエクスポート構成設定getMetadataKeywords（）のデフォルトとして使用されます。

API: PROPERTY_METADATA_KEYWORDS
Default: N/A
Scope: Global | Context | Report
Since: 6.3.1

net.sf.jasperreports.export.xls.metadata.subject

生成されたXLSメタデータに使用するサブジェクト情報を含めるプロパティ。
その値は、getMetadataSubject（）XLSエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_METADATA_SUBJECT
Default: N/A
Scope: Global | Context | Report
Since: 6.3.1

net.sf.jasperreports.export.xls.metadata.title

生成されたXLSメタデータに使用するタイトル情報を含めるプロパティ。
その値は、getMetadataTitle（）XLSエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_METADATA_TITLE
Default: N/A
Scope: Global | Context | Report
Since: 6.3.1

その他

net.sf.jasperreports.export.xls.password

文書内のパスワードで保護されたシートの場合、パスワードを表す文字列値を含むプロパティ。
その値は、getPassword（）Excelエクスポート構成設定のデフォルトとして使用されます。
このプロパティはデフォルトでは設定されていません（null）。

API: PROPERTY_PASSWORD
Default: N/A
Scope: Global | Context | Report
Since: 3.0.1

net.sf.jasperreports.export.xls.pattern

値がExcel互換パターンであるプロパティ。XLS形式にエクスポートするときにテキストフィールドパターンの代わりとして使用されます。

API: PROPERTY_CELL_PATTERN
Default: N/A
Scope: Text Element
Since: 4.1.1

net.sf.jasperreports.export.xls.pattern.{arbitrary_pattern}

net.sf.jasperreports.export.xls.patternを持つプロパティ。プレフィックスは、関連するJava形式パターンに対応する特定のExcel形式パターンを格納するために使用されます。 {arbitrary_pattern}サフィックスはJavaパターンを表し、プロパティ値は関連するExcelパターンです。これらのプロパティがJRXMLレポートデザインで定義されている場合、特殊文字はXMLエスケープする必要があります。プロパティファイルで定義されている場合、特殊文字もエスケープする必要があります。レポートでいくつかのプロパティが定義されている場合、それらはコンテキストプロパティをオーバーライドします。

API: FORMAT_PATTERN_PREFIX
Default: N/A
Scope: Global | Context | Report
Since: 6.5.0

net.sf.jasperreports.export.xls.formula

Excelシートの特定のセルに適用する必要がある数式を格納するプロパティ。

API: PROPERTY_CELL_FORMULA
Default: N/A
Scope: Text Element
Since: 3.0.0

net.sf.jasperreports.export.xls.repeat.value

PROPERTY_COLUMN_NAMEに関連付けられた値が欠落している場合に繰り返す必要があるかどうかを指定するプロパティ。このプロパティは、メタデータベースのExcelエクスポートで使用できます。

API: PROPERTY_REPEAT_VALUE
Default: false
Scope: Element
Since: 4.0.2

net.sf.jasperreports.export.xls.row.outline.level.{arbitrary_level}

現在のアウトライン行レベル、および必要に応じて、指定されたレベルの現在のアウトライン行グループの終了行を示すために使用されるプロパティ接頭語。これらのプロパティの接尾語はアウトラインレベルに関連付けられ、プロパティ値は現在の行グループを続行するか終了するかを示します。最も推奨される解決策は、アウトラインレベル自体をプロパティ接尾語として使用することですが、これは必須ではありません。接尾辞には他の文字列値を使用できますが、接尾辞はソートされた行レベル記述子として使用されることに注意する必要があります。たとえば、 "aaa" <"bbb"であるため、 "aaa"接尾語に関連付けられたアウトラインレベルは、 "bbb"接尾語に関連付けられたレベルよりも小さくなります。行レベルの完全に直感的な表現では、行レベルをプロパティ接尾語として使用します。

このような場合、net.sf.jasperreports.export.xls.outline.level.2プロパティは、その値がアウトラインレベル2と相関しているため、現在の行がレベル2の行グループに属していることを意味します。 Office Open XML仕様に基づいて、アウトラインレベルの許容値は1〜7の正の整数です。このプロパティの値は、任意の式（nullを含む）にすることができます。このようなプロパティの出現が満たされると、接尾辞はその行のアウトラインレベルを示します。同じ行に同じ接頭辞を持つ複数のプロパティが定義されている場合、その行では最も深いアウトラインレベルが考慮されます。アウトライン行グループを終了するには、関連するアウトラインレベルプロパティにEnd値を設定する必要があります。これは、そのレベルの現在の行グループが現在の行で終了することをJRエンジンに指示する特別なプロパティ値です。

API: PROPERTY_ROW_OUTLINE_LEVEL_PREFIX
Default: N/A
Scope: Element
Since: 4.1.3

net.sf.jasperreports.export.xls.show.gridlines

特定のシートのグリッド線を表示するかどうかを指定するフラグプロパティ。
その値はisShowGridLines（）Excelエクスポートの構成設定のデフォルトとして使用されています。
シート内の複数の要素がこのプロパティを提供する場合、最後に読み取られた値が考慮されます。グローバル設定は、レポートレベルの設定によって上書きされます。レポートレベルの設定は、要素（シート）レベルの設定によって上書きされます。

API: PROPERTY_SHOW_GRIDLINES
Default: true
Scope: Global | Context | Report | Element
Since: 4.8.0

net.sf.jasperreports.export.xls.use.timezone

日付値をレポートの入力に使用されたタイムゾーンに変換するかどうかを決定するプロパティ。
その値は、Excelエクスポート構成設定isUseTimeZone（）のデフォルトとして使用されます。
デフォルトでは、システムのデフォルトのタイムゾーンを使用して日付値がExcelにエクスポートされます。このプロパティをtrueに設定すると、エクスポーターはレポートのタイムゾーンを使用して日付値をエクスポートするように指示されます。
このプロパティは、net.sf.jasperreports.export.xls.detect.cell.typeが設定されている場合にのみ有効です。

API: PROPERTY_USE_TIMEZONE
Default: false
Scope: Global | Context | Report | Text Element
Since: 4.5.0

net.sf.jasperreports.export.xls.white.page.background

ページの背景を白にするか、デフォルトのXLS背景色にするかを指定するプロパティ。
その値は、isWhitePageBackground（）Excelエクスポート構成設定のデフォルトとして使用されます。
プロパティが要素レベルで設定されている場合、その値はその要素を含むシートにのみ適用されます。ドキュメント内の他のシートは影響を受けません。

注：v.6.2.0以降、このプロパティはレポート要素ごとにも設定できます

API: PROPERTY_WHITE_PAGE_BACKGROUND
Default: true
Scope: Global | Context | Report | Element
Since: 2.0.1

net.sf.jasperreports.export.xls.workbook.template

既存のワークブックテンプレートの場所を格納するために使用されるプロパティ。
その値は、getWorkbookTemplate（）Excelエクスポート構成設定のデフォルトとして使用されます。
テンプレートの場所がわかっている場合、既存のワークブックドキュメントまたはテンプレートのコンテンツをエクスポートされたドキュメントに埋め込むことができます。この場合、テンプレートのコンテンツが最初にエクスポートされ、エクスポートされたレポートのコンテンツがこのレポートに追加されます。既存のテンプレートのマクロおよびその他の設定も、生成されたドキュメントに保持されます。テンプレートは、Excelテンプレートファイル（* .xlt）および有効なExcelドキュメント（* .xls）からロードできます。
このプロパティは、Apache POI API（JRXlsExporter）に基づいたExcelエクスポーターで使用されます。 JRXlsxExporterに類似したプロパティはありません。

API: PROPERTY_WORKBOOK_TEMPLATE
Default: N/A
Scope: Global | Context | Report
Since: 4.5.1

net.sf.jasperreports.export.xls.workbook.template.keep.sheets

既存のテンプレートのシートを生成されたドキュメントに保持するかどうかを指定するフラグプロパティ。
その値は、isKeepWorkbookTemplateSheets（）Excelエクスポート構成設定のデフォルトとして使用されます。生成されたドキュメントに、既存のテンプレートからマクロやその他のグローバル設定のみを埋め込むことが重要な場合がありますが、テンプレートドキュメントの独自のシートは保持しません。 falseに設定すると、このプロパティはテンプレートシートがエクスポートされないようにします。
このプロパティはPROPERTY_WORKBOOK_TEMPLATEと組み合わせて使用されます。
許可される値は次のとおりです。

true
false - デフォルトの値です

API: PROPERTY_WORKBOOK_TEMPLATE_KEEP_SHEETS
Default: false
Scope: Global | Context | Report
Since: 4.5.1

net.sf.jasperreports.export.xls.wrap.text

特定のセルでテキストの折り返しを許可するかどうかを指定するカスタム要素プロパティ。
その値は、isWrapText（）Excelエクスポート構成設定のデフォルトとして使用されます。
falseに設定すると、テキストの折り返しが禁止されます。それ以外の場合は許可されます。

API: PROPERTY_WRAP_TEXT
Default: true
Scope: Global | Context | Report | Element
Since: 3.7.3

net.sf.jasperreports.export.xls.write.header

メタデータベースのExcelエクスポートで、エクスポートヘッダー（列名）を書き込むかどうかを指定するプロパティ。
その値は、isWriteHeader（）Excelメタデータエクスポート構成設定のデフォルトとして使用されます。

API: PROPERTY_WRITE_HEADER
Default: false
Scope: Global | Context | Report
Since: 4.0.2

net.sf.jasperreports.export.xlsx.macro.template

マクロオブジェクトを含む既存のExcel 2007ブックテンプレートの場所を格納するために使用されるプロパティ。 Excel 2007形式にエクスポートする場合、テンプレートの場所が有効であれば、マクロオブジェクトは生成されたドキュメントにコピーされます。マクロは、Excel 2007マクロ対応テンプレートファイル（* .xltm）および有効なExcelマクロ対応ドキュメント（* .xlsm）からロードできます。
このプロパティの値は、Excel 2007エクスポート構成設定getMacroTemplate（）のデフォルトとして使用されます。

API: PROPERTY_MACRO_TEMPLATE
Default: N/A
Scope: Global | Context | Report
Since: 4.5.1

JasperReport Excel出力プロパティまとめ(日本語版)

対象とする人

元ネタ

設定

デフォルト表示設定系

net.sf.jasperreports.export.xls.shrink.to.fit

net.sf.jasperreports.export.xls.font.size.fix.enabled

net.sf.jasperreports.export.xls.ignore.cell.background

net.sf.jasperreports.export.xls.ignore.cell.border

net.sf.jasperreports.export.xls.ignore.graphics

net.sf.jasperreports.export.xls.ignore.hyperlink

net.sf.jasperreports.export.xls.ignore.text.formatting

net.sf.jasperreports.export.xls.image.anchor.type

net.sf.jasperreports.export.xls.image.border.fix.enabled

net.sf.jasperreports.export.xls.remove.empty.space.between.columns

net.sf.jasperreports.export.xls.remove.empty.space.between.rows

net.sf.jasperreports.export.xls.auto.filter

Start -

End -

注意

net.sf.jasperreports.export.xls.auto.fit.column

net.sf.jasperreports.export.xls.auto.fit.page.height

net.sf.jasperreports.export.xls.auto.fit.row

net.sf.jasperreports.export.xls.cell.hidden

net.sf.jasperreports.export.xls.cell.locked

net.sf.jasperreports.export.xls.collapse.row.span

net.sf.jasperreports.export.xls.column.name

net.sf.jasperreports.export.xls.column.names.{arbitrary_name}

net.sf.jasperreports.export.xls.column.width

net.sf.jasperreports.export.xls.column.width.ratio

注意

net.sf.jasperreports.export.xls.create.custom.palette

net.sf.jasperreports.export.xls.data

net.sf.jasperreports.export.xls.defined.names.{arbitrary_name}

net.sf.jasperreports.export.xls.detect.cell.type

印刷設定系

net.sf.jasperreports.export.xls.first.page.number

net.sf.jasperreports.export.xls.fit.height

net.sf.jasperreports.export.xls.fit.width

net.sf.jasperreports.export.xls.page.scale

net.sf.jasperreports.export.xls.print.footer.margin

net.sf.jasperreports.export.xls.print.header.margin

net.sf.jasperreports.export.xls.print.page.bottom.margin

net.sf.jasperreports.export.xls.print.page.height

net.sf.jasperreports.export.xls.print.page.left.margin

net.sf.jasperreports.export.xls.print.page.right.margin

net.sf.jasperreports.export.xls.print.page.top.margin

net.sf.jasperreports.export.xls.print.page.width

改ページ関連

net.sf.jasperreports.export.xls.force.page.breaks

net.sf.jasperreports.export.xls.break.after.row

net.sf.jasperreports.export.xls.break.before.row

セルの固定

net.sf.jasperreports.export.xls.freeze.column

net.sf.jasperreports.export.xls.freeze.column.edge

net.sf.jasperreports.export.xls.freeze.row

net.sf.jasperreports.export.xls.freeze.row.edge

net.sf.jasperreports.export.xls.ignore.anchors

シート設定系

net.sf.jasperreports.export.xls.max.rows.per.sheet

net.sf.jasperreports.export.xls.one.page.per.sheet

net.sf.jasperreports.export.xls.sheet.direction

net.sf.jasperreports.export.xls.sheet.footer.center

net.sf.jasperreports.export.xls.sheet.footer.left

net.sf.jasperreports.export.xls.sheet.footer.right

net.sf.jasperreports.export.xls.sheet.header.center

net.sf.jasperreports.export.xls.sheet.header.left

net.sf.jasperreports.export.xls.sheet.header.right

net.sf.jasperreports.export.xls.sheet.name

net.sf.jasperreports.export.xls.sheet.names.{arbitrary_name}

net.sf.jasperreports.export.xls.sheet.tab.color

メタデータ設定関連

net.sf.jasperreports.export.xls.metadata.application

net.sf.jasperreports.export.xls.metadata.author

net.sf.jasperreports.export.xls.metadata.keywords

net.sf.jasperreports.export.xls.metadata.subject

net.sf.jasperreports.export.xls.metadata.title

その他

net.sf.jasperreports.export.xls.password

net.sf.jasperreports.export.xls.pattern