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.

Example

>>> df = pd.DataFrame(
...     columns=["Product", "Price"],
...     data=[
...         ("phone", 560),
...         ("headset", 80),
...         ("watch", 250),
...     ],
... )
>>> table = session.read_pandas(
...     df, keys={"Product"}, table_name="Example"
... )
>>> cube = session.create_cube(table)
>>> m = cube.measures
>>> m["Price.SUM"].description
''
>>> m["Price.SUM"].description = "The sum of the price"
>>> m["Price.SUM"].description
'The sum of the price'
>>> m["Price.SUM"].description = " "  # Blank description
>>> m["Price.SUM"].description
''