Links#

AbstractLink #

Abstract class to implement links.

RouteLink(route: RouteInterface, field: str)

Establish a link to the route and the widget or layout item.

Construct for DashboardRouteLink class.

WebComponentLink(path: str | list[str])

WebComponentLink is a link to a web component.

Constructor for WebComponentLink Class.

Parameters:

Name	Type	Description	Default
`path`	`str \| list[str]`	path to the web component data. Represents the path to the data injected by the web component, e.g. ['path', 'to', 'data'], where 'data' is the field to be used.	required

WidgetField(*, widget: AbstractSelectWidget, field: str)

Establish a link to a selectable widget.

Used in indirect dependencies and text fields that are linked to a other widgets.

Construct link to a selectable widget.

Parameters:

Name	Type	Description	Default
`widget`	`SelectableWidget`	selectable widget to establish link	required
`field`	`str`	field from selectable widget	required

GenericLink = WidgetField | RouteLink