Edit Button (Graphs/Python)

The “Edit” window for graphs and Python scripts provides various possibilities and you can change almost everything here. It is even possible to edit the program. Entries and functions are almost exactly the same for graphs and script, and therefore they are explained together here.

Please also read the “How to Add a Command” chapter for more information about how to work with this dialogue.

Source

This area provides access to the graph's or script's source.

Edit graph/Edit Python script

A click on this button opens a graphs or Python editor. There you have to enter the instructions you want to execute when the command is used. The editors have exactly the same functionality as their “Batch Graph” and “Batch Script” counterparts from the “Layout” menu. Please read the appropriate chapters to learn more about how to use them.

A workflow for an example how to create a Python command can be found under “A Python Command”. Adding a new graph works exactly the same way.

File location

With “Add new graph” or “Add new Python script” you will see a non-editable “embedded” entry. If you have chosen “...from file” the field contains the path to the script you have been loading before.

…

A click on this button opens a file browser where you can change or update the path to the command's graph/script file. With embedded commands the button is inactive.

Save to file and convert to reference

This button can be seen with “Add new graph from file” or “Add new Python script from file”. When you click on it, RealFlow will convert the embedded command into a file and create a link to it. From this moment, the “Commands Manager” will always require access to the graph/script, so please be careful where you save the file: if it is not found the command cannot be executed.

Embed command into RealFlow

If you have chosen one of the “...from file” options you have the possibility of converting the external graph/script into an embedded command. The original file will be kept and not deleted; RealFlow will just cut the link to the file.

Properties

In this section the command is described and you can add an icon that will be displayed in RealFlow's shelves.

Class ID

A command requires a unique Id to make it identifiable within RealFlow. We recommend using the already suggested Id to avoid conflicts. Please read more about the importance of the “Class ID” here.

Generate

If you are not happy with the suggested Id please click on this button to create a new number.

Name

This field contains the command's name and how it will be displayed in RealFlow's shelves.

Copyright

Please add your copyright information here (not mandatory).

Shortcut

This field contains the command's shortcut(s). To assign a key combination use the “Edit” button.

Edit

To provide quick access to your command you can define a shortcut with a small editor. RealFlow also has a sophisticated “Shortcut Editor” where you have access to all of RealFlow's key combinations. Please follow this link to learn more.

Icon

A symbol, representing your command, makes it perfect. Supported formats are PNG, JPG, BMP, and SVG. SVG symbols have the great advantage that they can be scaled without a loss of quality. The selected icon is displayed here.

Edit Icon

Icons of built-in commands cannot be added. Therefore, this function is inactive.

Icon Editor

This is the “Icon Editor's” layout:

Under “From Gallery” it is possible to choose a symbol from RealFlow's icon repository. Simply click on “Browse icon gallery...” to get there. In the “Preview” area you will see the selected icon. Adjust its size with the “Resolution” slider. Most icons are stored in SVG format and can be magnified without any loss of quality.

“From File” let's you choose a PNG, JPG, BMP or SVG file from your hard disk with the “...” button. The chosen image will be shown in the “File location” field. If you want to keep the icon as an external reference, check the appropriate storage method. If you want to embed the image into RealFlow, choose this option.

The “Preview” function works as described above. Please bear in mind that upscaled pixel-based image formats will look jaggy.

Description

This field contains a detailed description of the command.

Input Parameters

This section provides various possibilities and is therefore explained in a separate chapter. Please visit the "Input Parameters" page for more information.