Class ColorSwatch

A color swatch is a visual element that displays a color or a gradient.

Inheritance
Object
CallbackEventHandler
Focusable
VisualElement
ColorSwatch
Inherited Members
UnityEngine.UIElements.VisualElement.ExecuteDefaultAction(UnityEngine.UIElements.EventBase)
UnityEngine.UIElements.VisualElement.Focus()
UnityEngine.UIElements.VisualElement.SetEnabledFromHierarchy(System.Boolean)
UnityEngine.UIElements.VisualElement.Overlaps(UnityEngine.Rect)
UnityEngine.UIElements.VisualElement.DoMeasure(System.Single, UnityEngine.UIElements.VisualElement.MeasureMode, System.Single, UnityEngine.UIElements.VisualElement.MeasureMode)
UnityEngine.UIElements.VisualElement.ToString()
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Single, System.Single, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, System.Single>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Rect, UnityEngine.Rect, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Rect>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Color, UnityEngine.Color, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Color>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Vector3, UnityEngine.Vector3, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector3>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Vector2, UnityEngine.Vector2, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector2>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.Quaternion, UnityEngine.Quaternion, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Quaternion>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.UIElements.Experimental.StyleValues, UnityEngine.UIElements.Experimental.StyleValues, System.Int32)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, System.Single>, System.Single, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, System.Single>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Rect>, UnityEngine.Rect, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Rect>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Color>, UnityEngine.Color, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Color>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Vector3>, UnityEngine.Vector3, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector3>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Vector2>, UnityEngine.Vector2, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Vector2>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(System.Func<UnityEngine.UIElements.VisualElement, UnityEngine.Quaternion>, UnityEngine.Quaternion, System.Int32, System.Action<UnityEngine.UIElements.VisualElement, UnityEngine.Quaternion>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Start(UnityEngine.UIElements.Experimental.StyleValues, System.Int32)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Layout(UnityEngine.Rect, System.Int32)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.TopLeft(UnityEngine.Vector2, System.Int32)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Size(UnityEngine.Vector2, System.Int32)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Scale(System.Single, System.Int32)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Position(UnityEngine.Vector3, System.Int32)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.Experimental.ITransitionAnimations.Rotation(UnityEngine.Quaternion, System.Int32)
UnityEngine.UIElements.VisualElement.Sort(System.Comparison<UnityEngine.UIElements.VisualElement>)
UnityEngine.UIElements.VisualElement.GetFirstOfType<T>()
UnityEngine.UIElements.VisualElement.GetFirstAncestorOfType<T>()
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IVisualElementScheduler.Execute(System.Action<UnityEngine.UIElements.TimerState>)
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IVisualElementScheduler.Execute(System.Action)
UnityEngine.UIElements.VisualElement.canGrabFocus
UnityEngine.UIElements.VisualElement.focusController
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.position
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.rotation
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.scale
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.ITransform.matrix
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IExperimentalFeatures.animation
UnityEngine.UIElements.VisualElement.cacheAsBitmap
UnityEngine.UIElements.VisualElement.Item[System.Int32]
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.alignContent
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.alignItems
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.alignSelf
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.backgroundColor
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.backgroundImage
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomColor
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomLeftRadius
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomRightRadius
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderBottomWidth
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderLeftColor
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderLeftWidth
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderRightColor
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderRightWidth
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopColor
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopLeftRadius
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopRightRadius
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.borderTopWidth
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.bottom
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.color
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.display
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexBasis
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexDirection
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexGrow
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexShrink
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.flexWrap
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.fontSize
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.height
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.justifyContent
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.left
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.letterSpacing
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginBottom
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginLeft
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginRight
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.marginTop
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.maxHeight
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.maxWidth
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.minHeight
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.minWidth
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.opacity
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingBottom
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingLeft
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingRight
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.paddingTop
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.position
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.right
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.rotate
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.scale
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.textOverflow
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.top
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transformOrigin
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionDelay
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionDuration
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionProperty
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.transitionTimingFunction
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.translate
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityBackgroundImageTintColor
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityBackgroundScaleMode
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityFont
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityFontDefinition
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityFontStyleAndWeight
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityParagraphSpacing
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceBottom
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceLeft
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceRight
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unitySliceTop
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextAlign
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextOutlineColor
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextOutlineWidth
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.unityTextOverflowPosition
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.visibility
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.whiteSpace
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.width
UnityEngine.UIElements.VisualElement.UnityEngine.UIElements.IResolvedStyle.wordSpacing
UnityEngine.UIElements.CallbackEventHandler.RegisterCallback<TEventType>(UnityEngine.UIElements.EventCallback<TEventType>, UnityEngine.UIElements.TrickleDown)
UnityEngine.UIElements.CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(UnityEngine.UIElements.EventCallback<TEventType, TUserArgsType>, TUserArgsType, UnityEngine.UIElements.TrickleDown)
UnityEngine.UIElements.CallbackEventHandler.UnregisterCallback<TEventType>(UnityEngine.UIElements.EventCallback<TEventType>, UnityEngine.UIElements.TrickleDown)
UnityEngine.UIElements.CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(UnityEngine.UIElements.EventCallback<TEventType, TUserArgsType>, UnityEngine.UIElements.TrickleDown)
Namespace: Unity.AppUI.UI
Syntax
public class ColorSwatch : VisualElement, IEventHandler, IStylePropertyAnimations, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, INotifyValueChanged<List<ColorEntry>>, ISizeableElement

Constructors

ColorSwatch()

Default Constructor.

Declaration
public ColorSwatch()

Fields

imageUssClassName

The ColorSwatch image styling class.

Declaration
public static readonly string imageUssClassName
Field Value
Type Description
String

roundUssClassName

The ColorSwatch round styling class.

Declaration
public static readonly string roundUssClassName
Field Value
Type Description
String

sizeUssClassName

The ColorSwatch size styling class.

Declaration
public static readonly string sizeUssClassName
Field Value
Type Description
String

ussClassName

The ColorSwatch main styling class.

Declaration
public static readonly string ussClassName
Field Value
Type Description
String

Properties

color

The single color of the ColorSwatch. Setting this property will overwrite the current color entry list to contain only the given single color value. The property's getter always return the first item of the color entry list.

Declaration
public Color color { get; set; }
Property Value
Type Description
Color

round

Round variant of the ColorSwatch.

Declaration
public bool round { get; set; }
Property Value
Type Description
Boolean

size

The size of the ColorSwatch element.

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

value

The color entry list.

Declaration
public List<ColorEntry> value { get; set; }
Property Value
Type Description
List<ColorEntry>
Implements
UnityEngine.UIElements.INotifyValueChanged<T>.value

Methods

AddColor(Color, Single)

Add a color entry in the current swatch. This methods is useful to create gradients dynamically.

Declaration
public int AddColor(Color newColor, float position)
Parameters
Type Name Description
Color newColor

The color to add.
Single position

At which position the given color should be added. The expected value must be normalized.
Returns
Type Description
Int32

The index of the added color entry in the list.

Refresh()

Force the refresh of the visual element.

Declaration
public void Refresh()

RemoveColor(Int32)

Remove a color entry from the current list.

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

The index of the color entry to remove.

SetValueWithoutNotify(List<ColorEntry>)

Set the color entry list value, without being notified of any changes.

Declaration
public void SetValueWithoutNotify(List<ColorEntry> newValue)
Parameters
Type Name Description
List<ColorEntry> newValue

The new color entry list.
Implements
UnityEngine.UIElements.INotifyValueChanged<T>.SetValueWithoutNotify(T)

Extension Methods