zen_dash.objects package

Submodules

zen_dash.objects.flex_data module

class zen_dash.objects.flex_data.FlexData(*, fxFlex: Optional[str] = '18%', fxFlex_md: Optional[str] = '33%', fxFlex_sm: Optional[str] = '50%', fxFlex_xs: Optional[str] = '100%')[source]

Bases: BaseUpdate

class Config[source]

Bases: object

exclude_none = True

fxFlex: Optional[str]

fxFlex_md: Optional[str]

fxFlex_sm: Optional[str]

fxFlex_xs: Optional[str]

zen_dash.objects.instances module

class zen_dash.objects.instances.BoxData(*, icon: str, name: str, value: str)[source]

Bases: BaseUpdate

icon: str

name: str

value: str

class zen_dash.objects.instances.ButtonColor(value)[source]

Bases: Enum

An enumeration.

ACCENT = 'accent'

PRIMARY = 'primary'

WARN = 'warn'

class zen_dash.objects.instances.ButtonData(*, url: str, name: str, redirect: bool = False, download: bool = False, target_attribute: TargetAttribute = TargetAttribute.Blank, color: ButtonColor = ButtonColor.PRIMARY, button_type: ButtonType = ButtonType.RAISED, style: Optional[Dict[str, str]] = None, icon: Optional[str] = None)[source]

Bases: BaseUpdate

button_type: ButtonType

color: ButtonColor

download: bool

icon: Optional[str]

name: str

redirect: bool

style: Optional[Dict[str, str]]

target_attribute: TargetAttribute

url: str

class zen_dash.objects.instances.ButtonFloating(*, url: str, name: str, redirect: bool = False, style: Dict[str, str], icon: str, fab_style: FABStyle = FABStyle.FAB, color: FABColor = FABColor.ACCENT, target_attribute: TargetAttribute = TargetAttribute.PARENT)[source]

Bases: BaseUpdate

color: FABColor

fab_style: FABStyle

icon: str

name: str

redirect: bool

style: Dict[str, str]

target_attribute: TargetAttribute

url: str

class zen_dash.objects.instances.ButtonToggleData(*, name: str, multi: bool = False, data: List[ButtonToggleInstance])[source]

Bases: BaseUpdate

data: List[ButtonToggleInstance]

multi: bool

name: str

class zen_dash.objects.instances.ButtonToggleInstance(*, name: str, selected: bool = False)[source]

Bases: BaseUpdate

name: str

selected: bool

class zen_dash.objects.instances.ButtonType(value)[source]

Bases: Enum

An enumeration.

BASIC = 'basic'

FAB = 'fab'

FLAT = 'flat'

ICON = 'icon'

MINIFAB = 'mini_fab'

RAISED = 'raised'

STROKED = 'stroked'

class zen_dash.objects.instances.ChartData(*, name: str, data: Dict)[source]

Bases: BaseUpdate

data: Dict

name: str

class zen_dash.objects.instances.CheckBoxData(*, data: List[CheckBoxInstance], style: Style = Style.horizontal, name: str)[source]

Bases: BaseUpdate

data: List[CheckBoxInstance]

name: str

style: Style

class zen_dash.objects.instances.CheckBoxInstance(*, name: str, selected: bool)[source]

Bases: BaseUpdate

name: str

selected: bool

class zen_dash.objects.instances.CustomHTML(*, name: str, html: str, full_custom: bool = False, script: Optional[str] = None)[source]

Bases: BaseUpdate

full_custom: bool

html: str

name: str

script: Optional[str]

class zen_dash.objects.instances.DateTimeData(*, name: str, first_date: str, second_date: Optional[str] = None)[source]

Bases: BaseUpdate

first_date: str

name: str

second_date: Optional[str]

class zen_dash.objects.instances.DialogBox(*, url: str = '', height: str = '60%', width: str = '60%')[source]

Bases: BaseUpdate

height: str

url: str

width: str

class zen_dash.objects.instances.Display(*, duration: int = 5, message: Optional[str] = None, status: DisplayStatus = DisplayStatus.SUCCESS)[source]

Bases: BaseUpdate

duration: int

message: Optional[str]

status: DisplayStatus

class zen_dash.objects.instances.DisplayDialog(*, height: str = '500px', width: str = '500px', custom_message: str)[source]

Bases: BaseUpdate

custom_message: str

height: str

width: str

class zen_dash.objects.instances.DisplayStatus(value)[source]

Bases: Enum

An enumeration.

ERROR = 'error'

SUCCESS = 'success'

WARN = 'warn'

class zen_dash.objects.instances.DownloadData(*, label: str, url: str, name: str)[source]

Bases: BaseUpdate

label: str

name: str

url: str

class zen_dash.objects.instances.FABColor(value)[source]

Bases: Enum

An enumeration.

ACCENT = 'accent'

PRIMARY = 'primary'

WARN = 'warn'

class zen_dash.objects.instances.FABStyle(value)[source]

Bases: Enum

An enumeration.

FAB = 'fab'

ICON = 'icon'

MINIFAB = 'mini_fab'

class zen_dash.objects.instances.FormData(*, name: str, submit_info: SubmitFormData, form_schema: Dict, ui_schema: Dict, data: Dict)[source]

Bases: BaseUpdate

data: Dict

form_schema: Dict

name: str

submit_info: SubmitFormData

ui_schema: Dict

class zen_dash.objects.instances.GroupedFilterData(*, multi: bool = False, name: str, url: Optional[str] = None, data: List[GroupedFilterDataInstance], selected: List[str] = [])[source]

Bases: BaseUpdate

data: List[GroupedFilterDataInstance]

multi: bool

name: str

selected: List[str]

url: Optional[str]

class zen_dash.objects.instances.GroupedFilterDataInstance(*, group_name: str, group_data: List[str])[source]

Bases: BaseUpdate

group_data: List[str]

group_name: str

class zen_dash.objects.instances.HighChartData(*, type: HighChartType = HighChartType.CHART, config: Dict)[source]

Bases: BaseUpdate

config: Dict

type: HighChartType

class zen_dash.objects.instances.HighChartType(value)[source]

Bases: Enum

An enumeration.

CHART = 'chart'

Funnel = 'funnel'

Gantt = 'gantt'

MAP = 'map'

STOCK = 'stock'

Sankey = 'sankey'

class zen_dash.objects.instances.IframeData(*, url: str, width: str = '1100', height: str = '400')[source]

Bases: BaseUpdate

height: str

url: str

width: str

class zen_dash.objects.instances.ImageData(*, url: str, height: str, width: str)[source]

Bases: BaseUpdate

height: str

url: str

width: str

class zen_dash.objects.instances.InputData(*, label: Optional[str] = None, name: str, value: Optional[str] = None)[source]

Bases: BaseUpdate

label: Optional[str]

name: str

value: Optional[str]

class zen_dash.objects.instances.InstanceType(value)[source]

Bases: Enum

Docstring for class InstanceType Instance Type required for ReturnData

Returns: Instance Type for Enum
Return type: Enum

BOX = 'box'

BUTTON = 'button'

BUTTON_TOGGLE = 'button_toggle'

CHART = 'chart'

CHECKBOX = 'checkbox'

CUSTOM_HTML = 'custom_html'

DATE = 'date'

DOWNLOAD = 'download'

FLOATING_BUTTON = 'floating_button'

FORM = 'form'

GROUP_FILTER = 'group_filter'

HIGHCHART = 'highchart'

IFRAME = 'iframe'

IMAGE = 'image'

INPUT = 'input'

MULTI_EXPAND = 'multi_expand'

MULTI_LIST = 'multi_list'

MULTI_TABS = 'multi_tabs'

RADIO = 'radio'

SIMPLE_FILTER = 'simple_filter'

SIMPLE_SERVER_FILTER = 'simple_server_filter'

SLIDER = 'slider'

TABLE = 'table'

TOGGLE = 'toggle'

UPLOAD = 'upload'

class zen_dash.objects.instances.MultiData(*, urls: List[MultiURLInfo])[source]

Bases: BaseUpdate

urls: List[MultiURLInfo]

class zen_dash.objects.instances.MultiURLInfo(*, name: Optional[str] = None, with_card: bool = False, url: str)[source]

Bases: BaseUpdate

name: Optional[str]

url: str

with_card: bool

class zen_dash.objects.instances.RadioData(*, data: List[str], style: Style = Style.horizontal, name: str, selected: Optional[str] = '')[source]

Bases: BaseUpdate

data: List[str]

name: str

selected: Optional[str]

style: Style

class zen_dash.objects.instances.ReactiveData(*, full_rective: Optional[bool] = False, reactive_ids: Optional[List[str]] = [], hidden: bool = False)[source]

Bases: BaseUpdate

full_rective: Optional[bool]

hidden: bool

reactive_ids: Optional[List[str]]

class zen_dash.objects.instances.ResponseFormData(*, redirect_url: str)[source]

Bases: BaseUpdate

redirect_url: str

class zen_dash.objects.instances.ReturnData(*, type: InstanceType, title: Optional[str] = None, chart_data: Optional[ChartData] = None, box_data: Optional[BoxData] = None, date_data: Optional[DateTimeData] = None, checkbox_data: Optional[CheckBoxData] = None, radio_data: Optional[RadioData] = None, slider_data: Optional[SliderData] = None, button_toggle_data: Optional[ButtonToggleData] = None, table_data: Optional[TableData] = None, toggle_data: Optional[ToggleData] = None, multi_data: Optional[MultiData] = None, simple_filter_data: Optional[SimpleFilterData] = None, simple_server_filter_data: Optional[SimpleServerSideFilterData] = None, group_filter_data: Optional[GroupedFilterData] = None, input_data: Optional[InputData] = None, download_data: Optional[DownloadData] = None, upload_data: Optional[UploadData] = None, image_data: Optional[ImageData] = None, highchart_data: Optional[HighChartData] = None, iframe_data: Optional[IframeData] = None, custom_html_data: Optional[CustomHTML] = None, footer: Optional[str] = None, flex: Optional[FlexData] = FlexData(fxFlex='18%', fxFlex_md='33%', fxFlex_sm='50%', fxFlex_xs='100%'), reactive: Optional[ReactiveData] = ReactiveData(full_rective=False, reactive_ids=[], hidden=False), tooltip_data: Optional[ToolTipData] = None, dialog_data: Optional[DialogBox] = None, button_data: Optional[ButtonData] = None, form_data: Optional[FormData] = None, floating_button_data: Optional[ButtonFloating] = None, ui_data: Optional[List[UIData]] = None)[source]

Bases: BaseUpdate

Main return object use for everything except /backend/page_detail, /backend/sidebar, and /backend/title depdning upon which type (InstanceType) you select, you have to select corsponding return value

for example, if you select BOX as input, you have to choose box_data as one of input.

Example: i.ReturnData(type=i.InstanceType.BOX, box_data=i.BoxData(icon=”attach_money”, name=”User Spent”, value=”$5000”), footer=”10% increase compare to last week “)

Parameters

type – InstanceType this will dectate what type of output will be render
title – Optional[str] tile of mat box in which output will be render

box_data: Optional[BoxData]

button_data: Optional[ButtonData]

button_toggle_data: Optional[ButtonToggleData]

chart_data: Optional[ChartData]

checkbox_data: Optional[CheckBoxData]

custom_html_data: Optional[CustomHTML]

date_data: Optional[DateTimeData]

dialog_data: Optional[DialogBox]

download_data: Optional[DownloadData]

flex: Optional[FlexData]

floating_button_data: Optional[ButtonFloating]

footer: Optional[str]

form_data: Optional[FormData]

group_filter_data: Optional[GroupedFilterData]

highchart_data: Optional[HighChartData]

iframe_data: Optional[IframeData]

image_data: Optional[ImageData]

input_data: Optional[InputData]

multi_data: Optional[MultiData]

radio_data: Optional[RadioData]

reactive: Optional[ReactiveData]

simple_filter_data: Optional[SimpleFilterData]

simple_server_filter_data: Optional[SimpleServerSideFilterData]

slider_data: Optional[SliderData]

table_data: Optional[TableData]

title: Optional[str]

toggle_data: Optional[ToggleData]

tooltip_data: Optional[ToolTipData]

type: InstanceType

ui_data: Optional[List[UIData]]

upload_data: Optional[UploadData]

classmethod validator_type_match(field_values)[source]

class zen_dash.objects.instances.SimpleFilterData(*, multi: bool = False, name: str, data: List[str], selected: List[str] = [])[source]

Bases: BaseUpdate

data: List[str]

multi: bool

name: str

selected: List[str]

class zen_dash.objects.instances.SimpleServerSideFilterData(*, multi: bool = False, name: str, data: List[str], selected: List[str] = [], url: Optional[str] = None)[source]

Bases: SimpleFilterData

url: Optional[str]

class zen_dash.objects.instances.SliderData(*, name: str, max: float, min: float, step: float, thumbLabel: bool = True, invert: bool = False, vertical: bool = False, value: Optional[float] = None)[source]

Bases: BaseUpdate

invert: bool

max: float

min: float

name: str

step: float

thumbLabel: bool

value: Optional[float]

vertical: bool

class zen_dash.objects.instances.Style(value)[source]

Bases: Enum

An enumeration.

horizontal = 'Horizontal'

vertical = 'Vertical'

class zen_dash.objects.instances.SubmitFormData(*, name: str, url: str)[source]

Bases: BaseUpdate

name: str

url: str

class zen_dash.objects.instances.TableColumn(*, columnDef: str, header: str)[source]

Bases: BaseUpdate

columnDef: str

header: str

class zen_dash.objects.instances.TableData(*, columns: List[TableColumn], data: List[Dict], name: str, items_per_page_options: List[int] = [5, 10, 20], items_per_page: int = 5, allow_download: bool = True)[source]

Bases: BaseUpdate

allow_download: bool

columns: List[TableColumn]

data: List[Dict]

items_per_page: int

items_per_page_options: List[int]

name: str

class zen_dash.objects.instances.TargetAttribute(value)[source]

Bases: Enum

An enumeration.

Blank = '_blank'

PARENT = '_parent'

SELF = '_self'

TOP = '_top'

class zen_dash.objects.instances.ToggleData(*, name: str, checked: bool = False)[source]

Bases: BaseUpdate

checked: bool

name: str

class zen_dash.objects.instances.ToolTipData(*, label: str = '')[source]

Bases: BaseUpdate

label: str

class zen_dash.objects.instances.UIAction(value)[source]

Bases: Enum

An enumeration.

ADD = 'add'

DELETE = 'delete'

class zen_dash.objects.instances.UIData(*, type: UIType, action: UIAction, value: str, key: str)[source]

Bases: BaseUpdate

action: UIAction

key: str

type: UIType

value: str

class zen_dash.objects.instances.UIType(value)[source]

Bases: Enum

An enumeration.

LOCALSTORAGE = 'local_storage'

SESSION = 'session'

class zen_dash.objects.instances.UpdateInstanceType(value)[source]

Bases: str, Enum

Docstring for class UpdateInstanceType Instance Type required for UpdateReturnData

Returns: Update Instance Type for Enum
Return type: Enum

BOX = 'box'

BUTTON_RESULT = 'button_result'

FORM = 'form'

SIMPLE_FILTER = 'simple_filter'

class zen_dash.objects.instances.UpdateReturnData(*, type: UpdateInstanceType, simple_fitler_data: Optional[List[str]] = None, box_data: Optional[BoxData] = None, display: Optional[Display] = None, display_dialog: Optional[DisplayDialog] = None, response_form_data: Optional[ResponseFormData] = None, ui_data: Optional[List[UIData]] = None, button_data: Optional[ButtonData] = None)[source]

Bases: BaseUpdate

box_data: Optional[BoxData]

button_data: Optional[ButtonData]

display: Optional[Display]

display_dialog: Optional[DisplayDialog]

json()[source]

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

response_form_data: Optional[ResponseFormData]

simple_fitler_data: Optional[List[str]]

type: UpdateInstanceType

ui_data: Optional[List[UIData]]

classmethod validator_type_match(field_values)[source]

class zen_dash.objects.instances.UploadData(*, url: str, multi: bool = False, name: str)[source]

Bases: BaseUpdate

multi: bool

name: str

url: str

zen_dash.objects.page module

class zen_dash.objects.page.FABURL(*, url: str)[source]

Bases: BaseUpdate

url: str

class zen_dash.objects.page.Instance(*, url: str)[source]

Bases: BaseUpdate

url: str

class zen_dash.objects.page.Page(*, rows: List[Row], floating_button_url: List[FABURL] = [], show_refresh_button: bool = True)[source]

Bases: BaseUpdate

floating_button_url: List[FABURL]

rows: List[Row]

show_refresh_button: bool

class zen_dash.objects.page.Row(*, data: List[Instance], layoutGap: Optional[str] = '30px')[source]

Bases: BaseUpdate

data: List[Instance]

layoutGap: Optional[str]

zen_dash.objects.scripts module

class zen_dash.objects.scripts.CustomScript(*, url: Optional[str] = None, text: Optional[str] = None, type: Style, rel: Optional[Rel] = None, custom: Optional[str] = None, aysnc: bool = False, defer: bool = True)[source]

Bases: BaseUpdate

aysnc: bool

custom: Optional[str]

defer: bool

rel: Optional[Rel]

text: Optional[str]

type: Style

url: Optional[str]

class zen_dash.objects.scripts.CustomScripts(*, scripts: List[CustomScript])[source]

Bases: BaseUpdate

scripts: List[CustomScript]

class zen_dash.objects.scripts.Rel(value)[source]

Bases: Enum

An enumeration.

ALTERNATE = 'alternate'

AUTHOR = 'author'

DNS_PREFETCH = 'dns-prefetch'

HELP = 'help'

ICON = 'ocpm'

LICENSE = 'license'

NEXT = 'next'

PINGBACK = 'pingback'

PRECONNECT = 'preconnect'

PREFETCH = 'prefetch'

PRELOAD = 'preload'

PRERENDER = 'prerender'

PREV = 'prev'

SEARCH = 'search'

STYLESHEET = 'stylesheet'

class zen_dash.objects.scripts.Style(value)[source]

Bases: Enum

An enumeration.

JS = 'javascript'

LINK = 'link'

zen_dash.objects.sidebar module

class zen_dash.objects.sidebar.FilterInfo(*, url: str)[source]

Bases: BaseUpdate

url: str

class zen_dash.objects.sidebar.GroupSidebarList(*, name: str, sub_pages: List[ZenPage])[source]

Bases: BaseUpdate

name: str

sub_pages: List[ZenPage]

zen_dash.objects.sidebar.RenderTabs(sidebar_list: SidebarList)[source]

class zen_dash.objects.sidebar.Sidebar(*, tabs: List[Union[SidebarTab, SidebarGroup]], filters: List[FilterInfo], size: str = '300px', library_version: str = '0.6.23')[source]

Bases: BaseUpdate

filters: List[FilterInfo]

classmethod first_cant_be_group(v)[source]

library_version: str

size: str

tabs: List[Union[SidebarTab, SidebarGroup]]

class zen_dash.objects.sidebar.SidebarGroup(*, name: str, subtabs: List[SidebarTab])[source]

Bases: BaseUpdate

name: str

subtabs: List[SidebarTab]

class zen_dash.objects.sidebar.SidebarList(*, pages: List[ZenPage], groupSidebar: List[GroupSidebarList])[source]

Bases: BaseUpdate

groupSidebar: List[GroupSidebarList]

pages: List[ZenPage]

class zen_dash.objects.sidebar.SidebarTab(*, label: str, icon: Optional[str] = 'Home', custom_url: Optional[str] = None)[source]

Bases: BaseUpdate

custom_url: Optional[str]

icon: Optional[str]

label: str

zen_dash.objects.sidebar.get_page_dict(pages: List[ZenPage])[source]

Module contents

class zen_dash.objects.Auth(*, SSO: bool = False, UP_Login: bool = False)[source]

Bases: BaseModel

SSO: bool

UP_Login: bool

class zen_dash.objects.Configuration(*, retry_count: int = 2, show_right_sidebar: bool = False, refresh: RefreshInfo = RefreshInfo(refresh=False, rate_in_seconds=300), websocket: WebSocketConfig = WebSocketConfig(active=False), auth: Auth = Auth(SSO=False, UP_Login=False))[source]

Bases: BaseModel

auth: Auth

refresh: RefreshInfo

retry_count: int

show_right_sidebar: bool

websocket: WebSocketConfig

class zen_dash.objects.RefreshInfo(*, refresh: bool = False, rate_in_seconds: int = 300)[source]

Bases: BaseModel

rate_in_seconds: int

refresh: bool

class zen_dash.objects.WebSocketConfig(*, active: bool = False)[source]

Bases: BaseModel

active: bool

class zen_dash.objects.Zen[source]

Bases: object

static full_url(*args, **kwargs) → str[source]

static server(*args, **kwargs)[source]

static server_full_url(*args, **kwargs) → str[source]

static server_url(*args, **kwargs) → str[source]

static server_view(*args, **kwargs)[source]

static url(*args, **kwargs) → str[source]

static view(*args, **kwargs)[source]

class zen_dash.objects.ZenPage(*, name: str, icon: str, page: Page, websocket_calls: List[Type[Zen]] = [], pydantic_class: Type[BaseModel] = None, tab_number: Optional[int] = None, subtab_number: Optional[int] = None, custom_url: Optional[str] = None)[source]

Bases: BaseModel

custom_url: Optional[str]

icon: str

name: str

page: Page

pydantic_class: Type[BaseModel]

subtab_number: Optional[int]

tab_number: Optional[int]

websocket_calls: List[Type[Zen]]