Billboard Interface

class epyk.interfaces.graphs.CompChartsBillboard.Billboard(ui)

area(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a area chart from Billboard.

Tags:

Categories:

Usage:

data = page.py.requests.csv(data_urls.DEMO_COUNTRY)
c = page.ui.charts.bb.area(data, y_columns=["Value"], x_axis="Year", height=(500, "px"))
c.options.axis.y.tick.formats.scale(1000000)

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.AreaChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

area_step(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a area step chart from Billboard.

Tags:

Categories:

Usage:

from epyk.mocks import randoms

data = randoms.getSeries(5, 40)
area_step = page.ui.charts.billboard.area_step(data, y_columns=list(range(4)), x_axis='x')

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.AreaChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

bar(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a bar chart from Billboard.

Tags:

Categories:

Usage:

from epyk.mocks import randoms

data = randoms.getSeries(5, 40)
b = page.ui.charts.billboard.bar(data, y_columns=list(range(4)), x_axis='x')

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.BarChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

bubble(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a bubble chart from Billboard.

Tags:

Categories:

Usage:

c = page.ui.charts.bb.bubble(y_columns=["Value"], x_axis="Year", height=(500, "px"))
c.options.axis.y.tick.formats.scale(1000000)

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.BubbleChart

Parameters:

• record – Optional. 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)

donut(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a donut chart from Billboard.

Tags:

Categories:

Usage:

from epyk.mocks import urls as data_urls

data = randoms.getSeries(5, 40)
p = page.ui.charts.billboard.donut(data, y_columns=[1], x_axis='g')

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.DonutChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

gauge(value: int = 0, text: str = '', profile=None, options=None, width=(100, '%'), height=(330, 'px'), html_code=None)

Display a gauge chart from Billboard.

Tags:

Categories:

Usage:

g = page.ui.charts.billboard.gauge(60)

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.GaugeChart

Parameters:

• value – Integer. Optional. The gauge chart value.

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

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

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

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

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

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

hbar(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a horizontal bar chart from Billboard.

Tags:

Categories:

Usage:

data = page.py.requests.csv(data_urls.DEMO_COUNTRY)
c = page.ui.charts.bb.hbar(data, y_columns=["Value"], x_axis="Year", height=(500, "px"))
c.options.axis.y.tick.formats.scale(1000000)
c.options.axis.x.tick.count = 5

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.BarChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

line(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a line chart from Billboard.

Tags:

Categories:

Usage:

dataPoints = [
  {'x': 0, 'y': 10, 'y1': 10},
  {'x': 1, 'y': 35, 'y1': 20}]
chart = page.ui.charts.billboard.line(dataPoints, y_columns=["y", 'y1'], x_axis='x')
page.ui.button("reset").click([chart.build(dataPoints2)])

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.LineChart

Parameters:

• record – Optional. 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)

line_range(record=None, y_columns=None, x_axis=None, range=5, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a line range chart from Billboard.

Tags:

Categories:

Usage:

dataPoints = [
  {'x': 0, 'y': 10, 'y1': 10},
  {'x': 1, 'y': 35, 'y1': 20},
  {'x': 2, 'y': 25, 'y1': 10},
  {'x': 3, 'y': 30, 'y1': 5},
  {'x': 4, 'y': 28, 'y1': 10}]
c = page.ui.charts.billboard.line_range(dataPoints, y_columns=["y", 'y1'], x_axis='x')

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.LineChart

Parameters:

• record – Optional. 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(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a pie chart from Billboard.

Tags:

Categories:

Usage:

from epyk.mocks import urls as data_urls

data = randoms.getSeries(5, 40)
p = page.ui.charts.billboard.pie(data, y_columns=[1], x_axis='g')

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.PieChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

plot(record=None, y=None, x=None, kind='line', profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None, **kwargs)

Tags:

Categories:

Usage:

Related Pages:

Parameters:

• record – Optional. The list of dictionaries with the input data

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

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

• kind – Optional. The chart type

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

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

• height – Optional. 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)

radar(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a radar chart from Billboard.

Tags:

Categories:

Usage:

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.RadarChart

Parameters:

• record – Optional. 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)

scatter(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a scatter chart from Billboard.

Tags:

Categories:

Usage:

data = page.py.requests.csv(data_urls.DEMO_COUNTRY)
c = page.ui.charts.bb.scatter(data, y_columns=["Value"], x_axis="Year", height=(500, "px"))
c.options.axis.y.tick.formats.scale(1000000)
c.options.axis.x.tick.count = 5

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.ScatterPlot

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

spline(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a spline chart from Billboard.

Tags:

Categories:

Usage:

data = page.py.requests.csv(data_urls.DEMO_COUNTRY)
c = page.ui.charts.bb.spline(data, y_columns=["Value"], x_axis="Year", height=(500, "px"))
c.options.axis.y.tick.formats.scale(1000000)

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.SplineChart

Parameters:

• record – Optional. 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)

stacked(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a stacked bar chart from Billboard.

Tags:

Categories:

Usage:

data = page.py.requests.csv(data_urls.DEMO_COUNTRY)
c = page.ui.charts.bb.stacked(data, y_columns=["Value"], x_axis="Year", height=(500, "px"))
c.options.axis.y.tick.formats.scale(1000000)
c.options.axis.x.tick.count = 5

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.StackedBarChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

step(record=None, y_columns=None, x_axis=None, profile=None, width=(100, '%'), height=(330, 'px'), options=None, html_code=None)

Display a step chart from Billboard.

Tags:

Categories:

Usage:

data = page.py.requests.csv(data_urls.DEMO_COUNTRY)
c = page.ui.charts.bb.step(data, y_columns=["Value"], x_axis="Year", height=(500, "px"))
c.options.axis.y.tick.formats.scale(1000000)

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.StepChart

Parameters:

• record – Optional. The Python list of dictionaries.

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

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

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

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

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

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

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

timeseries(record=None, y_columns=None, x_axis=None, profile=None, options=None, width=(100, '%'), height=(330, 'px'), html_code=None)

Display a timeseries chart from Billboard.

Tags:

Categories:

Usage:

from epyk.mocks import urls as data_urls

data_rest = page.py.requests.csv(data_urls.PLOTLY_APPLE_PRICES)
ts = page.ui.charts.billboard.timeseries(data_rest, y_columns=['AAPL.Open'], x_axis="Date")

Related Pages:

https://naver.github.io/billboard.js/demo/#Chart.LineChart

Parameters:

• record – List of dict. Optional. The Python list of dictionaries.

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

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

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

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

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

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

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