Home / Webapp / Switch
Webapp

Switch

Switch API available from the Webapp library.

44 config keys · 29 public methods

Import

from Xenonix.Webapp import Switch

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
Name False Any valid value Object name used for lookup, labels, or public access.
Background '#c9ced6' Any valid value Background color.
Foreground '#ffffff' Any valid value Text/foreground color.
Active_Background '#22c55e' Any valid value Active Background setting for Switch.
Active_Foreground '#ffffff' Any valid value Active Foreground setting for Switch.
Knob_Background '#ffffff' Any valid value Knob Background setting for Switch.
Border_Color 'transparent' Any valid value Border color.
Border_Size 0 Any valid value Border thickness.
Border_Radius 999 Any valid value Corner radius.
Display True True, False Initial visible/hidden state.
Left None Any valid value Left position when placed absolutely.
Top None Any valid value Top position when placed absolutely.
Right None Any valid value Right position when placed absolutely.
Bottom None Any valid value Bottom position when placed absolutely.
Width 58 Any valid value Widget or image width.
Height 30 Any valid value Widget or image height.
Animate_Left 0 Any valid value Animate Left setting for Switch.
Animate_Top 0 Any valid value Animate Top setting for Switch.
Animate_Width 0 Any valid value Animate Width setting for Switch.
Animate_Height 0 Any valid value Animate Height setting for Switch.
Animate_Time 1.0 Any valid value Animate Time setting for Switch.
Animate_Ease 'cubic-bezier(0.22, 1, 0.36, 1)' Any valid value Animate Ease setting for Switch.
Dot_Margin 3 Any valid value Dot Margin setting for Switch.
Dot_Speed 30 Any valid value Dot Speed setting for Switch.
Font_Size 10 Any valid value Font Size setting for Switch.
Font_Weight '700' Any valid value Font Weight setting for Switch.
Font_Family 'Helvetica' Any valid value Font Family setting for Switch.
Disable False Any valid value Disable setting for Switch.
Value False Any valid value Value setting for Switch.
Text_On '' Any valid value Text On setting for Switch.
Text_Off '' Any valid value Text Off setting for Switch.
Hover_Background False Any valid value Hover Background setting for Switch.
Hover_Border_Color False Any valid value Hover Border Color setting for Switch.
Padding 3 Any valid value Inner spacing.
Margin 0 Any valid value Extra region margin.
Mode 'Flow' Flow, Place, Auto, Manual Layout or algorithm mode.
Classes '' Any valid value Extra CSS classes.
Style '' Any valid value Extra CSS style.
Z_Index None Any valid value CSS stacking order.
Shadow_X 0 Any valid value Horizontal shadow offset.
Shadow_Y 2 Any valid value Vertical shadow offset.
Shadow_Blur 8 Any valid value Shadow blur amount.
Shadow_Spread 0 Any valid value Shadow spread amount.
Shadow_Color 'rgba(0,0,0,0.18)' Any valid value Shadow color.

Public methods

Create

Creates a new Switch instance.

Create(Main, *args, **kwargs)

Arguments

Argument Default Accepted values What it does
Main Required Any valid value Main value used by the operation.
args *args Any valid value Additional values passed to the operation.
kwargs **kwargs Any valid value Additional values passed to the operation.

Output

Creates a new Switch object.

Create

Runs the Create operation for Switch.

Create()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Copy

Creates a copy of the object, optionally with supplied data.

Copy(Name=False, Main=False)

Arguments

Argument Default Accepted values What it does
Name False Any valid value Display/name identifier.
Main False Any valid value Turns main on or off.

Output

Returns a copy of the object.

Delete

Removes the requested item.

Delete()

Arguments

No arguments.

Output

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

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.

Toggle

Runs the Toggle operation for Switch.

Toggle()

Arguments

No arguments.

Output

Returns the calculated result.

Animate

Runs the Animate operation for Switch.

Animate(Widget=None, Hide=False, Thread=True)

Arguments

Argument Default Accepted values What it does
Widget None Any valid value Widget value used by the operation.
Hide False Any valid value Turns hide on or off.
Thread True Any valid value Turns thread on or off.

Output

Returns True/False to indicate success.

Animate_Cancel

Runs the Animate_Cancel operation for Switch.

Animate_Cancel()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Focus

Moves focus to this widget/object where supported.

Focus()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Focus

Moves focus to this widget/object where supported.

Focus()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Widget

Runs the Widget operation for Switch.

Widget()

Arguments

No arguments.

Output

Returns the calculated result.

Refresh

Runs the Refresh operation for Switch.

Refresh()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Get

Runs the Get operation for Switch.

Get()

Arguments

No arguments.

Output

Returns the calculated result.

Set

Runs the Set operation for Switch.

Set(Value=False)

Arguments

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

Output

Returns the calculated result.

Set_On_Click

Sets a specific value.

Set_On_Click()

Arguments

No arguments.

Output

Sets the value and returns the updated object or status.

Bind

Runs the Bind operation for Switch.

Bind(**Input)

Arguments

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

Output

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

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.

Move

Moves the object/data by the requested amount.

Move(Left=None, Top=None)

Arguments

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

Output

Returns True/False to indicate success.

Center

Runs the Center operation for Switch.

Center(Left=None, Top=None)

Arguments

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

Output

Returns structured data such as a list or dictionary.

Position

Runs the Position operation for Switch.

Position(Left=None, Top=None, Right=None, Bottom=None)

Arguments

Argument Default Accepted values What it does
Left None Any valid value Left value used by the operation.
Top None Any valid value Top value used by the operation.
Right None Any valid value Right value used by the operation.
Bottom None Any valid value Bottom value used by the operation.

Output

Returns structured data such as a list or dictionary.

Size

Runs the Size operation for Switch.

Size(Width=False, Height=False)

Arguments

Argument Default Accepted values What it does
Width False Any valid value Width in pixels, world units, or widget units depending on the class.
Height False Any valid value Height in pixels, world units, or widget units depending on the class.

Output

Returns structured data such as a list or dictionary.

Enlarge

Runs the Enlarge operation for Switch.

Enlarge(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.

Shrink

Runs the Shrink operation for Switch.

Shrink(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.

Box

Runs the Box operation for Switch.

Box()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Ratio

Runs the Ratio operation for Switch.

Ratio()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Place

Runs the Place operation for Switch.

Place(Left=None, Top=None, Right=None, Bottom=None, Width=None, Height=None)

Arguments

Argument Default Accepted values What it does
Left None Any valid value Left value used by the operation.
Top None Any valid value Top value used by the operation.
Right None Any valid value Right value used by the operation.
Bottom None Any valid value Bottom value used by the operation.
Width None Any valid value Width in pixels, world units, or widget units depending on the class.
Height None Any valid value Height in pixels, world units, or widget units depending on the class.

Output

Returns the object, so the call can be chained.

Pack

Runs the Pack operation for Switch.

Pack(Classes=None, Style=None, Margin=None, Padding=None)

Arguments

Argument Default Accepted values What it does
Classes None Any valid value Classes value used by the operation.
Style None Any valid value Style value used by the operation.
Margin None Any valid value Margin value used by the operation.
Padding None Any valid value Padding value used by the operation.

Output

Returns the object, so the call can be chained.