Skip to content

job_selector class

Select jobs from the list of all job entities.

Methods

__init__()

__init__(
    value=None,
    show_id=True,
    show_submitted_label=True,
    show_submitted_id=False,
    show_submission_id=False,
    show_date=True,
    show_cancel=True,
    show_delete=True,
    on_change=None,
    height="50vh",
    on_details=None,
    id=None,
    class_name=None,
) -> None

Create a new job_selector element.

Parameters:

Name Type Description Default

value

Union[Job,list[Job]]
dynamic

Bound to the selected s, or None if there is none.

None

show_id

bool

If False, the Job id is not shown in the selector.

True

show_submitted_label

bool

If False, the Scenario or Sequence label is not shown in the selector.

True

show_submitted_id

bool

If True, the Scenario or Sequence id is shown in the selector.

False

show_submission_id

bool

If True, the submission id is shown in the selector.

False

show_date

bool

If False, the Job date is not shown in the selector.

True

show_cancel

bool

If False, the Cancel buttons are not shown in the selector.

True

show_delete

bool

If False, the Delete buttons are not shown in the selector.

True

on_change

Union[str, Callable]

A function or the name of a function that is triggered when the selection is updated.
The parameters of that function are all optional:

  • state (State): the state instance.
  • var_name (str): the variable name.
  • value (Job): the selected job.
None

height

str

The maximum height, in CSS units, of the control.

50vh

on_details

Union[str, Callable, bool]

The name of a function that is triggered when the details icon is pressed.
The parameters of that function are all optional:

  • state (State): the state instance.
  • id (str): the id of the control.
  • payload (dict): a dictionary that contains the Job Id in the value for key args.


If False, the icon is not shown.

None

id

str

The identifier that will be assigned to the rendered HTML component.

None

class_name

str
dynamic

The list of CSS class names associated with the generated HTML Element.
These class names will be added to the default taipy_gui_core-[element_type].

None