reno.explorer.ClickablePane

class reno.explorer.ClickablePane(*, child, click_enabled, drag_scroll_enabled, loading, align, aspect_ratio, css_classes, design, height, height_policy, margin, max_height, max_width, min_height, min_width, sizing_mode, styles, stylesheets, tags, visible, width, width_policy, name)

Bases: JSComponent

Wrap any panel component with a click event handler, and optionally a drag to pan handler (important for zoomed SFD diagrams.)

Methods

__init__(**params)
clone(**params)	Makes a copy of the object sharing the same parameters.
controls([parameters, jslink])	Creates a set of widgets which allow manipulating the parameters on this instance.
embed([max_states, max_opts, json, ...])	Renders a static version of a panel in a notebook by evaluating the set of states defined by the widgets in the model.
fire_on_click()	Trigger the callbacks for the click event.
get_root([doc, comm, preprocess])	Returns the root model and applies pre-processing hooks
jscallback([args])	Allows defining a JS callback to be triggered when a property changes on the source object.
jslink(target[, code, args, bidirectional])	Links properties on the this Reactive object to those on the target Reactive object in JS code.
link(target[, callbacks, bidirectional])	Links the parameters on this Reactive object to attributes on the target Parameterized object.
on_click(callback)	Register a function to execute whenever a click on the wrapper is detected.
on_event(event, callback)	Registers a callback to be executed when the specified DOM event is triggered.
on_msg(callback)	Registers a callback to be executed when a message event containing arbitrary data is received.
reset_pan()	Reset component panning to top left of 0, 0.
save(filename[, title, resources, template, ...])	Saves Panel objects to file.
select([selector])	Iterates over the Viewable and any potential children in the applying the Selector.
servable([title, location, area, target])	Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.
server_doc([doc, title, location])	Returns a serveable bokeh Document with the panel attached
show([title, port, address, ...])	Starts a Bokeh server and displays the Viewable in a new tab.

Attributes

align
aspect_ratio
child	The panel component being wrapped.
click_enabled	Whether to listen for clicks on the wrapper or not, disable if click handling is temporarily needed in the child component.
css_classes
design
drag_scroll_enabled	Whether to enable scrolling the wrapped component by clicking and dragging.
height
height_policy
loading
margin
max_height
max_width
min_height
min_width
name
param
sizing_mode
styles
stylesheets
tags
visible
width
width_policy

__module__ = 'reno.explorer'

__original_doc__ = 'Wrap any panel component with a click event handler, and\n    optionally a drag to pan handler (important for zoomed SFD diagrams.)'

child = None

The panel component being wrapped. Note that since this outer component is handling clicks, strange things can occur if the sub component is also meant to take clicks. (Disable click_enabled if it’s predictable when the sub component should handle instead.)

click_enabled = True

Whether to listen for clicks on the wrapper or not, disable if click handling is temporarily needed in the child component.

drag_scroll_enabled = False

Whether to enable scrolling the wrapped component by clicking and dragging.

fire_on_click()

Trigger the callbacks for the click event.

name = 'ClickablePane'

on_click(callback)

Register a function to execute whenever a click on the wrapper is detected.

reset_pan()

Reset component panning to top left of 0, 0.