Skip to content

GC.events() ​

Make the chart report clicks, selections, drags and zooms to Shiny.

The payload of each event is described at https://nvelden.github.io/geneviewer-docs/api#events.

Usage ​

python
chart.events(
    click,
    highlight,
    rendered,
    render_id,
    dblclick,
    select,
    legend_click,
    drag,
    zoom,
)

An argument shown without a default is optional too: left out, the chart keeps its default.

chart is a GC chart.

Arguments ​

ArgumentTypeDescription
clickboolReport clicks as the input <id>_click. Default True.
highlightboolOutline the part under the mouse. Default False.
renderedboolReport each drawn update as <id>_rendered. Default False.
render_idstr or float, optionalIdentifier of the update; a new one marks a new load.
dblclickboolReport double-clicks as <id>_dblclick. Default False.
selectboolSelect genes and labels: <id>_select and <id>_selection. Default False.
legend_clickboolWhether clicking a legend entry hides its genes. Default True.
dragboolMove labels, titles, scales and legend parts: <id>_drag and <id>_moves. Default False.
zoomboolReport the window of the zoom slider as <id>_zoom. Default False.

Value ​

GC: The chart.