mlreportgen.dom.WhiteSpace クラス

名前空間: mlreportgen.dom

空白のタイプ

このページをすべて展開する

説明

テキスト内の空白と改行の動作を指定します。

mlreportgen.dom.WhiteSpace クラスは handle クラスです。

作成

説明

例

ws = WhiteSpace(option) は、指定された空白オプションを Text オブジェクトまたは Paragraph オブジェクト内の空白に対して適用します。PDF の場合、Paragraph オブジェクトに対してのみ WhiteSpace を指定できます。

入力引数

すべて展開する

`option` — 空白の動作
`'normal'` | `'nowrap'` | `'pre'` | `'pre-line'` | `'preserve'` | `'pre-wrap'`

空白の動作。次の値のいずれかとして指定します。

メモ

'preserve' と 'normal' のみが Word 出力に影響します。

値	説明
`'normal'` (既定)	HTML と PDF の場合、先頭と末尾のスペースを削除し、テキスト内の複数のスペースを単一のスペースに折りたたみ、改行を無視します。 Word の場合、改行を無視し、先頭と末尾のスペースを削除します。
`'nowrap'`	連続する空白は単一の空白に折りたたまれます。テキストは次の行に折り返されません。テキストは `<br />` タグが出現するまで同じ行で継続します。
`'pre'`	空白を維持します。テキストは改行でのみ折り返されます。HTML の `<pre>` タグのように機能します。
`'preserve'`	スペースと改行を保持します。
`'pre-line'`	連続する空白は単一の空白に折りたたまれます。テキストは必要に応じて、また改行で折り返されます。
`'pre-wrap'`	空白を維持します。テキストは必要に応じて、また改行で折り返されます。

プロパティ

すべて展開する

`WhiteSpace` — テキスト内の空白の処理方法
`[]` (既定値) | `"normal"` | `"nowrap"` | ...

テキスト内の空白と改行の処理方法。次の表のいずれかの値として指定します。

値	説明	サポートされる出力タイプ
`"normal"`	HTML や PDF の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。テキスト内の複数のスペースは単一のスペースに折りたたまれます。 Microsoft^® Word の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。	すべて
`"nowrap"`	連続する空白は単一の空白に折りたたまれます。テキストが次の行に折り返されることはありません。	HTML
`"pre"`	空白を維持します。テキストは改行でのみ折り返されます。HTML の `<pre>` タグのように機能します。	HTML および PDF
`"preserve"`	"pre" と同様です。	すべて
`"pre-line"`	連続する空白は単一の空白に折りたたまれます。テキストは必要に応じて、また改行で折り返されます。	HTML および PDF
`"pre-wrap"`	空白を維持します。テキストは必要に応じて、また改行で折り返されます。	HTML および PDF

メモ

WhiteSpace プロパティを設定すると、対応する mlreportgen.dom.WhiteSpace 書式オブジェクトが Style プロパティに追加されます。WhiteSpace プロパティを空の値に設定すると、そのオブジェクトは削除されます。

データ型: char | string

`Tag` — `mlreportgen.dom.WhiteSpace` オブジェクトのタグ
文字ベクトル | string スカラー

mlreportgen.dom.WhiteSpace オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクトクラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。

属性:

NonCopyable true

データ型: char | string

`Id` — `mlreportgen.dom.WhiteSpace` オブジェクトの識別子
文字ベクトル | string スカラー

mlreportgen.dom.WhiteSpace オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id には独自の値を指定できます。

属性:

NonCopyable true

データ型: char | string

例

すべて折りたたむ

コロン後のスペースの保持

ライブスクリプトを開く

この例では、出力形式ごとに 'preserve' オプションを使用した場合の効果を示します。たとえば、章のタイトルを作成する場合などに、末尾のスペースを保持すると便利です。通常、テキスト 'Chapter: ' の後には自動番号を追加します。'preserve' を使用すると、末尾のスペースが保持されます。

HTML 出力

出力形式として HTML を選択した場合、複数のスペースが折りたたまれますが、末尾のスペースは保持されます。

import mlreportgen.dom.*;
doctype = 'html';
d = Document('testHTML',doctype);
open(d);
     
p = Paragraph('This paragraph has extra spaces    and one after the colon: ');
% p.Style = {WhiteSpace('preserve')};

append(p,'XX');
append(d,p);
     
close(d);
rptview(d.OutputPath);

Word 出力

出力形式として Word を選択した場合、複数のスペースは折りたたまれず、末尾のスペースは保持されます。WhiteSpace プロパティをコメントアウトしてみます。複数のスペースが保持されますが、コロンの後の末尾のスペースは削除されます。

import mlreportgen.dom.*;
doctype = 'docx';
d = Document('test',doctype);
open(d);
     
p = Paragraph('This paragraph has extra spaces    and one after the colon: ');
p.Style = {WhiteSpace('preserve')};

append(p,'XX');
append(d,p);
     
close(d);
rptview(d.OutputPath);

PDF 出力

2 番目のコードブロックの説明

import mlreportgen.dom.*;
doctype = 'pdf';
d = Document('test',doctype);
open(d);
     
p = Paragraph('This paragraph has extra spaces    and one after the colon: ');
p.Style = {WhiteSpace('preserve')};

append(p,'XX');
append(d,p);
     
close(d);
rptview(d.OutputPath);