String クラスの apply_max_num_of_decimal_places インターフェイス¶

インターフェイス概要¶

apply_max_num_of_decimal_placesメソッドは文字列に対して浮動小数点数の最大桁数の条件を反映します。

例えば、もし文字列が123.45678で小数点数の最大桁数が3だった場合、このインターフェイスは123.456の文字列を返却します。

もしも文字列が浮動小数点数のフォーマットではない場合、このインターフェイスは元の文字列をそのまま返却します。

基本的な使い方¶

apply_max_num_of_decimal_placesはmax_num_of_decimal_places（浮動小数点数の最大桁数、intもしくはInt型）引数の指定を必要とします。

また、このインターフェイスはString型の新しいインスタンスを返却します。

import apysc as ap

ap.Stage(
    stage_width=0,
    stage_height=0,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)

string = ap.String("123.456")
string = string.apply_max_num_of_decimal_places(max_num_of_decimal_places=1)
ap.assert_equal(string, "123.4")

# If a string is not a `float` value, this interface returns
# the original string.
string = ap.String("abc")
string = string.apply_max_num_of_decimal_places(max_num_of_decimal_places=1)
ap.assert_equal(string, "abc")

ap.save_overall_html(
    dest_dir_path="string_apply_max_num_of_decimal_places_basic_usage_1/"
)

apply_max_num_of_decimal_places API¶

特記事項: このAPIドキュメントはドキュメントビルド用のスクリプトによって自動で生成・同期されています。そのためもしかしたらこの節の内容は前節までの内容と重複している場合があります。

[インターフェイスの構造] apply_max_num_of_decimal_places(self, *, max_num_of_decimal_places: Union[int, ForwardRef('Int')], variable_name_suffix: str = '') -> 'String'

[インターフェイス概要]

この文字列に浮動小数点数の最大桁数の設定を反映します。

[引数]

• max_num_of_decimal_places: Union[int, Int]

  • 浮動小数点数の最大桁数。

• variable_name_suffix: str, optional

  • JavaScript上の変数のサフィックスの設定です。この設定はJavaScriptのデバッグ時に役立つことがあります。

[返却値]

• string: String

  • 反映後の文字列。

[コードサンプル]

>>> import apysc as ap
>>> _ = ap.Stage()
>>> string = ap.String("123.456")
>>> string = string.apply_max_num_of_decimal_places(max_num_of_decimal_places=1)
>>> ap.assert_equal(string, "123.4")