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

DisplayObject クラスの get_css と set_css メソッドのインターフェイス¶

このページではDisplayObjectクラスのget_cssとset_cssの各インターフェイスについて説明します。

各インターフェイスの概要¶

get_cssメソッドはDisplayObjectのインスタンスに設定されている特定のCSSの文字列を返却し、set_cssメソッドは特定のCSSの値を設定します。

基本的な使い方¶

各インターフェイスはCSS名としてのname引数の指定を必要とします。加えて、set_cssメソッドではCSSの値の文字列としてのvalue引数が必要になります。

以下のコード例では1秒ごとのタイマーでCSSのdisplayの値がもしデフォルトの空文字になっていればnoneの値を設定しています。デフォルト値以外の値になっていればデフォルトの値へと戻しています。

from typing_extensions import TypedDict

import apysc as ap


class _SpriteOptions(TypedDict):
    sprite: ap.Sprite


def on_timer(e: ap.TimerEvent, options: _SpriteOptions) -> None:
    """
    The handler that the timer calls.

    Parameters
    ----------
    e : ap.TimerEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    sprite: ap.Sprite = options["sprite"]
    display_css_val: ap.String = sprite.get_css(name="display")
    condition: ap.Boolean = display_css_val == "none"
    with ap.If(condition):
        sprite.set_css(name="display", value="")
    with ap.Else():
        sprite.set_css(name="display", value="none")


ap.Stage(
    stage_width=150,
    stage_height=150,
    background_color=ap.Color("#333"),
    stage_elem_id="stage",
)
sprite: ap.Sprite = ap.Sprite()
sprite.graphics.begin_fill(color=ap.Color("#0af"))
sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)
options: _SpriteOptions = {"sprite": sprite}
timer: ap.Timer = ap.Timer(handler=on_timer, delay=1000, options=options)
timer.start()

ap.save_overall_html(dest_dir_path="display_object_get_and_set_css_basic_usage/")

get_css API¶

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

[インターフェイスの構造] get_css(self, *, name: Union[str, apysc._type.string.String]) -> apysc._type.string.String

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

CSSの設定値の文字列を取得します。

[引数]

name: str or String
- CSS名（例 : ‘display’）。

[返却値]

css: ap.String
- CSSの値。

[コードサンプル]

>>> import apysc as ap
>>> stage: ap.Stage = ap.Stage()
>>> sprite: ap.Sprite = ap.Sprite()
>>> sprite.graphics.begin_fill(color=ap.Color("#0af"), alpha=0.5)
>>> sprite.set_css(name="display", value="none")
>>> sprite.get_css(name="display")
String("none")

set_css API¶

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

[インターフェイスの構造] set_css(self, *, name: Union[str, apysc._type.string.String], value: Union[str, apysc._type.string.String]) -> None

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

CSSに指定された文字列の値を設定します。