spark.graph_editor.editor

spark.graph_editor.editor#

Classes#

DockPanels

Create a collection of name/value pairs.

SparkGraphEditor

Module Contents#

class spark.graph_editor.editor.DockPanels(*args, **kwds)[source]#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

  • attribute access:

    >>> Color.RED
<Color.RED: 1>

  • value lookup:

    >>> Color(1)
<Color.RED: 1>

  • name lookup:

    >>> Color['RED']
<Color.RED: 1>

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

GRAPH[source]#
INSPECTOR[source]#
NODES[source]#
CONSOLE[source]#
class spark.graph_editor.editor.SparkGraphEditor[source]#
app[source]#
launch()[source]#

Creates and shows the editor window without blocking. This method is safe to call multiple times.

Return type:

None

exit_editor()[source]#

Exit editor.

Return type:

None

closeEvent(event)[source]#

Overrides the default close event to check for unsaved changes.

Return type:

None

new_session()[source]#

Clears the current session after checking for unsaved changes.

Return type:

None

save_session()[source]#

Saves the current session to a Spark Graph Editor file.

Return type:

bool

save_session_as()[source]#

Saves the current session to a new Spark Graph Editor file.

Return type:

bool

load_session()[source]#

Loads a graph state from a Spark Graph Editor file after checking for unsaved changes.

Return type:

None

load_from_model()[source]#

Loads a graph state from a Spark configuration file after checking for unsaved changes.

Return type:

None

export_model()[source]#

Exports the graph state to a Spark configuration file.

Return type:

bool

export_model_as()[source]#

Exports the graph state to a new Spark configuration file.

Return type:

bool

Contents