Webapp

Chart

Chart API available from the Webapp library.

70 config keys · 30 public methods

Import

from Xenonix.Webapp import Chart

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 500 Any valid value Widget or image height.
Canvas_Width 900 Any valid value Canvas Width setting for Chart.
Canvas_Height 500 Any valid value Canvas Height setting for Chart.
Animate_Left 0 Any valid value Animate Left setting for Chart.
Animate_Top 0 Any valid value Animate Top setting for Chart.
Animate_Width 0 Any valid value Animate Width setting for Chart.
Animate_Height 0 Any valid value Animate Height setting for Chart.
Animate_Time 1.0 Any valid value Animate Time setting for Chart.
Animate_Ease 'cubic-bezier(0.22, 1, 0.36, 1)' Any valid value Animate Ease setting for Chart.
Chart_Type 'Bar' Any valid value Chart Type setting for Chart.
Direction 'Bottom_To_Top' Any valid value Direction setting for Chart.
Title '' Any valid value Title setting for Chart.
Labels [] Any valid value Labels setting for Chart.
Series [] Any valid value Series setting for Chart.
Pie [] Any valid value Pie setting for Chart.
Axis True Any valid value Axis setting for Chart.
Axis_X True Any valid value Axis X setting for Chart.
Axis_Y True Any valid value Axis Y setting for Chart.
Axis_Text True Any valid value Axis Text setting for Chart.
Value_Ticks False Any valid value Value Ticks setting for Chart.
Y_Ticks False Any valid value Y Ticks setting for Chart.
Tick_Count 5 Any valid value Tick Count setting for Chart.
Grid True True, False Shows or hides a grid where supported.
Legend True Any valid value Legend setting for Chart.
Tooltip True Any valid value Tooltip setting for Chart.
Text False Any valid value Text setting for Chart.
Text_Size 12 Any valid value Text Size setting for Chart.
Title_Size 18 Any valid value Title Size setting for Chart.
Legend_Size 12 Any valid value Legend Size setting for Chart.
Axis_Size 11 Any valid value Axis Size setting for Chart.
Font_Family 'Helvetica' Any valid value Font Family setting for Chart.
Bar_Gap 0.18 Any valid value Bar Gap setting for Chart.
Group_Gap 0.18 Any valid value Group Gap setting for Chart.
Line_Width 3 Any valid value Line Width setting for Chart.
Point_Size 5 Any valid value Point display size.
Pie_Donut 0 Any valid value Pie Donut setting for Chart.
Pie_Start_Angle -90 Any valid value Pie Start Angle setting for Chart.
Margin_Left 70 Any valid value Margin Left setting for Chart.
Margin_Right 30 Any valid value Margin Right setting for Chart.
Margin_Top 55 Any valid value Margin Top setting for Chart.
Margin_Bottom 60 Any valid value Margin Bottom setting for Chart.
Grid_Color '#e5e7eb' Any valid value Grid Color setting for Chart.
Axis_Color '#111827' Any valid value Axis Color setting for Chart.
Text_Color '#111827' Any valid value Text Color setting for Chart.
Tooltip_Delay 0.4 Any valid value Tooltip Delay setting for Chart.
Palette ['#2563eb', '#16a34a', '#dc2626', '#ca8a04', '#9333ea', '#0891b2', '#be185d', '#0f172a'] Any valid value Palette setting for Chart.
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.
Aspect_Ratio True Any valid value Aspect Ratio setting for Chart.

Public methods

Create

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

Create

Runs the Create operation for Chart.

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

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

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

Widget()

Arguments

No arguments.

Output

Returns the calculated result.

Refresh

Runs the Refresh operation for Chart.

Refresh()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Grab

Runs the Grab operation for Chart.

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.

Set

Runs the Set operation for Chart.

Set(Labels=None, Series=None, Pie=None, Type=None, Direction=None)

Arguments

Argument Default Accepted values What it does
Labels None Any valid value Labels value used by the operation.
Series None Any valid value Series value used by the operation.
Pie None Any valid value Pie value used by the operation.
Type None Any valid value Type value used by the operation.
Direction None Any valid value Direction value used by the operation.

Output

Returns the object, so the call can be chained.

Add_Series

Adds a new item to the object or UI.

Add_Series(Name='Series', Values=None, Color=None)

Arguments

Argument Default Accepted values What it does
Name 'Series' Any valid value Display/name identifier.
Values None Any valid value Values value used by the operation.
Color None Any valid value Color used for drawing or display.

Output

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

Direction

Runs the Direction operation for Chart.

Direction(Value=None)

Arguments

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

Output

Returns the object, so the call can be chained.

Export

Runs the Export operation for Chart.

Export()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Import

Runs the Import operation for Chart.

Import(Data)

Arguments

Argument Default Accepted values What it does
Data Required Type, Direction, Labels, Series, Pie, Config Dataset path or dataset definition.

Output

Returns True/False to indicate success.

Labels

Runs the Labels operation for Chart.

Labels(Value=None)

Arguments

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

Output

Returns the object, so the call can be chained.

Pie

Runs the Pie operation for Chart.

Pie(Value=None)

Arguments

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

Output

Returns the object, so the call can be chained.

Scale

Scales the object/data by the requested amount.

Scale(Scale=1, Width=True, Height=True, Left=False, Top=False)

Arguments

Argument Default Accepted values What it does
Scale 1 Any valid value Scale value used by the operation.
Width True Any valid value Width in pixels, world units, or widget units depending on the class.
Height True Any valid value Height in pixels, world units, or widget units depending on the class.
Left False Any valid value Turns left on or off.
Top False Any valid value Turns top on or off.

Output

Returns True/False to indicate success.

Series

Runs the Series operation for Chart.

Series(Value=None)

Arguments

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

Output

Returns the object, so the call can be chained.

Ticks

Runs the Ticks operation for Chart.

Ticks(Value=None)

Arguments

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

Output

Returns the object, so the call can be chained.

Type

Runs the Type operation for Chart.

Type(Value=None)

Arguments

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

Output

Returns the object, so the call can be chained.

Y_Ticks

Runs the Y_Ticks operation for Chart.

Y_Ticks(Value=None)

Arguments

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

Output

Returns the object, so the call can be chained.

Bind

Runs the Bind operation for Chart.

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

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 True/False to indicate success.