append_js_expression interface

This page explains the append_js_expression function interface.

What interface is this?

The append_js_expression function interface appends any JavaScript to the exported HTML at any position. This interface may be helpful if you need to use the apysc not supported interfaces or irregular JavaScript implementation, like the Django template tags or parameters (e.g., {% if ... %}).

Basic usage

The append_js_expression function requires JavaScript string at the argument.

The following example appends the console.log JavaScript calling at the rectangle click handler:

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

If you click the following rectangle, the handler displays the The rectangle is clicked! message on the browser console (please press the F12 key).

append_js_expression 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] append_js_expression(expression: str) -> None

[Interface summary]

Append js expression.

[Parameters]

  • expression: str

    • JavaScript Expression string.

[Examples]

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