Main Content

このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

mlreportgen.dom.NumberFormat クラス

名前空間: mlreportgen.dom

数値の書式設定

R2021a 以降

説明

mlreportgen.dom.NumberFormat クラスのオブジェクトを使用して、レポート内での数値の書式設定を指定します。1 つの数値に対して書式設定を指定するには、その数値を mlreportgen.dom.Number クラスのオブジェクトとして表し、Number オブジェクトの Style プロパティに NumberFormat オブジェクトを含めます。段落、リスト、テーブルなどのドキュメント要素内のすべての数値の書式を設定するには、その要素を表すオブジェクトの Style プロパティに NumberFormat オブジェクトを含めます。

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

クラス属性

ConstructOnLoad
true
HandleCompatible
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

numberFormatObj = mlreportgen.dom.NumberFormat は、NumberFormat オブジェクトを作成します。Value プロパティに書式指定を設定します。

numberFormatObj = mlreportgen.dom.NumberFormat(value) は、NumberFormat オブジェクトを作成し、Value プロパティを value で指定された書式に設定します。

プロパティ

すべて展開する

書式指定。文字ベクトルまたは string スカラーとして指定します。この指定は、関数 sprintf に対して有効な書式指定でなければなりません。以下の演算子の 1 つを使用できます。

  • %f

  • %e

  • %E

  • %g

  • %G

例: "%0.2f"

属性:

NonCopyable
true

Value プロパティを整数に適用するオプション。数値または logical の 1 (true) または 0 (false) として指定します。true の場合、指定書式を整数に適用します。false の場合、指定書式を整数に適用しません。

属性:

NonCopyable
true

データ型: logical

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

属性:

NonCopyable
true

データ型: char | string

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

属性:

NonCopyable
true

データ型: char | string

すべて折りたたむ

Number オブジェクトとして数値を表します。NumberFormat オブジェクトを使用して、小数点以下 4 桁の精度を指定します。

import mlreportgen.dom.*
  
rpt = Document("Report with NumberFormat","pdf");

n = Number(pi);
n.Style = [n.Style {NumberFormat("%0.4f")}];
append(rpt,n);
  
close(rpt);
rptview(rpt);

バージョン履歴

R2021a で導入