OptJqvM Module

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

property backgroundColor

Background color of map container in any CSS compatible format.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop color:

String. The color code.

property borderColor

Border Color to use to outline map objects.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop color:

String. The color code.

property borderOpacity

Border Opacity to use to outline map objects ( use anything from 0-1, e.g. 0.5, defaults to 0.25 )

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop num:

Float. The opacity value.

property borderWidth

Border Width to use to outline map objects ( defaults to 1 ).

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop num:

Float. The border width value in pixel.

property color

Color of map regions.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop color:

String. The color code.

property colors

Colors of individual map regions. Keys of the colors objects are country codes according to ISO 3166-1 alpha-2 standard. Keys of colors must be in lower case.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop colors:

Dictionary. The color to be used per country.

property enableZoom

Whether to Enable Map Zoom ( true or false, defaults to true)

property hoverColor

Color of the region when mouse pointer is over it.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop color:

String. The color code.

property hoverColors

Colors of individual map regions when mouse pointer is over it. Keys of the colors objects are country codes according to ISO 3166-1 alpha-2 standard. Keys of colors must be in lower case.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop colors:

Dictionary. The color code.

property hoverOpacity

Opacity of the region when mouse pointer is over it.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop num:

Float. The opacity value.

property map

Map you want to load. Must include the javascript file with the name of the map you want. Available maps with this library are world_en, usa_en, europe_en and germany_en

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop value:

String. The map alias code.

property multiSelectRegion

Whether to enable more than one region to be selected at a time.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop value:

String. The map alias code.

property normalizeFunction

This function can be used to improve results of visualizations for data with non-linear nature. Function gets raw value as the first parameter and should return value which will be used in calculations of color, with which particular region will be painted.

onRegionClick(js_funcs, profile=None)

Callback function which will be called when the user clicks the region path. Country code will be passed to the callback as argument.

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Parameters:

• js_funcs – List | String. A Javascript Python function.

• profile – Boolean. Optional. Set to true to get the profile for the function on the Javascript console.

property scaleColors

This option defines colors, with which regions will be painted when you set option values. Array scaleColors can have more then two elements. Elements should be strings representing colors in RGB hex format.

Usage:

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

Prop colors:

List. The colors codes.

property selectedColor

Color for a region when you select it.

Related Pages:

https://www.10bestdesign.com/jqvmap/documentation/

property selectedRegions

This is the Region that you are looking to have preselected (two letter ISO code, defaults to null ).

property showTooltip

Whether to show Tooltips on Mouseover ( true or false, defaults to true )