atoti.Measure.description

property Measure.description: str

Description of the measure. It is displayed in Atoti UI when hovering the corresponding node in the Data model tree to help users understand its purpose.

>>> table = session.create_table(
...     "Example",
...     data_types={"Product": "String", "Price": "float"},
...     keys={"Product"},
... )
>>> cube = session.create_cube(table)
>>> m = cube.measures

Empty by default:

>>> m["Price.SUM"].description
''

Changing the description:

>>> m["Price.SUM"].description = "The sum of the price"
>>> m["Price.SUM"].description
'The sum of the price'

Blank descriptions are normalized to an empty string:

>>> m["Price.SUM"].description = " "  # Blank description
>>> m["Price.SUM"].description
''

Measure.data_type

Measure.folder

⌘I

Releases and upgrades

Getting started

Guides

API reference

Measure.description