docs.unity3d.com
    Show / Hide Table of Contents

    Class TwoPaneSplitView

    A SplitView that contains two resizable panes. One pane is fixed-size while the other pane has flex-grow style set to 1 to take all remaining space. The border between he panes is draggable to resize both panes. Both horizontal and vertical modes are supported. Requires exactly two child elements to operate.

    Inheritance
    Object
    CallbackEventHandler
    Focusable
    VisualElement
    TwoPaneSplitView
    Inherited Members
    VisualElement.disabledUssClassName
    VisualElement.viewDataKey
    VisualElement.userData
    VisualElement.canGrabFocus
    VisualElement.focusController
    VisualElement.usageHints
    VisualElement.transform
    VisualElement.ITransform.position
    VisualElement.ITransform.rotation
    VisualElement.ITransform.scale
    VisualElement.ITransform.matrix
    VisualElement.layout
    VisualElement.contentRect
    VisualElement.paddingRect
    VisualElement.worldBound
    VisualElement.localBound
    VisualElement.worldTransform
    VisualElement.pickingMode
    VisualElement.name
    VisualElement.ExecuteDefaultAction(EventBase)
    VisualElement.Focus()
    VisualElement.SendEvent(EventBase)
    VisualElement.SetEnabledFromHierarchy(Boolean)
    VisualElement.enabledInHierarchy
    VisualElement.enabledSelf
    VisualElement.SetEnabled(Boolean)
    VisualElement.visible
    VisualElement.MarkDirtyRepaint()
    VisualElement.generateVisualContent
    VisualElement.ContainsPoint(Vector2)
    VisualElement.Overlaps(Rect)
    VisualElement.DoMeasure(Single, VisualElement.MeasureMode, Single, VisualElement.MeasureMode)
    VisualElement.ToString()
    VisualElement.GetClasses()
    VisualElement.ClearClassList()
    VisualElement.AddToClassList(String)
    VisualElement.RemoveFromClassList(String)
    VisualElement.ToggleInClassList(String)
    VisualElement.EnableInClassList(String, Boolean)
    VisualElement.ClassListContains(String)
    VisualElement.FindAncestorUserData()
    VisualElement.ITransitionAnimations.Start(Single, Single, Int32, Action<VisualElement, Single>)
    VisualElement.ITransitionAnimations.Start(Rect, Rect, Int32, Action<VisualElement, Rect>)
    VisualElement.ITransitionAnimations.Start(Color, Color, Int32, Action<VisualElement, Color>)
    VisualElement.ITransitionAnimations.Start(Vector3, Vector3, Int32, Action<VisualElement, Vector3>)
    VisualElement.ITransitionAnimations.Start(Vector2, Vector2, Int32, Action<VisualElement, Vector2>)
    VisualElement.ITransitionAnimations.Start(Quaternion, Quaternion, Int32, Action<VisualElement, Quaternion>)
    VisualElement.ITransitionAnimations.Start(StyleValues, StyleValues, Int32)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Single>, Single, Int32, Action<VisualElement, Single>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Rect>, Rect, Int32, Action<VisualElement, Rect>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Color>, Color, Int32, Action<VisualElement, Color>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Vector3>, Vector3, Int32, Action<VisualElement, Vector3>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Vector2>, Vector2, Int32, Action<VisualElement, Vector2>)
    VisualElement.ITransitionAnimations.Start(Func<VisualElement, Quaternion>, Quaternion, Int32, Action<VisualElement, Quaternion>)
    VisualElement.ITransitionAnimations.Start(StyleValues, Int32)
    VisualElement.ITransitionAnimations.Layout(Rect, Int32)
    VisualElement.ITransitionAnimations.TopLeft(Vector2, Int32)
    VisualElement.ITransitionAnimations.Size(Vector2, Int32)
    VisualElement.ITransitionAnimations.Scale(Single, Int32)
    VisualElement.ITransitionAnimations.Position(Vector3, Int32)
    VisualElement.ITransitionAnimations.Rotation(Quaternion, Int32)
    VisualElement.experimental
    VisualElement.IExperimentalFeatures.animation
    VisualElement.hierarchy
    VisualElement.cacheAsBitmap
    VisualElement.parent
    VisualElement.panel
    VisualElement.visualTreeAssetSource
    VisualElement.Add(VisualElement)
    VisualElement.Insert(Int32, VisualElement)
    VisualElement.Remove(VisualElement)
    VisualElement.RemoveAt(Int32)
    VisualElement.Clear()
    VisualElement.ElementAt(Int32)
    VisualElement.Item[Int32]
    VisualElement.childCount
    VisualElement.IndexOf(VisualElement)
    VisualElement.Children()
    VisualElement.Sort(Comparison<VisualElement>)
    VisualElement.BringToFront()
    VisualElement.SendToBack()
    VisualElement.PlaceBehind(VisualElement)
    VisualElement.PlaceInFront(VisualElement)
    VisualElement.RemoveFromHierarchy()
    VisualElement.GetFirstOfType<T>()
    VisualElement.GetFirstAncestorOfType<T>()
    VisualElement.Contains(VisualElement)
    VisualElement.FindCommonAncestor(VisualElement)
    VisualElement.schedule
    VisualElement.IVisualElementScheduler.Execute(Action<TimerState>)
    VisualElement.IVisualElementScheduler.Execute(Action)
    VisualElement.style
    VisualElement.customStyle
    VisualElement.styleSheets
    VisualElement.tooltip
    VisualElement.resolvedStyle
    VisualElement.IResolvedStyle.alignContent
    VisualElement.IResolvedStyle.alignItems
    VisualElement.IResolvedStyle.alignSelf
    VisualElement.IResolvedStyle.backgroundColor
    VisualElement.IResolvedStyle.backgroundImage
    VisualElement.IResolvedStyle.borderBottomColor
    VisualElement.IResolvedStyle.borderBottomLeftRadius
    VisualElement.IResolvedStyle.borderBottomRightRadius
    VisualElement.IResolvedStyle.borderBottomWidth
    VisualElement.IResolvedStyle.borderLeftColor
    VisualElement.IResolvedStyle.borderLeftWidth
    VisualElement.IResolvedStyle.borderRightColor
    VisualElement.IResolvedStyle.borderRightWidth
    VisualElement.IResolvedStyle.borderTopColor
    VisualElement.IResolvedStyle.borderTopLeftRadius
    VisualElement.IResolvedStyle.borderTopRightRadius
    VisualElement.IResolvedStyle.borderTopWidth
    VisualElement.IResolvedStyle.bottom
    VisualElement.IResolvedStyle.color
    VisualElement.IResolvedStyle.display
    VisualElement.IResolvedStyle.flexBasis
    VisualElement.IResolvedStyle.flexDirection
    VisualElement.IResolvedStyle.flexGrow
    VisualElement.IResolvedStyle.flexShrink
    VisualElement.IResolvedStyle.flexWrap
    VisualElement.IResolvedStyle.fontSize
    VisualElement.IResolvedStyle.height
    VisualElement.IResolvedStyle.justifyContent
    VisualElement.IResolvedStyle.left
    VisualElement.IResolvedStyle.letterSpacing
    VisualElement.IResolvedStyle.marginBottom
    VisualElement.IResolvedStyle.marginLeft
    VisualElement.IResolvedStyle.marginRight
    VisualElement.IResolvedStyle.marginTop
    VisualElement.IResolvedStyle.maxHeight
    VisualElement.IResolvedStyle.maxWidth
    VisualElement.IResolvedStyle.minHeight
    VisualElement.IResolvedStyle.minWidth
    VisualElement.IResolvedStyle.opacity
    VisualElement.IResolvedStyle.paddingBottom
    VisualElement.IResolvedStyle.paddingLeft
    VisualElement.IResolvedStyle.paddingRight
    VisualElement.IResolvedStyle.paddingTop
    VisualElement.IResolvedStyle.position
    VisualElement.IResolvedStyle.right
    VisualElement.IResolvedStyle.textOverflow
    VisualElement.IResolvedStyle.top
    VisualElement.IResolvedStyle.unityBackgroundImageTintColor
    VisualElement.IResolvedStyle.unityBackgroundScaleMode
    VisualElement.IResolvedStyle.unityFont
    VisualElement.IResolvedStyle.unityFontDefinition
    VisualElement.IResolvedStyle.unityFontStyleAndWeight
    VisualElement.IResolvedStyle.unityParagraphSpacing
    VisualElement.IResolvedStyle.unitySliceBottom
    VisualElement.IResolvedStyle.unitySliceLeft
    VisualElement.IResolvedStyle.unitySliceRight
    VisualElement.IResolvedStyle.unitySliceTop
    VisualElement.IResolvedStyle.unityTextAlign
    VisualElement.IResolvedStyle.unityTextOutlineColor
    VisualElement.IResolvedStyle.unityTextOutlineWidth
    VisualElement.IResolvedStyle.unityTextOverflowPosition
    VisualElement.IResolvedStyle.visibility
    VisualElement.IResolvedStyle.whiteSpace
    VisualElement.IResolvedStyle.width
    VisualElement.IResolvedStyle.wordSpacing
    Focusable.focusable
    Focusable.tabIndex
    Focusable.delegatesFocus
    Focusable.Blur()
    CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
    CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
    CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
    CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
    CallbackEventHandler.HandleEvent(EventBase)
    CallbackEventHandler.HasTrickleDownHandlers()
    CallbackEventHandler.HasBubbleUpHandlers()
    CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)
    Namespace: UnityEngine.UIElements
    Syntax
    public class TwoPaneSplitView : VisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle

    Constructors

    TwoPaneSplitView()

    Declaration
    public TwoPaneSplitView()

    TwoPaneSplitView(Int32, Single, TwoPaneSplitViewOrientation)

    Parameterized constructor.

    Declaration
    public TwoPaneSplitView(int fixedPaneIndex, float fixedPaneStartDimension, TwoPaneSplitViewOrientation orientation)
    Parameters
    Type Name Description
    Int32 fixedPaneIndex

    0 for setting first child as the fixed pane, 1 for the second child element.

    Single fixedPaneStartDimension

    Set an inital width or height for the fixed pane.

    TwoPaneSplitViewOrientation orientation

    Orientation of the split view.

    Properties

    contentContainer

    Declaration
    public override VisualElement contentContainer { get; }
    Property Value
    Type Description
    VisualElement
    Overrides
    VisualElement.contentContainer

    fixedPane

    The child element that is set as the fixed size pane.

    Declaration
    public VisualElement fixedPane { get; }
    Property Value
    Type Description
    VisualElement

    fixedPaneIndex

    0 for setting first child as the fixed pane, 1 for the second child element.

    Declaration
    public int fixedPaneIndex { get; set; }
    Property Value
    Type Description
    Int32

    fixedPaneInitialDimension

    The initial width or height for the fixed pane.

    Declaration
    public float fixedPaneInitialDimension { get; set; }
    Property Value
    Type Description
    Single

    flexedPane

    The child element that is set as the flexable size pane.

    Declaration
    public VisualElement flexedPane { get; }
    Property Value
    Type Description
    VisualElement

    orientation

    Orientation of the split view.

    Declaration
    public TwoPaneSplitViewOrientation orientation { get; set; }
    Property Value
    Type Description
    TwoPaneSplitViewOrientation

    Methods

    CollapseChild(Int32)

    Collapse one of the panes of the split view. This will hide the resizer and make the other child take up all available space.

    Declaration
    public void CollapseChild(int index)
    Parameters
    Type Name Description
    Int32 index

    Index of child to collapse.

    UnCollapse()

    Un-collapse the split view. This will restore the split view to the state it was before the previous collapse.

    Declaration
    public void UnCollapse()

    Extension Methods

    UQueryExtensions.Q<T>(VisualElement, String, String[])
    UQueryExtensions.Q(VisualElement, String, String[])
    UQueryExtensions.Q<T>(VisualElement, String, String)
    UQueryExtensions.Q(VisualElement, String, String)
    UQueryExtensions.Query(VisualElement, String, String[])
    UQueryExtensions.Query(VisualElement, String, String)
    UQueryExtensions.Query<T>(VisualElement, String, String[])
    UQueryExtensions.Query<T>(VisualElement, String, String)
    UQueryExtensions.Query(VisualElement)
    VisualElementExtensions.StretchToParentSize(VisualElement)
    VisualElementExtensions.StretchToParentWidth(VisualElement)
    VisualElementExtensions.AddManipulator(VisualElement, IManipulator)
    VisualElementExtensions.RemoveManipulator(VisualElement, IManipulator)
    VisualElementExtensions.WorldToLocal(VisualElement, Vector2)
    VisualElementExtensions.LocalToWorld(VisualElement, Vector2)
    VisualElementExtensions.WorldToLocal(VisualElement, Rect)
    VisualElementExtensions.LocalToWorld(VisualElement, Rect)
    VisualElementExtensions.ChangeCoordinatesTo(VisualElement, VisualElement, Vector2)
    VisualElementExtensions.ChangeCoordinatesTo(VisualElement, VisualElement, Rect)
    BindingExtensions.Bind(VisualElement, SerializedObject)
    BindingExtensions.Unbind(VisualElement)
    BindingExtensions.TrackPropertyValue(VisualElement, SerializedProperty, Action<SerializedProperty>)
    In This Article
    • Constructors
      • TwoPaneSplitView()
      • TwoPaneSplitView(Int32, Single, TwoPaneSplitViewOrientation)
    • Properties
      • contentContainer
      • fixedPane
      • fixedPaneIndex
      • fixedPaneInitialDimension
      • flexedPane
      • orientation
    • Methods
      • CollapseChild(Int32)
      • UnCollapse()
    • Extension Methods
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023