OptChartJs Module

class epyk.core.html.options.OptChartJs.ChartJsOptions(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_title(text: str, color: Optional[str] = None)
Parameters:
  • text

  • color

property elements: OptionElements
property layout: OptionLayout
property legend: OptionLegend
property plugins: OptionChartJsPlugins
property scales: OptionScales
property title: OptionTitle
property tooltips
class epyk.core.html.options.OptChartJs.OptionAxes(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_label(text: str, color: Optional[str] = None)
Parameters:
  • text

  • color

property border: OptionAxesBorder

Related Pages:

https://www.chartjs.org/docs/latest/samples/other-charts/scatter-multi-axis.html https://www.chartjs.org/docs/latest/migration/v4-migration.html

category(vals)
Parameters:

vals

property grid: OptionAxesGridLine

Related Pages:

https://www.chartjs.org/docs/latest/samples/other-charts/scatter-multi-axis.html https://www.chartjs.org/docs/latest/migration/v4-migration.html

property gridLines: OptionAxesGridLine
property id

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property offset

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property padding
property position

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property reverse

Related Pages:

https://www.chartjs.org/docs/latest/samples/other-charts/scatter-multi-axis.html

property scaleLabel: OptionAxesScaleLabel
property stacked

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property static
property stepSize

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property suggestedMax

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property suggestedMin

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property ticks: OptionAxesTicks
property time: OptionAxesTime
property title: OptionTitle

options.scales[scaleId].title, it defines options for the scale title. Note that this only applies to cartesian axes.

Related Pages:

Type:

Namespace

class epyk.core.html.options.OptChartJs.OptionAxesGridLine(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property borderColor

The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.

Related Pages:

property borderDash

Length and spacing of dashes on grid lines.

Related Pages:

property borderDashOffset

Offset for line dashes.

Related Pages:

property borderWidth

Offset for line dashes.

Related Pages:

property circular

If true, gridlines are circular (on radar chart only).

Related Pages:

property color

The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.

Related Pages:

property display

If false, do not display grid lines for this axis.

Related Pages:

property drawBorder

If true, draw border at the edge between the axis and the chart area.

Related Pages:

property drawOnChartArea

If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.

Related Pages:

property drawTicks

If true, draw lines beside the ticks in the axis area beside the chart.

Related Pages:

property lineWidth

Stroke width of grid lines.

Related Pages:

property offsetGridLines

If true, grid lines will be shifted to be between labels. This is set to true for a bar chart by default.

Related Pages:

property tickColor

Related Pages:

https://www.chartjs.org/docs/latest/axes/styling.html

property tickMarkLength

Length in pixels that the grid lines will draw into the axis area.

Related Pages:

property z

z-index of gridline layer. Values <= 0 are drawn under datasets, > 0 on top.

Related Pages:

property zeroLineBorderDash

Length and spacing of dashes of the grid line for the first index (index 0).

Related Pages:

property zeroLineBorderDashOffset

Offset for line dashes of the grid line for the first index (index 0).

Related Pages:

property zeroLineColor

Stroke color of the grid line for the first index (index 0).

Related Pages:

property zeroLineWidth

Stroke width of the grid line for the first index (index 0).

Related Pages:

class epyk.core.html.options.OptChartJs.OptionAxesScaleLabel(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
label(value: str)

Shortcut to the labelString and display property.

Parameters:

value – The label value.

class epyk.core.html.options.OptChartJs.OptionAxesTicks(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property backdropColor

Change the font color.

Related Pages:

property beginAtZero

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

callback(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None)

Related Pages:

Parameters:
  • js_funcs

  • profile

property color

Change the font color.

Related Pages:

property fontColor

Change the font color.

Related Pages:

property fontSize

Change the labels CSS font size.

Related Pages:

property major: OptionAxesTicksMajor
mapTo(mapping: dict)

Map the values to a static dictionary.

Parameters:

mapping – The mapping table.

property max

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property maxTicksLimit

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property min

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property minor: OptionAxesTicksMajor
property mirror

Flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.

Related Pages:

property stepSize

Force the step size.

Related Pages:

property suggestedMax

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property suggestedMin

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property textStrokeColor

Change the font color.

Related Pages:

userCallback(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None)

Convert to number using the accounting Javascript module-

Related Pages:

Parameters:
  • js_funcs

  • profile

class epyk.core.html.options.OptChartJs.OptionAxesTime(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property displayFormats: OptionDisplayFormats
class epyk.core.html.options.OptChartJs.OptionChartJsPieTooltips(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property callbacks

OptionChartJsTooltipsPieCallbacks

Type:

rtype

class epyk.core.html.options.OptChartJs.OptionChartJsPlugins(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property legend: OptionLegend
property subtitle: OptionTitle

Related Pages:

https://www.chartjs.org/docs/latest/samples/subtitle/basic.html

property title: OptionTitle
class epyk.core.html.options.OptChartJs.OptionChartJsSize(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property height
property width
class epyk.core.html.options.OptChartJs.OptionChartJsTooltips(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property backgroundColor

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property bodyAlign

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property bodyColor

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property bodySpacing

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property borderColor

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property borderWidth

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property boxHeight

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property boxPadding

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property boxWidth

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property callbacks

OptionChartJsTooltipsCallbacks

Type:

rtype

property caretPadding

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property caretSize

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property cornerRadius

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property displayColors

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property enabled

//www.chartjs.org/docs/3.7.0/configuration/tooltip.html

Type:

https

property footerAlign

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property footerColor

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property footerMarginTop

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property footerSpacing

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property multiKeyBackground

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property position

//www.chartjs.org/docs/3.7.0/configuration/tooltip.html

Type:

https

property rtl

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property textDirection

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property titleAlign

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property titleColor

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property titleMarginBottom

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property titleSpacing

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property usePointStyle

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property xAlign

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property yAlign

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

class epyk.core.html.options.OptChartJs.OptionChartJsTooltipsCallbacks(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property label

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

property value

Related Pages:

https://www.chartjs.org/docs/3.7.0/configuration/tooltip.html

class epyk.core.html.options.OptChartJs.OptionChartJsTooltipsPieCallbacks(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartJs.OptionDisplayFormats(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartJs.OptionElements(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property point: OptionPoint
class epyk.core.html.options.OptChartJs.OptionElementsLine(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property line: OptionLine
class epyk.core.html.options.OptChartJs.OptionGeo(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property colorScale

OptionGeoColorScale

Type:

rtype

property radiusScale

OptionGeoRadiusScale

Type:

rtype

class epyk.core.html.options.OptChartJs.OptionGeoColorScale(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property legend

OptionLegend

Type:

rtype

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

Change the color.

class epyk.core.html.options.OptChartJs.OptionLayout(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property padding: OptionPadding
property paddings
class epyk.core.html.options.OptChartJs.OptionLegend(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property align

Alignment of the legend.

Related Pages:

property display

Is the legend shown?

Related Pages:

property labels: OptionLabels
property position

Position of the legend values are top, left, bottom, right

Related Pages:

property reverse

Legend will show datasets in reverse order.

Related Pages:

property rtl

true for rendering the legends from right to left.

Related Pages:

property title: OptionTitle
class epyk.core.html.options.OptChartJs.OptionLine(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property tension
class epyk.core.html.options.OptChartJs.OptionPadding(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property bottom

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property left

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property right

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property top

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

class epyk.core.html.options.OptChartJs.OptionPieAnimation(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property animateRotate

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property animateScale

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

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

OptionLegend

Type:

rtype

class epyk.core.html.options.OptChartJs.OptionPoint(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property radius
class epyk.core.html.options.OptChartJs.OptionScaleGeo(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
set_projection(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None)
Parameters:
  • js_funcs

  • profile

class epyk.core.html.options.OptChartJs.OptionScales(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_axis(value: str) OptionAxes

Add a bespoke series to the chart.

Parameters:

value – The series alias

add_x_axis() OptionAxes

Add a X axis to a chart component.

add_y_axis() OptionAxes

Add / Get y axis to the chart.

property r: OptionScaleR

Add options to the r scale.

property x: OptionAxes

Add options to the x axis.

property xAxes: OptionAxes

Shortcut property to the last x_axes definition. Use the function x_axes to be more specific.

x_axes(i: Optional[int] = None) OptionAxes

Get a specific x axis.

Parameters:

i – optional. Default take the latest one

property y: OptionAxes

Add options to the y axis.

property y2: OptionAxes

Add options to a y2 axis.

property yAxes: OptionAxes

Shortcut property to the last y_axis definition. Use the function y_axis to be more specific.

y_axis is useful when multiple y axes are used for the same chart.

y_axis(i: Optional[int] = None) OptionAxes

Get a specific y axis.

Parameters:

i – optional. Default take the latest one

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

Related Pages:

https://www.chartjs.org/docs/latest/samples/title/alignment.html

property color

Related Pages:

https://www.chartjs.org/docs/latest/samples/other-charts/pie.html

property display

Related Pages:

https://www.chartjs.org/docs/latest/configuration/title.html https://www.chartjs.org/docs/latest/samples/other-charts/pie.html

property font: OptionLabelFont
property text

Set the Chart title.

Usage:

bar = page.ui.charts.chartJs.bar()
bar.options.plugins.title.text = pk.js_callback("function(){return Math.random()}")
bar.options.plugins.title.display = True

Related Pages:

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.OptChartJs.OptionsBar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property datasets: Bar

Common datasets configuration for all series

property stacked

Related Pages:

https://www.chartjs.org/samples/latest/charts/bar/stacked.html

class epyk.core.html.options.OptChartJs.OptionsChartSharedChartJs(component: HtmlModel, page: Optional[PageModel] = None)
x_format(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None)
Parameters:
  • js_funcs

  • profile

x_format_money(symbol: Union[str, JsDataModel, float, dict, list, bool] = '', digit: int = 0, thousand_sep: Union[str, JsDataModel, float, dict, list, bool] = '.', decimal_sep: Union[str, JsDataModel, float, dict, list, bool] = ',', fmt: Union[str, JsDataModel, float, dict, list, bool] = '%v %s', factor: Optional[int] = None, alias: str = '')
Parameters:
  • symbol

  • digit

  • thousand_sep

  • decimal_sep

  • fmt

  • factor

  • alias

x_format_number(factor: int = 1, alias: Optional[str] = None, digits: int = 0, thousand_sep: Union[str, JsDataModel, float, dict, list, bool] = '.')
Parameters:
  • factor

  • alias

  • digits

  • thousand_sep

x_label(value: Union[str, JsDataModel, float, dict, list, bool])

Set the label of the x-axis.

Parameters:

value – The axis label.

x_tick_count(num: int)
Parameters:

num

y_format(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None)
Parameters:
  • js_funcs

  • profile

y_format_money(symbol: Union[str, JsDataModel, float, dict, list, bool] = '', digit: int = 0, thousand_sep: Union[str, JsDataModel, float, dict, list, bool] = '.', decimal_sep: int = ',', fmt: Union[str, JsDataModel, float, dict, list, bool] = '%v %s', factor: Optional[int] = None, alias: str = '')
Parameters:
  • symbol

  • digit

  • thousand_sep

  • decimal_sep

  • fmt

  • factor

  • alias

y_format_number(factor: int = 1, alias: Optional[str] = None, digits: int = 0, thousand_sep: Union[str, JsDataModel, float, dict, list, bool] = '.')
Parameters:
  • factor

  • alias

  • digits

  • thousand_sep

y_label(value: Union[str, JsDataModel, float, dict, list, bool])

Set the label of the y-axis.

Parameters:

value – The axis label.

y_tick_count(num: int)
Parameters:

num

class epyk.core.html.options.OptChartJs.OptionsGeo(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property geo

OptionGeo

Type:

rtype

property plugins: OptionPlugins
class epyk.core.html.options.OptChartJs.OptionsLine(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property backgroundColor

The line fill color.

Related Pages:

property borderCapStyle

Cap style of the line.

Related Pages:

property borderColor

The line color.

Related Pages:

property borderDash

Length and spacing of dashes.

Related Pages:

property borderDashOffset

Offset for line dashes.

Related Pages:

property borderJoinStyle

Line joint style.

Related Pages:

property borderWidth

The line width (in pixels).

Related Pages:

property datasets: Line

Common datasets configuration for all series

property elements: OptionElementsLine
property fill

How to fill the area under the line.

Related Pages:

property interaction: OptionInteractionLine
property showLines

If false, the line is not drawn for this dataset.

Related Pages:

property spanGaps

If true, lines will be drawn between points with no or null data. If false, points with null data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

Related Pages:

property tension

Bezier curve tension of the line. Set to 0 to draw straightlines. This option is ignored if monotone cubic interpolation is used.

Related Pages:

class epyk.core.html.options.OptChartJs.OptionsPie(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property animation: OptionPieAnimation
property circumference

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property cutoutPercentage

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property datasets: Pie

Common datasets configuration for all series

property rotation

Related Pages:

https://www.chartjs.org/docs/latest/charts/line.html

property tooltips
class epyk.core.html.options.OptChartJs.OptionsPolar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property animation: OptionPieAnimation
property datasets: Polar

Common datasets configuration for all series

property startAngle

Starting angle to draw arcs for the first item in a dataset. In degrees, 0 is at top.

Related Pages: