OptTrees Module

class epyk.core.html.options.OptTrees.OptDropDown(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)

property a

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

Parameters:

js_funcs – A Javascript Python function
profile – Optional. Set to true to get the profile for the function on the Javascript console

property ul

property width

Set the width of the dropdown item.

Prop number:: The width of the item in pixel

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:

https://www.w3schools.com/cssref/

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.OptTrees.OptionsTree(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)

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

Add a specific event on the leaf nodes in the hierarchy view.

Parameters:

js_funcs – A Javascript Python function
profile – Optional. Set to true to get the profile for the function on the Javascript console

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

Add event on the node label.

Parameters:

js_funcs – A Javascript Python function
profile – Optional. Set to true to get the profile for the function on the Javascript console

property expanded

Flag to set the initial state of the tree.

Prop flag:: A flag to specify the state of the tree

property filter_on

The sub string to filter the tree result

Type:: prop key

property icon_close

Set the icon when the node is closed.

Prop icon:: The icon reference from font-awesome

property icon_open

Set the icon when the node is open.

Prop icon:: The icon reference from font-awesome

property icon_style

Set the CSS attributes to each node and leaf in the tree.

Prop css:: The CSS Style to be used

property is_root: prop flag:

property style

Set the CSS attributes to each node and leaf in the tree.

Prop css:: The CSS Style to be used

property with_badge

Display a badge with the count of leaves in the tree for a given node.

Prop flag:: A flag to specify if the badge with the count of leaves is visible

property with_icon

The key in the data used to display an icon

Type:: prop key