Webapp

Compound

Compound API available from the Webapp library.

45 config keys · 27 public methods

Import

from Xenonix.Webapp import Compound

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`	`'#ffffff'`	Any valid value	Background color.
`Foreground`	`'#000000'`	Any valid value	Text/foreground color.
`Border_Color`	`'#000000'`	Any valid value	Border color.
`Border_Size`	`0`	Any valid value	Border thickness.
`Border_Radius`	`0`	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`	`None`	Any valid value	Widget or image width.
`Height`	`None`	Any valid value	Widget or image height.
`Animate_Left`	`0`	Any valid value	Animate Left setting for Compound.
`Animate_Top`	`0`	Any valid value	Animate Top setting for Compound.
`Animate_Width`	`0`	Any valid value	Animate Width setting for Compound.
`Animate_Height`	`0`	Any valid value	Animate Height setting for Compound.
`Animate_Time`	`1.0`	Any valid value	Animate Time setting for Compound.
`Animate_Ease`	`'cubic-bezier(0.22, 1, 0.36, 1)'`	Any valid value	Animate Ease setting for Compound.
`Font_Size`	`12`	Any valid value	Font Size setting for Compound.
`Font_Weight`	`'normal'`	Any valid value	Font Weight setting for Compound.
`Font_Family`	`'Helvetica'`	Any valid value	Font Family setting for Compound.
`Value`	`''`	Any valid value	Value setting for Compound.
`Path`	`False`	Any valid value	Path setting for Compound.
`Rotate`	`0`	Any valid value	Rotate setting for Compound.
`Transparent`	`True`	Any valid value	Transparent setting for Compound.
`Compound`	`'center'`	Any valid value	Compound setting for Compound.
`Aspect_Ratio`	`True`	Any valid value	Aspect Ratio setting for Compound.
`Gap`	`8`	Any valid value	Gap setting for Compound.
`Padding`	`8`	Any valid value	Inner spacing.
`Margin`	`0`	Any valid value	Extra region margin.
`Image_Width`	`None`	Any valid value	Image Width setting for Compound.
`Image_Height`	`None`	Any valid value	Image Height setting for Compound.
`Hover_Background`	`False`	Any valid value	Hover Background setting for Compound.
`Hover_Foreground`	`False`	Any valid value	Hover Foreground setting for Compound.
`Hover_Border_Color`	`False`	Any valid value	Hover Border Color setting for Compound.
`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`	`0`	Any valid value	Vertical shadow offset.
`Shadow_Blur`	`0`	Any valid value	Shadow blur amount.
`Shadow_Spread`	`0`	Any valid value	Shadow spread amount.
`Shadow_Color`	`'transparent'`	Any valid value	Shadow color.

Public methods

Create

Creates a new Compound 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 Compound object.

Create

Runs the Create operation for Compound.

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.

Clear

Clears stored data, selection, or visible content.

Clear()

Arguments

No arguments.

Output

Updates the object or visible UI state.

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.

Animate

Runs the Animate operation for Compound.

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 Compound.

Animate_Cancel()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Refresh

Runs the Refresh operation for Compound.

Refresh()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Get

Runs the Get operation for Compound.

Get()

Arguments

No arguments.

Output

Returns the calculated result.

Set

Runs the Set operation for Compound.

Set(Value='', Path='')

Arguments

Argument	Default	Accepted values	What it does
`Value`	`''`	Any valid value	Value to set or process.
`Path`	`''`	Any valid value	File path used for reading or writing.

Output

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

Compound

Runs the Compound operation for Compound.

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

Bind

Runs the Bind operation for Compound.

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 Compound.

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 Compound.

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 Compound.

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 Compound.

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 Compound.

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 Compound.

Box()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Ratio

Runs the Ratio operation for Compound.

Ratio()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Place

Runs the Place operation for Compound.

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 Compound.

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.