Home / Webapp / Tree
Webapp

Tree

Tree widget.

60 config keys · 59 public methods

Import

from Xenonix.Webapp import Tree

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.
Auto_Dark False Any valid value Auto Dark setting for Tree.
Background '#ffffff' Any valid value Background color.
Light_Background False Any valid value Light Background setting for Tree.
Dark_Background False Any valid value Dark Background setting for Tree.
Foreground '#000000' Any valid value Text/foreground color.
Light_Foreground False Any valid value Light Foreground setting for Tree.
Dark_Foreground False Any valid value Dark Foreground setting for Tree.
Border_Color '#000000' Any valid value Border color.
Light_Border_Color False Any valid value Light Border Color setting for Tree.
Dark_Border_Color False Any valid value Dark Border Color setting for Tree.
Border_Size 1 Any valid value Border thickness.
Border_Radius 8 Any valid value Corner radius.
Resize True Any valid value Resize setting for Tree.
Popup False Any valid value Popup setting for Tree.
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 '100%' Any valid value Widget or image width.
Height 260 Any valid value Widget or image height.
Animate_Left 0 Any valid value Animate Left setting for Tree.
Animate_Top 0 Any valid value Animate Top setting for Tree.
Animate_Width 0 Any valid value Animate Width setting for Tree.
Animate_Height 0 Any valid value Animate Height setting for Tree.
Animate_Time 1.0 Any valid value Animate Time setting for Tree.
Animate_Ease 'cubic-bezier(0.22, 1, 0.36, 1)' Any valid value Animate Ease setting for Tree.
Font_Size 13 Any valid value Font Size setting for Tree.
Font_Weight 'normal' Any valid value Font Weight setting for Tree.
Font_Family 'Helvetica' Any valid value Font Family setting for Tree.
Scrollbar_Size 10 Any valid value Scrollbar Size setting for Tree.
Scrollbar_Active True Any valid value Scrollbar Active setting for Tree.
Background_Selected '#d0e4f5' Any valid value Background Selected setting for Tree.
Foreground_Selected '#000000' Any valid value Foreground Selected setting for Tree.
Hover_Background '#eef4fb' Any valid value Hover Background setting for Tree.
Light_Hover_Background False Any valid value Light Hover Background setting for Tree.
Dark_Hover_Background False Any valid value Dark Hover Background setting for Tree.
Hover_Foreground False Any valid value Hover Foreground setting for Tree.
Light_Hover_Foreground False Any valid value Light Hover Foreground setting for Tree.
Dark_Hover_Foreground False Any valid value Dark Hover Foreground setting for Tree.
Hover_Border_Color False Any valid value Hover Border Color setting for Tree.
Light_Hover_Border_Color False Any valid value Light Hover Border Color setting for Tree.
Dark_Hover_Border_Color False Any valid value Dark Hover Border Color setting for Tree.
Padding 6 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.
Dense True Any valid value Dense setting for Tree.
Multi_Select False True, False Allows multiple selections.
Tick_Strategy 'strict' Any valid value Tick Strategy setting for Tree.
Default_Expand False Any valid value Default Expand setting for Tree.
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.
History_Limit 100 Any valid value History Limit setting for Tree.

Public methods

Create

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

Create

Runs the Create operation for Tree.

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(Keep_History=False)

Arguments

Argument Default Accepted values What it does
Keep_History False Any valid value Turns keep history on or off.

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

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

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.

Widget

Runs the Widget operation for Tree.

Widget()

Arguments

No arguments.

Output

Returns the calculated result.

Refresh

Runs the Refresh operation for Tree.

Refresh()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Grab

Runs the Grab operation for Tree.

Grab(Path=False)

Arguments

Argument Default Accepted values What it does
Path False Any valid value File path used for reading or writing.

Output

Returns True/False to indicate success.

Scroll

Runs the Scroll operation for Tree.

Scroll(E=None, Value=0)

Arguments

Argument Default Accepted values What it does
E None Any valid value E value used by the operation.
Value 0 Any valid value Value to set or process.

Output

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

Add

Adds a new item to the object or UI.

Add(Name, Parent='', Index='end', Tag='Default', Value=None, ID=None, Path=None, Icon=None, Description=None, Push=True)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
Parent '' Any valid value Parent value used by the operation.
Index 'end' end Mode/value selector for index.
Tag 'Default' Any valid value Tag value used by the operation.
Value None Any valid value Value to set or process.
ID None Any valid value ID value used by the operation.
Path None Any valid value File path used for reading or writing.
Icon None Any valid value Icon value used by the operation.
Description None Any valid value Description value used by the operation.
Push True Any valid value Turns push on or off.

Output

Returns the calculated result.

Current

Runs the Current operation for Tree.

Current()

Arguments

No arguments.

Output

Returns the calculated result.

Edit

Runs the Edit operation for Tree.

Edit(Name=False, Value=False, Tag=False, ID=False, Path=False, Icon=False, Description=False, Push=True)

Arguments

Argument Default Accepted values What it does
Name False Any valid value Display/name identifier.
Value False Any valid value Value to set or process.
Tag False Any valid value Turns tag on or off.
ID False Any valid value Turns id on or off.
Path False Any valid value File path used for reading or writing.
Icon False Any valid value Turns icon on or off.
Description False Any valid value Turns description on or off.
Push True Any valid value Turns push on or off.

Output

Returns the calculated result.

Get

Runs the Get operation for Tree.

Get(ID=False)

Arguments

Argument Default Accepted values What it does
ID False Any valid value Turns id on or off.

Output

Returns the calculated result.

Remove

Removes the requested item.

Remove(ID, Push=True)

Arguments

Argument Default Accepted values What it does
ID Required children Mode/value selector for id.
Push True Any valid value Turns push on or off.

Output

Returns the calculated result.

Remove_All

Removes the requested item.

Remove_All(Push=True)

Arguments

Argument Default Accepted values What it does
Push True Any valid value Turns push on or off.

Output

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

Remove_Selected

Removes the requested item.

Remove_Selected()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Select

Runs the Select operation for Tree.

Select(ID=None, Keep=False)

Arguments

Argument Default Accepted values What it does
ID None Any valid value ID value used by the operation.
Keep False Any valid value Turns keep on or off.

Output

Returns the calculated result.

Selected

Runs the Selected operation for Tree.

Selected()

Arguments

No arguments.

Output

Returns the calculated result.

Unselect

Runs the Unselect operation for Tree.

Unselect(ID=None)

Arguments

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

Output

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

Child

Runs the Child operation for Tree.

Child(ID=False)

Arguments

Argument Default Accepted values What it does
ID False Any valid value Turns id on or off.

Output

Returns structured data such as a list or dictionary.

Collapse

Runs the Collapse operation for Tree.

Collapse(ID=False)

Arguments

Argument Default Accepted values What it does
ID False Any valid value Turns id on or off.

Output

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

Collapse_All

Runs the Collapse_All operation for Tree.

Collapse_All()

Arguments

No arguments.

Output

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

Expand

Runs the Expand operation for Tree.

Expand(ID=False)

Arguments

Argument Default Accepted values What it does
ID False Any valid value Turns id on or off.

Output

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

Expand_All

Runs the Expand_All operation for Tree.

Expand_All()

Arguments

No arguments.

Output

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

Export

Runs the Export operation for Tree.

Export(Path=False, Fire=True)

Arguments

Argument Default Accepted values What it does
Path False Any valid value File path used for reading or writing.
Fire True Any valid value Turns fire on or off.

Output

Returns structured data such as a list or dictionary.

Export_All

Runs the Export_All operation for Tree.

Export_All(File, Parent='', Indent=0)

Arguments

Argument Default Accepted values What it does
File Required Any valid value File value used by the operation.
Parent '' Any valid value Parent value used by the operation.
Indent 0 Any valid value Indent value used by the operation.

Output

Returns the calculated result.

Export_Text

Runs the Export_Text operation for Tree.

Export_Text(Path='TreeStructure.txt')

Arguments

Argument Default Accepted values What it does
Path 'TreeStructure.txt' Any valid value File path used for reading or writing.

Output

Returns True/False to indicate success.

Get_All

Returns a specific value.

Get_All(ID=False)

Arguments

Argument Default Accepted values What it does
ID False Any valid value Turns id on or off.

Output

Returns the requested value.

Get_Selected

Returns a specific value.

Get_Selected()

Arguments

No arguments.

Output

Returns the requested value.

History_Clear

Runs the History_Clear operation for Tree.

History_Clear()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Import

Runs the Import operation for Tree.

Import(Data)

Arguments

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

Output

Returns True/False to indicate success.

Index

Runs the Index operation for Tree.

Index(Item)

Arguments

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

Output

Returns the calculated result.

Level

Runs the Level operation for Tree.

Level(Item)

Arguments

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

Output

Returns the calculated result.

Parent

Runs the Parent operation for Tree.

Parent(ID=False)

Arguments

Argument Default Accepted values What it does
ID False Any valid value Turns id on or off.

Output

Returns the calculated result.

Redo

Runs the Redo operation for Tree.

Redo()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Tag

Runs the Tag operation for Tree.

Tag(Name, Foreground=False, Background=False)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
Foreground False Any valid value Turns foreground on or off.
Background False Any valid value Turns background on or off.

Output

Returns the calculated result.

Undo

Runs the Undo operation for Tree.

Undo()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Update_Tree

Runs the Update_Tree operation for Tree.

Update_Tree(Name=False, Item=False)

Arguments

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

Output

Returns True/False to indicate success.

Bind

Runs the Bind operation for Tree.

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

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

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

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

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

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

Box()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Ratio

Runs the Ratio operation for Tree.

Ratio()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Colors

Runs the Colors operation for Tree.

Colors(Background=None, Foreground=None, Border_Color=None)

Arguments

Argument Default Accepted values What it does
Background None Any valid value Background value used by the operation.
Foreground None Any valid value Foreground value used by the operation.
Border_Color None Any valid value Border Color value used by the operation.

Output

Returns structured data such as a list or dictionary.

Radius

Runs the Radius operation for Tree.

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

Shadow

Runs the Shadow operation for Tree.

Shadow(X=None, Y=None, Blur=None, Spread=None, Color=None)

Arguments

Argument Default Accepted values What it does
X None Any valid value X coordinate or horizontal value.
Y None Any valid value Y coordinate or vertical value.
Blur None Any valid value Blur value used by the operation.
Spread None Any valid value Spread value used by the operation.
Color None Any valid value Color used for drawing or display.

Output

Returns structured data such as a list or dictionary.

Place

Runs the Place operation for Tree.

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

Pack(**kwargs)

Arguments

Argument Default Accepted values What it does
kwargs **kwargs Any valid value Additional values passed to the operation.

Output

Returns the object, so the call can be chained.