Titles Interface

class epyk.interfaces.components.CompTitles.Titles(ui)

bold(text: str = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

tags:

categories:

Usage:

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py

• param text:

  Optional. The value to be displayed to the component

  param options:

  Optional. Specific Python options available for this component

  param tooltip:

  Optional. A string with the value of the tooltip

  param align:

  Optional. The text-align property within this component

  param color:

  Optional. The font color in the component. Default inherit

  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. An identifier for this component (on both Python and Javascript side)

  param profile:

  Optional. A flag to set the component performance storage

caption(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

tags:

categories:

Usage:

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py

• param text:

  Optional. The value to be displayed to the component

  param options:

  Optional. Specific Python options available for this component

  param tooltip:

  Optional. A string with the value of the tooltip

  param align:

  Optional. The text-align property within this component

  param color:

  Optional. The font color in the component. Default inherit

  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. An identifier for this component (on both Python and Javascript side)

  param profile:

  Optional. A flag to set the component performance storage

category(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

tags:

categories:

Usage:

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py

• param text:

  Optional. The value to be displayed to the component

  param options:

  Optional. Specific Python options available for this component

  param tooltip:

  Optional. A string with the value of the tooltip

  param align:

  Optional. The text-align property within this component

  param color:

  Optional. The font color in the component. Default inherit

  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. An identifier for this component (on both Python and Javascript side)

  param profile:

  Optional. A flag to set the component performance storage

head(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

Tags:

Categories:

Usage:

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py

Parameters:

• text – Optional. The value to be displayed to the component

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

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

• align – Optional. The text-align property within this component

• color – Optional. The font color in the component. Default inherit

• 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)

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

headline(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: bool = True, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

Tags:

Categories:

Usage:

page.ui.titles.headline("Daily")

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/calendar.py https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py

Parameters:

• text – Optional. The value to be displayed to the component

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

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

• align – Optional. The text-align property within this component

• color – Optional. The font color in the component. Default inherit

• 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)

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

rubric(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

Tags:

Categories:

Usage:

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py

Parameters:

• text – Optional. The value to be displayed to the component

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

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

• align – Optional. The text-align property within this component

• color – Optional. The font color in the component. Default inherit

• 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)

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

section(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

Tags:

Categories:

Usage:

t0 = page.ui.titles.section("Available Items")

Parameters:

• text – Optional. The value to be displayed to the component

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

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

• align – Optional. The text-align property within this component

• color – Optional. The font color in the component. Default inherit

• 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)

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

subtitle(text: str = '', name: Optional[str] = None, contents=None, color: Optional[str] = None, picture: Optional[str] = None, icon: Optional[str] = None, top: int = 5, html_code: Optional[str] = None, width: Optional[Union[tuple, int, str]] = ('auto', ''), height: Optional[Union[tuple, int, str]] = (None, 'px'), align: Optional[str] = None, options: Optional[dict] = None, profile: Optional[Union[bool, dict]] = None)

tags:

categories:

Usage:

• param text:

  Optional. The value to be displayed to the component

  param name:

  param contents:

  param color:

  Optional. The font color in the component. Default inherit

  param picture:

  param icon:

  param top:

  param html_code:

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

  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 align:

  Optional. The text-align property within this component

  param options:

  Optional. Specific Python options available for this component

  param profile:

  Optional. A flag to set the component performance storage

title(text: Optional[Union[str, dict]] = None, options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

Tags:

Categories:

Usage:

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py https://github.com/epykure/epyk-templates/blob/master/locals/components/paragraph.py

Parameters:

• text – Optional. The value to be displayed to the component

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

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

• align – Optional. he text-align property within this component

• color – Optional. The font color in the component. Default inherit

• 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)

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

underline(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

tags:

categories:

Usage:

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py

• param text:

  Optional. The value to be displayed to the component

  param options:

  Optional. Specific Python options available for this component

  param tooltip:

  Optional. A string with the value of the tooltip

  param color:

  Optional. The font color in the component. Default inherit

  param align:

  Optional. The text-align property within 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 html_code:

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

  param profile:

  Optional. A flag to set the component performance storage

upper(text: Union[str, dict] = '', options: Optional[dict] = None, tooltip: str = '', align: str = 'left', color: Optional[str] = None, width: Optional[Union[tuple, int, str]] = (None, 'px'), height: Optional[Union[tuple, int, str]] = ('auto', ''), html_code: Optional[str] = None, profile: Optional[Union[bool, dict]] = False)

tags:

categories:

Usage:

page.ui.titles.upper("Test")
page.ui.titles.upper("Test", color=True)

Templates:

https://github.com/epykure/epyk-templates/blob/master/locals/components/list.py https://github.com/epykure/epyk-templates/blob/master/locals/components/paragraph.py

• param text:

  Optional. The value to be displayed to the component

  param options:

  Optional. Specific Python options available for this component

  param tooltip:

  Optional. A string with the value of the tooltip

  param align:

  Optional. The text-align property within this component

  param color:

  Optional. The font color in the component. Default inherit

  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. An identifier for this component (on both Python and Javascript side)

  param profile:

  Optional. A flag to set the component performance storage