ApexChart Interface

class epyk.interfaces.graphs.CompChartsApex.ApexChart(ui)
area(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display an area chart from Apexcharts.

Tags:

Categories:

Usage:

chart_texas = page.ui.charts.apex.area(state_data, ["cases", "deaths"], 'date')
chart_texas.options.dataLabels.enabled = False
chart_texas.options.title.text = state
chart_texas.options.subtitle.text = "Cases"
chart_texas.options.chart.events.custom_config("beforeResetZoom", "function(chartContext, config) { console.log('ok')}", True)

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

bar(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a bar chart from Apexcharts.

Tags:

Categories:

Usage:

chart = page.ui.charts.apex.bar()
chart.options.dataLabels.enabled = False
series = chart.options.add_series()
series.name = "Test Series"
series.data = [45, 23, 87, 5]

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

bubble(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a bubble chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

donut(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a donut chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

gauge(values: float = 0, labels: str = '', profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[Union[bool, dict]] = None, html_code: Optional[str] = None)

Display a gauge chart from ApexCharts.

Tags:

Categories:

Related Pages:

Parameters:
  • values – Optional. The gauge value

  • labels – Optional. The gauge label

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

hbar(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a horizontal bars chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

heatmap(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a heatmap chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

line(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[Union[bool, dict]] = None, html_code: Optional[str] = None, **kwargs)

Display a line chart from ApexCharts.

Tags:

Categories:

Usage:

chart = page.ui.charts.apex.line()
chart.options.chart.sparkline.enabled = True
chart.options.title.text = "$235,312"
chart.options.subtitle.text = "Expenses"
chart.options.dataLabels.enabled = False

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – Optional. The columns corresponding to keys in the dictionaries in the record

  • x_axis – Optional. The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

pie(records=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a pie chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • records – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – The width of the component in the page, default (100, ‘%’)

  • height – The height of the component in the page, default (330, “px”)

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

plot(record=None, y: Optional[list] = None, x: Optional[str] = None, kind: str = 'line', profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None, **kwargs)
Tags:

Categories:

Usage:

:param record: Optional. The list of dictionaries with the input data
:param y: Optional. The columns corresponding to keys in the dictionaries in the record
:param x: Optional. The column corresponding to a key in the dictionaries in the record
:param kind: Optional. The chart type
:param profile: Optional. A flag to set the component performance storage
:param width: Optional. The width of the component in the page, default (100, '%')
:param height: Optional. The height of the component in the page, default (330, "px")
:param options: Optional. Specific Python options available for this component
:param html_code: Optional. An identifier for this component (on both Python and Javascript side)
polar(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a polar chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

radar(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a radar chart from Apexcharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

radial(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a radial chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

scatter(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a scatter chart from Apexchart.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)

treemap(record=None, y_columns: Optional[list] = None, x_axis: Optional[str] = None, profile: Optional[Union[bool, dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (330, 'px'), options: Optional[dict] = None, html_code: Optional[str] = None)

Display a treemap chart from ApexCharts.

Tags:

Categories:

Usage:

Related Pages:

Parameters:
  • record – The Python list of dictionaries

  • y_columns – The columns corresponding to keys in the dictionaries in the record

  • x_axis – The column corresponding to a key in the dictionaries in the record

  • profile – Optional. A flag to set the component performance storage

  • width – Optional. A tuple with the integer for the component width and its unit

  • height – Optional. A tuple with the integer for the component height and its unit

  • options – Optional. Specific Python options available for this component

  • html_code – Optional. An identifier for this component (on both Python and Javascript side)