Module h2o_wave.types
Classes
Breadcrumb
Create a breadcrumb for a BreadcrumbsCard.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The label to display.
The name of this item. Prefix the name with a '#' to trigger hash-change navigation.
Methods
BreadcrumbsCard
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
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
A list of Breadcrumb instances to display. See breadcrumb()
Methods
Button
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
Creates an instance of this class using the contents of a dict.
Instance variables
The caption displayed below the label. Setting a caption renders a compound button.
True if the button should be disabled.
The text displayed on the button.
True if the button should be rendered as link text and not a standard button.
An identifying name for this component. If the name is prefixed with a '#', the button sets the location hash to the name when clicked.
True if the button should be rendered as the primary button in the set.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
A value for this button. If a value is set, it is used for the button's submitted instead of a boolean True.
True if the component should be visible. Defaults to true.
Methods
Buttons
Create a set of buttons laid out horizontally.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The button in this set.
Specifies how to lay out buttons horizontally. One of 'start', 'end', 'center', 'between', 'around'. See enum h2o_wave.ui.ButtonsJustify.
An identifying name for this component.
True if the component should be visible. Defaults to true.
Methods
CanvasCard
WARNING: Experimental and subject to change.
Create a card that displays a drawing canvas (whiteboard).
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The data for this card.
Canvas height, in pixels.
The title for this card.
Canvas width, in pixels.
Methods
ChatCard
WARNING: Experimental and subject to change.
Create a card that displays a chat room.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
The maximum number of messages contained in this card. Defaults to 50 messages.
Contextual menu commands for this component.
The data for this card.
The title for this card.
Methods
Checkbox
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if the checkbox is disabled.
True if the selection is indeterminate (neither selected nor unselected).
Text to be displayed alongside the checkbox.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the checkbox value changes.
True if selected, False if unselected.
True if the component should be visible. Defaults to true.
Methods
Checklist
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
Creates an instance of this class using the contents of a dict.
Instance variables
The choices to be presented.
Text to be displayed above the component.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the checklist value changes.
The names of the selected choices.
True if the component should be visible. Defaults to true.
Methods
Choice
Create a choice for a checklist, choice group or dropdown.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
True if the checkbox is disabled.
Text to be displayed alongside the component.
An identifying name for this component.
Methods
ChoiceGroup
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
Creates an instance of this class using the contents of a dict.
Instance variables
The choices to be presented.
Text to be displayed alongside the component.
An identifying name for this component.
True if this field is required.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the selection changes.
The name of the selected choice.
True if the component should be visible. Defaults to true.
Methods
ColorPicker
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
Creates an instance of this class using the contents of a dict.
Instance variables
A list of colors (CSS-compatible strings) to limit color choices to.
Text to be displayed alongside the component.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the color picker value changes.
The selected color (CSS-compatible string).
True if the component should be visible. Defaults to true.
Methods
Combobox
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
Creates an instance of this class using the contents of a dict.
Instance variables
The choices to be presented.
True if this field is disabled.
Text to be displayed as an error below the text box.
Text to be displayed alongside the component.
An identifying name for this component.
A string that provides a brief hint to the user as to what kind of information is expected in the field.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
The name of the selected choice.
True if the component should be visible. Defaults to true.
Methods
Command
Create a command.
Commands are typically displayed as context menu items or toolbar button.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The caption for this command (typically a tooltip).
DEPRECATED. Use value
instead. Data associated with this command, if any.
The icon to be displayed for this command.
Sub-commands, if any
The text displayed for this command.
An identifying name for this component. If the name is prefixed with a '#', the command sets the location hash to the name when executed.
Data associated with this command, if any.
Methods
Component
Create a component.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Button.
Button set.
Checkbox.
Checklist.
Choice group.
Color picker.
Combobox.
Date picker.
Dropdown.
Expander.
File upload.
Frame.
Inline components
Label.
Link.
Markup
Message bar.
Picker.
Progress bar.
Range Slider.
Separator.
Slider.
Spinbox.
Stats
Stepper.
Table.
Tabs.
Template
Text block.
Large sized text block.
Medium sized text block.
Small sized text block.
Extra-large sized text block.
Extra-small sized text block.
Textbox.
Toggle.
Vega-lite Visualization.
Visualization.
Methods
DatePicker
Create a date picker.
A date picker allows a user to pick a date value.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
True if this field is disabled.
Text to be displayed alongside the component.
An identifying name for this component.
A string that provides a brief hint to the user as to what kind of information is expected in the field.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the datepicker value changes.
The date value in YYYY-MM-DD format.
True if the component should be visible. Defaults to true.
Methods
Dialog
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
Creates an instance of this class using the contents of a dict.
Instance variables
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.
True if the dialog should have a closing 'X' button at the top right corner.
The components displayed in this dialog.
Dialog with large header banner, mutually exclusive with closable
prop. Defaults to false.
The dialog's title.
The width of the dialog, e.g. '400px', defaults to '600px'.
Methods
Dropdown
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
Creates an instance of this class using the contents of a dict.
Instance variables
The choices to be presented.
True if this field is disabled.
Text to be displayed alongside the component.
An identifying name for this component.
A string that provides a brief hint to the user as to what kind of information is expected in the field.
True if this is a required field.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the dropdown value changes.
The name of the selected choice.
The names of the selected choices. If this parameter is set, multiple selections will be allowed.
True if the component should be visible. Defaults to true.
Methods
EditorCard
WARNING: Experimental and subject to change.
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
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The editing mode. Defaults to public
. One of 'public', 'private'. See enum h2o_wave.ui.EditorCardMode.
Methods
Expander
Creates a new expander.
Expanders can be used to show or hide a group of related components.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
True if expanded, False if collapsed.
List of components to be hideable by the expander.
The text displayed on the expander.
An identifying name for this component.
True if the component should be visible. Defaults to true.
Methods
FileUpload
Create a file upload component. A file upload component allows a user to browse, select and upload one or more files.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
List of allowed file extensions, e.g. pdf
, docx
, etc.
The height of the file upload, e.g. '400px', '50%', etc.
Text to be displayed alongside the component.
Maximum allowed size (Mb) per file. Defaults to no limit.
Maximum allowed size (Mb) for all files combined. Defaults to no limit.
True if the component should allow multiple files to be uploaded.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the component should be visible. Defaults to true.
Methods
FlexCard
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
Creates an instance of this class using the contents of a dict.
Instance variables
Layout strategy for cross axis. One of 'start', 'end', 'center', 'baseline', 'stretch'. See enum h2o_wave.ui.FlexCardAlign.
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
Layout direction. One of 'horizontal', 'vertical'. See enum h2o_wave.ui.FlexCardDirection.
The child card properties.
The child card type.
Layout strategy for main axis. One of 'start', 'end', 'center', 'between', 'around'. See enum h2o_wave.ui.FlexCardJustify.
Wrapping strategy. One of 'start', 'end', 'center', 'between', 'around', 'stretch'. See enum h2o_wave.ui.FlexCardWrap.
Methods
FlexCardJustify
Class variables
FlexCardWrap
Class variables
FooterCard
Render a page footer displaying a caption. Footer cards are typically displayed at the bottom of a page.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
The caption. Supports markdown.
Contextual menu commands for this component.
Methods
FormCard
Create a form.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The components in this form.
The title for this card.
Methods
Frame
Create a new inline frame (an iframe
).
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The HTML content of the page. A string containing <html>...</html>
.
The height of the frame, e.g. 200px
, 50%
, etc. Defaults to 150px
.
An identifying name for this component.
The path or URL of the web page, e.g. /foo.html
or http://example.com/foo.html
True if the component should be visible. Defaults to true.
The width of the frame, e.g. 200px
, 50%
, etc. Defaults to 100%
.
Methods
FrameCard
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
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The HTML content of the page. A string containing <html>...</html>
.
The path or URL of the web page, e.g. /foo.html
or http://example.com/foo.html
.
The title for this card.
Methods
GraphicsCard
Create a card for displaying vector graphics.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The displayed height of the rectangular viewport. (Not the height of its coordinate system.)
Foreground layer for rendering dynamic SVG elements.
Background layer for rendering static SVG elements. Must be packed to conserve memory.
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
The displayed width of the rectangular viewport. (Not the width of its coordinate system.)
Methods
GridCard
EXPERIMENTAL. DO NOT USE.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
EXPERIMENTAL. DO NOT USE.
Contextual menu commands for this component.
EXPERIMENTAL. DO NOT USE.
EXPERIMENTAL. DO NOT USE.
Methods
HeaderCard
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
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The icon, displayed to the left.
The icon's color.
The navigation menu to display when the header's icon is clicked.
The subtitle, displayed below the title.
The title.
Methods
IconTableCellType
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
Creates an instance of this class using the contents of a dict.
Instance variables
Icon color.
An identifying name for this component.
Methods
ImageCard
Create a card that displays a base64-encoded image.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
Image data, base64-encoded.
The card's title.
The image MIME subtype. One of apng
, bmp
, gif
, x-icon
, jpeg
, png
, webp
.
Methods
Inline
Create an inline (horizontal) list of components.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Whether to display the components inset from the parent form, with a contrasting background.
The components laid out inline.
Specifies how to lay out the individual components. Defaults to 'start'. One of 'start', 'end'. See enum h2o_wave.ui.InlineJustify.
Methods
Label
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if the label should be disabled.
The text displayed on the label.
An identifying name for this component.
True if the field is required.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the component should be visible. Defaults to true.
Methods
LargeBarStatCard
Create a large captioned card displaying a primary value, an auxiliary value and a progress bar, with captions for each value.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value, typically a target value.
The caption displayed below the auxiliary value.
A string indicating how to place this component on the page.
The card's caption.
Contextual menu commands for this component.
Data for this card.
The color of the progress bar.
The value of the progress bar, between 0 and 1.
The card's title.
The primary value displayed.
The caption displayed below the primary value.
Methods
LargeStatCard
Create a stat card displaying a primary value, an auxiliary value and a caption.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value displayed next to the primary value.
A string indicating how to place this component on the page.
The caption displayed below the primary value.
Contextual menu commands for this component.
Data for this card.
The card's title.
The primary value displayed.
Methods
Layout
Represents the layout structure for a page.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
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.
The height of the layout. Defaults to auto
.
The maximum height of the layout.
The maximum width of the layout.
The minimum height of the layout.
The minimum width of the layout.
An identifying name for this zone.
The width of the layout. Defaults to 100%
.
The zones in this layout. Each zones can in turn contain sub-zones.
Methods
Link
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if the link should be rendered as a button.
True if the link should be disabled.
True if the link should be used for file download.
The text to be displayed. If blank, the path
is used as the label.
An identifying name for this component.
The path or URL to link to.
Where to display the link. Setting this to an empty string or '_blank'
opens the link in a new tab or window.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the component should be visible. Defaults to true.
Methods
ListCard
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
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
The child card properties.
The child card type.
The title for this card.
Methods
ListItem1Card
EXPERIMENTAL. DO NOT USE.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
EXPERIMENTAL. DO NOT USE.
A string indicating how to place this component on the page.
EXPERIMENTAL. DO NOT USE.
Contextual menu commands for this component.
EXPERIMENTAL. DO NOT USE.
EXPERIMENTAL. DO NOT USE.
EXPERIMENTAL. DO NOT USE.
Methods
Mark
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
Creates an instance of this class using the contents of a dict.
Instance variables
Mark color field or value.
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.
Mark color range for multi-series plots. A string containing space-separated colors, e.g. '#fee8c8 #fdbb84 #e34a33'
Coordinate system. rect
is synonymous to cartesian
. theta
is transposed polar
. One of 'rect', 'cartesian', 'polar', 'theta', 'helix'. See enum h2o_wave.ui.MarkCoord.
Curve type for line
and area
mark types. One of 'none', 'smooth', 'step-before', 'step', 'step-after'. See enum h2o_wave.ui.MarkCurve.
Field to dodge marks by, or 'auto' to infer.
Mark fill color.
Mark fill opacity.
Label field or value.
Label text alignment. One of 'left', 'right', 'center', 'start', 'end'. See enum h2o_wave.ui.MarkLabelAlign.
Label fill color.
Label fill opacity.
Label font size.
Label font weight.
Label line height.
Distance between label and mark.
Horizontal distance between label and mark.
Vertical distance between label and mark.
Strategy to use if labels overlap. One of 'hide', 'overlap', 'constrain'. See enum h2o_wave.ui.MarkLabelOverlap.
Label position relative to the mark. One of 'top', 'bottom', 'middle', 'left', 'right'. See enum h2o_wave.ui.MarkLabelPosition.
Label rotation angle, in degrees, or 'none' to disable automatic rotation. The default behavior is 'auto' for automatic rotation.
Label stroke color.
Label stroke opacity.
Label stroke size (line width or pen thickness).
Reference line stroke color.
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].
Reference line stroke opacity.
Reference line stroke size (line width or pen thickness).
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'.
Mark shape range for multi-series plots using point
mark types. A string containing space-separated shapes, e.g. 'circle square diamond'
Mark size field or value.
Mark size range. A string containing space-separated integers, e.g. '4 30'
Field to stack marks by, or 'auto' to infer.
Mark stroke color.
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].
Mark stroke opacity.
Mark stroke size.
Graphical geometry. One of 'interval', 'line', 'path', 'point', 'area', 'polygon', 'schema', 'edge', 'heatmap'. See enum h2o_wave.ui.MarkType.
X field or value.
X base field or value.
X bin lower bound field or value. For histograms.
X bin upper bound field or value. For histograms.
X axis scale maximum.
X axis scale minimum.
Whether to nice X axis scale ticks.
X axis scale type. One of 'linear', 'cat', 'category', 'identity', 'log', 'pow', 'power', 'time', 'time-category', 'quantize', 'quantile'. See enum h2o_wave.ui.MarkXScale.
X axis title.
Y field or value.
Y base field or value.
Y bin lower bound field or value. For histograms.
Y bin upper bound field or value. For histograms.
Y axis scale maximum.
Y axis scale minimum.
Whether to nice Y axis scale ticks.
Y axis scale type. One of 'linear', 'cat', 'category', 'identity', 'log', 'pow', 'power', 'time', 'time-category', 'quantize', 'quantile'. See enum h2o_wave.ui.MarkYScale.
Y axis title.
Methods
MarkLabelPosition
Class variables
MarkType
Class variables
MarkXScale
Class variables
MarkYScale
Class variables
MarkdownCard
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
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The markdown content. Supports Github Flavored Markdown (GFM): https://guides.github.com/features/mastering-markdown/
Additional data for the card.
The title for this card.
Methods
Markup
Render HTML content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The HTML content.
An identifying name for this component.
True if the component should be visible. Defaults to true.
Methods
MarkupCard
Render HTML content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The HTML content.
The title for this card.
Methods
MessageBar
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
Creates an instance of this class using the contents of a dict.
Instance variables
An identifying name for this component.
The text displayed on the message bar.
The icon and color of the message bar. One of 'info', 'error', 'warning', 'success', 'danger', 'blocked'. See enum h2o_wave.ui.MessageBarType.
True if the component should be visible. Defaults to true.
Methods
MessageBarType
Class variables
MetaCard
Represents page-global state.
This card is invisible. It is used to control attributes of the active page.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Display a dialog on the page.
Shortcut icon path. Preferably a .png
file (.ico
files may not work in mobile browsers). Not supported in Safari.
The layouts supported by this page.
Display a desktop notification.
Redirect the page to a new URL.
Refresh rate in seconds. A value of 0 turns off live-updates. Values != 0 are currently ignored (reserved for future use).
Specify the name of the theme (color scheme) to use on this page. One of 'light' or 'neon'.
The title of the page.
Configure a tracker for the page (for web analytics).
Methods
NavCard
Create a card containing a navigation pane.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The navigation groups contained in this pane.
The name of the active (highlighted) navigation item.
Methods
NavGroup
Create a group of navigation items.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Indicates whether nav groups should be rendered as collapsed initially
The navigation items contained in this group.
The label to display for this group.
Methods
NavItem
Create a navigation item.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
True if this item should be disabled.
An optional icon to display next to the label.
The label to display.
The name of this item. Prefix the name with a '#' to trigger hash-change navigation.
Methods
Picker
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
Creates an instance of this class using the contents of a dict.
Instance variables
The choices to be presented.
Controls whether the picker should be disabled or not.
Text to be displayed above the component.
Maximum number of selectable choices. Defaults to no limit.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the picker value changes.
The names of the selected choices.
True if the component should be visible. Defaults to true.
Methods
PixelArtCard
Create a card displaying a collaborative Pixel art tool, just for kicks.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The data for this card.
The title for this card.
Methods
Plot
Create a plot. A plot is composed of one or more graphical mark layers.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The graphical mark layers contained in this plot.
Methods
PlotCard
Create a card displaying a plot.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
The events to capture on this card.
The plot to be displayed in this card.
The title for this card.
Methods
Progress
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
Creates an instance of this class using the contents of a dict.
Instance variables
The text displayed below the bar.
The text displayed above the bar.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
The progress, between 0.0 and 1.0, or -1 (default) if indeterminate.
True if the component should be visible. Defaults to true.
Methods
ProgressTableCellType
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
Creates an instance of this class using the contents of a dict.
Instance variables
Color of the progress arc.
An identifying name for this component.
Methods
RangeSlider
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if this field is disabled.
Text to be displayed alongside the component.
The maximum value of the slider. Defaults to 100.
The upper bound of the selected range.
The minimum value of the slider. Defaults to 0.
The lower bound of the selected range.
An identifying name for this component.
The difference between two adjacent values of the slider.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the slider value changes.
True if the component should be visible. Defaults to true.
Methods
RepeatCard
EXPERIMENTAL. DO NOT USE. Create a card containing other cards.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
The child card properties.
EXPERIMENTAL. DO NOT USE.
Methods
SectionCard
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
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The components to display in this card
The subtitle, displayed below the title. Supports Markdown.
The title.
Methods
Separator
Create a separator.
A separator visually separates content into groups.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The text displayed on the separator.
An identifying name for this component.
True if the component should be visible. Defaults to true.
Methods
Slider
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if this field is disabled.
Text to be displayed alongside the component.
The maximum value of the slider.
The minimum value of the slider.
An identifying name for this component.
The difference between two adjacent values of the slider.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the slider value changes.
The current value of the slider.
True if the component should be visible. Defaults to true.
Methods
SmallSeriesStatCard
Create a small stat card displaying a primary value and a series plot.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
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'.
The plot's color.
The plot's curve style. Defaults to linear
. One of 'linear', 'smooth', 'step', 'step-after', 'step-before'. See enum h2o_wave.ui.SmallSeriesStatCardPlotCurve.
The plot's data.
The type of plot. Defaults to area
. One of 'area', 'interval'. See enum h2o_wave.ui.SmallSeriesStatCardPlotType.
The data field to use for y-axis values.
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.
The card's title.
The primary value displayed.
Methods
SmallSeriesStatCardPlotCurve
Class variables
SmallStatCard
Create a stat card displaying a single value.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
The card's title.
The primary value displayed.
Methods
Spinbox
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if this field is disabled.
Text to be displayed alongside the component.
The maximum value of the spinbox.
The minimum value of the spinbox.
An identifying name for this component.
The difference between two adjacent values of the spinbox.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
The current value of the spinbox.
True if the component should be visible. Defaults to true.
Methods
Stat
Create a stat (a label-value pair) for displaying a metric.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The caption displayed below the primary value.
An optional icon, displayed next to the label.
The color of the icon.
The label for the metric.
The value of the metric.
Methods
StatListCard
Render a card displaying a list of stats.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The individual stats to be displayed.
An optional name for this item.
The subtitle, displayed below the title.
The title.
Methods
StatListItem
Create a stat item (a label-value pair) for stat_list_card.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value, displayed below the primary value.
The caption for the metric, displayed below the label.
An optional icon, displayed next to the label.
The color of the icon.
The label for the metric.
An optional name for this item (required only if this item is clickable).
The primary value of the metric.
The font color of the primary value.
Methods
StatTableCard
Render a card displaying a table of stats.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
The names of this table's columns.
Contextual menu commands for this component.
The rows displayed in this table.
An optional name for this item.
The subtitle, displayed below the title.
The title.
Methods
StatTableItem
Create a stat item (a label and a set of values) for stat_table_card.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The caption for the metric, displayed below the label.
An optional icon, displayed next to the label.
The color of the icon.
The label for the row.
An optional name for this row (required only if this row is clickable).
The values displayed in the row.
Methods
Stats
Create a set of stats laid out horizontally.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Whether to display the stats with a contrasting background.
The individual stats to be displayed.
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
Step
Create a step for a stepper.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Indicates whether this step has already been completed.
Icon to be displayed.
Text displayed below icon.
Methods
Stepper
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
Creates an instance of this class using the contents of a dict.
Instance variables
The sequence of steps to be displayed.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the component should be visible. Defaults to true.
Methods
Tab
Create a tab.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The icon displayed on the tab.
The text displayed on the tab.
An identifying name for this component.
Methods
TabCard
Create a card containing tabs for navigation.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The tabs to display in this card
True if tabs should be rendered as links instead of buttons.
An optional name for the card. If provided, the selected tab can be accessed using the name of the card.
The name of the tab to select.
Methods
Table
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
Creates an instance of this class using the contents of a dict.
Instance variables
The columns in this table.
Indicates whether the contents of this table can be downloaded and saved as a CSV file. Defaults to False.
True to allow group by feature.
The height of the table, e.g. '400px', '50%', etc.
True to allow multiple rows to be selected.
An identifying name for this component.
Indicates whether a Reset button should be displayed to reset search / filter / group-by values to their defaults. Defaults to False.
The rows in this table.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
The names of the selected rows. If this parameter is set, multiple selections will be allowed (multiple
is assumed to be True
).
True if the component should be visible. Defaults to true.
Methods
TableCellType
Defines cell content to be rendered instead of a simple text.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
No documentation available.
No documentation available.
Methods
TableColumn
Create a table column.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Defines how to render each cell in this column. Defaults to plain text.
Defines the data type of this column. Defaults to string
. One of 'string', 'number', 'time'. See enum h2o_wave.ui.TableColumnDataType.
Indicates whether the contents of this column are displayed as filters in a dropdown.
The text displayed on the column header.
Indicates whether each cell in this column should be displayed as a clickable link.
The maximum width of this column, e.g. '100px'. Only px
units are supported at this time.
The minimum width of this column, e.g. '50px'. Only px
units are supported at this time.
An identifying name for this column.
Indicates whether the contents of this column can be searched through. Enables a search box for the table if true.
Indicates whether the column is sortable.
Methods
TableRow
Create a table row.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The cells in this row (displayed left to right).
An identifying name for this row.
Methods
Tabs
Create a tab bar.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The tabs in this tab bar.
True if tabs should be rendered as links instead of buttons.
An identifying name for this component.
The name of the tab to select.
True if the component should be visible. Defaults to true.
Methods
TallGaugeStatCard
Create a tall stat card displaying a primary value, an auxiliary value and a progress gauge.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value displayed next to the primary value.
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
The color of the progress gauge.
The value of the progress gauge, between 0 and 1.
The card's title.
The primary value displayed.
Methods
TallSeriesStatCard
Create a tall stat card displaying a primary value, an auxiliary value and a series plot.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value displayed below the primary value.
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
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'.
The plot's color.
The plot's curve style. Defaults to linear
. One of 'linear', 'smooth', 'step', 'step-after', 'step-before'. See enum h2o_wave.ui.TallSeriesStatCardPlotCurve.
The plot's data.
The type of plot. Defaults to area
. One of 'area', 'interval'. See enum h2o_wave.ui.TallSeriesStatCardPlotType.
The data field to use for y-axis values.
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.
The card's title.
The primary value displayed.
Methods
TallSeriesStatCardPlotCurve
Class variables
Template
Render dynamic content using an HTML template.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The Handlebars template. https://handlebarsjs.com/guide/
Data for the Handlebars template
An identifying name for this component.
True if the component should be visible. Defaults to true.
Methods
TemplateCard
Render dynamic content using an HTML template.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
The Handlebars template. https://handlebarsjs.com/guide/
Data for the Handlebars template.
The title for this card.
Methods
Text
Create text content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The text content.
An identifying name for this component.
The font size of the text content. One of 'xl', 'l', 'm', 's', 'xs'. See enum h2o_wave.ui.TextSize.
Tooltip message.
True if the component should be visible. Defaults to true.
Methods
TextL
Create large sized text content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Contextual menu commands for this component.
The text content.
An identifying name for this component.
Tooltip message.
True if the component should be visible. Defaults to true.
Methods
TextM
Create medium sized text content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The text content.
An identifying name for this component.
Tooltip message.
True if the component should be visible. Defaults to true.
Methods
TextS
Create small sized text content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The text content.
An identifying name for this component.
Tooltip message.
True if the component should be visible. Defaults to true.
Methods
TextXl
Create extra-large sized text content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Contextual menu commands for this component.
The text content.
An identifying name for this component.
Tooltip message.
True if the component should be visible. Defaults to true.
Methods
TextXs
Create extra-small sized text content.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The text content.
An identifying name for this component.
Tooltip message.
True if the component should be visible. Defaults to true.
Methods
Textbox
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if the text box is disabled.
Text to be displayed as an error below the text box.
The height of the text box, e.g. '100px'. Applicable only if multiline
is true.
Icon displayed in the far right end of the text field.
The text displayed above the field.
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].
True if the text box should allow multi-line text entry.
An identifying name for this component.
True if the text box should hide text content.
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.
Text to be displayed before the text box contents.
True if the text box is a read-only field.
True if the text box is a required field.
Text to be displayed after the text box contents.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the text value changes.
Text to be displayed inside the text box.
True if the component should be visible. Defaults to true.
Methods
Toggle
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
Creates an instance of this class using the contents of a dict.
Instance variables
True if the checkbox is disabled.
Text to be displayed alongside the component.
An identifying name for this component.
An optional tooltip message displayed when a user clicks the help icon to the right of the component.
True if the form should be submitted when the toggle value changes.
True if selected, False if unselected.
True if the component should be visible. Defaults to true.
Methods
ToolbarCard
Create a card containing a toolbar.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Items to render.
Items to render in an overflow menu.
Items to render on the right side (or left, in RTL).
Methods
Tracker
Configure user interaction tracking (analytics) for a page.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The tracking ID or measurement ID.
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
VegaCard
Create a card containing a Vega-lite plot.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for the plot, if any.
The Vega-lite specification.
The title of this card.
Methods
VegaVisualization
Create a Vega-lite plot for display inside a form.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Data for the plot, if any.
The height of the visualization. Defaults to 300px.
An identifying name for this component.
The Vega-lite specification.
True if the component should be visible. Defaults to true.
The width of the visualization. Defaults to 100%.
Methods
Visualization
Create a visualization for display inside a form.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Data for this visualization.
The events to capture on this visualization.
The hight of the visualization. Defaults to 300px.
An identifying name for this component.
The plot to be rendered in this visualization.
True if the component should be visible. Defaults to true.
The width of the visualization. Defaults to 100%.
Methods
WideBarStatCard
Create a wide stat card displaying a primary value, an auxiliary value and a progress bar.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value displayed next to the primary value.
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
The color of the progress bar.
The value of the progress bar, between 0 and 1.
The card's title.
The primary value displayed.
Methods
WideGaugeStatCard
Create a wide stat card displaying a primary value, an auxiliary value and a progress gauge.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value displayed next to the primary value.
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
The color of the progress gauge.
The value of the progress gauge, between 0 and 1.
The card's title.
The primary value displayed.
Methods
WideSeriesStatCard
Create a wide stat card displaying a primary value, an auxiliary value and a series plot.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
The auxiliary value displayed below the primary value.
A string indicating how to place this component on the page.
Contextual menu commands for this component.
Data for this card.
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'.
The plot's color.
The plot's curve style. Defaults to linear
. One of 'linear', 'smooth', 'step', 'step-after', 'step-before'. See enum h2o_wave.ui.WideSeriesStatCardPlotCurve.
The plot's data.
The type of plot. Defaults to area
. One of 'area', 'interval'. See enum h2o_wave.ui.WideSeriesStatCardPlotType.
The data field to use for y-axis values.
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.
The card's title.
The primary value displayed.
Methods
WideSeriesStatCardPlotCurve
Class variables
Zone
Represents an zone within a page layout.
Static methods
load
Creates an instance of this class using the contents of a dict.
Instance variables
Layout strategy for cross axis. One of 'start', 'end', 'center', 'stretch'. See enum h2o_wave.ui.ZoneAlign.
Layout direction. One of 'row', 'column'. See enum h2o_wave.ui.ZoneDirection.
Layout strategy for main axis. One of 'start', 'end', 'center', 'between', 'around'. See enum h2o_wave.ui.ZoneJustify.
An identifying name for this zone.
The size of this zone.
Wrapping strategy. One of 'start', 'end', 'center', 'between', 'around', 'stretch'. See enum h2o_wave.ui.ZoneWrap.
The sub-zones contained inside this zone.