docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class AvatarGroup

    AvatarGroup UI element.

    Inheritance
    object
    CallbackEventHandler
    Focusable
    VisualElement
    BaseVisualElement
    AvatarGroup
    Implements
    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement
    Inherited Members
    BaseVisualElement.contextPrefix
    BaseVisualElement.scaleOverride
    BaseVisualElement.themeOverride
    BaseVisualElement.langOverride
    BaseVisualElement.layoutDirectionOverride
    BaseVisualElement.preferredTooltipPlacementOverride
    BaseVisualElement.tooltipDelayMsOverride
    BaseVisualElement.GetLayoutDirectionUssClassName(Dir)
    VisualElement.disabledUssClassName
    VisualElement.ExecuteDefaultAction(EventBase)
    VisualElement.Focus()
    VisualElement.SendEvent(EventBase)
    VisualElement.SetEnabledFromHierarchy(bool)
    VisualElement.SetEnabled(bool)
    VisualElement.MarkDirtyRepaint()
    VisualElement.ContainsPoint(Vector2)
    VisualElement.Overlaps(Rect)
    VisualElement.DoMeasure(float, VisualElement.MeasureMode, float, VisualElement.MeasureMode)
    VisualElement.ToString()
    VisualElement.GetClasses()
    VisualElement.ClearClassList()
    VisualElement.AddToClassList(string)
    VisualElement.RemoveFromClassList(string)
    VisualElement.ToggleInClassList(string)
    VisualElement.EnableInClassList(string, bool)
    VisualElement.ClassListContains(string)
    VisualElement.FindAncestorUserData()
    VisualElement.Add(VisualElement)
    VisualElement.Insert(int, VisualElement)
    VisualElement.Remove(VisualElement)
    VisualElement.RemoveAt(int)
    VisualElement.Clear()
    VisualElement.ElementAt(int)
    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.viewDataKey
    VisualElement.userData
    VisualElement.canGrabFocus
    VisualElement.focusController
    VisualElement.usageHints
    VisualElement.transform
    VisualElement.layout
    VisualElement.contentRect
    VisualElement.paddingRect
    VisualElement.worldBound
    VisualElement.localBound
    VisualElement.worldTransform
    VisualElement.pickingMode
    VisualElement.name
    VisualElement.enabledInHierarchy
    VisualElement.enabledSelf
    VisualElement.visible
    VisualElement.generateVisualContent
    VisualElement.experimental
    VisualElement.hierarchy
    VisualElement.cacheAsBitmap
    VisualElement.parent
    VisualElement.panel
    VisualElement.visualTreeAssetSource
    VisualElement.this[int]
    VisualElement.childCount
    VisualElement.schedule
    VisualElement.style
    VisualElement.customStyle
    VisualElement.styleSheets
    VisualElement.tooltip
    VisualElement.resolvedStyle
    Focusable.Blur()
    Focusable.focusable
    Focusable.tabIndex
    Focusable.delegatesFocus
    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)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.AppUI.UI
    Assembly: Unity.AppUI.dll
    Syntax
    public class AvatarGroup : BaseVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement

    Constructors

    AvatarGroup()

    Defines the AvatarGroup constructor.

    Declaration
    public AvatarGroup()

    Fields

    spacingUssClassName

    The AvatarGroup spacing styling class.

    Declaration
    public const string spacingUssClassName = "appui-avatar-group--spacing-"
    Field Value
    Type Description
    string

    surplusUssClassName

    The AvatarGroup surplus styling class.

    Declaration
    public const string surplusUssClassName = "appui-avatar-group__surplus"
    Field Value
    Type Description
    string

    ussClassName

    The AvatarGroup main styling class.

    Declaration
    public const string ussClassName = "appui-avatar-group"
    Field Value
    Type Description
    string

    Properties

    bindItem

    Method used to bind an item to a child Avatar.

    Declaration
    public Action<Avatar, int> bindItem { get; set; }
    Property Value
    Type Description
    Action<Avatar, int>

    contentContainer

    The AvatarGroup content container.

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

    max

    The maximum number of avatars to display before the overflow.

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

    renderSurplus

    The custom render function for the surplus avatars.

    Declaration
    public AvatarGroup.RenderSurplusDelegate renderSurplus { get; set; }
    Property Value
    Type Description
    AvatarGroup.RenderSurplusDelegate

    size

    The size of avatars.

    Declaration
    public Size size { get; set; }
    Property Value
    Type Description
    Size

    sourceItems

    The collection of items that will be displayed as Radio component.

    Declaration
    public IList sourceItems { get; set; }
    Property Value
    Type Description
    IList

    spacing

    The spacing between avatars.

    Declaration
    public AvatarGroupSpacing spacing { get; set; }
    Property Value
    Type Description
    AvatarGroupSpacing

    total

    The AvatarGroup total count.

    Declaration
    public int total { get; }
    Property Value
    Type Description
    int

    variant

    The AvatarGroup variant.

    Declaration
    public AvatarVariant variant { get; set; }
    Property Value
    Type Description
    AvatarVariant

    Methods

    GetDefaultSurplusElement(int)

    The default surplus VisualElement.

    Declaration
    public static VisualElement GetDefaultSurplusElement(int surplus)
    Parameters
    Type Name Description
    int surplus

    The number of surplus avatars.

    Returns
    Type Description
    VisualElement

    The default surplus VisualElement.

    GetSpacingUssClassName(AvatarGroupSpacing)

    Declaration
    public static string GetSpacingUssClassName(AvatarGroupSpacing enumValue)
    Parameters
    Type Name Description
    AvatarGroupSpacing enumValue
    Returns
    Type Description
    string

    Refresh()

    Refresh the AvatarGroup.

    Declaration
    public void Refresh()

    SetCustomTotal(int?)

    Set a custom AvatarGroup total count instead of the child count.

    Declaration
    public void SetCustomTotal(int? customTotal)
    Parameters
    Type Name Description
    int? customTotal

    The custom total count.

    Remarks

    You can pass a null value to reset the custom total count and use the child count instead.

    Implements

    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement

    Extension Methods

    VisualElementExtensions.FindNavController(VisualElement)
    VisualElementExtensions.GetChildren<T>(VisualElement, bool)
    VisualElementExtensions.GetContextProvider<T>(VisualElement)
    VisualElementExtensions.GetContext<T>(VisualElement)
    VisualElementExtensions.GetPreferredTooltipPlacement(VisualElement)
    VisualElementExtensions.GetSelfContext<T>(VisualElement)
    VisualElementExtensions.GetTooltipTemplate(VisualElement)
    VisualElementExtensions.IsContextProvider<T>(VisualElement)
    VisualElementExtensions.ProvideContext<T>(VisualElement, T)
    VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)
    VisualElementExtensions.SetPreferredTooltipPlacement(VisualElement, OptionalEnum<PopoverPlacement>)
    VisualElementExtensions.SetTooltipTemplate(VisualElement, VisualElement)
    VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)