HtmlEvent Module

class epyk.core.html.HtmlEvent.Dialog(report: PageModel, text: Union[Html, str], width: tuple, height: tuple, helper: str, options: Optional[dict], html_code: Optional[str], profile: Optional[Union[bool, dict]])
property dom: JsHtmlProgressBar

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript by default.

Returns:

A Javascript Dom object

property js: Dialog

Open content in an interactive overlay.

Related Pages:

Returns:

A Javascript Dom object

property options: OptionDialog

Property to the comments component options.

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

Python can pass some options to the JavaScript layer.

Related Pages:

class epyk.core.html.HtmlEvent.Filters(page: PageModel, items, width, height, html_code, helper, options, profile)
append(value: Any, category: Optional[str] = None, name: Optional[str] = None, disabled: bool = False, fixed: bool = False)
Parameters:
  • value

  • category

  • name

  • disabled

  • fixed

delete(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None)
Parameters:
  • js_funcs – The Javascript functions.

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

property dom: Tags

The Javascript Dom object.

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

Set the Filters component draggable.

Parameters:
  • js_funcs – Javascript functions

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

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

  • source_event – Optional. The source target for the event

drop(js_funcs: Union[List[Union[str, JsDataModel]], str], prevent_default: bool = True, profile: Optional[Union[bool, dict]] = None)
Parameters:
  • js_funcs – The Javascript functions.

  • prevent_default

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

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

Javascript event triggered by the enter key.

Parameters:
  • js_funcs – The JavaScript events.

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

property options: OptionsTagItems

Property to the comments component options.

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

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlEvent.Menu(page, records, width, height, helper, options, html_code, profile)
property dom: JsHtmlProgressBar

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript by default.

Returns:

A Javascript Dom object

property js: Menu

The Javascript functions defined for this component.

Those can be specific ones for the module or generic ones from the language.

Related Pages:

Returns:

A Javascript Dom object

property options: OptionsMenu

Property to the comments component options.

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

Python can pass some options to the JavaScript layer.

Related Pages:

property style: ClassMenu

Property to the CSS Style of the component.

class epyk.core.html.HtmlEvent.OptionsBar(page: PageModel, records, width: tuple, height: tuple, color: str, options: Optional[dict], profile: Optional[Union[bool, dict]])
draggable(options: Optional[dict] = None, *args, **kwargs)

Set the component as a draggable item.

Parameters:
  • js_funcs – Javascript functions

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

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

  • source_event – Optional. The source target for the event

property options: OptionBar

Property to the comments component options.

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

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlEvent.ProgressBar(page: PageModel, number: float, total, width: tuple, height: tuple, helper: Optional[str], options: Optional[dict], html_code: Optional[str], profile: Optional[Union[bool, dict]])
property dom: JsHtmlProgressBar

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript by default.

Returns:

A Javascript Dom object

property js: ProgressBar

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript by default.

Related Pages:

Returns:

A Javascript Dom object

property options: OptionsProgBar

The progress bar is designed to display the current percent complete for a process.

The bar is coded to be flexibly sized through CSS and will scale to fit inside its parent container by default.

Related Pages:

to(number: float, timer: int = 10)

Move the progress bar to a defined level in a specific amount of time in millisecond.

Parameters:
  • number – The final state for the progress bar

  • timer – Optional. the appended of the increase in millisecond

class epyk.core.html.HtmlEvent.Range(page: PageModel, number: int, min_val: float, max_val: float, width: tuple, height: tuple, helper: Optional[str], options: Optional[dict], html_code: Optional[str], profile: Optional[Union[bool, dict]])
class epyk.core.html.HtmlEvent.SignIn(page: PageModel, text: Optional[str], size: tuple, icon: Optional[str])
class epyk.core.html.HtmlEvent.SkillBar(page: PageModel, data, y_column, x_axis, title, width, height, html_code, options, profile)
property js: SkillBar

The JavaScript predefined functions for this component.

Returns:

A Javascript object

property options: OptionsSkillbars

Property to the comments component options.

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

Python can pass some options to the JavaScript layer.

class epyk.core.html.HtmlEvent.Slider(page: PageModel, number: int, min_val: float, max_val: float, width: tuple, height: tuple, helper: Optional[str], options: Optional[dict], html_code: Optional[str], profile: Optional[Union[bool, dict]])
change(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, on_ready: bool = False)

Triggered after the user slides a handle, if the value has changed or if the value is changed programmatically via the value method.

Related Pages:

Parameters:
  • js_funcs – Javascript functions

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

  • on_ready – Optional. Trigger the change event when page is ready

property dom: JsHtmlSlider

The Javascript Dom object.

property js: Slider

Return all the Javascript functions defined for an HTML Component.

Those functions will use plain javascript by default.

Related Pages:

Returns:

A Javascript Dom object

property options: OptionsSlider

Property to the comments component options.

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

Python can pass some options to the JavaScript layer.

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

Triggered when the user starts sliding.

Related Pages:

Parameters:
  • js_funcs – Javascript functions

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

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

Triggered when the user starts sliding.

Related Pages:

Parameters:
  • js_funcs – Javascript functions

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

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

Triggered after the user slides a handle.

Related Pages:

Parameters:
  • js_funcs – Javascript functions

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

property style: ClassSlider

Property to the CSS Style of the component.

class epyk.core.html.HtmlEvent.SliderDate(page: PageModel, number: Union[float, list], min_val: float, max_val: float, width: Union[tuple, int], height: Union[tuple, int], helper: str, options: dict, html_code: str, profile: Union[dict, bool])
property dom: JsHtmlSliderDate

The Javascript Dom object.

class epyk.core.html.HtmlEvent.SliderDates(page: PageModel, number: Union[float, list], min_val: float, max_val: float, width: Union[tuple, int], height: Union[tuple, int], helper: str, options: dict, html_code: str, profile: Union[dict, bool])
property dom: JsHtmlSliderDates

The Javascript Dom object.