openflexure_microscope_server.ui.ActionButton

class documentation

class ActionButton(BaseModel): (source)

View In Hierarchy

The data required for creating an actionButton in Vue.

Currently this cannot be used to submitData, or to submitOnEvent.

Class Variable action The name of the action to be triggered.
Class Variable button_primary Specify whether the button is styled as a primary button.
Class Variable can_terminate Specify whether the action can be terminated.
Class Variable confirmation_message The message for the confirmation modal.
Class Variable disabled Specify whether the button is disabled.
Class Variable element_type Undocumented
Class Variable modal_progress Specify whether to show a progress modal.
Class Variable notify_on_success Specify whether to a notification on successful completion.
Class Variable poll_interval The interval for polling in seconds.
Class Variable requires_confirmation Specify whether a confirmation modal is needed.
Class Variable response_is_success_message Set True to use the action response as the success message.
Class Variable stream_with_modal Specify whether to show a mini stream preview in the progress modal.
Class Variable submit_label The label for the action button.
Class Variable success_message The message to show on successful completion.
Class Variable thing The Thing "path" for the Thing instance.
Class Variable update_interface_on_response If True the action button emits a requestUpdate signal when completed.
action: str = (source)

The name of the action to be triggered.

button_primary: bool = (source)

Specify whether the button is styled as a primary button.

can_terminate: bool = (source)

Specify whether the action can be terminated.

confirmation_message: str = (source)

The message for the confirmation modal.

disabled: bool = (source)

Specify whether the button is disabled.

element_type: Literal['action_button'] = (source)

Undocumented

modal_progress: bool = (source)

Specify whether to show a progress modal.

notify_on_success: bool = (source)

Specify whether to a notification on successful completion.

poll_interval: float = (source)

The interval for polling in seconds.

requires_confirmation: bool = (source)

Specify whether a confirmation modal is needed.

response_is_success_message: bool = (source)

Set True to use the action response as the success message.

If success_message is set, this is never used.

stream_with_modal: bool = (source)

Specify whether to show a mini stream preview in the progress modal.

This option only has an effect if modal_progress is True. If modal_progress is False, no modal (and therefore no stream preview) is shown.

submit_label: str = (source)

The label for the action button.

success_message: str = (source)

The message to show on successful completion.

thing: str = (source)

The Thing "path" for the Thing instance.

update_interface_on_response: bool = (source)

If True the action button emits a requestUpdate signal when completed.

Downstream components can subscribe to this and request an update.