to_string interface

This page explains the to_string method interface.

What interface is this?

The to_string method returns a String representation of itself.

This interface exists on each basic data class, such as the Int, Number, Boolean, or Array.

Basic usage

The to_string method requires no arguments.

A result value becomes a JavaScript-based value.

For instance, a Boolean value becomes true or false, not True or 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/")

Sometimes this method becomes useful when using text-related interfaces with its string.

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 method API

Note: the document build script generates and updates this API document section automatically. Maybe this section is duplicated compared with previous sections.

[Interface signature] to_string(self) -> apysc._type.string.String

[Interface summary]

Convert this instance to a string.

[Returns]

  • string: String

    • A converted string.

[Examples]

>>> 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")