Unity - Scripting API: Group

Description

Allows interactive insertion of elements in a named scope.

Properties

title

Title of the group.

Constructors

Group

Group constructor.

Public Methods

AcceptsElement	Whether an element can be added to this group.
CollectElements	Retrieves a set of graph elements that match a specified condition. The matching graph elements are selected from this group.
FocusTitleTextField	Focuses the title text field of this group, so that it's editable from the UI.

Protected Methods

OnElementsAdded	Called when elements are added to this group.
OnElementsRemoved	Called when elements are removed from this group.
OnGroupRenamed	Called when this group is renamed.

Inherited Members

Static Properties

disabledUssClassName

USS class name of local disabled elements.

Properties

canGrabFocus	Return true if the element can be focused.
delegatesFocus	Whether the element should delegate the focus to its children.
focusable	True if the element can be focused.
focusController	Return the focus controller for this element.
tabIndex	An integer used to sort focusables in the focus ring. Must be greater than or equal to zero.
capabilities	The GraphElement's capabilities.
elementTypeColor	The color used for the MiniMap view.
layer	The GraphElement's layer in the graph.
selected	True if the GraphElement is currently selected.
showInMiniMap	Whether the element is shown in the minimap.
title	The GraphElement's title.
autoUpdateGeometry	Enables or disables the automatic resizing and positioning of the Scope.
containedElements	The list of GraphElements contained by the Scope.
containedElementsRect	The rect containing the GraphElements encompassed by the Scope. The rect is expressed in local coordinates.
headerContainer	Returns the header container for the Scope. Use this header container to customizer the header of the Scope.
childCount	Number of child elements in this object's contentContainer.
contentContainer	Child elements are added to it, usually this is the same as the element itself.
contentRect	The rectangle of the content area of the element, in the local space of the element.
customStyle	Returns the custom style properties accessor for this element.
dataSource	Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children.
dataSourcePath	Path from the data source to the value.
enabledInHierarchy	Returns true if the VisualElement is enabled in its own hierarchy.
enabledSelf	Returns true if the VisualElement is enabled locally.
experimental	Returns the UIElements experimental interfaces.
generateVisualContent	Called when the VisualElement visual contents need to be (re)generated.
hierarchy	Access to this element physical hierarchy
languageDirection	Indicates the directionality of the element's text. The value will propagate to the element's children.
layout	The position and size of the VisualElement relative to its parent, as computed by the layout system.
localBound	Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the transform, but before applying the layout translation.
name	The name of this VisualElement.
paddingRect	The rectangle of the padding area of the element, in the local space of the element.
panel	The panel onto which this VisualElement is attached.
parent	The parent of this VisualElement.
pickingMode	Determines if this element can be pick during mouseEvents or IPanel.Pick queries.
resolvedStyle	Returns the VisualElement resolved style values.
schedule	Retrieves this VisualElement's IVisualElementScheduler
style	Reference to the style object of this element.
styleSheets	Returns a VisualElementStyleSheetSet that manipulates style sheets attached to this element.
this[int]	Retrieves the child element at a specific index.
tooltip	Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI.
transform	Returns a transform object for this VisualElement. ITransform
usageHints	A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It's advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform).
userData	This property can be used to associate application-specific user data with this VisualElement.
viewDataKey	Used for view data persistence, such as tree expanded states, scroll position, or zoom level.
visible	Indicates whether or not this element should be rendered.
visualTreeAssetSource	Stores the asset reference, if the generated element is cloned from a VisualTreeAsset.
worldBound	Returns a Rect representing the Axis-aligned Bounding Box (AABB) after applying the world transform.
worldTransform	Returns a matrix that cumulates the following operations (in order): -Local Scaling -Local Rotation -Local Translation -Layout Translation -Parent worldTransform (recursive definition - consider identity when there is no parent)

Public Methods

HasBubbleUpHandlers	Return true if event handlers for the event propagation BubbleUp phase have been attached on this object.
HasTrickleDownHandlers	Returns true if event handlers, for the event propagation TrickleDown phase, are attached to this object.
RegisterCallback	Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect.
RegisterCallbackOnce	Adds an event handler to the instance. If the event handler has already been registered for the same phase (either TrickleDown or BubbleUp) then this method has no effect. The event handler is automatically unregistered after it has been invoked exactly once.
UnregisterCallback	Remove callback from the instance.
Blur	Tell the element to release the focus.
Focus	Attempt to give the focus to this element.
GetGlobalCenter	Get the GraphElement's center point.
GetPosition	Get the GraphElement position.
HitTest	See if point is over the GraphElement.
IsAscendable	Checks if the GraphElement is automatically brought to front when selected.
IsCopiable	Checks whether the GraphElement is copiable.
IsDroppable	The GraphElement is drag&droppable.
IsGroupable	Checks whether the GraphElement is groupable.
IsMovable	The GraphElement is movable.
IsRenamable	The GraphElement is renamable.
IsResizable	The GraphElement is resizable.
IsSelectable	The GraphElement is selectable.
IsSelected	The GraphElement is currently selected in specific container.
IsSnappable	Checks whether the GraphElement is snappable.
IsStackable	Checks whether the GraphElement is stackable.
OnSelected	Called when the GraphElement is selected.
OnUnselected	Called when the GraphElement is unselected.
ResetLayer	Reset the GraphElement to its original layer.
Select	Select the GraphElement.
SetPosition	Set the GraphElement position.
Unselect	Deselect the GraphElement.
AddElement	Adds a GraphElement to the Scope.
AddElements	Adds GraphElements to the Scope.
ContainsElement	Determines if the Scope contains the specified GraphElement.
GetPosition	Returns the geometry of the Scope.
HitTest	Determines whether the specified point is within the selectable area of the Scope.
Overlaps	Determines whether the specified rect overlaps the Scope.
RemoveElement	Removes an element from the Scope.
RemoveElements	Removes elements from the Scope.
RemoveElementsWithoutNotification	Removes elements from the Scope but do not send a notification.
SetPosition	Sets the geometry of the Scope.
UpdateGeometryFromContent	Updates the size and position of the Scope based on its contents.
Add	Add an element to this element's contentContainer
AddToClassList	Adds a class to the class list of the element in order to assign styles from USS. Note the class name is case-sensitive.
BringToFront	Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements.
Children	Returns the elements from its contentContainer.
ClassListContains	Searches for a class in the class list of this element.
Clear	Remove all child elements from this element's contentContainer
ClearBinding	Removes a binding from the element.
ClearBindings	Removes all bindings from the element.
ClearClassList	Removes all classes from the class list of this element. AddToClassList
Contains	Checks if this element is an ancestor of the specified child element.
ContainsPoint	Checks if the specified point intersects with this VisualElement's layout.
ElementAt	Retrieves the child element at a specific index.
EnableInClassList	Enables or disables the class with the given name.
FindAncestorUserData	Searches up the hierarchy of this VisualElement and retrieves stored userData, if any is found.
FindCommonAncestor	Finds the lowest common ancestor between two VisualElements inside the VisualTree hierarchy.
GetBinding	Gets the binding instance for the provided targeted property.
GetBindingInfos	Gets information on all the bindings of the current element.
GetClasses	Retrieve the classes for this element.
GetDataSourceContext	Queries the dataSource and dataSourcePath of a binding object.
GetFirstAncestorOfType	Walks up the hierarchy, starting from this element's parent, and returns the first VisualElement of this type
GetFirstOfType	Walks up the hierarchy, starting from this element, and returns the first VisualElement of this type
GetHierarchicalDataSourceContext	Queries the dataSource and dataSourcePath inherited from the hierarchy.
HasBinding	Allows to know if a target property has a binding associated to it.
IndexOf	Retrieves the child index of the specified VisualElement.
Insert	Insert an element into this element's contentContainer
MarkDirtyRepaint	Triggers a repaint of the VisualElement on the next frame. This method is called internally when a change occurs that requires a repaint, such as when UIElements.BaseField_1.value is changed or the text in a Label. If you are implementing a custom control, you can call this method to trigger a repaint when a change occurs that requires a repaint such as when using generateVisualContent to render a mesh and the mesh data has now changed.
PlaceBehind	Places this element right before the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually behind of its sibling.
PlaceInFront	Places this element right after the sibling element in their parent children list. If the element and the sibling position overlap, the element will be visually in front of its sibling.
Remove	Removes this child from the contentContainerhierarchy.
RemoveAt	Remove the child element located at this position from this element's contentContainer
RemoveFromClassList	Removes a class from the class list of the element.
RemoveFromHierarchy	Removes this element from its parent hierarchy.
SendEvent	Sends an event to the event handler.
SendToBack	Sends this element to the beginning of its parent children list. The element will be visually behind any overlapping sibling elements.
SetBinding	Assigns a binding between a target and a source.
SetEnabled	Changes the VisualElement enabled state. A disabled VisualElement does not receive most events.
Sort	Reorders child elements from this VisualElement contentContainer.
ToggleInClassList	Toggles between adding and removing the given class name from the class list.
TryGetBinding	Gets the binding instance for the provided targeted property.
TryGetDataSourceContext	Queries the dataSource and dataSourcePath of a binding object.

Protected Methods

HandleEventBubbleUp	Executes logic on this element during the BubbleUp phase, immediately before this element's BubbleUp callbacks. Calling StopPropagation will prevent further invocations of this method along the propagation path.
HandleEventTrickleDown	Executes logic on this element during the TrickleDown phase, immediately after this element's TrickleDown callbacks. Calling StopPropagation will prevent further invocations of this method along the propagation path.
NotifyPropertyChanged	Informs the data binding system that a property of a control has changed.
OnCustomStyleResolved	Called when the custom style properties are resolved.
ScheduleUpdateGeometryFromContent	Schedules the update of the size and position of the Scope based on its contents.
SetScopePositionOnly	Change the position of the scope but does not move its elements.

Scripting API

Group

Success!

Submission failed

Description

Properties

Constructors

Public Methods

Protected Methods

Inherited Members

Static Properties

Properties

Public Methods

Protected Methods