Skip to content

pixano.app.display

display_cli(url, port)

Display a Pixano app inside a command line interface.

Parameters:

Name Type Description Default
url str

Pixano app URL.

 required
port int

Pixano app port.

 required
Source code in pixano/app/display.py 
 95
 96
 97
 98
 99
100
101
102
def display_cli(url: str, port: int):
    """Display a Pixano app inside a command line interface.

    Args:
        url: Pixano app URL.
        port: Pixano app port.
    """
    print(f"Please visit {url}:{port} in a web browser.")

display_colab(url, port, height)

Display a Pixano app inside a Google Colab.

Parameters:

Name Type Description Default
url str

Pixano app URL.

 required
port int

Pixano app port.

 required
height int

Frame height.

 required
Source code in pixano/app/display.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def display_colab(url: str, port: int, height: int):
    """Display a Pixano app inside a Google Colab.

    Args:
        url: Pixano app URL.
        port: Pixano app port.
        height: Frame height.
    """
    # Define frame template
    shell = """
        (() => {
            const url = new URL(%URL%);
            const port = %PORT%;
            if (port) {
                url.port = port;
            }
            const iframe = document.createElement('iframe');
            iframe.src = url;
            iframe.setAttribute('width', '100%');
            iframe.setAttribute('height', '%HEIGHT%');
            iframe.setAttribute('frameborder', 0);
            document.body.appendChild(iframe);
        })();
    """

    # Replace variables in template
    replacements = [
        ("%HEIGHT%", f"{height}"),
        ("%PORT%", f"{port}"),
        ("%URL%", json.dumps(url)),
    ]
    for k, v in replacements:
        shell = shell.replace(k, v)

    # Display frame
    script = IPython.display.Javascript(shell)
    IPython.display.display(script)

display_ipython(url, port, height)

Display a Pixano app inside a Jupyter notebook.

Parameters:

Name Type Description Default
url str

Pixano app URL.

 required
port int

Pixano app port.

 required
height int

Frame height.

 required
Source code in pixano/app/display.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def display_ipython(url: str, port: int, height: int):
    """Display a Pixano app inside a Jupyter notebook.

    Args:
        url: Pixano app URL.
        port: Pixano app port.
        height: Frame height.
    """
    # Define frame template
    shell = """
        <iframe id="%HTML_ID%" width="100%" height="%HEIGHT%" frameborder="0">
        </iframe>
        <script>
            (function() {
                const frame = document.getElementById(%JSON_ID%);
                const url = new URL(%URL%, window.location);
                const port = %PORT%;
                if (port) {
                    url.port = port;
                }
                frame.src = url;
            })();
        </script>
    """

    # Replace variables in template
    frame_id = f"frame-{shortuuid.uuid()}"
    replacements = [
        ("%HTML_ID%", html.escape(frame_id, quote=True)),
        ("%JSON_ID%", json.dumps(frame_id)),
        ("%HEIGHT%", f"{height}"),
        ("%PORT%", f"{port}"),
        ("%URL%", json.dumps(url)),
    ]
    for k, v in replacements:
        shell = shell.replace(k, v)

    # Display frame
    iframe = IPython.display.HTML(shell)
    IPython.display.display(iframe)