Tool Widgets

Tools

class ipyelk.tools.Tool(**kwargs: Any)

handler(*args)

Handler callback for running the tool

on_run(callback, remove=False)

Register a callback to execute when the button is clicked. The callback will be called with one argument, the clicked button widget instance.

Parameters

remove: bool (optional)

Set to true to remove the callback from the list of callbacks.

class ipyelk.tools.ToolButton(**kwargs: Any)

Generic Tool that provides a simple button UI

Parameters:

handler – Called when button is pressed.

Tool View Widgets

class ipyelk.tools.Toolbar(**kwargs: Any)

Toolbar for an Elk App

class ipyelk.tools.ControlOverlay(**kwargs: Any)

Simple Container Widget for rendering element specific jupyterlab widgets