netlist_carpentry.vis.dynamic.widgets ¶

Handles the behavior of additional widges, e.g. the InfoBox.

Classes:

InfoBox –

The InfoBox widget containing additional data about the selected node.

InfoBox ¶

Bases: BaseModel

The InfoBox widget containing additional data about the selected node.

Methods:

change_object –

Changes the currently selected object to the new (given) object, whose data will then be shown.
get_display_data –

Returns the data to display in the info box based on the currently selected node.
widget –

Returns the HTML widget representing this info box.

Attributes:

style (FormatDefinition) –

The style (FormatDefinition) of this info box.

style: FormatDefinition

The style (FormatDefinition) of this info box.

change_object(new_obj: Union[Instance, Port[Module], None]) -> None

Changes the currently selected object to the new (given) object, whose data will then be shown.

If None is passed, the previously selected object will just be removed and the idle/inactive text will be shown instead.

Parameters:

new_obj ¶
(Union[Instance, Port[Module], None]) –

The new object (module port or instance), whose date will then be shown. If None, the previously selected object will just be removed and the idle/inactive text will be shown instead.

get_display_data() -> str

Returns the data to display in the info box based on the currently selected node.

widget() -> HTML

Returns the HTML widget representing this info box.

Can be displayed via display(InfoBox.widget())

Returns: