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

append_js_expression インターフェイス

このページではappend_js_expression関数のインターフェイスについて説明します。

インターフェイス概要

append_js_expression関数は出力先のHTMLの任意の場所にJavaScriptのコードを追加します。このインターフェイスはapyscがサポートしていない特殊な処理などを追加する際などに役に立つことがあります(Djangoなどのライブラリでテンプレートタグなどを独自の出力したい場合など)。

基本的な使い方

append_js_expression関数は引数にJavaScriptのコードの文字列が必要とします。

以下のコード例では四角をクリックした際のハンドラ内でconsole.logのJavaScriptの関数呼び出しのコードを追加しています。

import apysc as ap


def on_click(e: ap.MouseEvent[ap.Rectangle], options: dict) -> None:
    """
    The handler that the animation calls when its end.

    Parameters
    ----------
    e : ap.MouseEvent
        Event instance.
    options : dict
        Optional arguments dictionary.
    """
    ap.append_js_expression(expression='console.log("The rectangle is clicked!");')


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"))
rectangle: ap.Rectangle = sprite.graphics.draw_rect(x=50, y=50, width=50, height=50)
rectangle.click(on_click)

ap.save_overall_html(dest_dir_path="append_js_expression_basic_usage/")

四角をクリックするとThe rectangle is clicked!というメッセージがブラウザのコンソールに表示されます(F12キーを押して確認してください)。

append_js_expression API

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

[インターフェイスの構造] append_js_expression(expression: str) -> None


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

JavaScriptのコードの追加を行います。


[引数]

  • expression: str

    • 追加対象のJavaScriptのコードの文字列。


[コードサンプル]

>>> import apysc as ap
>>> ap.append_js_expression(expression='console.log("Hello!")')