Template

ipyvizzu.template

A module for storing the JavaScript templates.

ipyvizzu.template.ChartProperty

Bases: Enum

An enum class for storing chart properties.

Source code in ipyvizzu/template.py

class ChartProperty(Enum):
    """An enum class for storing chart properties."""
 
    CONFIG = "config"
    """An enum key-value for storing config chart property."""
 
    STYLE = "style"
    """An enum key-value for storing style chart property."""

CONFIG = 'config' class-attribute

An enum key-value for storing config chart property.

STYLE = 'style' class-attribute

An enum key-value for storing style chart property.

ipyvizzu.template.DisplayTarget

Bases: Enum

An enum class for storing chart display options.

Source code in ipyvizzu/template.py

class DisplayTarget(Enum):
    """An enum class for storing chart display options."""
 
    BEGIN = "begin"
    """Display all animation steps after the constructor's cell."""
 
    END = "end"
    """Display all animation steps after the last running cell."""
 
    ACTUAL = "actual"
    """Display the actual animation step after the currently running cell."""
 
    MANUAL = "manual"
    """Display all animation steps after calling a show method."""

BEGIN = 'begin' class-attribute

Display all animation steps after the constructor's cell.

END = 'end' class-attribute

Display all animation steps after the last running cell.

ACTUAL = 'actual' class-attribute

Display the actual animation step after the currently running cell.

MANUAL = 'manual' class-attribute

Display all animation steps after calling a show method.

ipyvizzu.template.DisplayTemplate

A class for storing JavaScript snippet templates.

Source code in ipyvizzu/template.py

class DisplayTemplate:
    """A class for storing JavaScript snippet templates."""
 
    # pylint: disable=too-few-public-methods
 
    IPYVIZZUJS: str = "{ipyvizzujs}"
    """ipyvizzu JavaScript class."""
 
    INIT: str = (
        "window.ipyvizzu.createChart(element, "
        + "'{chart_id}', '{vizzu}', '{div_width}', '{div_height}');"
    )
    """Call createChart JavaScript method."""
 
    ANIMATE: str = (
        "window.ipyvizzu.animate(element, "
        + "'{chart_id}', '{display_target}', {scroll}, "
        + "lib => {{ return {chart_target} }}, {chart_anim_opts});"
    )
    """Call animate JavaScript method."""
 
    FEATURE: str = (
        "window.ipyvizzu.feature(element, '{chart_id}', '{name}', {enabled});"
    )
    """Call feature JavaScript method."""
 
    STORE: str = "window.ipyvizzu.store(element, '{chart_id}', '{id}');"
    """Call store JavaScript method."""
 
    SET_EVENT: str = (
        "window.ipyvizzu.setEvent(element, "
        + "'{chart_id}', '{id}', '{event}', event => {{ {handler} }});"
    )
    """Call setEvent JavaScript method."""
 
    CLEAR_EVENT: str = (
        "window.ipyvizzu.clearEvent(element, '{chart_id}', '{id}', '{event}');"
    )
    """Call clearEvent JavaScript method."""
 
    LOG: str = "window.ipyvizzu.log(element, '{chart_id}', '{chart_property}');"
    """Call log JavaScript method."""
 
    CLEAR_INHIBITSCROLL: str = (
        "if (window.IpyVizzu) { window.IpyVizzu.clearInhibitScroll(element); }"
    )
    """Call clearInhibitScroll JavaScript method if ipyvizzu JavaScript class exists."""

IPYVIZZUJS: str = '{ipyvizzujs}' class-attribute

ipyvizzu JavaScript class.

INIT: str = 'window.ipyvizzu.createChart(element, ' + "'{chart_id}', '{vizzu}', '{div_width}', '{div_height}');" class-attribute

Call createChart JavaScript method.

ANIMATE: str = 'window.ipyvizzu.animate(element, ' + "'{chart_id}', '{display_target}', {scroll}, " + 'lib => {{ return {chart_target} }}, {chart_anim_opts});' class-attribute

Call animate JavaScript method.

FEATURE: str = "window.ipyvizzu.feature(element, '{chart_id}', '{name}', {enabled});" class-attribute

Call feature JavaScript method.

STORE: str = "window.ipyvizzu.store(element, '{chart_id}', '{id}');" class-attribute

Call store JavaScript method.

SET_EVENT: str = 'window.ipyvizzu.setEvent(element, ' + "'{chart_id}', '{id}', '{event}', event => {{ {handler} }});" class-attribute

Call setEvent JavaScript method.

CLEAR_EVENT: str = "window.ipyvizzu.clearEvent(element, '{chart_id}', '{id}', '{event}');" class-attribute

Call clearEvent JavaScript method.

LOG: str = "window.ipyvizzu.log(element, '{chart_id}', '{chart_property}');" class-attribute

Call log JavaScript method.

CLEAR_INHIBITSCROLL: str = 'if (window.IpyVizzu) { window.IpyVizzu.clearInhibitScroll(element); }' class-attribute

Call clearInhibitScroll JavaScript method if ipyvizzu JavaScript class exists.