Home / Webapp / Flowchart
Webapp

Flowchart

Node-based flowchart editor widget.

60 config keys · 41 public methods

Import

from Xenonix.Webapp import Flowchart

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 900 Any valid value Widget or image width.
Height 600 Any valid value Widget or image height.
Canvas_Width 1800 Any valid value Canvas Width setting for Flowchart.
Canvas_Height 1200 Any valid value Canvas Height setting for Flowchart.
Node_Width 160 Any valid value Node Width setting for Flowchart.
Node_Height 90 Any valid value Node Height setting for Flowchart.
Node_Color '#4F8EF7' Any valid value Node Color setting for Flowchart.
Node_Fill '#FFF7D6' Any valid value Node Fill setting for Flowchart.
Node_Foreground '#000000' Any valid value Node Foreground setting for Flowchart.
Node_Radius 10 Any valid value Node Radius setting for Flowchart.
Node_Title_Size 14 Any valid value Node Title Size setting for Flowchart.
Node_Text_Size 12 Any valid value Node Text Size setting for Flowchart.
Node_Thickness 2 Any valid value Node Thickness setting for Flowchart.
Node_Font_Family 'Helvetica' Any valid value Node Font Family setting for Flowchart.
Edge_Color '#111827' Any valid value Edge Color setting for Flowchart.
Edge_Thickness 2 Any valid value Edge Thickness setting for Flowchart.
Edge_Route_Padding 10 Any valid value Edge Route Padding setting for Flowchart.
Edge_Corner_Radius 18 Any valid value Edge Corner Radius setting for Flowchart.
Selected_Color '#38bdf8' Any valid value Color used for selected items.
Selected_Thickness 4 Any valid value Selected Thickness setting for Flowchart.
Disabled_Color '#9ca3af' Any valid value Disabled Color setting for Flowchart.
Locked_Color '#ef4444' Any valid value Locked Color setting for Flowchart.
Port_Radius 7 Any valid value Port Radius setting for Flowchart.
Port_Offset 12 Any valid value Port Offset setting for Flowchart.
Port_Label_Margin 20 Any valid value Port Label Margin setting for Flowchart.
Port_Input_Fill '#e0f2fe' Any valid value Port Input Fill setting for Flowchart.
Port_Output_Fill '#dcfce7' Any valid value Port Output Fill setting for Flowchart.
Port_Input_Stroke '#1F618D' Any valid value Port Input Stroke setting for Flowchart.
Port_Output_Stroke '#117A65' Any valid value Port Output Stroke setting for Flowchart.
Port_Counts {'Top': 3, 'Bottom': 3, 'Left': 2, 'Right': 2} Any valid value Port Counts setting for Flowchart.
Smooth_Edges False Any valid value Smooth Edges setting for Flowchart.
Grid_Size 20 Any valid value Grid Size setting for Flowchart.
Snap_To_Grid False Any valid value Snap To Grid setting for Flowchart.
Zoom 1.0 Any valid value Zoom setting for Flowchart.
Zoom_Min 0.3 Any valid value Zoom Min setting for Flowchart.
Zoom_Max 4.0 Any valid value Zoom Max setting for Flowchart.
Zoom_Step 1.1 Any valid value Zoom Step setting for Flowchart.
Padding 0 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 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.
Scrollbar_Active True Any valid value Scrollbar Active setting for Flowchart.

Public methods

Create

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

Create

Runs the Create operation for Flowchart.

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()

Arguments

No arguments.

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.

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

Widget()

Arguments

No arguments.

Output

Returns the calculated result.

Selected

Runs the Selected operation for Flowchart.

Selected()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Add_Edge

Adds a new item to the object or UI.

Add_Edge(From_Node=None, From_Side='Right', To_Node=None, To_Side='Left', From_Index=0, To_Index=0, Color=None, Thickness=None, Value=None, ID=None, Push=True, Fire=True)

Arguments

Argument Default Accepted values What it does
From_Node None Any valid value From Node value used by the operation.
From_Side 'Right' Any valid value From Side value used by the operation.
To_Node None Any valid value To Node value used by the operation.
To_Side 'Left' Any valid value To Side value used by the operation.
From_Index 0 Any valid value From Index value used by the operation.
To_Index 0 Any valid value To Index value used by the operation.
Color None Any valid value Color used for drawing or display.
Thickness None Any valid value Line/outline thickness used for drawing.
Value None Any valid value Value to set or process.
ID None Any valid value ID value used by the operation.
Push True Any valid value Turns push on or off.
Fire True Any valid value Turns fire on or off.

Output

Adds a new item and returns the created object/id when available.

Add_Node

Adds a new item to the object or UI.

Add_Node(X=100, Y=100, Width=None, Height=None, Color=None, Fill=None, Foreground=None, Title='', Description='', Type='', Ports=None, Port_Counts=None, Port_Names=None, Port_Colors=None, Value=None, ID=None, Push=True, Fire=True)

Arguments

Argument Default Accepted values What it does
X 100 Any valid value X coordinate or horizontal value.
Y 100 Any valid value Y coordinate or vertical value.
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.
Color None Any valid value Color used for drawing or display.
Fill None Any valid value Fill value used by the operation.
Foreground None Any valid value Foreground value used by the operation.
Title '' Any valid value Title value used by the operation.
Description '' Any valid value Description value used by the operation.
Type '' Any valid value Type value used by the operation.
Ports None Any valid value Ports value used by the operation.
Port_Counts None Any valid value Port Counts value used by the operation.
Port_Names None Any valid value Port Names value used by the operation.
Port_Colors None Any valid value Port Colors 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.
Push True Any valid value Turns push on or off.
Fire True Any valid value Turns fire on or off.

Output

Adds a new item and returns the created object/id when available.

Config_Edge

Runs the Config_Edge operation for Flowchart.

Config_Edge(ID=None, **Input)

Arguments

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

Output

Returns True/False to indicate success.

Config_Node

Runs the Config_Node operation for Flowchart.

Config_Node(ID=None, **Input)

Arguments

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

Output

Returns True/False to indicate success.

Config_Port

Runs the Config_Port operation for Flowchart.

Config_Port(Node_Id=None, Side='Right', Index=0, Color=None, Name=None)

Arguments

Argument Default Accepted values What it does
Node_Id None From_Node Mode/value selector for node id.
Side 'Right' From_Side Mode/value selector for side.
Index 0 From_Index Mode/value selector for index.
Color None Any valid value Color used for drawing or display.
Name None Any valid value Display/name identifier.

Output

Returns True/False to indicate success.

Cut

Runs the Cut operation for Flowchart.

Cut()

Arguments

No arguments.

Output

Returns the calculated result.

Delete_Selected

Removes the requested item.

Delete_Selected()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Deselect

Runs the Deselect operation for Flowchart.

Deselect()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Edges

Runs the Edges operation for Flowchart.

Edges()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Export

Runs the Export operation for Flowchart.

Export(Fire=True)

Arguments

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

Output

Returns structured data such as a list or dictionary.

Flow_Order

Runs the Flow_Order operation for Flowchart.

Flow_Order(Include_Disabled=True, Allow_Cycles=True, Start_Id=1)

Arguments

Argument Default Accepted values What it does
Include_Disabled True Any valid value Turns include disabled on or off.
Allow_Cycles True Any valid value Turns allow cycles on or off.
Start_Id 1 Any valid value Start Id value used by the operation.

Output

Returns True/False to indicate success.

Get_Edge

Returns a specific value.

Get_Edge(ID)

Arguments

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

Output

Returns the requested value.

Get_Node

Returns a specific value.

Get_Node(ID)

Arguments

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

Output

Returns the requested value.

Import

Runs the Import operation for Flowchart.

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.

Nodes

Runs the Nodes operation for Flowchart.

Nodes()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Paste

Runs the Paste operation for Flowchart.

Paste(Offset_X=30, Offset_Y=30)

Arguments

Argument Default Accepted values What it does
Offset_X 30 Any valid value Offset X coordinate/component.
Offset_Y 30 Any valid value Offset Y coordinate/component.

Output

Returns the calculated result.

Redo

Runs the Redo operation for Flowchart.

Redo()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Remove_Edge

Removes the requested item.

Remove_Edge(ID=None, Push=True, Fire=True)

Arguments

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

Output

Returns True/False to indicate success.

Remove_Node

Removes the requested item.

Remove_Node(ID=None, Push=True, Fire=True)

Arguments

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

Output

Returns True/False to indicate success.

Select_Edge

Runs the Select_Edge operation for Flowchart.

Select_Edge(ID=None, Fire=True)

Arguments

Argument Default Accepted values What it does
ID None Any valid value ID value used by the operation.
Fire True Any valid value Turns fire on or off.

Output

Returns the calculated result.

Select_Node

Runs the Select_Node operation for Flowchart.

Select_Node(ID=None, Fire=True)

Arguments

Argument Default Accepted values What it does
ID None Any valid value ID value used by the operation.
Fire True Any valid value Turns fire on or off.

Output

Returns the calculated result.

Undo

Runs the Undo operation for Flowchart.

Undo()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Zoom_In

Runs the Zoom_In operation for Flowchart.

Zoom_In(Factor=None)

Arguments

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

Output

Returns the calculated result.

Zoom_Out

Runs the Zoom_Out operation for Flowchart.

Zoom_Out(Factor=None)

Arguments

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

Output

Returns the calculated result.

Zoom_Reset

Runs the Zoom_Reset operation for Flowchart.

Zoom_Reset()

Arguments

No arguments.

Output

Returns the calculated result.

Zoom_Set

Runs the Zoom_Set operation for Flowchart.

Zoom_Set(Value=1.0)

Arguments

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

Output

Returns the calculated result.

Bind

Runs the Bind operation for Flowchart.

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.

Place

Runs the Place operation for Flowchart.

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

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.