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 this slider.

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 that is assigned to the rendered HTML component.

None
properties dict[str, Any]

Bound to a dictionary that contains additional properties for this element.

None
class_name str
dynamic

The list of CSS class names that are associated with the generated HTML Element.
These class names are added to the default taipy-indicator class name.

None