Skip to content

indicator class

Displays a label on a red-to-green scale at a specific position.

Methods

__init__()

__init__(
    display=None,
    value=None, # min
    min=0,
    max=100,
    format=None,
    orientation="horizontal",
    width=None,
    height=None,
    hover_text=None,
    id=None,
    properties=None,
    class_name=None,
) -> None

Create a new indicator element.

Parameters:

Name Type Description Default

display

Any
dynamic

The label to be displayed.
This can be formatted if it is a numerical value.

None

value

Union[int, float]
dynamic

The location of the label on the [min, max] range.
The default value is the min value.

min

min

Union[int, float]

The minimum value of the range.

0

max

Union[int, float]

The maximum value of the range.

100

format

str

The format to use when displaying the value.
This uses the printf syntax.

None

orientation

str

The orientation of the indicator.

horizontal

width

str

The width of the indicator, in CSS units (used when orientation is horizontal).

None

height

str

The height of the indicator, in CSS units (used when orientation is vertical).

None

hover_text

str
dynamic

UNDOCUMENTED

None

id

str

The identifier assigned to the rendered HTML component.
This can be used in callbacks or to target the element for styling.

None

properties

dict[str, Any]

A dictionary of additional properties that can be set to the element.

None

class_name

str
dynamic

A space-separated list of CSS class names to be applied to the generated HTML element.
These classes are added to the default taipy-indicator class.

None