Basic

The following methods apply to all elements including the root awe.Page element.

In addition to the arguments documented below, every new_XXX method accepts these optional arguments:

• id Override the generated element id. Useful with the @inject decorator.
• props Pass additional props to the underlying react component.
• style Override default element style with a javascript style object.
• updater Accepts a callable, generator, async def and async generator. If passed, will be invoked asynchronously with the created element as its single argument. It may be long running. A convenient way of updating elements in the background.

class awe.view.Element

new_grid(columns, **kwargs)

Add a grid child.

Grid children created with new_XXX methods can provide an additional cols argument which defaults to 1. Element flow is left, right, top, down.

Parameters:columns – Number of columns for the grid. Returns:The created grid element.

new_tabs(**kwargs)

Add a tabs child.

The only valid new_XXX method on tabs is new_tab.

Returns:The created tabs element.

new_table(headers, page_size=None, **kwargs)

Add a table child.

Parameters:

• headers – list of string headers or dict, in which case, it’s keys are used.
• page_size – Optionally, enable table pagination by specifying a page size.

Returns:

The created table element.

new_button(function, text='', icon=None, shape=None, type='default', block=False, **kwargs)

Add a button child.

Most properties here are passed as is to the underlying ant-design button component, so refer to its documentation for more information.

https://ant.design/components/button

Parameters:

• function – The python function that should be invoked then the button is clicked.
• text – Option text for the button, the function name is used by default (unless shape is supplied).
• icon – See ant design icon documentation.
• type – Any of: default (which is the default), primary, ghost, dashed, danger.
• shape – Optionally pass circle for a circle shaped button.
• block – Pass True to make the button fit the full width of its parent element.

Returns:

The created button element.

new_input(placeholder=None, on_enter=None, **kwargs)

Add an input child.

Parameters:

• placeholder – Optional placeholder text for the input.
• on_enter – Option function to be called when enter is pressed in the input.

Returns:

The created input element.

new_card(text='', **kwargs)

Add a card child.

A card is a small padded box.

Parameters:text – Optional text for the card. Otherwise, use new_XXX methods as usual. Returns:The created card element.

new_text(text='', **kwargs)

Add a text child.

Parameters:text – Optional text, otherwise, interpreted as line break. \n will be interpreted correctly. Returns:The created text element.

new_divider(**kwargs)

Add a divider child.

A divider is a simple horizontal separator.

Returns:The created divider element.

new_collapse(**kwargs)

Add a collapse child.

The only valid new_XXX method on collapse is new_panel.

Returns:The created collapse element.

new_chart(data=None, options=None, transform=None, moving_window=None, **kwargs)

Add a chart child.

Parameters:

• data – A list of data items. Each data item is expected to match the format the transformer expects. A data item may also be supplied in the form of a 2-tuple (time, data), in which case, the first item is the epoch time in seconds with ms precision and the second item is the data item itself.
• options – Optional highcharts options object.
• transform – A transformer for the supplied data which transforms the data into suitable highcharts charts and series definitions. Can be either a transformer object, a dict with transformer configuration or a string specifying the transformer name.
• moving_window – Optional moving window size in seconds. If specified, chart will maintain this window size.

Returns:

The created chart element.

new_icon(type, theme='outlined', spin=False, two_tone_color=None, **kwargs)

Add a new icon element.

Most properties here are passed as is to the underlying ant-design icon component, so refer to its documentation for more information.

https://ant.design/components/icon

Parameters:

• type – The icon type. See ant design icon documentation.
• theme – Any of: outlined (the default), filled, twoTone
• spin – Pass True to make the icon spin.
• two_tone_color – When theme is twoTone, a CSS style color for the main color of the icon.

Returns:

The created icon element.

new_inline(text='', **kwargs)

Add a new inline element.

Useful in combination with icons. As opposed to new_text, new_inline doesn’t take up a full line when added (a span is used internally).

Parameters:text – Optional text for the inline. Inline can also be a container element. Returns:The created inline element.

new_link(link, **kwargs)

Add a new link element.

Parameters:link – The link (URL) Returns:The created link element.

new_markdown(source, **kwargs)

Add a new markdown element.

Parameters:source – The markdown source. Returns:The created markdown element.

new_prop(prop, root=None)

Create a new element based prop.

Mostly used by element implementations but can be used for some low level updates.

Normally, the regular props field is used to pass basic data structures to the underlying react components. Sometimes however, the underlying react component prop accepts a ReactNode as the prop value. In these cases, using new_prop will create a new “root” element, similar to Page. Use the standard new_XXX methods on it to create the element hierarchy that will be passed to the underlying react component prop.

Note that a prop named PROP_NAME can only be created if it doesn’t already exist in props and was not created with a previous new_prop call.

Parameters:

• prop – The prop name.
• root – Optionally, use a root element built using the element builder

Returns:

The created element based prop.

new(obj, **kwargs)

This method can return different results depending on obj type.

If obj is a class that inherits from Element, a new element of that type will be created. If obj is a dict or list, it will be parsed and the parser result will be created. If obj is a string, it will be yaml loaded and that result will be passed to the parser.

When result is passed to the parser, an additional inputs argument can be supplied as a dict from keys to values that are referenced in the DSL using the $ intrinsic function.

Parameters:

• obj – The Element subclass, a dict/list or a string to be passed to the parser.
• kwargs – Arguments that should be passed to the _init method of the created element or one of props, style, id, inputs if valid.

Returns:

The created element.

register(custom_element_cls)

Register a new custom element.

Not that there is not need to explicitly call this method. When creating a new custom element, the element will be registered for you if it isn’t already registered.

Parameters:custom_element_cls – A subclass of CustomElement.

remove(element=None)

Remove an element from the page.

Parameters:element – If supplied, remove the supplied element, otherwise, remove self.

update_data(data)

Update element data.

Mostly used by element implementations but can be used for some low level updates.

Parameters:data – The data to update.

update_props(props, override=True)

Update element props (underlying react component props).

Mostly used by element implementations but can be used for some low level updates.

Parameters:

• props – The props to update.
• override – Should the supplied props override existing props. (default: True)

update_prop(path, value)

Update a prop inner value.

Mostly used by element implementations but can be used for some low level updates.

Parameters:

• path – The nested path of the prop. If the prop is named A then reaching A.b.c would be ['A', 'b', 'c'].
• value – The value to set in the nested prop path.

update_element(path, action, data)

Very low level method that dispatches an updateElement action to the react application running the page. Usually preceded by an internal element data update.

s

Push current element to stack and return self.

Returns:self.

p

Pop an element from the stack.

Returns:The popped element.

n

Return the top most stack element.

Returns:The last stacked element or the current root element if none was stacked.