Module `macrobond_data_api.web.web_types.series_tree.series_tree_listing_response`

Classes

class SeriesTreeListingAspect (*args, **kwargs)

Defines an aspect in a structured series list

var description : Optional[str]: A longer description of the aspect that can be used as a tooltip. This is might be omitted if there is only one aspect.
var groups : List[SeriesTreeListingGroup]
var title : Optional[str]: The title of the aspect. This is might be omitted if there is only one aspect.

class SeriesTreeListingGroup (*args, **kwargs)

Defines an aspect in a structured series list

var series : List[SeriesTreeListingSeries]: The list of series in this group.
var title : Optional[str]: The title of the group. This is might be omitted if there is only one group.

class SeriesTreeListingResponse (*args, **kwargs)

A structured list of series for a leaf in the series database tree

var aspects : List[SeriesTreeListingAspect]: The list of aspects. There will always be at least one.
var commonTitle : str: The common part of the series titles
var hasAspects : bool: If True then there are several aspects of the series which is typically displayed as tabs
var hasGroups : bool: If True then the list is grouped

class SeriesTreeListingSeries (*args, **kwargs)

Defines an aspect in a structured series list

var Indentation : Optional[int]: The indentation level.
var discontinued : Optional[bool]: If True then the series is discontinued. This is typically indicated by drawing the series title in red.
var emphasized : Optional[bool]: If True then the series is emphasized. This is typically indicated by drawing the series title in bold.
var properties : Dict[str, object]: Properties that can be used for display purposes. It will always contain a property called Description. If there is a series, the property Name will contain the series name. If there is no Name, the series is missing and the description is typically shown as 'disabled'.
var spaceAbove : Optional[bool]: If True then some extra space should be drawn above this series.