OptChartApex Module

class epyk.core.html.options.OptChartApex.OptionAnimations(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property dynamicAnimation

OptionDynamicAnimations

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionAxisBorder(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionAxisTicks(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionChart(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property animations: OptionAnimations

OptionAnimations

Type:

rtype

property dropShadow: OptionDropShadow

OptionDropShadow

Type:

rtype

property events: OptionEvents

OptionEvents

Type:

rtype

property sparkline: OptionSparkline

OptionSparkline

Type:

rtype

property toolbar: OptionToolbar

OptionToolbar

Type:

rtype

property zoom: OptionZoom

OptionZoom

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionDataLabels(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
formatter(js_funcs, profile=None)
Parameters:

  • js_funcs – String | List. The Javascript functions.

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

property name: OptionName

OptionName

Type:

rtype

property style

OptionStyle

Type:

rtype

property textAnchor

Related Pages:

https://apexcharts.com/docs/options/datalabels/

property total: OptionTotal

OptionTotal

Type:

rtype

property value: OptionValue

OptionValue

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionDropShadow(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionDynamicAnimations(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionEvents(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
animationEnd(js_funcs, profile=None)

Fires when the chart’s initial animation is finished.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

beforeMount(js_funcs, profile=None)

Fires before the chart has been drawn on screen.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

click(js_funcs, profile=None)

Fires when user clicks on any area of the chart.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

legendClick(js_funcs, profile=None)

Fires when user clicks on legend.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

markerClick(js_funcs, profile=None)

Fires when user clicks on the markers.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

mounted(js_funcs, profile=None)

Fires after the chart has been drawn on screen.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

mouseMove(js_funcs, profile=None)

Fires when user moves mouse on any area of the chart.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

scrolled(js_funcs, profile=None)

Fires when user drags the brush in a brush chart. The 2nd argument includes information of the new axes generated after scrolling the brush.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

selection(js_funcs, profile=None)

Fires when user selects rect using the selection tool. The second argument contains the yaxis and xaxis coordinates where user made the selection

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

updated(js_funcs, profile=None)

Fires when the chart has been dynamically updated either with updateOptions() or updateSeries() functions.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

zoomed(js_funcs, profile=None)

Fires when user zooms in/out the chart using either the selection zooming tool or zoom in/out buttons. The 2nd argument includes information of the new xaxis/yaxis generated after zooming.

Related Pages:

Parameters:

  • js_funcs – List | String. Javascript functions.

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

class epyk.core.html.options.OptChartApex.OptionFill(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property gradient: OptionGradient

OptionGradient

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionFixed(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionFormatters(options, name)
mapTo(mapping)
Parameters:

mapping –

class epyk.core.html.options.OptChartApex.OptionGradient(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionGrid(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property padding

OptionPadding

Type:

rtype

property row

OptionRow

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionHollow(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionHover(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionLabels(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
formatter(js_funcs, profile=None)
Parameters:

  • js_funcs – String | List. The Javascript functions.

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

property style

OptionStyle

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionLegend(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property labels: OptionLabels

OptionLabels

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionMarkers(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property hover

OptionHover

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionMonochrome(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionName(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionPadding(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionPlotOptions(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property bar: OptionPlotOptionsBar

OptionPlotOptionsBar

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionPlotOptionsBar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property dataLabels: OptionDataLabels

OptionDataLabels

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionResponsive(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property opts

OptionsLine

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionRow(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionSeries(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionSparkline(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionStroke(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionStyle(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionTheme(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property monochrome: OptionMonochrome

OptionMonochrome

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionTitle(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property style: OptionStyle

OptionStyle

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionToolbar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartApex.OptionTooltip(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property fixed: OptionFixed

OptionFixed

Type:

rtype

property y: OptionY

OptionY

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionTotal(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
formatter(js_funcs, profile=None)
Parameters:

  • js_funcs – String | List. The Javascript functions.

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

class epyk.core.html.options.OptChartApex.OptionValue(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
formatter(js_funcs, profile=None)
Parameters:

  • js_funcs – String | List. The Javascript functions.

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

class epyk.core.html.options.OptChartApex.OptionXaxis(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
axisBorder()
Return type:

OptionAxisBorder

axisTicks()
Return type:

OptionAxisTicks

property labels

OptionLabels

Type:

rtype

property title

OptionTitle

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionY(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
formatter(js_funcs, profile=None)
Parameters:

  • js_funcs – String | List. The Javascript functions.

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

class epyk.core.html.options.OptChartApex.OptionYaxis(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
axisTicks()
Return type:

OptionAxisTicks

property labels

OptionLabels

Type:

rtype

property title

OptionTitle

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionZoom(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.Options(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property builder

Add a JavaScript Builder function to the options.

This will be used to automatically map the Python component to its corresponding JavaScript builder function used by the build method.

Usage:

but = page.ui.button()
but.options.builder = "Button"
Prop value:

The JavaScript builder function name.

property config_default

The default value for the configuration in case of template.

Default value is an empty string.

Usage:

component.options.config_default = {"value": "test"}
config_html()

Return the HTML options used by the python and passed to the HTML.

Those options will not be available in the JavaScript layer and they are only defined either to build the HTML from Python or to set some HTML properties.

The returned dictionary is a copy so it can be changed or used in other processes. To change the internal component property, the options property should be used.

config_js(attrs: Optional[dict] = None)

Return the JavaScript options used by the builders functions.

Builder functions can be defined in the framework or external from the various packages.

The returned dictionary is a copy so it can be changed or used in other processes. To change the internal component property, the options property should be used.

Parameters:

attrs – Optional. The extra or overridden options

custom_config(name: str, value: Any, js_type: bool = False)

Add a custom JavaScript configuration.

Usage:

chart = page.ui.charts.apex.scatter()
chart.options.chart.zoom.custom_config("test", False)
Parameters:

  • name – The key to be added to the attributes

  • value – String or JString. The value of the defined attributes

  • js_type – Optional. Specify if the parameter is a JavaScript fragment

details()

Retrieve the defined properties details.

This function will return a dictionary with all the component attributes (required and optional) ones. It will provide the full available description of those components.

Usage:

but = page.ui.button()
pprint.pprint(but.options.details(), indent=4)
from_json(vals: dict, schema: Optional[dict] = None)

Load the option schema for a component from a json string.

TODO: add more feature to handle functions and enumeration

Parameters:

  • vals – The input schema

  • schema – The full object schema

has_attribute(cls_obj, name: Optional[str] = None)

Add an extra sub layer to the data structure.

The key in the object representation will be the function name.

Parameters:

  • cls_obj – Class. The sub data class used in the structure definition

  • name – The sub attribute name

isJsContent(property_name: str)

Check if the content of a property is defined to always be a JavaScript fragment.

Thus the framework will not convert it to a Json content.

Usage:

div = page.ui.div()
print(div.options.isJsContent("inline"))
Parameters:

property_name – The property name

property managed

Boolean flag to set if the component needs to be added to the page.

If set to False the component has to be managed manually in the page.

Usage:

but = page.ui.button()
but.options.managed = False
Prop bool:

Flag to specify if this component is automatically managed by the page

optional()

Return all options not added to the HTML component by default.

Those are options which will impact either the Python or the JavaScript builders.

To get the full definition of options the details method should be used.

Usage:

but = page.ui.button()
pprint.pprint(but.options.optional(), indent=4)
property profile

Boolean flag to set if extra logs need to be displayed.

This could help in debugging, default is the page verbose flag (default is false).

Usage:

but = page.ui.button()
but.options.verbose = True
Prop flag:

Flag to display / hide warning logs generated by the framework.

required()

Return all the mandatory / required options with the default values.

Those options are added by the framework to provide a default for the HTML components but they can be changed.

System options are also added to this category as they are always available in any HTML components.

To get the full definition of options the details method should be used.

Usage:

but = page.ui.button()
pprint.pprint(but.options.required(), indent=4)
set_attrs(vals: dict)

Set the object internal attributes.

Parameters:

vals – All the attributes to be added to the component

property style

Change some CSS attributes to the internal HTML component.

Related Pages:

Prop values:

The CSS attributes.

update_config(attrs: dict)

Update the option configuration.

Parameters:

attrs – The attributes to set

property verbose

Boolean flag to set if extra logs need to be displayed.

This could help in debugging, default is the page verbose flag (default is false).

Usage:

but = page.ui.button()
but.options.verbose = True
Prop flag:

Boolean. Flag to display / hide warning logs generated by the framework.

class epyk.core.html.options.OptChartApex.OptionsArea(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property fill: OptionFill

OptionFill

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionsBar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property plotOptions: OptionPlotOptions

OptionPlotOptions

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionsChartSharedApex(component: HtmlModel, page: Optional[PageModel] = None)
x_format(js_funcs, profile: Optional[Union[bool, dict]] = None)
Parameters:

  • js_funcs –

  • profile –

x_format_money(symbol='', digit=0, thousand_sep='.', decimal_sep=',', fmt='%v %s', factor=None, alias='')
Parameters:

  • symbol –

  • digit –

  • thousand_sep –

  • decimal_sep –

  • fmt –

  • factor –

  • alias –

x_format_number(factor=1, alias=None, digits=0, thousand_sep='.')
Parameters:

  • factor –

  • alias –

  • digits –

  • thousand_sep –

x_label(value)

Set the label of the x axis.

Related Pages:

Parameters:

value – String. The axis label.

x_tick_count(num)

Number of Tick Intervals to show.

Related Pages:

Parameters:

num – Integer. The number of ticks

y_format(jsFncs, profile=None)
Parameters:

  • js_funcs –

  • profile –

y_format_money(symbol='', digit=0, thousand_sep='.', decimal_sep=',', fmt='%v %s', factor=None, alias='')
Parameters:

  • symbol –

  • digit –

  • thousand_sep –

  • decimal_sep –

  • fmt –

  • factor –

  • alias –

y_format_number(factor=1, alias=None, digits=0, thousand_sep='.')
Parameters:

  • factor –

  • alias –

  • digits –

  • thousand_sep –

y_label(value)

Set the label of the y axis.

Related Pages:

Parameters:

value – String. The axis label.

y_tick_count(num)

Number of Tick Intervals to show.

Related Pages:

Parameters:

num – Integer. The number of ticks

class epyk.core.html.options.OptChartApex.OptionsLine(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_responsive() → OptionResponsive
Return type:

OptionResponsive

add_series() → OptionSeries
Return type:

OptionSeries

property chart: OptionChart
property dataLabels: OptionDataLabels

OptionDataLabels

Type:

rtype

property grid: OptionGrid
property legend: OptionLegend

OptionLegend

Type:

rtype

property markers: OptionMarkers

OptionMarkers

Type:

rtype

property stroke: OptionStroke

OptionStroke

Type:

rtype

property subtitle: OptionTitle

OptionTitle

Type:

rtype

property theme: OptionTheme

Related Pages:

Return type:

OptionTheme

property title: OptionTitle

OptionTitle

Type:

rtype

property tooltip: OptionTooltip

OptionTooltip

Type:

rtype

property xaxis: OptionXaxis

OptionXaxis

Type:

rtype

property yaxis: OptionYaxis

OptionYaxis

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionsPie(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property plotOptions: OptionsPlotRadial

OptionsPlotRadial

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionsPlotRadial(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property dataLabels: OptionDataLabels

OptionDataLabels

Type:

rtype

property radialBar: OptionsPlotRadialBar

OptionsPlotRadialBar

Type:

rtype

class epyk.core.html.options.OptChartApex.OptionsPlotRadialBar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property dataLabels: OptionDataLabels

OptionDataLabels

Type:

rtype

property hollow: OptionHollow

OptionHollow

Type:

rtype