Webapp

GUI

Application controller for building Webapp interfaces.

33 config keys · 63 public methods

Import

from Xenonix.Webapp import GUI

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

Config key	Default	Common values	What it controls
`Error_Display`	`True`	Any valid value	Error Display setting for GUI.
`Error_Log`	`False`	Any valid value	Error Log setting for GUI.
`Title`	`'Nucleon Wavionix'`	Any valid value	Title setting for GUI.
`Icon`	`''`	Any valid value	Icon setting for GUI.
`IP`	`'0.0.0.0'`	Any valid value	IP setting for GUI.
`Port`	`17792`	Any valid value	Port setting for GUI.
`Reload`	`False`	Any valid value	Reload setting for GUI.
`Show`	`True`	Any valid value	Show setting for GUI.
`Background`	`'#F0F0F0'`	Any valid value	Background color.
`Foreground`	`'#111111'`	Any valid value	Text/foreground color.
`Width`	`'100%'`	Any valid value	Widget or image width.
`Height`	`'100%'`	Any valid value	Widget or image height.
`Min_Height`	`'100vh'`	Any valid value	Min Height setting for GUI.
`Max_Width`	`'none'`	Any valid value	Max Width setting for GUI.
`Padding`	`'0'`	Any valid value	Inner spacing.
`Gap`	`'0'`	Any valid value	Gap setting for GUI.
`Classes`	`''`	Any valid value	Extra CSS classes.
`Style`	`''`	Any valid value	Extra CSS style.
`Body_Classes`	`'w-full h-full'`	Any valid value	Body Classes setting for GUI.
`Body_Style`	`''`	Any valid value	Body Style setting for GUI.
`Visible`	`True`	Any valid value	Visible setting for GUI.
`Full_Screen`	`False`	Any valid value	Full Screen setting for GUI.
`Scroll`	`True`	Any valid value	Scroll setting for GUI.
`Scroll_X`	`None`	Any valid value	Scroll X setting for GUI.
`Scroll_Y`	`None`	Any valid value	Scroll Y setting for GUI.
`Welcome_Message`	`False`	Any valid value	Welcome Message setting for GUI.
`NiceGUI_Log_Level`	`'error'`	Any valid value	NiceGUI Log Level setting for GUI.
`Storage_Secret`	`'Nucleon_Wavionix_Storage_Secret'`	Any valid value	Storage Secret setting for GUI.
`Session_Enabled`	`False`	Any valid value	Session Enabled setting for GUI.
`Session_Registry_Name`	`'Nucleon_Wavionix_Sessions'`	Any valid value	Session Registry Name setting for GUI.
`Session_Timeout`	`0`	Any valid value	Session Timeout setting for GUI.
`Session_Heartbeat`	`15`	Any valid value	Session Heartbeat setting for GUI.
`Session_Cleanup_Interval`	`30`	Any valid value	Session Cleanup Interval setting for GUI.

Public methods

Create

Creates a new GUI instance.

Create(*Args, **KArgs)

Arguments

Argument	Default	Accepted values	What it does
`Args`	`*args`	Any valid value	Args value used by the operation.
`KArgs`	`**kwargs`	Any valid value	KArgs value used by the operation.

Output

Creates a new GUI object.

Focus_Set

Runs the Focus_Set operation for GUI.

Focus_Set(Widget=None, Type=None)

Arguments

Argument	Default	Accepted values	What it does
`Widget`	`None`	Any valid value	Widget value used by the operation.
`Type`	`None`	Any valid value	Type value used by the operation.

Output

Returns True/False to indicate success.

Focus_Clear

Runs the Focus_Clear operation for GUI.

Focus_Clear(Widget=None)

Arguments

Argument	Default	Accepted values	What it does
`Widget`	`None`	Any valid value	Widget value used by the operation.

Output

Returns True/False to indicate success.

Focus_Get

Runs the Focus_Get operation for GUI.

Focus_Get()

Arguments

No arguments.

Output

Returns the calculated result.

Focus_Check

Runs the Focus_Check operation for GUI.

Focus_Check(Widget=None, Type=None)

Arguments

Argument	Default	Accepted values	What it does
`Widget`	`None`	Any valid value	Widget value used by the operation.
`Type`	`None`	Any valid value	Type value used by the operation.

Output

Returns True/False to indicate success.

Create

Runs the Create operation for GUI.

Create()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Show

Displays the object/result.

Show()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Hide

Hides the object/result.

Hide()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Body

Runs the Body operation for GUI.

Body()

Arguments

No arguments.

Output

Returns the calculated result.

Scroll

Runs the Scroll operation for GUI.

Scroll(Value=None, X=None, Y=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.
`X`	`None`	Any valid value	X coordinate or horizontal value.
`Y`	`None`	Any valid value	Y coordinate or vertical value.

Output

Returns structured data such as a list or dictionary.

After

Runs the After operation for GUI.

After(Delay, Function)

Arguments

Argument	Default	Accepted values	What it does
`Delay`	Required	Any valid value	Delay value used by the operation.
`Function`	Required	Any valid value	Function value used by the operation.

Output

Returns the object, so the call can be chained.

Icon

Runs the Icon operation for GUI.

Icon(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Address

Adds a new item to the object or UI.

Address(IP=None, Port=None)

Arguments

Argument	Default	Accepted values	What it does
`IP`	`None`	Any valid value	IP value used by the operation.
`Port`	`None`	Any valid value	Port value used by the operation.

Output

Returns structured data such as a list or dictionary.

Clear_File

Clears stored data, selection, or visible content.

Clear_File(Input=None)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`None`	Any valid value	Input value used by the operation.

Output

Returns True/False to indicate success.

Color

Runs the Color operation for GUI.

Color(Target, Function=None, Value='#ffffff', Close=False)

Arguments

Argument	Default	Accepted values	What it does
`Target`	Required	Any valid value	Target value used by the operation.
`Function`	`None`	Any valid value	Function value used by the operation.
`Value`	`'#ffffff'`	Any valid value	Value to set or process.
`Close`	`False`	Any valid value	Turns close on or off.

Output

Returns True/False to indicate success.

Date

Runs the Date operation for GUI.

Date(Target, Function=None, Value=None, Close=True, Width=290, Minimal=True, Height=None)

Arguments

Argument	Default	Accepted values	What it does
`Target`	Required	Any valid value	Target value used by the operation.
`Function`	`None`	Any valid value	Function value used by the operation.
`Value`	`None`	Any valid value	Value to set or process.
`Close`	`True`	Any valid value	Turns close on or off.
`Width`	`290`	Any valid value	Width in pixels, world units, or widget units depending on the class.
`Minimal`	`True`	Any valid value	Turns minimal on or off.
`Height`	`None`	Any valid value	Height in pixels, world units, or widget units depending on the class.

Output

Returns True/False to indicate success.

Download

Runs the Download operation for GUI.

Download(Path, Name=None, Progress=False, Function=None, Loading_Bar=False, Once=True)

Arguments

Argument	Default	Accepted values	What it does
`Path`	Required	Any valid value	File path used for reading or writing.
`Name`	`None`	Any valid value	Display/name identifier.
`Progress`	`False`	Any valid value	Turns progress on or off.
`Function`	`None`	Any valid value	Function value used by the operation.
`Loading_Bar`	`False`	Any valid value	Turns loading bar on or off.
`Once`	`True`	Any valid value	Turns once on or off.

Output

Returns True/False to indicate success.

Error

Runs the Error operation for GUI.

Error(E)

Arguments

Argument	Default	Accepted values	What it does
`E`	Required	Any valid value	E value used by the operation.

Output

Runs the operation. Some methods update the object in place.

File

Runs the File operation for GUI.

File(Multiple=False, Accept='', Timeout=300)

Arguments

Argument	Default	Accepted values	What it does
`Multiple`	`False`	Any valid value	Turns multiple on or off.
`Accept`	`''`	Any valid value	Accept value used by the operation.
`Timeout`	`300`	Any valid value	Timeout value used by the operation.

Output

Returns structured data such as a list or dictionary.

Folder

Runs the Folder operation for GUI.

Folder(Accept='', Timeout=300)

Arguments

Argument	Default	Accepted values	What it does
`Accept`	`''`	Any valid value	Accept value used by the operation.
`Timeout`	`300`	Any valid value	Timeout value used by the operation.

Output

Returns structured data such as a list or dictionary.

Full_Screen

Runs the Full_Screen operation for GUI.

Full_Screen(Toggle=None)

Arguments

Argument	Default	Accepted values	What it does
`Toggle`	`None`	Any valid value	Toggle value used by the operation.

Output

Returns the calculated result.

Full_Screen_Toggle

Runs the Full_Screen_Toggle operation for GUI.

Full_Screen_Toggle()

Arguments

No arguments.

Output

Returns the calculated result.

IP

Runs the IP operation for GUI.

IP(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Loading_Bar

Runs the Loading_Bar operation for GUI.

Loading_Bar(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns True/False to indicate success.

Nothing

Runs the Nothing operation for GUI.

Nothing()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Notify

Runs the Notify operation for GUI.

Notify(Message)

Arguments

Argument	Default	Accepted values	What it does
`Message`	Required	Any valid value	Message value used by the operation.

Output

Returns True/False to indicate success.

Page

Runs the Page operation for GUI.

Page(Function=None, *Args, **KArgs)

Arguments

Argument	Default	Accepted values	What it does
`Function`	`None`	Any valid value	Function value used by the operation.
`Args`	`*args`	Any valid value	Args value used by the operation.
`KArgs`	`**kwargs`	Any valid value	KArgs value used by the operation.

Output

Returns the object, so the call can be chained.

Page_Scroll

Runs the Page_Scroll operation for GUI.

Page_Scroll(Value=True, X=None, Y=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`True`	Any valid value	Value to set or process.
`X`	`None`	Any valid value	X coordinate or horizontal value.
`Y`	`None`	Any valid value	Y coordinate or vertical value.

Output

Returns structured data such as a list or dictionary.

Palette

Runs the Palette operation for GUI.

Palette(Target, Function=None, Value='#ffffff', Close=False, Header=False, Footer=False)

Arguments

Argument	Default	Accepted values	What it does
`Target`	Required	Any valid value	Target value used by the operation.
`Function`	`None`	Any valid value	Function value used by the operation.
`Value`	`'#ffffff'`	Any valid value	Value to set or process.
`Close`	`False`	Any valid value	Turns close on or off.
`Header`	`False`	Any valid value	Turns header on or off.
`Footer`	`False`	Any valid value	Turns footer on or off.

Output

Returns True/False to indicate success.

Port

Runs the Port operation for GUI.

Port(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Ready

Runs the Ready operation for GUI.

Ready(Function=None)

Arguments

Argument	Default	Accepted values	What it does
`Function`	`None`	Any valid value	Function value used by the operation.

Output

Returns the object, so the call can be chained.

Session

Runs the Session operation for GUI.

Session(Key=None, Default=None)

Arguments

Argument	Default	Accepted values	What it does
`Key`	`None`	Any valid value	Key value used by the operation.
`Default`	`None`	Any valid value	Default value used by the operation.

Output

Returns the calculated result.

Session_Active

Runs the Session_Active operation for GUI.

Session_Active()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Session_All

Runs the Session_All operation for GUI.

Session_All(Active=False)

Arguments

Argument	Default	Accepted values	What it does
`Active`	`False`	Any valid value	Turns active on or off.

Output

Returns structured data such as a list or dictionary.

Session_Cleanup

Runs the Session_Cleanup operation for GUI.

Session_Cleanup(Timeout=None, Function=None)

Arguments

Argument	Default	Accepted values	What it does
`Timeout`	`None`	Any valid value	Timeout value used by the operation.
`Function`	`None`	Any valid value	Function value used by the operation.

Output

Returns structured data such as a list or dictionary.

Session_Clear

Runs the Session_Clear operation for GUI.

Session_Clear()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Session_Count

Runs the Session_Count operation for GUI.

Session_Count(Active=True)

Arguments

Argument	Default	Accepted values	What it does
`Active`	`True`	Any valid value	Turns active on or off.

Output

Returns the calculated result.

Session_Data

Runs the Session_Data operation for GUI.

Session_Data()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Session_Delete

Runs the Session_Delete operation for GUI.

Session_Delete(Key=None)

Arguments

Argument	Default	Accepted values	What it does
`Key`	`None`	Any valid value	Key value used by the operation.

Output

Returns structured data such as a list or dictionary.

Session_Exists

Runs the Session_Exists operation for GUI.

Session_Exists(Key=None, Value=None, Active=True, Current=True, **Input)

Arguments

Argument	Default	Accepted values	What it does
`Key`	`None`	Any valid value	Key value used by the operation.
`Value`	`None`	Any valid value	Value to set or process.
`Active`	`True`	Any valid value	Turns active on or off.
`Current`	`True`	Any valid value	Turns current on or off.
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Returns True/False to indicate success.

Session_Find

Runs the Session_Find operation for GUI.

Session_Find(Key=None, Value=None, Active=True, Current=True, **Input)

Arguments

Argument	Default	Accepted values	What it does
`Key`	`None`	Any valid value	Key value used by the operation.
`Value`	`None`	Any valid value	Value to set or process.
`Active`	`True`	Any valid value	Turns active on or off.
`Current`	`True`	Any valid value	Turns current on or off.
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Returns structured data such as a list or dictionary.

Session_Get

Runs the Session_Get operation for GUI.

Session_Get(Key=None, Default=None)

Arguments

Argument	Default	Accepted values	What it does
`Key`	`None`	Any valid value	Key value used by the operation.
`Default`	`None`	Any valid value	Default value used by the operation.

Output

Returns the calculated result.

Session_Has

Runs the Session_Has operation for GUI.

Session_Has(Key)

Arguments

Argument	Default	Accepted values	What it does
`Key`	Required	Any valid value	Key value used by the operation.

Output

Returns True/False to indicate success.

Session_Id

Runs the Session_Id operation for GUI.

Session_Id()

Arguments

No arguments.

Output

Returns the calculated result.

Session_Info

Runs the Session_Info operation for GUI.

Session_Info()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Session_Register

Runs the Session_Register operation for GUI.

Session_Register(Data=None)

Arguments

Argument	Default	Accepted values	What it does
`Data`	`None`	Any valid value	Dataset path or dataset definition.

Output

Returns structured data such as a list or dictionary.

Session_Reset

Runs the Session_Reset operation for GUI.

Session_Reset()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Session_Set

Runs the Session_Set operation for GUI.

Session_Set(Key=None, Value=None, **Input)

Arguments

Argument	Default	Accepted values	What it does
`Key`	`None`	Any valid value	Key value used by the operation.
`Value`	`None`	Any valid value	Value to set or process.
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Returns structured data such as a list or dictionary.

Session_Storage

Runs the Session_Storage operation for GUI.

Session_Storage()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Session_Timeout

Runs the Session_Timeout operation for GUI.

Session_Timeout(Seconds=None, Function=None, Heartbeat=None, Cleanup_Interval=None)

Arguments

Argument	Default	Accepted values	What it does
`Seconds`	`None`	Any valid value	Seconds value used by the operation.
`Function`	`None`	Any valid value	Function value used by the operation.
`Heartbeat`	`None`	Any valid value	Heartbeat value used by the operation.
`Cleanup_Interval`	`None`	Any valid value	Cleanup Interval value used by the operation.

Output

Returns structured data such as a list or dictionary.

Session_Touch

Runs the Session_Touch operation for GUI.

Session_Touch()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Session_Unregister

Runs the Session_Unregister operation for GUI.

Session_Unregister(ID=None)

Arguments

Argument	Default	Accepted values	What it does
`ID`	`None`	Any valid value	ID value used by the operation.

Output

Returns True/False to indicate success.

Session_Update

Runs the Session_Update operation for GUI.

Session_Update(**Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Returns structured data such as a list or dictionary.

Start

Starts the process or connection.

Start()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Start_Config

Starts the process or connection.

Start_Config(Function=None, *Args, **KArgs)

Arguments

Argument	Default	Accepted values	What it does
`Function`	`None`	Any valid value	Function value used by the operation.
`Args`	`*args`	Any valid value	Args value used by the operation.
`KArgs`	`**kwargs`	Any valid value	KArgs value used by the operation.

Output

Returns the object, so the call can be chained.

Time

Runs the Time operation for GUI.

Time(Target, Function=None, Value=None, Close=False, Width=290, Format_24=True)

Arguments

Argument	Default	Accepted values	What it does
`Target`	Required	Any valid value	Target value used by the operation.
`Function`	`None`	Any valid value	Function value used by the operation.
`Value`	`None`	Any valid value	Value to set or process.
`Close`	`False`	Any valid value	Turns close on or off.
`Width`	`290`	Any valid value	Width in pixels, world units, or widget units depending on the class.
`Format_24`	`True`	Any valid value	Turns format 24 on or off.

Output

Returns True/False to indicate success.

Timer

Runs the Timer operation for GUI.

Timer(Delay, Function, Once=True)

Arguments

Argument	Default	Accepted values	What it does
`Delay`	Required	Any valid value	Delay value used by the operation.
`Function`	Required	Any valid value	Function value used by the operation.
`Once`	`True`	Any valid value	Turns once on or off.

Output

Returns the calculated result.

Title

Runs the Title operation for GUI.

Title(Value=None)

Arguments

Argument	Default	Accepted values	What it does
`Value`	`None`	Any valid value	Value to set or process.

Output

Returns the calculated result.

Upload

Runs the Upload operation for GUI.

Upload(Input=None, Function=None, Save_To='', Loading_Bar=False)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`None`	Any valid value	Input value used by the operation.
`Function`	`None`	Any valid value	Function value used by the operation.
`Save_To`	`''`	Any valid value	Save To value used by the operation.
`Loading_Bar`	`False`	Any valid value	Turns loading bar on or off.

Output

Returns True/False to indicate success.

Bind

Runs the Bind operation for GUI.

Bind(**Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Returns the object, so the call can be chained.

Config_Get

Reads one or more configuration values by name.

Config_Get(*Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`*args`	Any valid value	Input value used by the operation.

Output

Returns selected configuration values.

Config

Changes one or more supported settings. Pass only the configuration keys you want to update.

Config(**Input)

Arguments

Argument	Default	Accepted values	What it does
`Input`	`**kwargs`	Any valid value	Input value used by the operation.

Output

Updates configuration values on the object.