GlideCurrencyFormatter - スコープ付き

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：7分

    • GlideCurrencyFormatter API は、FX 通貨文字列に形式を設定するメソッドを提供します。

    GlideCurrencyFormatter オブジェクトをインスタンス化するときに、このオブジェクトの出力結果の形式を定義します。いったん設定すると、そのオブジェクトの GlideCurrencyFormatter.format() メソッドを呼び出すたびに同じ形式が使用されます。FX 通貨に形式を設定するために呼び出す必要があるメソッドは、GlideCurrencyFormatter() と format() の 2 つだけです。

    GlideCurrencyFormatter() API は、以下を可能にするオプションのメソッドも提供します。
    • setLocale() を使用して通貨のロケールを設定します。ロケールを設定すると、通貨金額の小数部を表すために小数点または小数点を表すカンマを使用するかどうかなど、そのロケールに固有の形式設定がフォーマッターで考慮されます。デフォルト：システムロケール
    • setMinFractionDigits() を使用して、表示する小数部の最小桁数を設定します。表示に含める小数点/小数点を表すカンマ以下の最小桁数を定義します。デフォルトでは、渡されたすべての桁が表示されます。渡された金額の桁数が指定された最小桁数よりも少ない場合、結果は「0」でパディングされます。
    • setMaxFractionDigits() を使用して、表示する最大桁数を設定します。表示に含める小数点/小数点を表すカンマ以下の最大桁数を定義します。デフォルトでは、渡されたすべての桁が表示されます。渡された桁数が指定された最大桁数よりも多い場合、小数部の最大桁数に丸めるプロセスの中で、最大桁数を超える桁が切り捨てられます。丸めが実行されて、右端の桁が得られます。例えば、小数部の最大桁数が 2 に設定されていて、渡された通貨値が 123.456 の場合、形式が設定された値は 123.46 です。通貨値が 23.122 の場合、形式が設定された値は 23.12 です。最大値が最小値未満に設定されている場合は、最小値が使用されます。

    このクラスは sn_currency 名前空間で実行されます。

    GlideCurrencyFormatter - GlideCurrencyFormatter(文字列 formatString)

    GlideCurrencyFormatter オブジェクトをインスタンス化し、FX 通貨の形式設定に使用する形式設定文字列を定義します。

    このメソッドは、実際の文字列の形式設定は実行しません。通貨に形式を設定するには、GlideCurrencyFormatter.format() メソッドを呼び出す必要があります。

    表 : 1. パラメーター
    名前 タイプ 説明
    formatString 文字列 オプション。フォーマッターに渡された通貨の形式設定に使用する形式設定文字列です。

    有効な値：

    • %s：format() 呼び出しで指定された国コードに関連付けられた通貨記号に置き換えられます。
    • %v：通貨金額 (123.45 など) に置き換えられます。
    • %c：format() 呼び出しで指定された ISO 通貨コード (USD や EUR など) に置き換えられます。
    • %l：渡された値に置き換えられます。形式設定は行われません。
    • %p：パーセント記号 (%) に置き換えられます。

    例えば、形式設定文字列が '%s%v%c' で、形式を設定する値が 123.45 米ドルの場合、返される形式設定された文字列は $123.45 USD です。形式設定文字列が '%s%l%c' で、形式を設定する値文字列が '56M' の場合、返される形式設定された文字列は €56M EUR です。

    注:
    このオブジェクトに対して format() メソッドが呼び出されるたびに、同じ形式設定文字列が使用されます。

    この例では、メソッドを呼び出す方法を示します。

    var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);

    GlideCurrencyFormatter - format(文字列値, 文字列 currencyCode)

    指定された通貨コードを使用して、指定された通貨値に形式を設定します。

    生成される通貨形式は、GlideCurrencyFormatter オブジェクトが最初にインスタンス化されたときに渡された値に依存します。

    表 : 2. パラメーター
    名前 タイプ 説明
    value 文字列 形式を設定する通貨金額です。金額には、端数を表す小数点のみを含めることができます。カンマはサポートされていません。

    有効な値：123.45、2436.23

    無効な値：123,45、2,134.56
    currencyCode 文字列 通貨の形式設定に使用する 3 文字の ISO 通貨コードです。
    表 : 3. 返される内容
    タイプ 説明
    文字列 形式が設定された通貨値です。

    この例では、メソッドを呼び出す方法を示します。

    var amount = '123456.123456789';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

    出力:

    Formatted currency: $123,456.12USD

    GlideCurrencyFormatter - setLocale(文字列 language, 文字列 country)

    通貨フォーマッターのデフォルトの言語と国 (ロケールを構成する) を設定します。

    GlideCurrencyFormatter.format() メソッドを呼び出す前にこのメソッドを呼び出さなければ、ロケールはデフォルトで現在のセッションロケールになります。

    表 : 4. パラメーター
    名前 タイプ 説明
    言語 文字列 2 文字の ISO 639 言語コードです (en、sp、fr など)。
    country 文字列 2 文字の ISO 3166 国コードです (US、ES、FR など)。
    表 : 5. 返される内容
    タイプ 説明
    なし

    この例は、通貨フォーマッターをフランスに設定しています。

    var amount = '123456.123456789';
var currencyCode = 'EUR';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
exchangeValue.setLocale("fr", "FR"); // Language = fr Country = FR
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

    出力：

    Formatted currency: €123 456,12EUR

    GlideCurrencyFormatter - setMaxFractionDigits(数値 maxFractionDigits)

    返される小数点/小数点を表すカンマ以下の最大桁数を設定します。

    表 : 6. パラメーター
    名前 タイプ 説明
    maxFractionDigits 番号 返される小数部の最大桁数です。この値が minFractionDigits 値未満に設定されている場合は、minFractionDigits によって上書きされます。
    表 : 7. 返される内容
    タイプ 説明
    なし

    この例では、メソッドを呼び出す方法を示します。

    var amount = '123456.123456789';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMaxFractionDigits(2).format(amount, currencyCode));

    出力:

    Formatted currency: $123,456.12USD

    GlideCurrencyFormatter - setMinFractionDigits(数値 minFractionDigits)

    返される小数部の最小桁数 (小数点/小数点を表すカンマ以下の桁数) を設定します。

    表 : 8. パラメーター
    名前 タイプ 説明
    minFractionDigits 番号 返される小数部の最小桁数です。
    表 : 9. 返される内容
    タイプ 説明
    なし 
    var amount = '123456.12';
var currencyCode = 'USD';
var formatString = '%s%v%c';
var exchangeValue = new sn_currency.GlideCurrencyFormatter(formatString);
gs.info('Formatted currency: ' + exchangeValue.setMinFractionDigits(3).format(amount, currencyCode));

    出力:

    Formatted currency: $123,456.120USD