Network Interface

class epyk.interfaces.components.CompNetwork.Network(ui)
alert(category: str, value: str = '', width: Optional[Union[tuple, int, str]] = (320, 'px'), height: Optional[Union[tuple, int, str]] = (None, None), html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = False) → Alert

Function to add when the python run some tags to put on the top of your report messages.

The type of the messages can be different according to its criticallity. This is fully defined and #driven in the Python and visible in the browser when the page is ready

All the notification can be hidden directly from the report by setting the flag alerts = False e.g: rptObj.alerts = False

Usage:

page.ui.messaging.alert('WARNING', 'Server URL not recognized', 'Please check')

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Alert

Related Pages:

Templates:

Parameters:

  • category – The warning level.

  • value – Optional. The content of the notification.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

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

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

assistant(image, name: str = '', path: Optional[str] = None, html_code: Optional[str] = None, size: Optional[Union[tuple, int, str]] = (50, 'px'), profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Assistant

Usage:

:param image:
:param name:
:param path:
:param html_code: Optional. An identifier for this component (on both Python and Javascript side).
:param size: Optional. A tuple with the integer for the component width and its unit.
:param profile: Optional. A flag to set the component performance storage.
:param options: Optional. Specific Python options available for this component.
bot(html_code: str, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (200, 'px'), profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Bot

Usage:

container = page.ui.network.bot(html_code='bot_service')

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Bot

Templates:

Parameters:

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

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

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

chat(html_code: str, record: Optional[List[dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (200, 'px'), profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Chat

Usage:

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Chat

Templates:

Parameters:

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

  • record – Optional. The Python list of dictionaries.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

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

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

comments(html_code: str, record: Optional[List[dict]] = None, width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = (200, 'px'), profile: Optional[Union[bool, dict]] = None, options: Optional[dict] = None) → Comments

Python wrapper to a div item composed to several sub html items to display message

Usage:

db = page.db(database="test.db")
page.comments('Test', dbService={'db': db, 'com_table': 'comments', 'reply_table': 'replyComments',
  'reply_service': 'post_reply/url', 'user_coms': 'user_comments', 'privacy': 'public', 'service': your/url})

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Comments

Related Pages:

Parameters:

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

  • record – Optional. The Python list of dictionaries.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

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

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

danger(value: str = '', html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (320, 'px'), height: Optional[Union[tuple, int, str]] = (None, None), options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = False) → Alert

Function to add when the python run some tags to put on the top of your report messages.

The type of the messages can be different according to its criticality. This is fully defined and #driven in the Python and visible in the browser when the page is ready

All the notification can be hidden directly from the report by setting the flag alerts = False e.g: rptObj.alerts = False

Usage:

page.ui.messaging.alert('danger', 'Server URL not recognized', 'Please check')

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Alert

Related Pages:

Parameters:

  • value – Optional. The content of the notification.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

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

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

download(name: str, icon: Optional[str] = None, path: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (25, 'px'), height: Optional[Union[tuple, int, str]] = (25, 'px'), html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → IconEdit

Usage:

:param name: Optional.
:param icon: Optional. The component icon content from font-awesome references.
:param path: Optional. String. The image file path.
:param width: Optional. A tuple with the integer for the component width and its unit.
:param height: Optional. A tuple with the integer for the component height and its unit.
:param html_code: Optional. The id for this component.
:param options: Optional. Specific Python options available for this component.
:param profile: Optional. A flag to set the component performance storage.
dropfile(placeholder: str = '', delimiter: str = 'TAB', width: Optional[Union[tuple, int, str]] = (100, '%'), height: Optional[Union[tuple, int, str]] = ('auto', ''), tooltip: Optional[str] = None, html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → DropFile

Add an HTML component to drop files. The files will be dropped by default to the OUTPUT folder of the defined environment.

Files will also be recorded in the database in order to ensure that those data will not be shared. The data sharing is and should be defined only by the user from the UI.

Underlying HTML Objects:

  • epyk.core.html.HtmlFiles.DropFile

Usage:

page.ui.network.dropfile()

Related Pages:

Parameters:

  • placeholder – Optional. The placeholder text when input empty.

  • delimiter – Optional. The column delimiter.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

  • tooltip – Optional. A string with the value of the tooltip.

  • html_code – Optional. The id for this component.

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

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

impression(number: int = 0, icon: str = 'fas fa-chart-bar', options: Optional[dict] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Div

Add an impression component. This is designed to use the viewport function to increment the value,

Usage:

page.ui.network.impression()
Parameters:

  • number – Optional. The initial value

  • icon – Optional. The icon text

  • options – Optional. The number component options

  • html_code – Optional. The code used on the JavaScript side

  • profile – Optional. The profiling options

info(value: str = '', html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (320, 'px'), height: Optional[Union[tuple, int, str]] = (None, None), options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = False) → Alert

Function to add when the python run some tags to put on the top of your report messages. The type of the messages can be different according to its criticallity. This is fully defined and #driven in the Python and visible in the browser when the page is ready

Usage:

page.ui.messaging.alert('info', 'Server URL not recognized', 'Please check')

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Alert

Related Pages:

Parameters:

  • value – Optional. The content of the notification.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

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

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

news(value: str = '', html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (320, 'px'), height: Optional[Union[tuple, int, str]] = (None, None), options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = False) → News

Usage:

b = page.ui.button("Display")
n = page.ui.messaging.news("This is a title", "This is the content", link_script="TestSlider")
b.click(n.jsGenerate("Updated content", isPyData=True))

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.News

Templates:

Parameters:

  • value – Optional.

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

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

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

room(img: str, html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (60, 'px'), height: Optional[Union[tuple, int, str]] = (60, 'px'), options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = False) → Room

Usage:

:param img: Optional. The image path on the server or locally to be used.
:param html_code: Optional. The id for this component.
:param width: Optional. A tuple with the integer for the component width and its unit.
:param height: Optional. A tuple with the integer for the component height and its unit.
:param options: Optional. Specific Python options available for this component.
:param profile: Optional. A flag to set the component performance storage.
success(value: str = '', html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (320, 'px'), height: Optional[Union[tuple, int, str]] = (None, None), options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = False) → Alert

unction to add when the python run some tags to put on the top of your report messages. The type of the messages can be different according to its criticallity. This is fully defined and #driven in the Python and visible in the browser when the page is ready

Usage:

page.ui.messaging.alert('success', 'Server URL not recognized', 'Please check')

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Alert

Related Pages:

Parameters:

  • value – Optional. The content of the notification.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

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

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

upload(icon: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (25, 'px'), height: Optional[Union[tuple, int, str]] = (25, 'px'), html_code: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None) → IconEdit

Usage:

:param icon: Optional. The component icon content from font-awesome references
:param width: Optional. A tuple with the integer for the component width and its unit
:param height: Optional. A tuple with the integer for the component height and its unit
:param html_code: Optional. The id for this component
:param options: Optional. Specific Python options available for this component
:param profile: Optional. A flag to set the component performance storage
votes(number: int = 0, options: Optional[dict] = None, html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = None) → Div

Add a vote component with two arrows and a number.

Usage:

vote = page.ui.network.votes()
vote.up.style.css.cursor = "pointer"
vote.up.click(vote.number.dom.add(1))
vote.down.click(vote.number.dom.add(-1))
Parameters:

  • number – Optional. The initial value

  • options – Optional. The number component options

  • html_code – Optional. The code used on the JavaScript side

  • profile – Optional. The profiling options

warning(value: str = '', html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (320, 'px'), height: Optional[Union[tuple, int, str]] = (None, None), options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = False) → Alert

Function to add when the python run some tags to put on the top of your report messages. The type of the messages can be different according to its criticallity. This is fully defined and #driven in the Python and visible in the browser when the page is ready

Usage:

page.ui.messaging.alert('warning', 'Server URL not recognized', 'Please check')

danger = page.ui.network.warning()
danger.options.time = None
danger.options.close = True

Underlying HTML Objects:

  • epyk.core.html.HtmlMessaging.Alert

Related Pages:

Parameters:

  • value – Optional. The content of the notification.

  • width – Optional. A tuple with the integer for the component width and its unit.

  • height – Optional. A tuple with the integer for the component height and its unit.

  • html_code – Optional. An identifier for this component (on both Python and Javascript side).

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

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