Home / Webapp / Editor
Webapp

Editor

Editor API available from the Webapp library.

40 public methods

Import

from Xenonix.Webapp import Editor

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

This object does not expose a public Config table.

Public methods

Create

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

Copy

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

Copy()

Arguments

No arguments.

Output

Returns a copy of the object.

Focus

Moves focus to this widget/object where supported.

Focus()

Arguments

No arguments.

Output

Updates the object or visible UI state.

Edit

Runs the Edit operation for Editor.

Edit()

Arguments

No arguments.

Output

Returns the calculated result.

Select

Runs the Select operation for Editor.

Select(Index=None)

Arguments

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

Output

Returns the calculated result.

Selected

Runs the Selected operation for Editor.

Selected()

Arguments

No arguments.

Output

Returns the calculated result.

Set

Runs the Set operation for Editor.

Set(Path)

Arguments

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

Output

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

Active_Border_Color

Runs the Active_Border_Color operation for Editor.

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

Cancel_Draft

Runs the Cancel_Draft operation for Editor.

Cancel_Draft()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Clear_Shapes

Clears stored data, selection, or visible content.

Clear_Shapes()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Cut

Runs the Cut operation for Editor.

Cut()

Arguments

No arguments.

Output

Returns the calculated result.

Default_Angle

Calculates or applies angle/rotation behavior.

Default_Angle(Value=None)

Arguments

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

Output

Returns or applies an angle value.

Delete_Selected

Removes the requested item.

Delete_Selected()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Draw

Draws the supplied object, region, or overlay onto the current image/display.

Draw(Value=True)

Arguments

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

Output

Returns the object, so the call can be chained.

Export

Runs the Export operation for Editor.

Export()

Arguments

No arguments.

Output

Returns structured data such as a list or dictionary.

Finish_Draft

Runs the Finish_Draft operation for Editor.

Finish_Draft()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Hide_All

Runs the Hide_All operation for Editor.

Hide_All()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Import

Runs the Import operation for Editor.

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.

Lock_All

Runs the Lock_All operation for Editor.

Lock_All()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Pan_View

Runs the Pan_View operation for Editor.

Pan_View(Value=True)

Arguments

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

Output

Returns the object, so the call can be chained.

Paste

Runs the Paste operation for Editor.

Paste(Offset_X=10, Offset_Y=10)

Arguments

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

Output

Returns the calculated result.

Redo

Runs the Redo operation for Editor.

Redo()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Reset

Runs the Reset operation for Editor.

Reset()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Reset_View

Runs the Reset_View operation for Editor.

Reset_View()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Shape_Add

Runs the Shape_Add operation for Editor.

Shape_Add(Shape, Select=True)

Arguments

Argument Default Accepted values What it does
Shape Required Any valid value Shape value used by the operation.
Select True Any valid value Turns select on or off.

Output

Returns the object, so the call can be chained.

Shape_Color

Runs the Shape_Color operation for Editor.

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

Shape_Fill

Runs the Shape_Fill operation for Editor.

Shape_Fill(Color=None, Alpha=None)

Arguments

Argument Default Accepted values What it does
Color None Any valid value Color used for drawing or display.
Alpha None Any valid value Alpha value used by the operation.

Output

Returns structured data such as a list or dictionary.

Shape_Mode

Runs the Shape_Mode operation for Editor.

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

Shape_Thickness

Runs the Shape_Thickness operation for Editor.

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

Shapes

Runs the Shapes operation for Editor.

Shapes()

Arguments

No arguments.

Output

Returns the calculated result.

Shapes_Set

Runs the Shapes_Set operation for Editor.

Shapes_Set(Shapes)

Arguments

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

Output

Returns the object, so the call can be chained.

Show_All

Runs the Show_All operation for Editor.

Show_All()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Tools

Runs the Tools operation for Editor.

Tools(Main=None)

Arguments

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

Output

Returns the calculated result.

Undo

Runs the Undo operation for Editor.

Undo()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Unlock_All

Runs the Unlock_All operation for Editor.

Unlock_All()

Arguments

No arguments.

Output

Returns the object, so the call can be chained.

Zoom_In

Runs the Zoom_In operation for Editor.

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 object, so the call can be chained.

Zoom_Out

Runs the Zoom_Out operation for Editor.

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 object, so the call can be chained.

Zoom_Set

Runs the Zoom_Set operation for Editor.

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 object, so the call can be chained.

Bind

Runs the Bind operation for Editor.

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

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.