component

Component

Bases: PyCelonisBaseModel

Class for view components.

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component.

DataComponent

Bases: Component, ABC

Component that displays data.

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

KpiList

Bases: DataComponent

Class for KPI List components.

TYPE class-attribute

TYPE = 'kpi-list'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

KpiCard

Bases: DataComponent

Class for Kpi Card components.

TYPE class-attribute

TYPE = 'kpi-card'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

Table

Bases: DataComponent

Class for table components.

TYPE class-attribute

TYPE = 'table'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

Waterfall

Bases: DataComponent

Class for Waterfall charts.

TYPE class-attribute

TYPE = 'waterfall'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

BarChart

Bases: DataComponent

Class for Bar charts.

TYPE class-attribute

TYPE = 'bar-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

PieChart

Bases: DataComponent

Class for Pie charts.

TYPE class-attribute

TYPE = 'pie-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

Treemap

Bases: DataComponent

Class for Treemap charts.

TYPE class-attribute

TYPE = 'treemap'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

StackedBarChart

Bases: DataComponent

Class for Stacked Bar charts.

TYPE class-attribute

TYPE = 'stacked-bar-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

GroupedBarChart

Bases: DataComponent

Class for Grouped Bar charts.

TYPE class-attribute

TYPE = 'grouped-bar-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

BarPointsChart

Bases: DataComponent

Class for Bar Points charts.

TYPE class-attribute

TYPE = 'bar-points-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

Scatterplot

Bases: DataComponent

Class for Scatterplot charts.

TYPE class-attribute

TYPE = 'scatterplot'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

LineChart

Bases: DataComponent

Class for Line charts.

TYPE class-attribute

TYPE = 'line-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

ColumnsChart

Bases: DataComponent

Class for Columns charts.

TYPE class-attribute

TYPE = 'columns-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

GroupedColumnsChart

Bases: DataComponent

Class for Grouped Columns charts.

TYPE class-attribute

TYPE = 'grouped-columns-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

ColumnsLineChart

Bases: DataComponent

Class for Columns Line charts.

TYPE class-attribute

TYPE = 'columns-line-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

StackedColumnsChart

Bases: DataComponent

Class for Stacked Columns charts.

TYPE class-attribute

TYPE = 'stacked-columns-chart'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

Histogram

Bases: DataComponent

Class for Histogram charts.

TYPE class-attribute

TYPE = 'histogram'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

WorldMap

Bases: DataComponent

Class for World Map charts.

TYPE class-attribute

TYPE = 'world-map'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component

Sankey

Bases: DataComponent

Class for Sankey charts.

TYPE class-attribute

TYPE = 'sankey'

id instance-attribute

id

Id of component.

type_ class-attribute instance-attribute

type_ = Field(..., alias='type')

Type of component (e.g. table).

settings class-attribute instance-attribute

settings = Field(default_factory=ComponentSettings)

Settings of component.

get_query

get_query()

Returns full query with column, filter, and sorting for component.

Returns:

• PQL –

  A PQL query.

get_columns

get_columns()

Returns all columns of component including dimensions and kpis.

Returns:

• List[PQLColumn] –

  List of PQLColumns.

get_filters

get_filters()

Returns filters of component.

Returns:

• List[PQLFilter] –

  Component filters.

get_order_by_columns

get_order_by_columns()

Returns order by columns of component.

Returns:

• List[OrderByColumn] –

  Order by columns of component