※この翻訳ドキュメントはスクリプトによって出力・同期されています。内容が怪しそうな場合はGitHubにissueを追加したり英語の原文の確認をお願いします。

to_string インターフェイス

このページではto_stringメソッドのインターフェイスについて説明します。

インターフェイス概要

to_stringメソッドはそのインスタンス自体のString型での表現の値を返却します。

このインターフェイスはIntやNumber、BooleanやArrayなどの基本的な各データクラスに存在します。

基本的な使い方

to_stringメソッドは引数の指定を必要としません。

返却値はJavaScriptに準じた値となります。

たとえば、Booleanの値であればTrueやFalseなどの値ではなくtrueやfalseといった文字列の値になります。

import apysc as ap

stage: ap.Stage = ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=0,
    stage_height=0,
    stage_elem_id="stage",
)
int_value: ap.Int = ap.Int(100)
string: ap.String = int_value.to_string()
ap.assert_equal(string, "100")

number_value: ap.Number = ap.Number(10.5)
string = number_value.to_string()
ap.assert_equal(string, "10.5")

bool_value: ap.Boolean = ap.Boolean(True)
string = bool_value.to_string()
ap.assert_equal(string, "true")

array_value: ap.Array = ap.Array([10, 20, 30])
string = array_value.to_string()
ap.assert_equal(string, "10,20,30")

ap.save_overall_html(dest_dir_path="to_string_basic_usage_1/")

このメソッドはその文字列を使ってテキスト関係のインターフェイスを使う際に便利なことがあります。

import apysc as ap

stage: ap.Stage = ap.Stage(
    background_color=ap.Color("#333"),
    stage_width=300,
    stage_height=50,
    stage_elem_id="stage",
)
width: ap.Int = ap.Int(50)
text: ap.SvgText = ap.SvgText(
    text=ap.String("width is: ") + width.to_string(),
    fill_color=ap.Color("#aaa"),
    x=20,
    y=30,
)
ap.save_overall_html(dest_dir_path="to_string_basic_usage_2/")

to_string メソッドのAPI

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

[インターフェイスの構造] to_string(self) -> apysc._type.string.String

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

このインスタンスを文字列へと変換します。

[返却値]

  • string: String

    • 変換された文字列。

[コードサンプル]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage(
...     background_color=ap.Color("#333"), stage_width=200, stage_height=200
... )
>>> int_value: ap.Int = ap.Int(value=100)
>>> string: ap.String = int_value.to_string()
>>> ap.assert_equal(string, "100")