atoti.Hierarchy.description

property Hierarchy.description: str

Description of the hierarchy.

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)
>>> h = cube.hierarchies
>>> h["Product"].description
''
>>> h["Product"].description = "The name of the product"
>>> h["Product"].description
'The name of the product'
>>> h["Product"].description = " "  # Blank description
>>> h["Product"].description
''