Module h2o_wave.types

Classes

Breadcrumb

class Breadcrumb(name: str, label: str)

Create a breadcrumb for a BreadcrumbsCard.

Static methods

load

def load(_Breadcrumb__d:¬†Dict) ‚ÄĎ>¬†Breadcrumb

Creates an instance of this class using the contents of a dict.

Instance variables

var label

The label to display.

var name

The name of this item. Prefix the name with a '#' to trigger hash-change navigation.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

BreadcrumbsCard

class BreadcrumbsCard(box: str, items: List[Breadcrumb], commands: Optional[List[Command]] = None)

Create a card containing breadcrumbs. Breadcrumbs should be used as a navigational aid in your app or site. They indicate the current page’s location within a hierarchy and help the user understand where they are in relation to the rest of that hierarchy. They also afford one-click access to higher levels of that hierarchy. Breadcrumbs are typically placed, in horizontal form, under the masthead or navigation of an experience, above the primary content area.

Static methods

load

def load(_BreadcrumbsCard__d:¬†Dict) ‚ÄĎ>¬†BreadcrumbsCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var items

A list of Breadcrumb instances to display. See breadcrumb()

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Button

class Button(name: str, label: Optional[str] = None, caption: Optional[str] = None, value: Optional[str] = None, primary: Optional[bool] = None, disabled: Optional[bool] = None, link: Optional[bool] = None, icon: Optional[str] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a button.

Buttons are best used to enable a user to commit a change or complete steps in a task. They are typically found inside forms, dialogs, panels or pages. An example of their usage is confirming the deletion of a file in a confirmation dialog.

When considering their place in a layout, contemplate the order in which a user will flow through the UI. As an example, in a form, the individual will need to read and interact with the form fields before submitting the form. Therefore, as a general rule, the button should be placed at the bottom of the UI container which holds the related UI elements.

Buttons may be placed within a "buttons" component which will lay out the buttons horizontally, or used individually and they will be stacked vertically.

While buttons can technically be used to navigate a user to another part of the experience, this is not recommended unless that navigation is part of an action or their flow.

Static methods

load

def load(_Button__d:¬†Dict) ‚ÄĎ>¬†Button

Creates an instance of this class using the contents of a dict.

Instance variables

var caption

The caption displayed below the label. Setting a caption renders a compound button.

var disabled

True if the button should be disabled.

var icon

An optional icon to display next to the button label (not applicable for links).

var label

The text displayed on the button.

True if the button should be rendered as link text and not a standard button.

var name

An identifying name for this component. If the name is prefixed with a '#', the button sets the location hash to the name when clicked.

var primary

True if the button should be rendered as the primary button in the set.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var value

A value for this button. If a value is set, it is used for the button's submitted instead of a boolean True.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Buttons

class Buttons(items: List[ForwardRef('Component')], justify: Optional[str] = None, name: Optional[str] = None, visible: Optional[bool] = None)

Create a set of buttons laid out horizontally.

Static methods

load

def load(_Buttons__d:¬†Dict) ‚ÄĎ>¬†Buttons

Creates an instance of this class using the contents of a dict.

Instance variables

var items

The button in this set.

var justify

Specifies how to lay out buttons horizontally. One of 'start', 'end', 'center', 'between', 'around'. See enum h2o_wave.ui.ButtonsJustify.

var name

An identifying name for this component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ButtonsJustify

class ButtonsJustify

Class variables

var AROUND
var BETWEEN
var CENTER
var END
var START

CanvasCard

class CanvasCard(box: str, title: str, width: int, height: int, data: Union[dict, str], commands: Optional[List[Command]] = None)

WARNING: Experimental and subject to change. Do not use in production sites!

Create a card that displays a drawing canvas (whiteboard).

Static methods

load

def load(_CanvasCard__d:¬†Dict) ‚ÄĎ>¬†CanvasCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

The data for this card.

var height

Canvas height, in pixels.

var title

The title for this card.

var width

Canvas width, in pixels.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ChatCard

class ChatCard(box: str, title: str, data: Union[dict, str], capacity: Optional[int] = None, commands: Optional[List[Command]] = None)

WARNING: Experimental and subject to change. Do not use in production sites!

Create a card that displays a chat room.

Static methods

load

def load(_ChatCard__d:¬†Dict) ‚ÄĎ>¬†ChatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var capacity

The maximum number of messages contained in this card. Defaults to 50 messages.

var commands

Contextual menu commands for this component.

var data

The data for this card.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Checkbox

class Checkbox(name: str, label: Optional[str] = None, value: Optional[bool] = None, indeterminate: Optional[bool] = None, disabled: Optional[bool] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a checkbox.

A checkbox allows users to switch between two mutually exclusive options (checked or unchecked, on or off) through a single click or tap. It can also be used to indicate a subordinate setting or preference when paired with another component.

A checkbox is used to select or deselect action items. It can be used for a single item or for a list of multiple items that a user can choose from. The component has two selection states: unselected and selected.

For a binary choice, the main difference between a checkbox and a toggle switch is that the checkbox is for status and the toggle switch is for action.

Use multiple checkboxes for multi-select scenarios in which a user chooses one or more items from a group of choices that are not mutually exclusive.

Static methods

load

def load(_Checkbox__d:¬†Dict) ‚ÄĎ>¬†Checkbox

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if the checkbox is disabled.

var indeterminate

True if the selection is indeterminate (neither selected nor unselected).

var label

Text to be displayed alongside the checkbox.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the checkbox value changes.

var value

True if selected, False if unselected.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Checklist

class Checklist(name: str, label: Optional[str] = None, values: Optional[List[str]] = None, choices: Optional[List[Choice]] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a set of checkboxes. Use this for multi-select scenarios in which a user chooses one or more items from a group of choices that are not mutually exclusive.

Static methods

load

def load(_Checklist__d:¬†Dict) ‚ÄĎ>¬†Checklist

Creates an instance of this class using the contents of a dict.

Instance variables

var choices

The choices to be presented.

var label

Text to be displayed above the component.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the checklist value changes.

var values

The names of the selected choices.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Choice

class Choice(name: str, label: Optional[str] = None, disabled: Optional[bool] = None)

Create a choice for a checklist, choice group or dropdown.

Static methods

load

def load(_Choice__d:¬†Dict) ‚ÄĎ>¬†Choice

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if the checkbox is disabled.

var label

Text to be displayed alongside the component.

var name

An identifying name for this component.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ChoiceGroup

class ChoiceGroup(name: str, label: Optional[str] = None, value: Optional[str] = None, choices: Optional[List[Choice]] = None, required: Optional[bool] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a choice group. The choice group component, also known as radio buttons, let users select one option from two or more choices. Each option is represented by one choice group button; a user can select only one choice group in a button group.

Choice groups emphasize all options equally, and that may draw more attention to the options than necessary. Consider using other components, unless the options deserve extra attention from the user. For example, if the default option is recommended for most users in most situations, use a dropdown instead.

If there are only two mutually exclusive options, combine them into a single Checkbox or Toggle switch. For example, use a checkbox for "I agree" instead of choice group buttons for "I agree" and "I don't agree."

Static methods

load

def load(_ChoiceGroup__d:¬†Dict) ‚ÄĎ>¬†ChoiceGroup

Creates an instance of this class using the contents of a dict.

Instance variables

var choices

The choices to be presented.

var label

Text to be displayed alongside the component.

var name

An identifying name for this component.

var required

True if this field is required.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the selection changes.

var value

The name of the selected choice.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ColorPicker

class ColorPicker(name: str, label: Optional[str] = None, value: Optional[str] = None, choices: Optional[List[str]] = None, visible: Optional[bool] = None, trigger: Optional[bool] = None, tooltip: Optional[str] = None)

Create a color picker.

A date picker allows a user to pick a color value. If the 'choices' parameter is set, a swatch picker is displayed instead of the standard color picker.

Static methods

load

def load(_ColorPicker__d:¬†Dict) ‚ÄĎ>¬†ColorPicker

Creates an instance of this class using the contents of a dict.

Instance variables

var choices

A list of colors (CSS-compatible strings) to limit color choices to.

var label

Text to be displayed alongside the component.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the color picker value changes.

var value

The selected color (CSS-compatible string).

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Combobox

class Combobox(name: str, label: Optional[str] = None, placeholder: Optional[str] = None, value: Optional[str] = None, choices: Optional[List[str]] = None, error: Optional[str] = None, disabled: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a combobox.

A combobox is a list in which the selected item is always visible, and the others are visible on demand by clicking a drop-down button or by typing in the input. They are used to simplify the design and make a choice within the UI.

When closed, only the selected item is visible. When users click the drop-down button, all the options become visible. To change the value, users open the list and click another value or use the arrow keys (up and down) to select a new value. When collapsed the user can select a new value by typing.

Static methods

load

def load(_Combobox__d:¬†Dict) ‚ÄĎ>¬†Combobox

Creates an instance of this class using the contents of a dict.

Instance variables

var choices

The choices to be presented.

var disabled

True if this field is disabled.

var error

Text to be displayed as an error below the text box.

var label

Text to be displayed alongside the component.

var name

An identifying name for this component.

var placeholder

A string that provides a brief hint to the user as to what kind of information is expected in the field.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var value

The name of the selected choice.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Command

class Command(name: str, label: Optional[str] = None, caption: Optional[str] = None, icon: Optional[str] = None, items: Optional[List[ForwardRef('Command')]] = None, value: Optional[str] = None, data: Optional[str] = None)

Create a command.

Commands are typically displayed as context menu items or toolbar button.

Static methods

load

def load(_Command__d:¬†Dict) ‚ÄĎ>¬†Command

Creates an instance of this class using the contents of a dict.

Instance variables

var caption

The caption for this command (typically a tooltip).

var data

DEPRECATED. Use value instead. Data associated with this command, if any.

var icon

The icon to be displayed for this command.

var items

Sub-commands, if any

var label

The text displayed for this command.

var name

An identifying name for this component. If the name is prefixed with a '#', the command sets the location hash to the name when executed.

var value

Data associated with this command, if any.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Component

class Component(text: Optional[Text] = None, text_xl: Optional[TextXl] = None, text_l: Optional[TextL] = None, text_m: Optional[TextM] = None, text_s: Optional[TextS] = None, text_xs: Optional[TextXs] = None, label: Optional[Label] = None, separator: Optional[Separator] = None, progress: Optional[Progress] = None, message_bar: Optional[MessageBar] = None, textbox: Optional[Textbox] = None, checkbox: Optional[Checkbox] = None, toggle: Optional[Toggle] = None, choice_group: Optional[ChoiceGroup] = None, checklist: Optional[Checklist] = None, dropdown: Optional[Dropdown] = None, combobox: Optional[Combobox] = None, slider: Optional[Slider] = None, spinbox: Optional[Spinbox] = None, date_picker: Optional[DatePicker] = None, color_picker: Optional[ColorPicker] = None, button: Optional[Button] = None, buttons: Optional[Buttons] = None, file_upload: Optional[FileUpload] = None, table: Optional[Table] = None, link: Optional[Link] = None, tabs: Optional[Tabs] = None, expander: Optional[Expander] = None, frame: Optional[Frame] = None, markup: Optional[Markup] = None, template: Optional[Template] = None, picker: Optional[Picker] = None, range_slider: Optional[RangeSlider] = None, stepper: Optional[Stepper] = None, visualization: Optional[Visualization] = None, vega_visualization: Optional[VegaVisualization] = None, stats: Optional[Stats] = None, inline: Optional[Inline] = None, image: Optional[Image] = None)

Create a component.

Static methods

load

def load(_Component__d:¬†Dict) ‚ÄĎ>¬†Component

Creates an instance of this class using the contents of a dict.

Instance variables

var button

Button.

var buttons

Button set.

var checkbox

Checkbox.

var checklist

Checklist.

var choice_group

Choice group.

var color_picker

Color picker.

var combobox

Combobox.

var date_picker

Date picker.

var dropdown

Dropdown.

var expander

Expander.

var file_upload

File upload.

var frame

Frame.

var image

Image

var inline

Inline components

var label

Label.

Link.

var markup

Markup

var message_bar

Message bar.

var picker

Picker.

var progress

Progress bar.

var range_slider

Range Slider.

var separator

Separator.

var slider

Slider.

var spinbox

Spinbox.

var stats

Stats

var stepper

Stepper.

var table

Table.

var tabs

Tabs.

var template

Template

var text

Text block.

var text_l

Large sized text block.

var text_m

Medium sized text block.

var text_s

Small sized text block.

var text_xl

Extra-large sized text block.

var text_xs

Extra-small sized text block.

var textbox

Textbox.

var toggle

Toggle.

var vega_visualization

Vega-lite Visualization.

var visualization

Visualization.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

DatePicker

class DatePicker(name: str, label: Optional[str] = None, placeholder: Optional[str] = None, value: Optional[str] = None, disabled: Optional[bool] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a date picker.

A date picker allows a user to pick a date value.

Static methods

load

def load(_DatePicker__d:¬†Dict) ‚ÄĎ>¬†DatePicker

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if this field is disabled.

var label

Text to be displayed alongside the component.

var name

An identifying name for this component.

var placeholder

A string that provides a brief hint to the user as to what kind of information is expected in the field.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the datepicker value changes.

var value

The date value in YYYY-MM-DD format.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Dialog

class Dialog(title: str, items: List[Component], width: Optional[str] = None, closable: Optional[bool] = None, blocking: Optional[bool] = None, primary: Optional[bool] = None, name: Optional[str] = None, events: Optional[List[str]] = None)

A dialog box (Dialog) is a temporary pop-up that takes focus from the page or app and requires people to interact with it. It’s primarily used for confirming actions, such as deleting a file, or asking people to make a choice.

Static methods

load

def load(_Dialog__d:¬†Dict) ‚ÄĎ>¬†Dialog

Creates an instance of this class using the contents of a dict.

Instance variables

var blocking

True to disable all actions and commands behind the dialog. Blocking dialogs should be used very sparingly, only when it is critical that the user makes a choice or provides information before they can proceed. Blocking dialogs are generally used for irreversible or potentially destructive tasks. Defaults to false.

var closable

True if the dialog should have a closing 'X' button at the top right corner.

var events

The events to capture on this dialog.

var items

The components displayed in this dialog.

var name

An identifying name for this component.

var primary

Dialog with large header banner, mutually exclusive with closable prop. Defaults to false.

var title

The dialog's title.

var width

The width of the dialog, e.g. '400px', defaults to '600px'.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Dropdown

class Dropdown(name: str, label: Optional[str] = None, placeholder: Optional[str] = None, value: Optional[str] = None, values: Optional[List[str]] = None, choices: Optional[List[Choice]] = None, required: Optional[bool] = None, disabled: Optional[bool] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a dropdown.

A dropdown is a list in which the selected item is always visible, and the others are visible on demand by clicking a drop-down button. They are used to simplify the design and make a choice within the UI. When closed, only the selected item is visible. When users click the drop-down button, all the options become visible.

To change the value, users open the list and click another value or use the arrow keys (up and down) to select a new value.

Note: Use either the 'value' parameter or the 'values' parameter. Setting the 'values' parameter renders a multi-select dropdown.

Static methods

load

def load(_Dropdown__d:¬†Dict) ‚ÄĎ>¬†Dropdown

Creates an instance of this class using the contents of a dict.

Instance variables

var choices

The choices to be presented.

var disabled

True if this field is disabled.

var label

Text to be displayed alongside the component.

var name

An identifying name for this component.

var placeholder

A string that provides a brief hint to the user as to what kind of information is expected in the field.

var required

True if this is a required field.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the dropdown value changes.

var value

The name of the selected choice.

var values

The names of the selected choices. If this parameter is set, multiple selections will be allowed.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

EditorCard

class EditorCard(box: str, mode: str, commands: Optional[List[Command]] = None)

WARNING: Experimental and subject to change. Do not use in production sites!

Create a card that enables WYSIWYG editing on a page. Adding this card to a page makes the page editable by end-users.

Static methods

load

def load(_EditorCard__d:¬†Dict) ‚ÄĎ>¬†EditorCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var mode

The editing mode. Defaults to public. One of 'public', 'private'. See enum h2o_wave.ui.EditorCardMode.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

EditorCardMode

class EditorCardMode

Class variables

var PRIVATE
var PUBLIC

Expander

class Expander(name: str, label: Optional[str] = None, expanded: Optional[bool] = None, items: Optional[List[ForwardRef('Component')]] = None, visible: Optional[bool] = None)

Creates a new expander.

Expanders can be used to show or hide a group of related components.

Static methods

load

def load(_Expander__d:¬†Dict) ‚ÄĎ>¬†Expander

Creates an instance of this class using the contents of a dict.

Instance variables

var expanded

True if expanded, False if collapsed.

var items

List of components to be hideable by the expander.

var label

The text displayed on the expander.

var name

An identifying name for this component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

FileUpload

class FileUpload(name: str, label: Optional[str] = None, multiple: Optional[bool] = None, file_extensions: Optional[List[str]] = None, max_file_size: Optional[float] = None, max_size: Optional[float] = None, height: Optional[str] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a file upload component. A file upload component allows a user to browse, select and upload one or more files.

Static methods

load

def load(_FileUpload__d:¬†Dict) ‚ÄĎ>¬†FileUpload

Creates an instance of this class using the contents of a dict.

Instance variables

var file_extensions

List of allowed file extensions, e.g. pdf, docx, etc.

var height

The height of the file upload, e.g. '400px', '50%', etc.

var label

Text to be displayed in the bottom button. Defaults to "Upload".

var max_file_size

Maximum allowed size (Mb) per file. Defaults to no limit.

var max_size

Maximum allowed size (Mb) for all files combined. Defaults to no limit.

var multiple

True if the component should allow multiple files to be uploaded.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

FlexCard

class FlexCard(box: str, item_view: str, item_props: Union[dict, str], data: Union[Data, str], direction: Optional[str] = None, justify: Optional[str] = None, align: Optional[str] = None, wrap: Optional[str] = None, commands: Optional[List[Command]] = None)

EXPERIMENTAL. DO NOT USE. Create a card containing other cards laid out using a one-dimensional model with flexible alignemnt and wrapping capabilities.

Static methods

load

def load(_FlexCard__d:¬†Dict) ‚ÄĎ>¬†FlexCard

Creates an instance of this class using the contents of a dict.

Instance variables

var align

Layout strategy for cross axis. One of 'start', 'end', 'center', 'baseline', 'stretch'. See enum h2o_wave.ui.FlexCardAlign.

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var direction

Layout direction. One of 'horizontal', 'vertical'. See enum h2o_wave.ui.FlexCardDirection.

var item_props

The child card properties.

var item_view

The child card type.

var justify

Layout strategy for main axis. One of 'start', 'end', 'center', 'between', 'around'. See enum h2o_wave.ui.FlexCardJustify.

var wrap

Wrapping strategy. One of 'start', 'end', 'center', 'between', 'around', 'stretch'. See enum h2o_wave.ui.FlexCardWrap.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

FlexCardAlign

class FlexCardAlign

Class variables

var BASELINE
var CENTER
var END
var START
var STRETCH

FlexCardDirection

class FlexCardDirection

Class variables

var HORIZONTAL
var VERTICAL

FlexCardJustify

class FlexCardJustify

Class variables

var AROUND
var BETWEEN
var CENTER
var END
var START

FlexCardWrap

class FlexCardWrap

Class variables

var AROUND
var BETWEEN
var CENTER
var END
var START
var STRETCH

FooterCard

class FooterCard(box: str, caption: str, commands: Optional[List[Command]] = None)

Render a page footer displaying a caption. Footer cards are typically displayed at the bottom of a page.

Static methods

load

def load(_FooterCard__d:¬†Dict) ‚ÄĎ>¬†FooterCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var caption

The caption. Supports markdown.

var commands

Contextual menu commands for this component.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

FormCard

class FormCard(box: str, items: Union[List[Component], str], title: Optional[str] = None, commands: Optional[List[Command]] = None)

Create a form.

Static methods

load

def load(_FormCard__d:¬†Dict) ‚ÄĎ>¬†FormCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var items

The components in this form.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Frame

class Frame(path: Optional[str] = None, content: Optional[str] = None, width: Optional[str] = None, height: Optional[str] = None, name: Optional[str] = None, visible: Optional[bool] = None)

Create a new inline frame (an iframe).

Static methods

load

def load(_Frame__d:¬†Dict) ‚ÄĎ>¬†Frame

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The HTML content of the page. A string containing <html>...</html>.

var height

The height of the frame, e.g. 200px, 50%, etc. Defaults to 150px.

var name

An identifying name for this component.

var path

The path or URL of the web page, e.g. /foo.html or http://example.com/foo.html

var visible

True if the component should be visible. Defaults to true.

var width

The width of the frame, e.g. 200px, 50%, etc. Defaults to 100%.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

FrameCard

class FrameCard(box: str, title: str, path: Optional[str] = None, content: Optional[str] = None, commands: Optional[List[Command]] = None)

Render a card containing a HTML page inside an inline frame (an iframe).

Either a path or content can be provided as arguments.

Static methods

load

def load(_FrameCard__d:¬†Dict) ‚ÄĎ>¬†FrameCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var content

The HTML content of the page. A string containing <html>...</html>.

var path

The path or URL of the web page, e.g. /foo.html or http://example.com/foo.html.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

GraphicsCard

class GraphicsCard(box: str, view_box: str, stage: Union[List[dict], str, NoneType] = None, scene: Union[Data, str, NoneType] = None, width: Optional[str] = None, height: Optional[str] = None, commands: Optional[List[Command]] = None)

Create a card for displaying vector graphics.

Static methods

load

def load(_GraphicsCard__d:¬†Dict) ‚ÄĎ>¬†GraphicsCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var height

The displayed height of the rectangular viewport. (Not the height of its coordinate system.)

var scene

Foreground layer for rendering dynamic SVG elements.

var stage

Background layer for rendering static SVG elements. Must be packed to conserve memory.

var view_box

The position and dimension of the SVG viewport, in user space. A space-separated list of four numbers: min-x, min-y, width and height. For example, '0 0 400 300'. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox

var width

The displayed width of the rectangular viewport. (Not the width of its coordinate system.)

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

GridCard

class GridCard(box: str, title: str, cells: Union[Data, str], data: Union[Data, str], commands: Optional[List[Command]] = None)

EXPERIMENTAL. DO NOT USE.

Static methods

load

def load(_GridCard__d:¬†Dict) ‚ÄĎ>¬†GridCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var cells

EXPERIMENTAL. DO NOT USE.

var commands

Contextual menu commands for this component.

var data

EXPERIMENTAL. DO NOT USE.

var title

EXPERIMENTAL. DO NOT USE.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

HeaderCard

class HeaderCard(box: str, title: str, subtitle: str, icon: Optional[str] = None, icon_color: Optional[str] = None, nav: Optional[List[NavGroup]] = None, commands: Optional[List[Command]] = None)

Render a page header displaying a title, subtitle and an optional navigation menu. Header cards are typically used for top-level navigation.

Static methods

load

def load(_HeaderCard__d:¬†Dict) ‚ÄĎ>¬†HeaderCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var icon

The icon, displayed to the left.

var icon_color

The icon's color.

var nav

The navigation menu to display when the header's icon is clicked.

var subtitle

The subtitle, displayed below the title.

var title

The title.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

IconTableCellType

class IconTableCellType(color: Optional[str] = None, name: Optional[str] = None)

Create a cell type that renders a column's cells as icons instead of plain text. If set on a column, the cell value is interpreted as the name of the icon to be displayed.

Static methods

load

def load(_IconTableCellType__d:¬†Dict) ‚ÄĎ>¬†IconTableCellType

Creates an instance of this class using the contents of a dict.

Instance variables

var color

Icon color.

var name

An identifying name for this component.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Image

class Image(title: str, type: Optional[str] = None, image: Optional[str] = None, path: Optional[str] = None)

Create an image.

Static methods

load

def load(_Image__d:¬†Dict) ‚ÄĎ>¬†Image

Creates an instance of this class using the contents of a dict.

Instance variables

var image

Image data, base64-encoded.

var path

The path or URL or data URL of the image, e.g. /foo.png or http://example.com/foo.png or data:image/png;base64,???.

var title

The image title, typically displayed as a tooltip.

var type

The image MIME subtype. One of apng, bmp, gif, x-icon, jpeg, png, webp. Required only if image is set.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ImageCard

class ImageCard(box: str, title: str, type: Optional[str] = None, image: Optional[str] = None, data: Union[dict, str, NoneType] = None, path: Optional[str] = None, commands: Optional[List[Command]] = None)

Create a card that displays a base64-encoded image.

Static methods

load

def load(_ImageCard__d:¬†Dict) ‚ÄĎ>¬†ImageCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var image

Image data, base64-encoded.

var path

The path or URL or data URL of the image, e.g. /foo.png or http://example.com/foo.png or data:image/png;base64,???.

var title

The card's title.

var type

The image MIME subtype. One of apng, bmp, gif, x-icon, jpeg, png, webp.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Inline

class Inline(items: List[ForwardRef('Component')], justify: Optional[str] = None, inset: Optional[bool] = None)

Create an inline (horizontal) list of components.

Static methods

load

def load(_Inline__d:¬†Dict) ‚ÄĎ>¬†Inline

Creates an instance of this class using the contents of a dict.

Instance variables

var inset

Whether to display the components inset from the parent form, with a contrasting background.

var items

The components laid out inline.

var justify

Specifies how to lay out the individual components. Defaults to 'start'. One of 'start', 'end'. See enum h2o_wave.ui.InlineJustify.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

InlineJustify

class InlineJustify

Class variables

var END
var START

InlineScript

class InlineScript(content: str, requires: Optional[List[str]] = None, targets: Optional[List[str]] = None)

Create a block of inline Javascript to be executed immediately on a page.

Static methods

load

def load(_InlineScript__d:¬†Dict) ‚ÄĎ>¬†InlineScript

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The Javascript source code to be executed.

var requires

The names of modules required on the page's window global before running this script.

var targets

The IDs of the HTML elements required to be present on the page before running this script.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Label

class Label(label: str, required: Optional[bool] = None, disabled: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None, name: Optional[str] = None)

Create a label.

Labels give a name or title to a component or group of components. Labels should be in close proximity to the component or group they are paired with. Some components, such as textboxes, dropdowns, or toggles, already have labels incorporated, but other components may optionally add a Label if it helps inform the user of the component’s purpose.

Static methods

load

def load(_Label__d:¬†Dict) ‚ÄĎ>¬†Label

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if the label should be disabled.

var label

The text displayed on the label.

var name

An identifying name for this component.

var required

True if the field is required.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

LargeBarStatCard

class LargeBarStatCard(box: str, title: str, caption: str, value: str, aux_value: str, value_caption: str, aux_value_caption: str, progress: float, plot_color: Optional[str] = None, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a large captioned card displaying a primary value, an auxiliary value and a progress bar, with captions for each value.

Static methods

load

def load(_LargeBarStatCard__d:¬†Dict) ‚ÄĎ>¬†LargeBarStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value, typically a target value.

var aux_value_caption

The caption displayed below the auxiliary value.

var box

A string indicating how to place this component on the page.

var caption

The card's caption.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var plot_color

The color of the progress bar.

var progress

The value of the progress bar, between 0 and 1.

var title

The card's title.

var value

The primary value displayed.

var value_caption

The caption displayed below the primary value.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

LargeStatCard

class LargeStatCard(box: str, title: str, value: str, aux_value: str, caption: str, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a stat card displaying a primary value, an auxiliary value and a caption.

Static methods

load

def load(_LargeStatCard__d:¬†Dict) ‚ÄĎ>¬†LargeStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value displayed next to the primary value.

var box

A string indicating how to place this component on the page.

var caption

The caption displayed below the primary value.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Layout

class Layout(breakpoint: str, zones: List[Zone], width: Optional[str] = None, min_width: Optional[str] = None, max_width: Optional[str] = None, height: Optional[str] = None, min_height: Optional[str] = None, max_height: Optional[str] = None, name: Optional[str] = None)

Represents the layout structure for a page.

Static methods

load

def load(_Layout__d:¬†Dict) ‚ÄĎ>¬†Layout

Creates an instance of this class using the contents of a dict.

Instance variables

var breakpoint

The minimum viewport width at which to use this layout. Values must be pixel widths (e.g. '0px', '576px', '768px') or a named preset. The named presets are: 'xs': '0px' for extra small devices (portrait phones), 's': '576px' for small devices (landscape phones), 'm': '768px' for medium devices (tablets), 'l': '992px' for large devices (desktops), 'xl': '1200px' for extra large devices (large desktops). A breakpoint value of 'xs' (or '0') matches all viewport widths, unless other breakpoints are set.

var height

The height of the layout. Defaults to auto.

var max_height

The maximum height of the layout.

var max_width

The maximum width of the layout.

var min_height

The minimum height of the layout.

var min_width

The minimum width of the layout.

var name

An identifying name for this zone.

var width

The width of the layout. Defaults to 100%.

var zones

The zones in this layout. Each zones can in turn contain sub-zones.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Link

class Link(label: Optional[str] = None, path: Optional[str] = None, disabled: Optional[bool] = None, download: Optional[bool] = None, button: Optional[bool] = None, visible: Optional[bool] = None, target: Optional[str] = None, tooltip: Optional[str] = None, name: Optional[str] = None)

Create a hyperlink.

Hyperlinks can be internal or external. Internal hyperlinks have paths that begin with a / and point to URLs within the Wave UI. All other kinds of paths are treated as external hyperlinks.

Static methods

load

def load(_Link__d:¬†Dict) ‚ÄĎ>¬†Link

Creates an instance of this class using the contents of a dict.

Instance variables

var button

True if the link should be rendered as a button.

var disabled

True if the link should be disabled.

var download

True if the link should prompt the user to save the linked URL instead of navigating to it. Works only if button is false.

var label

The text to be displayed. If blank, the path is used as the label.

var name

An identifying name for this component.

var path

The path or URL to link to.

var target

Where to display the link. Setting this to an empty string or '_blank' opens the link in a new tab or window.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ListCard

class ListCard(box: str, title: str, item_view: str, item_props: Union[dict, str], data: Union[Data, str], commands: Optional[List[Command]] = None)

EXPERIMENTAL. DO NOT USE. Create a card containing other cards laid out in the form of a list (vertically, top-to-bottom).

Static methods

load

def load(_ListCard__d:¬†Dict) ‚ÄĎ>¬†ListCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var item_props

The child card properties.

var item_view

The child card type.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ListItem1Card

class ListItem1Card(box: str, title: str, caption: str, value: str, aux_value: str, data: Union[dict, str], commands: Optional[List[Command]] = None)

EXPERIMENTAL. DO NOT USE.

Static methods

load

def load(_ListItem1Card__d:¬†Dict) ‚ÄĎ>¬†ListItem1Card

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

EXPERIMENTAL. DO NOT USE.

var box

A string indicating how to place this component on the page.

var caption

EXPERIMENTAL. DO NOT USE.

var commands

Contextual menu commands for this component.

var data

EXPERIMENTAL. DO NOT USE.

var title

EXPERIMENTAL. DO NOT USE.

var value

EXPERIMENTAL. DO NOT USE.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Mark

class Mark(coord: Optional[str] = None, type: Optional[str] = None, x: Union[str, float, int, NoneType] = None, x0: Union[str, float, int, NoneType] = None, x1: Union[str, float, int, NoneType] = None, x2: Union[str, float, int, NoneType] = None, x_min: Optional[float] = None, x_max: Optional[float] = None, x_nice: Optional[bool] = None, x_scale: Optional[str] = None, x_title: Optional[str] = None, y: Union[str, float, int, NoneType] = None, y0: Union[str, float, int, NoneType] = None, y1: Union[str, float, int, NoneType] = None, y2: Union[str, float, int, NoneType] = None, y_min: Optional[float] = None, y_max: Optional[float] = None, y_nice: Optional[bool] = None, y_scale: Optional[str] = None, y_title: Optional[str] = None, color: Optional[str] = None, color_range: Optional[str] = None, color_domain: Optional[List[str]] = None, shape: Optional[str] = None, shape_range: Optional[str] = None, size: Union[str, float, int, NoneType] = None, size_range: Optional[str] = None, stack: Optional[str] = None, dodge: Optional[str] = None, curve: Optional[str] = None, fill_color: Optional[str] = None, fill_opacity: Optional[float] = None, stroke_color: Optional[str] = None, stroke_opacity: Optional[float] = None, stroke_size: Optional[float] = None, stroke_dash: Optional[str] = None, label: Optional[str] = None, label_offset: Optional[float] = None, label_offset_x: Optional[float] = None, label_offset_y: Optional[float] = None, label_rotation: Optional[str] = None, label_position: Optional[str] = None, label_overlap: Optional[str] = None, label_fill_color: Optional[str] = None, label_fill_opacity: Optional[float] = None, label_stroke_color: Optional[str] = None, label_stroke_opacity: Optional[float] = None, label_stroke_size: Optional[float] = None, label_font_size: Optional[float] = None, label_font_weight: Optional[str] = None, label_line_height: Optional[float] = None, label_align: Optional[str] = None, ref_stroke_color: Optional[str] = None, ref_stroke_opacity: Optional[float] = None, ref_stroke_size: Optional[float] = None, ref_stroke_dash: Optional[str] = None)

Create a specification for a layer of graphical marks such as bars, lines, points for a plot. A plot can contain multiple such layers of marks.

Static methods

load

def load(_Mark__d:¬†Dict) ‚ÄĎ>¬†Mark

Creates an instance of this class using the contents of a dict.

Instance variables

var color

Mark color field or value.

var color_domain

The unique values in the data (labels or categories or classes) to map colors to, e.g. ['high', 'medium', 'low']. If this is not provided, the unique values are automatically inferred from the color attribute.

var color_range

Mark color range for multi-series plots. A string containing space-separated colors, e.g. '#fee8c8 #fdbb84 #e34a33'

var coord

Coordinate system. rect is synonymous to cartesian. theta is transposed polar. One of 'rect', 'cartesian', 'polar', 'theta', 'helix'. See enum h2o_wave.ui.MarkCoord.

var curve

Curve type for line and area mark types. One of 'none', 'smooth', 'step-before', 'step', 'step-after'. See enum h2o_wave.ui.MarkCurve.

var dodge

Field to dodge marks by, or 'auto' to infer.

var fill_color

Mark fill color.

var fill_opacity

Mark fill opacity.

var label

Label field or value.

var label_align

Label text alignment. One of 'left', 'right', 'center', 'start', 'end'. See enum h2o_wave.ui.MarkLabelAlign.

var label_fill_color

Label fill color.

var label_fill_opacity

Label fill opacity.

var label_font_size

Label font size.

var label_font_weight

Label font weight.

var label_line_height

Label line height.

var label_offset

Distance between label and mark.

var label_offset_x

Horizontal distance between label and mark.

var label_offset_y

Vertical distance between label and mark.

var label_overlap

Strategy to use if labels overlap. One of 'hide', 'overlap', 'constrain'. See enum h2o_wave.ui.MarkLabelOverlap.

var label_position

Label position relative to the mark. One of 'top', 'bottom', 'middle', 'left', 'right'. See enum h2o_wave.ui.MarkLabelPosition.

var label_rotation

Label rotation angle, in degrees, or 'none' to disable automatic rotation. The default behavior is 'auto' for automatic rotation.

var label_stroke_color

Label stroke color.

var label_stroke_opacity

Label stroke opacity.

var label_stroke_size

Label stroke size (line width or pen thickness).

var ref_stroke_color

Reference line stroke color.

var ref_stroke_dash

Reference line stroke dash style. A string containing space-separated integers that specify distances to alternately draw a line and a gap (in coordinate space units). If the number of elements in the array is odd, the elements of the array get copied and concatenated. For example, [5, 15, 25] will become [5, 15, 25, 5, 15, 25].

var ref_stroke_opacity

Reference line stroke opacity.

var ref_stroke_size

Reference line stroke size (line width or pen thickness).

var shape

Mark shape field or value for point mark types. Possible values are 'circle', 'square', 'bowtie', 'diamond', 'hexagon', 'triangle', 'triangle-down', 'cross', 'tick', 'plus', 'hyphen', 'line'.

var shape_range

Mark shape range for multi-series plots using point mark types. A string containing space-separated shapes, e.g. 'circle square diamond'

var size

Mark size field or value.

var size_range

Mark size range. A string containing space-separated integers, e.g. '4 30'

var stack

Field to stack marks by, or 'auto' to infer.

var stroke_color

Mark stroke color.

var stroke_dash

Mark stroke dash style. A string containing space-separated integers that specify distances to alternately draw a line and a gap (in coordinate space units). If the number of elements in the array is odd, the elements of the array get copied and concatenated. For example, [5, 15, 25] will become [5, 15, 25, 5, 15, 25].

var stroke_opacity

Mark stroke opacity.

var stroke_size

Mark stroke size.

var type

Graphical geometry. One of 'interval', 'line', 'path', 'point', 'area', 'polygon', 'schema', 'edge', 'heatmap'. See enum h2o_wave.ui.MarkType.

var x

X field or value.

var x0

X base field or value.

var x1

X bin lower bound field or value. For histograms.

var x2

X bin upper bound field or value. For histograms.

var x_max

X axis scale maximum.

var x_min

X axis scale minimum.

var x_nice

Whether to nice X axis scale ticks.

var x_scale

X axis scale type. One of 'linear', 'cat', 'category', 'identity', 'log', 'pow', 'power', 'time', 'time-category', 'quantize', 'quantile'. See enum h2o_wave.ui.MarkXScale.

var x_title

X axis title.

var y

Y field or value.

var y0

Y base field or value.

var y1

Y bin lower bound field or value. For histograms.

var y2

Y bin upper bound field or value. For histograms.

var y_max

Y axis scale maximum.

var y_min

Y axis scale minimum.

var y_nice

Whether to nice Y axis scale ticks.

var y_scale

Y axis scale type. One of 'linear', 'cat', 'category', 'identity', 'log', 'pow', 'power', 'time', 'time-category', 'quantize', 'quantile'. See enum h2o_wave.ui.MarkYScale.

var y_title

Y axis title.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

MarkCoord

class MarkCoord

Class variables

var CARTESIAN
var HELIX
var POLAR
var RECT
var THETA

MarkCurve

class MarkCurve

Class variables

var NONE
var SMOOTH
var STEP
var STEP_AFTER
var STEP_BEFORE

MarkLabelAlign

class MarkLabelAlign

Class variables

var CENTER
var END
var LEFT
var RIGHT
var START

MarkLabelOverlap

class MarkLabelOverlap

Class variables

var CONSTRAIN
var HIDE
var OVERLAP

MarkLabelPosition

class MarkLabelPosition

Class variables

var BOTTOM
var LEFT
var MIDDLE
var RIGHT
var TOP

MarkType

class MarkType

Class variables

var AREA
var EDGE
var HEATMAP
var INTERVAL
var LINE
var PATH
var POINT
var POLYGON
var SCHEMA

MarkXScale

class MarkXScale

Class variables

var CAT
var CATEGORY
var IDENTITY
var LINEAR
var LOG
var POW
var POWER
var QUANTILE
var QUANTIZE
var TIME
var TIME_CATEGORY

MarkYScale

class MarkYScale

Class variables

var CAT
var CATEGORY
var IDENTITY
var LINEAR
var LOG
var POW
var POWER
var QUANTILE
var QUANTIZE
var TIME
var TIME_CATEGORY

MarkdownCard

class MarkdownCard(box: str, title: str, content: str, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a card that renders Markdown content.

Github-flavored markdown is supported. HTML markup is allowed in markdown content. URLs, if found, are displayed as hyperlinks. Copyright, reserved, trademark, quotes, etc. are replaced with language-neutral symbols.

Static methods

load

def load(_MarkdownCard__d:¬†Dict) ‚ÄĎ>¬†MarkdownCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var content

The markdown content. Supports Github Flavored Markdown (GFM): https://guides.github.com/features/mastering-markdown/

var data

Additional data for the card.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Markup

class Markup(content: str, name: Optional[str] = None, visible: Optional[bool] = None)

Render HTML content.

Static methods

load

def load(_Markup__d:¬†Dict) ‚ÄĎ>¬†Markup

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The HTML content.

var name

An identifying name for this component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

MarkupCard

class MarkupCard(box: str, title: str, content: str, commands: Optional[List[Command]] = None)

Render HTML content.

Static methods

load

def load(_MarkupCard__d:¬†Dict) ‚ÄĎ>¬†MarkupCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var content

The HTML content.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

MessageBar

class MessageBar(type: Optional[str] = None, text: Optional[str] = None, name: Optional[str] = None, visible: Optional[bool] = None)

Create a message bar.

A message bar is an area at the top of a primary view that displays relevant status information. You can use a message bar to tell the user about a situation that does not require their immediate attention and therefore does not need to block other activities.

Static methods

load

def load(_MessageBar__d:¬†Dict) ‚ÄĎ>¬†MessageBar

Creates an instance of this class using the contents of a dict.

Instance variables

var name

An identifying name for this component.

var text

The text displayed on the message bar.

var type

The icon and color of the message bar. One of 'info', 'error', 'warning', 'success', 'danger', 'blocked'. See enum h2o_wave.ui.MessageBarType.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

MessageBarType

class MessageBarType

Class variables

var BLOCKED
var DANGER
var ERROR
var INFO
var SUCCESS
var WARNING

MetaCard

class MetaCard(box: str, title: Optional[str] = None, refresh: Optional[int] = None, notification: Optional[str] = None, redirect: Optional[str] = None, icon: Optional[str] = None, layouts: Optional[List[Layout]] = None, dialog: Optional[Dialog] = None, theme: Optional[str] = None, tracker: Optional[Tracker] = None, scripts: Optional[List[Script]] = None, script: Optional[InlineScript] = None, commands: Optional[List[Command]] = None)

Represents page-global state.

This card is invisible. It is used to control attributes of the active page.

Static methods

load

def load(_MetaCard__d:¬†Dict) ‚ÄĎ>¬†MetaCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var dialog

Display a dialog on the page.

var icon

Shortcut icon path. Preferably a .png file (.ico files may not work in mobile browsers). Not supported in Safari.

var layouts

The layouts supported by this page.

var notification

Display a desktop notification.

var redirect

Redirect the page to a new URL.

var refresh

Refresh rate in seconds. A value of 0 turns off live-updates. Values != 0 are currently ignored (reserved for future use).

var script

Javascript code to execute on this page.

var scripts

External Javascript files to load into the page.

var theme

Specify the name of the theme (color scheme) to use on this page. One of 'light' or 'neon'.

var title

The title of the page.

var tracker

Configure a tracker for the page (for web analytics).

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

NavCard

class NavCard(box: str, items: List[NavGroup], value: Optional[str] = None, commands: Optional[List[Command]] = None)

Create a card containing a navigation pane.

Static methods

load

def load(_NavCard__d:¬†Dict) ‚ÄĎ>¬†NavCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var items

The navigation groups contained in this pane.

var value

The name of the active (highlighted) navigation item.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

NavGroup

class NavGroup(label: str, items: List[NavItem], collapsed: Optional[bool] = None)

Create a group of navigation items.

Static methods

load

def load(_NavGroup__d:¬†Dict) ‚ÄĎ>¬†NavGroup

Creates an instance of this class using the contents of a dict.

Instance variables

var collapsed

Indicates whether nav groups should be rendered as collapsed initially

var items

The navigation items contained in this group.

var label

The label to display for this group.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

NavItem

class NavItem(name: str, label: str, icon: Optional[str] = None, disabled: Optional[bool] = None)

Create a navigation item.

Static methods

load

def load(_NavItem__d:¬†Dict) ‚ÄĎ>¬†NavItem

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if this item should be disabled.

var icon

An optional icon to display next to the label.

var label

The label to display.

var name

The name of this item. Prefix the name with a '#' to trigger hash-change navigation.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Picker

class Picker(name: str, choices: List[Choice], label: Optional[str] = None, values: Optional[List[str]] = None, max_choices: Optional[int] = None, disabled: Optional[bool] = None, visible: Optional[bool] = None, trigger: Optional[bool] = None, tooltip: Optional[str] = None)

Create a picker. Pickers are used to select one or more choices, such as tags or files, from a list. Use a picker to allow the user to quickly search for or manage a few tags or files.

Static methods

load

def load(_Picker__d:¬†Dict) ‚ÄĎ>¬†Picker

Creates an instance of this class using the contents of a dict.

Instance variables

var choices

The choices to be presented.

var disabled

Controls whether the picker should be disabled or not.

var label

Text to be displayed above the component.

var max_choices

Maximum number of selectable choices. Defaults to no limit.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the picker value changes.

var values

The names of the selected choices.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

PixelArtCard

class PixelArtCard(box: str, title: str, data: Union[dict, str], commands: Optional[List[Command]] = None)

WARNING: Experimental and subject to change. Do not use in production sites!

Create a card displaying a collaborative Pixel art tool.

Static methods

load

def load(_PixelArtCard__d:¬†Dict) ‚ÄĎ>¬†PixelArtCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

The data for this card.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Plot

class Plot(marks: List[Mark])

Create a plot. A plot is composed of one or more graphical mark layers.

Static methods

load

def load(_Plot__d:¬†Dict) ‚ÄĎ>¬†Plot

Creates an instance of this class using the contents of a dict.

Instance variables

var marks

The graphical mark layers contained in this plot.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

PlotCard

class PlotCard(box: str, title: str, data: Union[dict, str], plot: Plot, events: Optional[List[str]] = None, commands: Optional[List[Command]] = None)

Create a card displaying a plot.

Static methods

load

def load(_PlotCard__d:¬†Dict) ‚ÄĎ>¬†PlotCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var events

The events to capture on this card.

var plot

The plot to be displayed in this card.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Progress

class Progress(label: str, caption: Optional[str] = None, value: Optional[float] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None, name: Optional[str] = None)

Create a progress bar.

Progress bars are used to show the completion status of an operation lasting more than 2 seconds. If the state of progress cannot be determined, do not set a value. Progress bars feature a bar showing total units to completion, and total units finished. The label appears above the bar, and the caption appears below. The label should tell someone exactly what the operation is doing.

Examples of formatting include: [Object] is being [operation name], or [Object] is being [operation name] to [destination name] or [Object] is being [operation name] from [source name] to [destination name]

Status text is generally in units elapsed and total units. Real-world examples include copying files to a storage location, saving edits to a file, and more. Use units that are informative and relevant to give the best idea to users of how long the operation will take to complete. Avoid time units as they are rarely accurate enough to be trustworthy. Also, combine steps of a complex operation into one total bar to avoid ‚Äúrewinding‚ÄĚ the bar. Instead change the label to reflect the change if necessary. Bars moving backwards reduce confidence in the service.

Static methods

load

def load(_Progress__d:¬†Dict) ‚ÄĎ>¬†Progress

Creates an instance of this class using the contents of a dict.

Instance variables

var caption

The text displayed below the bar.

var label

The text displayed above the bar.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var value

The progress, between 0.0 and 1.0, or -1 (default) if indeterminate.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ProgressTableCellType

class ProgressTableCellType(color: Optional[str] = None, name: Optional[str] = None)

Create a cell type that renders a column's cells as progress bars instead of plain text. If set on a column, the cell value must be between 0.0 and 1.0.

Static methods

load

def load(_ProgressTableCellType__d:¬†Dict) ‚ÄĎ>¬†ProgressTableCellType

Creates an instance of this class using the contents of a dict.

Instance variables

var color

Color of the progress arc.

var name

An identifying name for this component.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

RangeSlider

class RangeSlider(name: str, label: Optional[str] = None, min: Optional[float] = None, max: Optional[float] = None, step: Optional[float] = None, min_value: Optional[float] = None, max_value: Optional[float] = None, disabled: Optional[bool] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a range slider.

A range slider is an element used to select a value range. It provides a visual indication of adjustable content, as well as the current setting in the total range of content. It is displayed as a horizontal track with options on either side. Knobs or levers are dragged to one end or the other to make the choice, indicating the current max and min value.

Static methods

load

def load(_RangeSlider__d:¬†Dict) ‚ÄĎ>¬†RangeSlider

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if this field is disabled.

var label

Text to be displayed alongside the component.

var max

The maximum value of the slider. Defaults to 100.

var max_value

The upper bound of the selected range.

var min

The minimum value of the slider. Defaults to 0.

var min_value

The lower bound of the selected range.

var name

An identifying name for this component.

var step

The difference between two adjacent values of the slider.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the slider value changes.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

RepeatCard

class RepeatCard(box: str, item_view: str, item_props: Union[dict, str], data: Union[Data, str], commands: Optional[List[Command]] = None)

EXPERIMENTAL. DO NOT USE. Create a card containing other cards.

Static methods

load

def load(_RepeatCard__d:¬†Dict) ‚ÄĎ>¬†RepeatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var item_props

The child card properties.

var item_view

EXPERIMENTAL. DO NOT USE.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Script

class Script(path: str, asynchronous: Optional[bool] = None, cross_origin: Optional[str] = None, referrer_policy: Optional[str] = None, integrity: Optional[str] = None)

Create a reference to an external Javascript file to be included on a page.

Static methods

load

def load(_Script__d:¬†Dict) ‚ÄĎ>¬†Script

Creates an instance of this class using the contents of a dict.

Instance variables

var asynchronous

Whether to fetch and load this script in parallel to parsing and evaluated as soon as it is available.

var cross_origin
var integrity

The cryptographic hash to verify the script's integrity. See https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity

var path

The URI of an external script.

var referrer_policy

Indicates which referrer to send when fetching the script. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

SectionCard

class SectionCard(box: str, title: str, subtitle: str, items: Union[List[Component], str, NoneType] = None, commands: Optional[List[Command]] = None)

Render a card displaying a title, a subtitle, and optional components. Section cards are typically used to demarcate different sections on a page.

Static methods

load

def load(_SectionCard__d:¬†Dict) ‚ÄĎ>¬†SectionCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var items

The components to display in this card

var subtitle

The subtitle, displayed below the title. Supports Markdown.

var title

The title.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Separator

class Separator(label: Optional[str] = None, name: Optional[str] = None, visible: Optional[bool] = None)

Create a separator.

A separator visually separates content into groups.

Static methods

load

def load(_Separator__d:¬†Dict) ‚ÄĎ>¬†Separator

Creates an instance of this class using the contents of a dict.

Instance variables

var label

The text displayed on the separator.

var name

An identifying name for this component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Slider

class Slider(name: str, label: Optional[str] = None, min: Optional[float] = None, max: Optional[float] = None, step: Optional[float] = None, value: Optional[float] = None, disabled: Optional[bool] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a slider.

A slider is an element used to set a value. It provides a visual indication of adjustable content, as well as the current setting in the total range of content. It is displayed as a horizontal track with options on either side. A knob or lever is dragged to one end or the other to make the choice, indicating the current value. Marks on the slider bar can show values and users can choose where they want to drag the knob or lever to set the value.

A slider is a good choice when you know that users think of the value as a relative quantity, not a numeric value. For example, users think about setting their audio volume to low or medium ‚ÄĒ not about setting the value to two or five.

The default value of the slider will be zero or be constrained to the min and max values. The min will be returned if the value is set under the min and the max will be returned if set higher than the max value.

Static methods

load

def load(_Slider__d:¬†Dict) ‚ÄĎ>¬†Slider

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if this field is disabled.

var label

Text to be displayed alongside the component.

var max

The maximum value of the slider.

var min

The minimum value of the slider.

var name

An identifying name for this component.

var step

The difference between two adjacent values of the slider.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the slider value changes.

var value

The current value of the slider.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

SmallSeriesStatCard

class SmallSeriesStatCard(box: str, title: str, value: str, plot_data: Union[Data, str], plot_value: str, plot_zero_value: Optional[float] = None, plot_category: Optional[str] = None, plot_type: Optional[str] = None, plot_curve: Optional[str] = None, plot_color: Optional[str] = None, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a small stat card displaying a primary value and a series plot.

Static methods

load

def load(_SmallSeriesStatCard__d:¬†Dict) ‚ÄĎ>¬†SmallSeriesStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var plot_category

The data field to use for x-axis values (ignored if plot_type is area; must be provided if plot_type is interval). Defaults to 'x'.

var plot_color

The plot's color.

var plot_curve

The plot's curve style. Defaults to linear. One of 'linear', 'smooth', 'step', 'step-after', 'step-before'. See enum h2o_wave.ui.SmallSeriesStatCardPlotCurve.

var plot_data

The plot's data.

var plot_type

The type of plot. Defaults to area. One of 'area', 'interval'. See enum h2o_wave.ui.SmallSeriesStatCardPlotType.

var plot_value

The data field to use for y-axis values.

var plot_zero_value

The base value to use for each y-axis mark. Set this to 0 if you want to pin the x-axis at y=0. If not provided, the minimum value from the data is used.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

SmallSeriesStatCardPlotCurve

class SmallSeriesStatCardPlotCurve

Class variables

var LINEAR
var SMOOTH
var STEP
var STEP_AFTER
var STEP_BEFORE

SmallSeriesStatCardPlotType

class SmallSeriesStatCardPlotType

Class variables

var AREA
var INTERVAL

SmallStatCard

class SmallStatCard(box: str, title: str, value: str, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a stat card displaying a single value.

Static methods

load

def load(_SmallStatCard__d:¬†Dict) ‚ÄĎ>¬†SmallStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Spinbox

class Spinbox(name: str, label: Optional[str] = None, min: Optional[float] = None, max: Optional[float] = None, step: Optional[float] = None, value: Optional[float] = None, disabled: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a spinbox.

A spinbox allows the user to incrementally adjust a value in small steps. It is mainly used for numeric values, but other values are supported too.

Static methods

load

def load(_Spinbox__d:¬†Dict) ‚ÄĎ>¬†Spinbox

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if this field is disabled.

var label

Text to be displayed alongside the component.

var max

The maximum value of the spinbox.

var min

The minimum value of the spinbox.

var name

An identifying name for this component.

var step

The difference between two adjacent values of the spinbox.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var value

The current value of the spinbox.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Stat

class Stat(label: str, value: Optional[str] = None, caption: Optional[str] = None, icon: Optional[str] = None, icon_color: Optional[str] = None)

Create a stat (a label-value pair) for displaying a metric.

Static methods

load

def load(_Stat__d:¬†Dict) ‚ÄĎ>¬†Stat

Creates an instance of this class using the contents of a dict.

Instance variables

var caption

The caption displayed below the primary value.

var icon

An optional icon, displayed next to the label.

var icon_color

The color of the icon.

var label

The label for the metric.

var value

The value of the metric.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

StatListCard

class StatListCard(box: str, title: str, items: List[StatListItem], name: Optional[str] = None, subtitle: Optional[str] = None, commands: Optional[List[Command]] = None)

Render a card displaying a list of stats.

Static methods

load

def load(_StatListCard__d:¬†Dict) ‚ÄĎ>¬†StatListCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var items

The individual stats to be displayed.

var name

An optional name for this item.

var subtitle

The subtitle, displayed below the title.

var title

The title.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

StatListItem

class StatListItem(label: str, name: Optional[str] = None, caption: Optional[str] = None, value: Optional[str] = None, value_color: Optional[str] = None, aux_value: Optional[str] = None, icon: Optional[str] = None, icon_color: Optional[str] = None)

Create a stat item (a label-value pair) for stat_list_card.

Static methods

load

def load(_StatListItem__d:¬†Dict) ‚ÄĎ>¬†StatListItem

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value, displayed below the primary value.

var caption

The caption for the metric, displayed below the label.

var icon

An optional icon, displayed next to the label.

var icon_color

The color of the icon.

var label

The label for the metric.

var name

An optional name for this item (required only if this item is clickable).

var value

The primary value of the metric.

var value_color

The font color of the primary value.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

StatTableCard

class StatTableCard(box: str, title: str, columns: List[str], items: List[StatTableItem], name: Optional[str] = None, subtitle: Optional[str] = None, commands: Optional[List[Command]] = None)

Render a card displaying a table of stats.

Static methods

load

def load(_StatTableCard__d:¬†Dict) ‚ÄĎ>¬†StatTableCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var columns

The names of this table's columns.

var commands

Contextual menu commands for this component.

var items

The rows displayed in this table.

var name

An optional name for this item.

var subtitle

The subtitle, displayed below the title.

var title

The title.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

StatTableItem

class StatTableItem(label: str, values: List[str], name: Optional[str] = None, caption: Optional[str] = None, icon: Optional[str] = None, icon_color: Optional[str] = None)

Create a stat item (a label and a set of values) for stat_table_card.

Static methods

load

def load(_StatTableItem__d:¬†Dict) ‚ÄĎ>¬†StatTableItem

Creates an instance of this class using the contents of a dict.

Instance variables

var caption

The caption for the metric, displayed below the label.

var icon

An optional icon, displayed next to the label.

var icon_color

The color of the icon.

var label

The label for the row.

var name

An optional name for this row (required only if this row is clickable).

var values

The values displayed in the row.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Stats

class Stats(items: List[Stat], justify: Optional[str] = None, inset: Optional[bool] = None)

Create a set of stats laid out horizontally.

Static methods

load

def load(_Stats__d:¬†Dict) ‚ÄĎ>¬†Stats

Creates an instance of this class using the contents of a dict.

Instance variables

var inset

Whether to display the stats with a contrasting background.

var items

The individual stats to be displayed.

var justify

Specifies how to lay out the individual stats. Defaults to 'start'. One of 'start', 'end', 'center', 'between', 'around'. See enum h2o_wave.ui.StatsJustify.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

StatsJustify

class StatsJustify

Class variables

var AROUND
var BETWEEN
var CENTER
var END
var START

Step

class Step(label: str, icon: Optional[str] = None, done: Optional[bool] = None)

Create a step for a stepper.

Static methods

load

def load(_Step__d:¬†Dict) ‚ÄĎ>¬†Step

Creates an instance of this class using the contents of a dict.

Instance variables

var done

Indicates whether this step has already been completed.

var icon

Icon to be displayed.

var label

Text displayed below icon.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Stepper

class Stepper(name: str, items: List[Step], visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a component that displays a sequence of steps in a process. The steps keep users informed about where they are in the process and how much is left to complete.

Static methods

load

def load(_Stepper__d:¬†Dict) ‚ÄĎ>¬†Stepper

Creates an instance of this class using the contents of a dict.

Instance variables

var items

The sequence of steps to be displayed.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Tab

class Tab(name: str, label: Optional[str] = None, icon: Optional[str] = None)

Create a tab.

Static methods

load

def load(_Tab__d:¬†Dict) ‚ÄĎ>¬†Tab

Creates an instance of this class using the contents of a dict.

Instance variables

var icon

The icon displayed on the tab.

var label

The text displayed on the tab.

var name

An identifying name for this component.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TabCard

class TabCard(box: str, items: List[Tab], value: Optional[str] = None, link: Optional[bool] = None, name: Optional[str] = None, commands: Optional[List[Command]] = None)

Create a card containing tabs for navigation.

Static methods

load

def load(_TabCard__d:¬†Dict) ‚ÄĎ>¬†TabCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var items

The tabs to display in this card

True if tabs should be rendered as links instead of buttons.

var name

An optional name for the card. If provided, the selected tab can be accessed using the name of the card.

var value

The name of the tab to select.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Table

class Table(name: str, columns: List[TableColumn], rows: List[TableRow], multiple: Optional[bool] = None, groupable: Optional[bool] = None, downloadable: Optional[bool] = None, resettable: Optional[bool] = None, height: Optional[str] = None, values: Optional[List[str]] = None, checkbox_visibility: Optional[str] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create an interactive table.

This table differs from a markdown table in that it supports clicking or selecting rows. If you simply want to display a non-interactive table of information, use a markdown table.

If multiple is set to False (default), each row in the table is clickable. When a row is clicked, the form is submitted automatically, and q.args.table_name is set to [row_name], where table_name is the name of the table, and row_name is the name of the row that was clicked on.

If multiple is set to True, each row in the table is selectable. A row can be selected by clicking on it. Multiple rows can be selected either by shift+clicking or using marquee selection. When the form is submitted,q.args.table_name is set to [row1_name, row2_name, …] where table_name is the name of the table, and row1_name, row2_name are the name of the rows that were selected. Note that if multiple is set to True, the form is not submitted automatically, and one or more buttons are required in the form to trigger submission.

Static methods

load

def load(_Table__d:¬†Dict) ‚ÄĎ>¬†Table

Creates an instance of this class using the contents of a dict.

Instance variables

var checkbox_visibility

Controls visibility of table rows when multiple is set to True. Defaults to 'on-hover'. One of 'always', 'on-hover', 'hidden'. See enum h2o_wave.ui.TableCheckboxVisibility.

var columns

The columns in this table.

var downloadable

Indicates whether the contents of this table can be downloaded and saved as a CSV file. Defaults to False.

var groupable

True to allow group by feature.

var height

The height of the table, e.g. '400px', '50%', etc.

var multiple

True to allow multiple rows to be selected.

var name

An identifying name for this component.

var resettable

Indicates whether a Reset button should be displayed to reset search / filter / group-by values to their defaults. Defaults to False.

var rows

The rows in this table.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var values

The names of the selected rows. If this parameter is set, multiple selections will be allowed (multiple is assumed to be True).

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TableCellType

class TableCellType(progress: Optional[ProgressTableCellType] = None, icon: Optional[IconTableCellType] = None)

Defines cell content to be rendered instead of a simple text.

Static methods

load

def load(_TableCellType__d:¬†Dict) ‚ÄĎ>¬†TableCellType

Creates an instance of this class using the contents of a dict.

Instance variables

var icon

No documentation available.

var progress

No documentation available.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TableCheckboxVisibility

class TableCheckboxVisibility

Class variables

var ALWAYS
var HIDDEN
var ON_HOVER

TableColumn

class TableColumn(name: str, label: str, min_width: Optional[str] = None, max_width: Optional[str] = None, sortable: Optional[bool] = None, searchable: Optional[bool] = None, filterable: Optional[bool] = None, link: Optional[bool] = None, data_type: Optional[str] = None, cell_type: Optional[TableCellType] = None)

Create a table column.

Static methods

load

def load(_TableColumn__d:¬†Dict) ‚ÄĎ>¬†TableColumn

Creates an instance of this class using the contents of a dict.

Instance variables

var cell_type

Defines how to render each cell in this column. Defaults to plain text.

var data_type

Defines the data type of this column. Defaults to string. One of 'string', 'number', 'time'. See enum h2o_wave.ui.TableColumnDataType.

var filterable

Indicates whether the contents of this column are displayed as filters in a dropdown.

var label

The text displayed on the column header.

Indicates whether each cell in this column should be displayed as a clickable link.

var max_width

The maximum width of this column, e.g. '100px'. Only px units are supported at this time.

var min_width

The minimum width of this column, e.g. '50px'. Only px units are supported at this time.

var name

An identifying name for this column.

var searchable

Indicates whether the contents of this column can be searched through. Enables a search box for the table if true.

var sortable

Indicates whether the column is sortable.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TableColumnDataType

class TableColumnDataType

Class variables

var NUMBER
var STRING
var TIME

TableRow

class TableRow(name: str, cells: List[str])

Create a table row.

Static methods

load

def load(_TableRow__d:¬†Dict) ‚ÄĎ>¬†TableRow

Creates an instance of this class using the contents of a dict.

Instance variables

var cells

The cells in this row (displayed left to right).

var name

An identifying name for this row.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Tabs

class Tabs(name: str, value: Optional[str] = None, items: Optional[List[Tab]] = None, visible: Optional[bool] = None, link: Optional[bool] = None)

Create a tab bar.

Static methods

load

def load(_Tabs__d:¬†Dict) ‚ÄĎ>¬†Tabs

Creates an instance of this class using the contents of a dict.

Instance variables

var items

The tabs in this tab bar.

True if tabs should be rendered as links instead of buttons.

var name

An identifying name for this component.

var value

The name of the tab to select.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TallGaugeStatCard

class TallGaugeStatCard(box: str, title: str, value: str, aux_value: str, progress: float, plot_color: Optional[str] = None, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a tall stat card displaying a primary value, an auxiliary value and a progress gauge.

Static methods

load

def load(_TallGaugeStatCard__d:¬†Dict) ‚ÄĎ>¬†TallGaugeStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value displayed next to the primary value.

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var plot_color

The color of the progress gauge.

var progress

The value of the progress gauge, between 0 and 1.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TallSeriesStatCard

class TallSeriesStatCard(box: str, title: str, value: str, aux_value: str, plot_data: Union[Data, str], plot_value: str, plot_zero_value: Optional[float] = None, plot_category: Optional[str] = None, plot_type: Optional[str] = None, plot_curve: Optional[str] = None, plot_color: Optional[str] = None, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a tall stat card displaying a primary value, an auxiliary value and a series plot.

Static methods

load

def load(_TallSeriesStatCard__d:¬†Dict) ‚ÄĎ>¬†TallSeriesStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value displayed below the primary value.

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var plot_category

The data field to use for x-axis values (ignored if plot_type is area; must be provided if plot_type is interval). Defaults to 'x'.

var plot_color

The plot's color.

var plot_curve

The plot's curve style. Defaults to linear. One of 'linear', 'smooth', 'step', 'step-after', 'step-before'. See enum h2o_wave.ui.TallSeriesStatCardPlotCurve.

var plot_data

The plot's data.

var plot_type

The type of plot. Defaults to area. One of 'area', 'interval'. See enum h2o_wave.ui.TallSeriesStatCardPlotType.

var plot_value

The data field to use for y-axis values.

var plot_zero_value

The base value to use for each y-axis mark. Set this to 0 if you want to pin the x-axis at y=0. If not provided, the minimum value from the data is used.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TallSeriesStatCardPlotCurve

class TallSeriesStatCardPlotCurve

Class variables

var LINEAR
var SMOOTH
var STEP
var STEP_AFTER
var STEP_BEFORE

TallSeriesStatCardPlotType

class TallSeriesStatCardPlotType

Class variables

var AREA
var INTERVAL

Template

class Template(content: str, data: Union[dict, str, NoneType] = None, name: Optional[str] = None, visible: Optional[bool] = None)

Render dynamic content using an HTML template.

Static methods

load

def load(_Template__d:¬†Dict) ‚ÄĎ>¬†Template

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The Handlebars template. https://handlebarsjs.com/guide/

var data

Data for the Handlebars template

var name

An identifying name for this component.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TemplateCard

class TemplateCard(box: str, title: str, content: str, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Render dynamic content using an HTML template.

Static methods

load

def load(_TemplateCard__d:¬†Dict) ‚ÄĎ>¬†TemplateCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var content

The Handlebars template. https://handlebarsjs.com/guide/

var data

Data for the Handlebars template.

var title

The title for this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Text

class Text(content: str, size: Optional[str] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None, name: Optional[str] = None)

Create text content.

Static methods

load

def load(_Text__d:¬†Dict) ‚ÄĎ>¬†Text

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The text content.

var name

An identifying name for this component.

var size

The font size of the text content. One of 'xl', 'l', 'm', 's', 'xs'. See enum h2o_wave.ui.TextSize.

var tooltip

Tooltip message.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TextL

class TextL(content: str, visible: Optional[bool] = None, tooltip: Optional[str] = None, commands: Optional[List[Command]] = None, name: Optional[str] = None)

Create large sized text content.

Static methods

load

def load(_TextL__d:¬†Dict) ‚ÄĎ>¬†TextL

Creates an instance of this class using the contents of a dict.

Instance variables

var commands

Contextual menu commands for this component.

var content

The text content.

var name

An identifying name for this component.

var tooltip

Tooltip message.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TextM

class TextM(content: str, visible: Optional[bool] = None, tooltip: Optional[str] = None, name: Optional[str] = None)

Create medium sized text content.

Static methods

load

def load(_TextM__d:¬†Dict) ‚ÄĎ>¬†TextM

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The text content.

var name

An identifying name for this component.

var tooltip

Tooltip message.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TextS

class TextS(content: str, visible: Optional[bool] = None, tooltip: Optional[str] = None, name: Optional[str] = None)

Create small sized text content.

Static methods

load

def load(_TextS__d:¬†Dict) ‚ÄĎ>¬†TextS

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The text content.

var name

An identifying name for this component.

var tooltip

Tooltip message.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TextSize

class TextSize

Class variables

var L
var M
var S
var XL
var XS

TextXl

class TextXl(content: str, visible: Optional[bool] = None, tooltip: Optional[str] = None, commands: Optional[List[Command]] = None, name: Optional[str] = None)

Create extra-large sized text content.

Static methods

load

def load(_TextXl__d:¬†Dict) ‚ÄĎ>¬†TextXl

Creates an instance of this class using the contents of a dict.

Instance variables

var commands

Contextual menu commands for this component.

var content

The text content.

var name

An identifying name for this component.

var tooltip

Tooltip message.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TextXs

class TextXs(content: str, visible: Optional[bool] = None, tooltip: Optional[str] = None, name: Optional[str] = None)

Create extra-small sized text content.

Static methods

load

def load(_TextXs__d:¬†Dict) ‚ÄĎ>¬†TextXs

Creates an instance of this class using the contents of a dict.

Instance variables

var content

The text content.

var name

An identifying name for this component.

var tooltip

Tooltip message.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Textbox

class Textbox(name: str, label: Optional[str] = None, placeholder: Optional[str] = None, value: Optional[str] = None, mask: Optional[str] = None, icon: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, error: Optional[str] = None, required: Optional[bool] = None, disabled: Optional[bool] = None, readonly: Optional[bool] = None, multiline: Optional[bool] = None, password: Optional[bool] = None, trigger: Optional[bool] = None, height: Optional[str] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a text box.

The text box component enables a user to type text into an app. It's typically used to capture a single line of text, but can be configured to capture multiple lines of text. The text displays on the screen in a simple, uniform format.

Static methods

load

def load(_Textbox__d:¬†Dict) ‚ÄĎ>¬†Textbox

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if the text box is disabled.

var error

Text to be displayed as an error below the text box.

var height

The height of the text box, e.g. '100px'. Applicable only if multiline is true.

var icon

Icon displayed in the far right end of the text field.

var label

The text displayed above the field.

var mask

The masking string that defines the mask's behavior. A backslash will escape any character. Special format characters are: '9': [0-9] 'a': [a-zA-Z] '*': [a-zA-Z0-9].

var multiline

True if the text box should allow multi-line text entry.

var name

An identifying name for this component.

var password

True if the text box should hide text content.

var placeholder

A string that provides a brief hint to the user as to what kind of information is expected in the field. It should be a word or short phrase that demonstrates the expected type of data, rather than an explanatory message.

var prefix

Text to be displayed before the text box contents.

var readonly

True if the text box is a read-only field.

var required

True if the text box is a required field.

var suffix

Text to be displayed after the text box contents.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the text value changes.

var value

Text to be displayed inside the text box.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Toggle

class Toggle(name: str, label: Optional[str] = None, value: Optional[bool] = None, disabled: Optional[bool] = None, trigger: Optional[bool] = None, visible: Optional[bool] = None, tooltip: Optional[str] = None)

Create a toggle. Toggles represent a physical switch that allows users to turn things on or off. Use toggles to present users with two mutually exclusive options (like on/off), where choosing an option results in an immediate action.

Use a toggle for binary operations that take effect right after the user flips the Toggle. For example, use a Toggle to turn services or hardware components on or off. In other words, if a physical switch would work for the action, a Toggle is probably the best component to use.

Static methods

load

def load(_Toggle__d:¬†Dict) ‚ÄĎ>¬†Toggle

Creates an instance of this class using the contents of a dict.

Instance variables

var disabled

True if the checkbox is disabled.

var label

Text to be displayed alongside the component.

var name

An identifying name for this component.

var tooltip

An optional tooltip message displayed when a user clicks the help icon to the right of the component.

var trigger

True if the form should be submitted when the toggle value changes.

var value

True if selected, False if unselected.

var visible

True if the component should be visible. Defaults to true.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ToolbarCard

class ToolbarCard(box: str, items: List[Command], secondary_items: Optional[List[Command]] = None, overflow_items: Optional[List[Command]] = None, commands: Optional[List[Command]] = None)

Create a card containing a toolbar.

Static methods

load

def load(_ToolbarCard__d:¬†Dict) ‚ÄĎ>¬†ToolbarCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var items

Items to render.

var overflow_items

Items to render in an overflow menu.

var secondary_items

Items to render on the right side (or left, in RTL).

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Tracker

class Tracker(type: str, id: str)

Configure user interaction tracking (analytics) for a page.

Static methods

load

def load(_Tracker__d:¬†Dict) ‚ÄĎ>¬†Tracker

Creates an instance of this class using the contents of a dict.

Instance variables

var id

The tracking ID or measurement ID.

var type

The tracking provider. Supported providers are ga (Google Analytics) and gtag (Google Global Site Tags or gtag.js) One of 'ga', 'gtag'. See enum h2o_wave.ui.TrackerType.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

TrackerType

class TrackerType

Class variables

var GA
var GTAG

VegaCard

class VegaCard(box: str, title: str, specification: str, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a card containing a Vega-lite plot.

Static methods

load

def load(_VegaCard__d:¬†Dict) ‚ÄĎ>¬†VegaCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for the plot, if any.

var specification

The Vega-lite specification.

var title

The title of this card.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

VegaVisualization

class VegaVisualization(specification: str, data: Union[dict, str, NoneType] = None, width: Optional[str] = None, height: Optional[str] = None, name: Optional[str] = None, visible: Optional[bool] = None)

Create a Vega-lite plot for display inside a form.

Static methods

load

def load(_VegaVisualization__d:¬†Dict) ‚ÄĎ>¬†VegaVisualization

Creates an instance of this class using the contents of a dict.

Instance variables

var data

Data for the plot, if any.

var height

The height of the visualization. Defaults to 300px.

var name

An identifying name for this component.

var specification

The Vega-lite specification.

var visible

True if the component should be visible. Defaults to true.

var width

The width of the visualization. Defaults to 100%.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

Visualization

class Visualization(plot: Plot, data: Union[dict, str], width: Optional[str] = None, height: Optional[str] = None, name: Optional[str] = None, visible: Optional[bool] = None, events: Optional[List[str]] = None)

Create a visualization for display inside a form.

Static methods

load

def load(_Visualization__d:¬†Dict) ‚ÄĎ>¬†Visualization

Creates an instance of this class using the contents of a dict.

Instance variables

var data

Data for this visualization.

var events

The events to capture on this visualization.

var height

The hight of the visualization. Defaults to 300px.

var name

An identifying name for this component.

var plot

The plot to be rendered in this visualization.

var visible

True if the component should be visible. Defaults to true.

var width

The width of the visualization. Defaults to 100%.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

WideBarStatCard

class WideBarStatCard(box: str, title: str, value: str, aux_value: str, progress: float, plot_color: Optional[str] = None, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a wide stat card displaying a primary value, an auxiliary value and a progress bar.

Static methods

load

def load(_WideBarStatCard__d:¬†Dict) ‚ÄĎ>¬†WideBarStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value displayed next to the primary value.

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var plot_color

The color of the progress bar.

var progress

The value of the progress bar, between 0 and 1.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

WideGaugeStatCard

class WideGaugeStatCard(box: str, title: str, value: str, aux_value: str, progress: float, plot_color: Optional[str] = None, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a wide stat card displaying a primary value, an auxiliary value and a progress gauge.

Static methods

load

def load(_WideGaugeStatCard__d:¬†Dict) ‚ÄĎ>¬†WideGaugeStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value displayed next to the primary value.

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var plot_color

The color of the progress gauge.

var progress

The value of the progress gauge, between 0 and 1.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

WideInfoCard

class WideInfoCard(box: str, title: str, caption: str, icon: Optional[str] = None, image: Optional[str] = None, category: Optional[str] = None, name: Optional[str] = None, color: Optional[str] = None, commands: Optional[List[Command]] = None)

Create a wide information card displaying a title, caption, and either an icon or image.

Static methods

load

def load(_WideInfoCard__d:¬†Dict) ‚ÄĎ>¬†WideInfoCard

Creates an instance of this class using the contents of a dict.

Instance variables

var box

A string indicating how to place this component on the page.

var caption

The card's caption, displayed below the title.

var category

The card's category, displayed above the title.

var color

The card's background color.

var commands

Contextual menu commands for this component.

var icon

The card's icon.

var image

The card’s image.

var name

An identifying name for this card. Makes the card clickable, similar to a button.

var title

The card's title.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

WideSeriesStatCard

class WideSeriesStatCard(box: str, title: str, value: str, aux_value: str, plot_data: Union[Data, str], plot_value: str, plot_zero_value: Optional[float] = None, plot_category: Optional[str] = None, plot_type: Optional[str] = None, plot_curve: Optional[str] = None, plot_color: Optional[str] = None, data: Union[dict, str, NoneType] = None, commands: Optional[List[Command]] = None)

Create a wide stat card displaying a primary value, an auxiliary value and a series plot.

Static methods

load

def load(_WideSeriesStatCard__d:¬†Dict) ‚ÄĎ>¬†WideSeriesStatCard

Creates an instance of this class using the contents of a dict.

Instance variables

var aux_value

The auxiliary value displayed below the primary value.

var box

A string indicating how to place this component on the page.

var commands

Contextual menu commands for this component.

var data

Data for this card.

var plot_category

The data field to use for x-axis values (ignored if plot_type is area; must be provided if plot_type is interval). Defaults to 'x'.

var plot_color

The plot's color.

var plot_curve

The plot's curve style. Defaults to linear. One of 'linear', 'smooth', 'step', 'step-after', 'step-before'. See enum h2o_wave.ui.WideSeriesStatCardPlotCurve.

var plot_data

The plot's data.

var plot_type

The type of plot. Defaults to area. One of 'area', 'interval'. See enum h2o_wave.ui.WideSeriesStatCardPlotType.

var plot_value

The data field to use for y-axis values.

var plot_zero_value

The base value to use for each y-axis mark. Set this to 0 if you want to pin the x-axis at y=0. If not provided, the minimum value from the data is used.

var title

The card's title.

var value

The primary value displayed.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

WideSeriesStatCardPlotCurve

class WideSeriesStatCardPlotCurve

Class variables

var LINEAR
var SMOOTH
var STEP
var STEP_AFTER
var STEP_BEFORE

WideSeriesStatCardPlotType

class WideSeriesStatCardPlotType

Class variables

var AREA
var INTERVAL

Zone

class Zone(name: str, size: Optional[str] = None, direction: Optional[str] = None, justify: Optional[str] = None, align: Optional[str] = None, wrap: Optional[str] = None, zones: Optional[List[ForwardRef('Zone')]] = None)

Represents an zone within a page layout.

Static methods

load

def load(_Zone__d:¬†Dict) ‚ÄĎ>¬†Zone

Creates an instance of this class using the contents of a dict.

Instance variables

var align

Layout strategy for cross axis. One of 'start', 'end', 'center', 'stretch'. See enum h2o_wave.ui.ZoneAlign.

var direction

Layout direction. One of 'row', 'column'. See enum h2o_wave.ui.ZoneDirection.

var justify

Layout strategy for main axis. One of 'start', 'end', 'center', 'between', 'around'. See enum h2o_wave.ui.ZoneJustify.

var name

An identifying name for this zone.

var size

The size of this zone.

var wrap

Wrapping strategy. One of 'start', 'end', 'center', 'between', 'around', 'stretch'. See enum h2o_wave.ui.ZoneWrap.

var zones

The sub-zones contained inside this zone.

Methods

dump

def dump(self) ‚ÄĎ>¬†Dict

Returns the contents of this object as a dict.

ZoneAlign

class ZoneAlign

Class variables

var CENTER
var END
var START
var STRETCH

ZoneDirection

class ZoneDirection

Class variables

var COLUMN
var ROW

ZoneJustify

class ZoneJustify

Class variables

var AROUND
var BETWEEN
var CENTER
var END
var START

ZoneWrap

class ZoneWrap

Class variables

var AROUND
var BETWEEN
var CENTER
var END
var START
var STRETCH