HtmlOthers Module

class epyk.core.html.HtmlOthers.Breadcrumb(page: PageModel, records, width, height, html_code, options, profile)
property options: OptBreadCrumb

Property to set all the possible object for a breadcrumb definition.

class epyk.core.html.HtmlOthers.Help(page: PageModel, val, width: tuple, profile: Optional[Union[bool, dict]], options: Optional[dict])
property style: ClassHelp

Property to the CSS Style of the component.

class epyk.core.html.HtmlOthers.Hr(page: PageModel, background_color: str, width: tuple, height: tuple, align: str, options: Optional[dict], profile: Optional[Union[bool, dict]])
margin(left: int = 0, right: int = 0, unit: str = '%')

Shortcut to set the margin let and right for this HTML component.

Parameters:

  • left – Optional. The margin left.

  • right – Optional. The margin right.

  • unit – Optional. The unit by default percentage.

property style: ClassStandard

Property to the CSS Style of the component.

class epyk.core.html.HtmlOthers.HtmlCaptcha(page: PageModel, record, width: tuple, height: tuple, options: Optional[dict], profile: Optional[Union[bool, dict]])
class epyk.core.html.HtmlOthers.HtmlJson(page: PageModel, tree_data, width, height, options, profile)
property dom: JsonFormatter

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript available for a DOM element by default.

property js: Json

Return the Javascript internal object.

Returns:

A Javascript object

property jsonId

Return the Javascript variable of the json object.

property options: OptionsJsonFmt

Property to the component options.

Options can either impact the Python side or the Javascript builder.

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlOthers.HtmlQRCode(page: PageModel, record, width: tuple, height: tuple, options: Optional[dict], profile: Optional[Union[bool, dict]])
property js: QrCode

Return the Javascript internal object.

Returns:

A Javascript object

property jsonId

Return the Javascript variable of the json object.

property options: OptionsQrCode

Property to the component options.

Options can either impact the Python side or the Javascript builder.

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlOthers.Legend(page: PageModel, record, width: tuple, height: tuple, options: Optional[dict], profile: Optional[Union[bool, dict]])
property options: OptionsLegend

Property to the component options.

Options can either impact the Python side or the Javascript builder.

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlOthers.Loading(page: PageModel, text: str, color: str, size: tuple, options: Optional[dict], profile: Optional[Union[bool, dict]])
fixed(css: Optional[dict] = None, icon_css: Optional[dict] = None)

Set css attributes of the loading div to be fixed.

This can be done directly in options in the component constructor options={“fixed”: True}.

Parameters:

  • css – Optional. The css attributes

  • icon_css – Optional. The CSS attributes

Returns:

self to allow the chains.

class epyk.core.html.HtmlOthers.Newline(page: PageModel, vals, html_code: Optional[str] = None, options: Optional[Union[bool, dict]] = None, profile: Optional[Union[List[Union[str, JsDataModel]], str]] = None, css_attrs: Optional[dict] = None)
class epyk.core.html.HtmlOthers.Slides(page: PageModel, start, width: tuple, height: tuple, options: Optional[dict], profile: Optional[Union[bool, dict]])
add(component: Union[Html, str])

Add a component to the slide.

Parameters:

component – The HTML component to be added to this component

add_slide(title: str, component: Union[Html, str], options: Optional[dict] = None)

Add a slide.

Parameters:

  • title – The title value in the slide

  • component – The HTML component

  • options – Optional. The various component options

property dom: Slides

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript available for a DOM element by default.

property options: OptionsText

Property to the component options.

Options can either impact the Python side or the Javascript builder.

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlOthers.Stars(page: PageModel, val, label, color, align, best, html_code, helper, options, profile)
click(js_funcs: Optional[Union[List[Union[str, JsDataModel]], str]] = None, profile: Optional[Union[bool, dict]] = None, source_event: Optional[str] = None, on_ready: bool = False)

Add the event click and double click to the starts item.

The Javascript function will be triggered after the change of content of the component.

Usage:

stars = page.ui.rich.stars(3, label="test Again")
stars.click(page.js.console.log("test").toStr())
Parameters:

  • js_funcs – The Javascript functions

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

  • source_event – Optional. The JavaScript DOM source for the event (can be a sug item)

  • on_ready – Optional. Specify if the event needs to be trigger when the page is loaded

Returns:

self to allow the chains

property dom: Stars

The JavaScript dom object to be used in any events.