Create a new ‘Button’ object

Base class: anvil.Component

Constructor

Button Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Button Properties

align - enum: "left", "right", "center"

The position of this component in the available space.

appearance - enum: "filled", "elevated", "tonal", "outlined", "text"

A predefined style for this component.

background_color - color

The colour of the background of this component.

bold - boolean

If True, this component’s text will be bold.

border - string

The border of this component. Can take any valid CSS border value.

enabled - boolean

If True, this component allows user interaction.

font_family - string

The font family to use for this component.

font_size - number

The font size of the text displayed on this component.

icon - enum:

The icon to display on this component.

icon_align - enum: "left", "right"

The alignment of the icon on this component.

icon_color - color

The colour of the icon displayed on this component.

icon_size - number

The size (pixels) of the icon displayed on this component.

italic - boolean

If True, this component’s text will be italic.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component

text_color - color

The colour of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

visible - boolean

If True, the component will be displayed.

Button Events

click()

When the component is clicked.

Create a new ‘ButtonMenu’ object

Base class: anvil.Component

Constructor

ButtonMenu Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

ButtonMenu Properties

align - enum: "left", "right", "center"

The position of this component in the available space.

appearance - enum: "filled", "elevated", "tonal", "outlined", "text"

A predefined style for the Button.

bold - boolean

If True, the Button’s text will be bold.

button_background_color - color

The colour of the background of the Button.

button_border - string

The border of the Button. Can take any valid CSS border value.

button_font_family - string

The font family to use for the Button

button_font_size - number

The font size of the text displayed on the Button.

button_text_color - color

The colour of the text on the Button.

enabled - boolean

If True, this component allows user interaction.

icon - enum:

The icon to display on the Button.

icon_color - color

The colour of the icon displayed on the Button.

icon_position - enum: "left", "right"

The alignment of the icon on this component.

icon_size - number

The size (pixels) of the icon displayed on this component.

italic - boolean

If True, the Button’s text will be italic.

menu_background_color - color

The colour of the menu.

menu_border - color

The border of the menu. Can take any valid CSS border value.

menu_items - object

A list of components to be added to the menu.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on the Button

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, the Button’s text will be underlined.

visible - boolean

If True, the component will be displayed.

ButtonMenu Events

click()

When the Button is clicked.

Create a new ‘Card’ object

Base class: anvil.Component

Constructor

Card Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Card Properties

align - enum:

The position of this component in the available space.

appearance - enum: "elevated", "filled", "outlined"

A predefined style for this component.

background_color - color

The color of the background of this component.

border - string

The border of this component. Can take any valid CSS border value.

orientation - enum: "column", "row"

The orientation of the content in this Card

parent

role - themeRole

A style for this component defined in CSS and added to Roles

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

visible - boolean

If True, the component will be displayed.

Create a new ‘Checkbox’ object

Base class: anvil.Component

Constructor

Checkbox Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

focus()

Set the keyboard focus to this Checkbox.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Checkbox Properties

align - enum:

The position of this component in the available space.

allow_indeterminate - boolean

If True, supports an indeterminate state. The indeterminate state can only be set in code by setting checked=None.

background_color - color

The color of the background of this component.

bold - boolean

If True, this component’s text will be bold.

border - string

The border of this component. Can take any valid CSS border value.

checkbox_color - color

The color of the checkbox.

checked - boolean

If True, the checkbox is checked.

enabled - boolean

If True, this component allows user interaction.

error - boolean

If True, the checkbox is in an error state.

font_family - string

The font family to use for this component.

font_size - number

The font size of text displayed on this component.

italic - boolean

If True, this component’s text will be italic.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component

text_color - color

The color of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

visible - boolean

If True, the component will be displayed.

Checkbox Events

change()

When the Checkbox is checked or unchecked.

show()

When the Checkbox is shown on the screen.

hide()

When the Checkbox is removed from the screen.

Create a new ‘CircularProgressIndicator’ object

Base class: anvil.Component

Constructor

CircularProgressIndicator Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

CircularProgressIndicator Properties

color - color

The colour of the progress bar

margin - margin

The margin (pixels) of the component.

parent

progress - number

The progress of the CircularProgressIndicator.

role - themeRole

A style for this component defined in CSS and added to Roles

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

type - enum: "determinate", "indeterminate"

Display a determinate or indeterminate progress indicator. Use determinate to set the progress with the progress property. Use indeterminate to express an unspecified amount of wait time.

visible - boolean

If True, the component will be displayed.

Create a new ‘Divider’ object

Base class: anvil.Component

Constructor

Divider Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Divider Properties

color - color

The colour of this component.

margin - margin

The margin (pixels) of the component.

parent

role - themeRole

A style for this component defined in CSS and added to Roles.

type - enum: "full_width", "inset"

Display the Divider across the full width of the container or inset.

visible - boolean

If True, the component will be displayed.

Divider Events

show()

When the Divider is shown on the screen.

hide()

When the Divider is removed from the screen.

Create a new ‘DropdownMenu’ object

Base class: anvil.Component

Constructor

DropdownMenu Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

DropdownMenu Properties

align - enum: "left", "right", "center"

The position of this component in the available space.

allow_none - boolean

If True, a placeholder item is added to the menu with value None

appearance - enum: "filled", "outlined"

A predefined style for this component.

background_color - color

The colour of the background of this component.

border_color - color

The colour of the border of this component.

enabled - boolean

If True, this component allows user interaction.

error - boolean

If True, this component is in an error state.

items - string list

The items to display in the menu.

items_bold - boolean

If True, the menu items will be bold.

items_font_family - string

The font family to use for the menu items.

items_font_size - number

The font size of the menu items.

items_italic - boolean

If True, the menu items will be italic.

items_text_color - color

The colour of the menu items’ text.

items_underline - boolean

If True, the menu items will be underlined.

label - string

The label text of the component.

label_bold - boolean

If True, the label text will be bold.

label_color - color

The colour of the label text on the component.

label_font_family - string

The font family to use for the label this component.

label_font_size - number

The font size of the label text on this component.

label_italic - boolean

If True, the label text will be italic.

label_underline - boolean

If True, the label text will be underlined.

leading_icon - enum:

The leading icon to display on this component.

leading_icon_color - color

The colour of the leading icon displayed on this component.

menu_background_color - color

The background color of the menu.

parent

placeholder - string

The text to be displayed when the component is empty

role - themeRole

A style for this component defined in CSS and added to Roles

selected_bold - boolean

If True and there is a selected item, the displayed text is bold.

selected_font_family - string

The font-family of the displayed text if there is a selected item.

selected_font_size - number

The font size (pixels) of the displayed text if there is a selected item.

selected_italic - boolean

If True and there is a selected item, the displayed text in italic.

selected_text_color - color

The colour of the displayed text if there is a selected item.

selected_underline - boolean

If True and there is a selected item, the displayed text is underlined

selected_value - object

The value of the currently selected item. Can only be set at runtime.

spacing - spacing

The margin and padding (pixels) of the component.

supporting_text - string

The supporting text displayed below this component

supporting_text_color - color

The colour of the supporting text below this component.

supporting_text_font_family - color

The font family to use for the supporting text below this component.

supporting_text_font_size - color

The font size of the supporting text displayed below this component.

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

visible - boolean

If True, the component will be displayed.

DropdownMenu Events

change()

When an item is selected.

Create a new ‘FileLoader’ object

Base class: anvil.Component

Constructor

FileLoader Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

clear()

Clear any selected files from this FileLoader.

focus()

Set the keyboard focus to this FileLoader.

open_file_selector()

Open the file selector from code, this should be called within a click event handler for another component.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

FileLoader Properties

align - enum: "left", "center", "right"

The position of this component in the available space.

appearance - enum: "text", "filled", "elevated", "tonal", "outlined"

A predefined style for this component.

background_color - color

The color of the background of this component.

bold - boolean

If True, this component’s text will be bold.

border - string

The border of this component. Can take any valid CSS border value.

enabled - boolean

If True, this component allows user interaction.

file - object

The currently selected file (or the first, if multiple files are selected). This is a Media object.

file_types - string

Specify what type of file to upload. Can accept a MIME type (eg ‘image/png’ or ‘image/*’), an extension (eg ‘.png’), or a comma-separated set of them (eg ‘.png,.jpg,.jpeg’).

font_family - string

The font family to use for this component.

font_size - number

The font size of text displayed on this component.

icon - enum:

The icon to display on this component.

icon_color - color

The color of the icon displayed on this component.

icon_size - number

The size (pixels) of the icon displayed on this component.

italic - boolean

If True, this component’s text will be italic.

multiple - boolean

If True, this FileLoader can load multiple files at the same time.

parent

role - themeRole

A style for this component defined in CSS and added to Roles.

show_state - boolean

If True, display a message indicating the number of selected files.

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component

text_color - color

The color of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

visible - boolean

If True, the component will be displayed.

FileLoader Events

change(file, files)

When a new file is loaded into this FileLoader.

• file - The first selected file. Set the 'multiple' property to allow loading more than one file.
• files - A list of loaded files. Set the 'multiple' property to allow loading more than one file.

show()

When the FileLoader is shown on the screen.

hide()

When the FileLoader is removed from the screen.

focus()

When the FileLoader gets focus.

lost_focus()

When the FileLoader loses focus.

Create a new ‘Heading’ object

Base class: anvil.Component

Constructor

Heading Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Heading Properties

align - enum: "left", "right", "center", "justify"

The position of this component in the available space.

background_color - color

The color of the background of this component.

bold - boolean

If True, this component’s text will be bold.

border - string

The border of this component. Can take any valid CSS border value.

font_family - string

The font family to use for this component.

font_size - number

The font size of text displayed on this component.

icon - enum:

The icon to display on this component.

icon_color - color

The color of the icon displayed on this component.

icon_size - number

The size (pixels) of the icon displayed on this component.

italic - boolean

If True, this component’s text will be italic.

line_height - string

The line height of this component.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

scale - enum: "small", "medium", "large"

The size of the heading component.

spacing - spacing

The margin and padding (pixels) of the component.

style - enum: "display", "headline", "title"

Role of the heading component: display, headline or title.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component

text_color - color

The color of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

visible - boolean

If True, the component will be displayed.

Heading Events

show()

When the Heading is shown on the screen.

hide()

When the Heading is removed from the screen.

Create a new ‘IconButton’ object

Base class: anvil.Component

Constructor

IconButton Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

IconButton Properties

align - enum:

The position of this component in the available space.

appearance - enum: "standard", "filled", "tonal", "outlined"

A predefined style for this component.

background_color - color

The colour of the background of this component.

border - string

The border of this component. Can take any valid CSS border value.

enabled - boolean

If True, this component allows user interaction.

icon - enum:

The icon to display on this component.

icon_color - color

The colour of the icon displayed on this component.

margin - margin

The margin (pixels) of the component.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

visible - boolean

If True, the component will be displayed.

IconButton Events

click()

When the component is clicked.

Create a new ‘InteractiveCard’ object

Base class: anvil.Component

Constructor

InteractiveCard Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

InteractiveCard Properties

align - enum:

The position of this component in the available space.

appearance - enum: "elevated", "filled", "outlined"

A predefined style for this component.

background_color - color

The color of the background of this component.

border - string

The border of this component. Can take any valid CSS border value.

enabled - boolean

If True, this component allows user interaction.

orientation - enum: "column", "row"

The orientation of the content in this Card

parent

role - themeRole

A style for this component defined in CSS and added to Roles

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

visible - boolean

If True, the component will be displayed.

InteractiveCard Events

click()

When the component is clicked.

Create a new ‘LinearProgressIndicator’ object

Base class: anvil.Component

Constructor

LinearProgressIndicator Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

LinearProgressIndicator Properties

margin - margin

The margin (pixels) of the component.

parent

progress - number

The progress of the LinearProgressIndicator.

progress_color - color

The colour of the progress bar

role - themeRole

A style for this component defined in CSS and added to Roles

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

track_color - color

The colour of the LinearProgressIndicator track.

type - enum: "determinate", "indeterminate"

Display a determinate or indeterminate progress indicator. Use determinate to set the progress with the progress property. Use indeterminate to express an unspecified amount of wait time.

visible - boolean

If True, the component will be displayed.

Create a new ‘Link’ object

Base class: anvil.Component

Constructor

Link Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Link Properties

align - enum: "left", "center", "right"

The position of this component in the available space.

background_color - color

The color of the background of this component.

bold - boolean

If True, this component’s text will be bold.

border - string

The border of this component. Can take any valid CSS border value.

font_family - string

The font family to use for this component.

font_size - number

The font size of text displayed on this component.

icon - enum:

The icon to display on this component.

icon_color - color

The color of the icon displayed on this component.

icon_size - number

The size (pixels) of the icon displayed on this component.

italic - boolean

If True, this component’s text will be italic.

parent

role - themeRole

A style for this component defined in CSS and added to Roles.

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component.

text_color - color

The color of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

url - string

TThe target URL of the link. Can be set to a URL string or to a Media object.

visible - boolean

If True, the component will be displayed.

Link Events

click()

When the Link is clicked.

show()

When the Link is shown on the screen.

hide()

When the Link is removed from the screen.

Create a new ‘MenuItem’ object

Base class: anvil.Component

Constructor

MenuItem Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

MenuItem Properties

add_icon_space - boolean

If True, add a space where the leading_icon would be so that this MenuItem is aligned with MenuItems with leading_icons.

background_color - color

The background colour of this component.

bold - boolean

If True, the text will be bold.

enabled - boolean

If True, this component allows user interaction.

font_family - string

The font family to use for this component.

font_size - number

The font size of the text displayed on this component.

italic - boolean

If True, the text will be italic.

leading_icon - enum:

The icon to display on this component.

leading_icon_color - color

The colour of the leading icon displayed on this component.

leading_icon_size - number

The size (pixels) of the leading icon displayed on this component.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component.

text_color - color

The colour of the text on this component.

tooltip - string

The text to display when the mouse is hovered over this component.

trailing_icon - enum:

The icon to display on this component.

trailing_icon_color - color

The colour of the tailing icon displayed on this component.

trailing_icon_size - number

The size (pixels) of the trailing icon displayed on this component.

trailing_text - string

The text to be displayed on the right side of the component. Will be to the left of the trailing icon if both exist.

underline - boolean

If True, the text will be underlined.

visible - boolean

If True, the component will be displayed.

MenuItem Events

click()

When the component is clicked.

Create a new ‘NavigationDrawerLayout’ object

Base class: anvil.Component

Constructor

NavigationDrawerLayout Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

NavigationDrawerLayout Properties

background_color - color

The background color of Forms using this Layout.

content_padding - padding

The padding (pixels) around the content of the page.

navigation_drawer_color - color

The color of the navigation drawer on Forms using this Layout.

parent

show_sidesheet - boolean

If True, the sidesheet will be shown on Forms using this Layout.

text_color - color

The default color of the text on Forms using this Layout.

NavigationDrawerLayout Events

show()

When the Form is shown on the screen.

hide()

When the Form is removed from the screen.

refreshing_data_bindings()

When refresh_data_bindings is called.

Create a new ‘NavigationLink’ object

Base class: anvil.Component

Constructor

NavigationLink Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

NavigationLink Properties

background_color - color

The color of the background of this component.

badge - boolean

If True, display a notification badge on the icon.

badge_count - number

The number to display on the badge.

bold - boolean

If True, this component’s text will be bold.

font_family - string

The font family to use for this component.

font_size - number

The font size of text displayed on this component.

icon - enum:

The icon to display on this component.

icon_color - color

The color of the icon displayed on this component.

icon_size - number

The size (pixels) of the icon displayed on this component.

italic - boolean

If True, this component’s text will be italic.

navigate_to - form

The Form to navigate to when the link is clicked.

parent

role - themeRole

A style for this component defined in CSS and added to Roles.

selected - boolean

If True, the component is in the selected state.

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component.

text_color - color

The color of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

url - string

TThe target URL of the link. Can be set to a URL string or to a Media object.

visible - boolean

If True, the component will be displayed.

NavigationLink Events

click()

When the NavigationLink is clicked.

show()

When the NavigationLink is shown on the screen.

hide()

When the NavigationLink is removed from the screen.

Create a new ‘NavigationRailLayout’ object

Base class: anvil.Component

Constructor

NavigationRailLayout Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

add_to_nav_rail()

Add components to the navigation rail.

hide_nav_drawer()

Hide the navigation drawer.

open_nav_drawer()

Open the navigation drawer.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

NavigationRailLayout Properties

background_color - color

The background color of Forms using this Layout.

content_padding - padding

The padding (pixels) around the content of the page.

navigation_rail_collapse_to - enum: "bottom_app_bar", "modal_navigation_drawer"

The way the side navigation will collapse on mobile.

navigation_rail_color - color

The color of the navigation rail on Forms using this Layout.

navigation_rail_vertical_align - enum: "top", "center", "bottom"

The vertical position of the content in the navigation rail.

parent

show_sidesheet - boolean

If True, the sidesheet will be shown on Forms using this Layout.

text_color - color

The default color of the text on Forms using this Layout.

NavigationRailLayout Events

show()

When the Form is shown on the screen.

hide()

When the Form is removed from the screen.

refreshing_data_bindings()

When refresh_data_bindings is called.

Create a new ‘RadioButton’ object

Base class: anvil.Component

Constructor

RadioButton Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

RadioButton Properties

align - enum:

The position of this component in the available space.

background_color - color

The color of the background of this component.

bold - boolean

If True, this component’s text will be bold.

border - string

The border of this component. Can take any valid CSS border value.

enabled - boolean

If True, this component allows user interaction.

font_family - string

The font family to use for this component.

font_size - number

The font size of text displayed on this component.

italic - boolean

If True, this component’s text will be italic.

parent

radio_color - color

The color of the radio button.

role - themeRole

A style for this component defined in CSS and added to Roles

selected - boolean

If True, the radio button is selected.

spacing - spacing

The margin and padding (pixels) of the component.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component

text_color - color

The color of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

visible - boolean

If True, the component will be displayed.

RadioButton Events

select()

When the Radio Button is selected.

show()

When the Radio Button is shown on the screen.

hide()

When the Radio Button is removed from the screen.

Create a new ‘RadioGroupPanel’ object

Base class: anvil.Component

Constructor

RadioGroupPanel Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

RadioGroupPanel Properties

parent

selected_value - object

Value property of the selected RadioButton.

RadioGroupPanel Events

change()

When the Radio Button selection changes.

show()

When the component is shown on the screen.

hide()

When the component is removed from the screen.

Create a new ‘Slider’ object

Base class: anvil.Component

Constructor

Slider Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Slider Properties

enabled - boolean

If True, this component allows user interaction.

label_color - color

The colour of the background of the label

label_text_color - color

The colour of the text of the label

margin - margin

The margin (pixels) of the component.

max - number

The maximum value of the Slider.

min - number

The minimum value of the Slider.

parent

progress_color - color

The colour of the progress bar

role - themeRole

A style for this component defined in CSS and added to Roles

show_label - boolean

If True, display a label above the thumb with the current value.

show_markers - boolean

If True, display discrete markers on the track.

step - number

The stepping interval for the Slider.

tag - object

Use this property to store any extra data for the component.

thumb_color - color

The colour of the slider thumb.

tooltip - string

The text to display when the mouse is hovered over this component.

track_color - color

The colour of the slider track.

value - number

The value of the slider.

visible - boolean

If True, the component will be displayed.

Slider Events

change()

When the value of the component is changed

Create a new ‘Switch’ object

Base class: anvil.Component

Constructor

Switch Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Switch Properties

align - enum: "left", "center", "right"

The position of this component in the available space.

enabled - boolean

If True, this component allows user interaction.

margin - margin

The margin (pixels) of the component.

parent

role - themeRole

A style for this component defined in CSS and added to Roles.

selected - boolean

If True, this component is toggled on.

selected_background_color - color

The background colour of the component when toggled on.

selected_icon - enum:

Optional icon to appear on the Switch when toggled on.

selected_thumb_color - color

The colour of the Switch thumb when toggled on.

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

unselected_background_color - color

The background colour of the component when toggled off.

unselected_icon - enum:

Optional icon to appear on the Switch when toggled off.

unselected_outline_color - color

The colour of the outline of the Switch when toggled off.

unselected_thumb_color - color

The colour of the Switch thumb when toggled off.

visible - boolean

If True, the component will be displayed.

Switch Events

change()

When the state of the Switch is changed.

show()

When the Switch is shown on the screen.

hide()

When the Switch is removed from the screen.

Create a new ‘Text’ object

Base class: anvil.Component

Constructor

Text Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

Text Properties

align - enum: "left", "right", "center", "justify"

The position of this component in the available space.

background_color - color

The color of the background of this component.

bold - boolean

If True, this component’s text will be bold.

border - string

The border of this component. Can take any valid CSS border value.

font_family - string

The font family to use for this component.

font_size - number

The font size of text displayed on this component.

icon - enum:

The icon to display on this component.

icon_color - color

The color of the icon displayed on this component.

icon_size - number

The size (pixels) of the icon displayed on this component.

italic - boolean

If True, this component’s text will be italic.

line_height - string

The line height of this component.

material_icon - enum:

The icon to display on this component.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

scale - enum: "small", "medium", "large"

The size of the text component.

spacing - spacing

The margin and padding (pixels) of the component.

style - enum: "display", "headline", "title"

Role of the text component: display, headline or title.

tag - object

Use this property to store any extra data for the component.

text - string

The text displayed on this component

text_color - color

The color of the text on the component.

tooltip - string

The text to display when the mouse is hovered over this component.

underline - boolean

If True, this component’s text will be underlined.

visible - boolean

If True, the component will be displayed.

Text Events

show()

When the Text is shown on the screen.

hide()

When the Text is removed from the screen.

Create a new ‘TextArea’ object

Base class: anvil.Component

Constructor

TextArea Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

focus()

Set the keyboard focus to this TextArea.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

select()

Set the input text on this TextArea.

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

TextArea Properties

align - enum: "left", "right", "center"

The position of this component in the available space.

appearance - enum: "filled", "outlined"

A predefined style for this component.

background_color - color

The colour of the background of this component.

bold_label - boolean

If True, the label text will be bold.

border_color - color

The colour of the border of this component.

character_limit - number

The max number of characters a user can enter into this component. The limit is displayed below the component.

display_bold - boolean

If True, the input and placeholder text will be bold.

display_font_family - string

The font family to use for the input and placeholder text.

display_font_size - number

The font size of the input and placeholder text.

display_italic - boolean

If True, the input and placeholder text will be italic.

display_text_color - color

The colour of the input text displayed on this component.

display_underline - boolean

The font family to use for the label on this component.

enabled - boolean

If True, this component allows user interaction.

error - boolean

If True, this component is in an error state.

label - string

The label text of the component.

label_color - color

The colour of the label text on the component.

label_font_family - string

The font family to use for the label on this component.

label_font_size - number

The font size of the label text on this component.

label_italic - boolean

If True, the label text will be italic.

label_underline - boolean

If True, the label text will be underlined.

margin - margin

The margin of this component. Default value is in pixels.

parent

placeholder - string

The text to be displayed when the component is empty

role - themeRole

A style for this component defined in CSS and added to Roles

subcontent_color - color

The colour of the supporting text and the character limit underneath this component.

subcontent_font_family - color

The font family to use for the supporting text and the character limit underneath this component.

subcontent_font_size - color

The font size of the supporting text and the character limit displayed underneath this component.

supporting_text - string

The supporting text displayed underneath this component

tag - object

Use this property to store any extra data for the component.

text - string

The input text to display on this component

tooltip - string

The text to display when the mouse is hovered over this component.

visible - boolean

If True, the component will be displayed.

TextArea Events

change()

When the text in this component is edited.

focus()

When the component gets focus.

lost_focus()

When the component loses focus.

change()

When the text in this component is edited.

focus()

When the component gets focus.

lost_focus()

When the component loses focus.

Create a new ‘TextBox’ object

Base class: anvil.Component

Constructor

TextBox Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

focus()

Set the keyboard focus to this TextBox.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

select()

Set the input text on this TextBox.

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

TextBox Properties

align - enum: "left", "right", "center"

The position of this component in the available space.

appearance - enum: "filled", "outlined"

A predefined style for this component.

background_color - color

The colour of the background of this component.

border_color - color

The colour of the border of this component.

character_limit - number

The max number of characters a user can enter into this component. The limit is displayed below the component.

display_bold - boolean

If True, the input and placeholder text will be bold.

display_font_family - string

The font family to use for the input and placeholder text.

display_font_size - number

The font size of the input and placeholder text.

display_italic - boolean

If True, the input and placeholder text will be italic.

display_text_color - color

The colour of the input text displayed on this component.

display_underline - boolean

If True, the input and placeholder text will be underlined.

enabled - boolean

If True, this component allows user interaction.

error - boolean

If True, this component is in an error state.

hide_text - boolean

If True, display stars instead of text when the user types input into this component.

label - string

The label text of the component.

label_bold - boolean

If True, the label text will be bold.

label_color - color

The colour of the label text on the component.

label_font_family - string

The font family to use for the label this component.

label_font_size - number

The font size of the label text on this component.

label_italic - boolean

If True, the label text will be italic.

label_underline - boolean

If True, the label text will be underlined.

leading_icon - enum:

The leading icon to display on this component.

leading_icon_color - color

The colour of the leading icon displayed on this component.

parent

placeholder - string

The text to be displayed when the component is empty

role - themeRole

A style for this component defined in CSS and added to Roles

spacing - spacing

The margin and padding (pixels) of the component.

subcontent_color - color

The colour of the supporting text and the character limit below this component.

subcontent_font_family - color

The font family to use for the supporting text and the character limit below this component.

subcontent_font_size - color

The font size of the supporting text and the character limit displayed below this component.

supporting_text - string

The supporting text displayed below this component

tag - object

Use this property to store any extra data for the component.

text - string

The input text to display on this component

tooltip - string

The text to display when the mouse is hovered over this component.

trailing_icon - enum:

The trailing icon to display on this component.

trailing_icon_color - color

The colour of the trailing icon displayed on this component.

type - enum: "text", "number", "email", "tel", "url"

The type of data that the user can enter into this box.

visible - boolean

If True, the component will be displayed.

TextBox Events

change()

When the text in this component is edited.

focus()

When the component gets focus.

lost_focus()

When the component loses focus.

trailing_icon_click()

When the trailing icon is clicked.

pressed_enter()

When the user presses enter in this component.

Create a new ‘ToggleIconButton’ object

Base class: anvil.component

Constructor

ToggleIconButton Methods

add_event_handler(event_name, handler_func)

Add an event handler function to be called when the event happens on this component. Event handlers will be called in the order they are added. Adding the same event handler multiple times will mean it gets called multiple times.

remove_event_handler(event_name, [handler_func])

Remove a specific event handler function for a given event. Calling remove_event_handler with just the event name will remove all the handlers for this event

set_event_handler(event_name, handler_func)

Set a function to call when the ’event_name’ event happens on this component. Using set_event_handler removes all other handlers. Setting the handler function to None removes all handlers.

ToggleIconButton Properties

align - enum: "left", "right", "center"

The position of this component in the available space.

appearance - enum: "standard", "filled", "tonal", "outlined"

A predefined style for this component.

background_color - color

The colour of the background of this component.

border - string

The border of this component. Can take any valid CSS border value.

enabled - boolean

If True, this component allows user interaction.

icon - enum:

The icon to display on this component.

icon_color - color

The colour of the icon displayed on this component.

margin - margin

The margin (pixels) of the component.

parent

role - themeRole

A style for this component defined in CSS and added to Roles

selected - boolean

If True, the component is in the selected state.

selected_background_color - color

The background colour when the component is in the selected state.

selected_border - string

The border style when the component is in the selected state. Accepts any valid CSS border value.

selected_icon_color - color

The icon colour when the component is in the selected state.

tag - object

Use this property to store any extra data for the component.

tooltip - string

The text to display when the mouse is hovered over this component.

visible - boolean

If True, the component will be displayed.

ToggleIconButton Events

click()

When the component is clicked.