Attention: Here be dragons (unstable version)

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Redot.

Checking the stable version of the documentation...

GraphFrame

Experimental: This class may be changed or removed in future versions.

Inherits: GraphElement < Container < Control < CanvasItem < Node < Object

GraphFrame is a special GraphElement that can be used to organize other GraphElements inside a GraphEdit.

Description

GraphFrame is a special GraphElement to which other GraphElements can be attached. It can be configured to automatically resize to enclose all attached GraphElements. If the frame is moved, all the attached GraphElements inside it will be moved as well.

A GraphFrame is always kept behind the connection layer and other GraphElements inside a GraphEdit.

Properties

bool

autoshrink_enabled

true

int

autoshrink_margin

40

int

drag_margin

16

MouseFilter

mouse_filter

0 (overrides Control)

Color

tint_color

Color(0.3, 0.3, 0.3, 0.75)

bool

tint_color_enabled

false

String

title

""

Methods

HBoxContainer

get_titlebar_hbox()

Theme Properties

Color

resizer_color

Color(0.875, 0.875, 0.875, 1)

StyleBox

panel

StyleBox

panel_selected

StyleBox

titlebar

StyleBox

titlebar_selected

Signals

autoshrink_changed() 🔗

Emitted when autoshrink_enabled or autoshrink_margin changes.

Property Descriptions

bool autoshrink_enabled = true 🔗

  • void set_autoshrink_enabled(value: bool)

  • bool is_autoshrink_enabled()

If true, the frame's rect will be adjusted automatically to enclose all attached GraphElements.

int autoshrink_margin = 40 🔗

  • void set_autoshrink_margin(value: int)

  • int get_autoshrink_margin()

The margin around the attached nodes that is used to calculate the size of the frame when autoshrink_enabled is true.

int drag_margin = 16 🔗

  • void set_drag_margin(value: int)

  • int get_drag_margin()

The margin inside the frame that can be used to drag the frame.

Color tint_color = Color(0.3, 0.3, 0.3, 0.75) 🔗

  • void set_tint_color(value: Color)

  • Color get_tint_color()

The color of the frame when tint_color_enabled is true.

bool tint_color_enabled = false 🔗

  • void set_tint_color_enabled(value: bool)

  • bool is_tint_color_enabled()

If true, the tint color will be used to tint the frame.

String title = "" 🔗

Title of the frame.

Method Descriptions

HBoxContainer get_titlebar_hbox() 🔗

Returns the HBoxContainer used for the title bar, only containing a Label for displaying the title by default.

This can be used to add custom controls to the title bar such as option or close buttons.

Theme Property Descriptions

Color resizer_color = Color(0.875, 0.875, 0.875, 1) 🔗

The color modulation applied to the resizer icon.

StyleBox panel 🔗

The default StyleBox used for the background of the GraphFrame.

StyleBox panel_selected 🔗

The StyleBox used for the background of the GraphFrame when it is selected.

StyleBox titlebar 🔗

The StyleBox used for the title bar of the GraphFrame.

StyleBox titlebar_selected 🔗

The StyleBox used for the title bar of the GraphFrame when it is selected.