Description

GraphFrame is a specialGraphElement to which otherGraphElements can be attached. It can be configured to automatically resize to enclose all attachedGraphElements. If the frame is moved, all the attachedGraphElements inside it will be moved as well.

A GraphFrame is always kept behind the connection layer and otherGraphElements inside aGraphEdit.

Properties

Methods

Theme Properties

Signals

autoshrink_changed()🔗

Emitted whenautoshrink_enabled orautoshrink_margin changes.

Property Descriptions

boolautoshrink_enabled =true🔗

• voidset_autoshrink_enabled(value:bool)

• boolis_autoshrink_enabled()

Iftrue, the frame's rect will be adjusted automatically to enclose all attachedGraphElements.

intautoshrink_margin =40🔗

• voidset_autoshrink_margin(value:int)

• intget_autoshrink_margin()

The margin around the attached nodes that is used to calculate the size of the frame whenautoshrink_enabled istrue.

intdrag_margin =16🔗

• voidset_drag_margin(value:int)

• intget_drag_margin()

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

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

• voidset_tint_color(value:Color)

• Colorget_tint_color()

The color of the frame whentint_color_enabled istrue.

booltint_color_enabled =false🔗

• voidset_tint_color_enabled(value:bool)

• boolis_tint_color_enabled()

Iftrue, the tint color will be used to tint the frame.

Stringtitle =""🔗

• voidset_title(value:String)

• Stringget_title()

Title of the frame.

Method Descriptions

HBoxContainerget_titlebar_hbox()🔗

Returns theHBoxContainer used for the title bar, only containing aLabel 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

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

The color modulation applied to the resizer icon.

StyleBoxpanel🔗

The defaultStyleBox used for the background of theGraphFrame.

StyleBoxpanel_selected🔗

TheStyleBox used for the background of theGraphFrame when it is selected.

StyleBoxtitlebar🔗

TheStyleBox used for the title bar of theGraphFrame.

StyleBoxtitlebar_selected🔗

TheStyleBox used for the title bar of theGraphFrame when it is selected.