Class Canvas

A Canvas is a VisualElement that can be used to group other VisualElements. You can use it to create a scrollable area inside a window.

Inheritance
Object
CallbackEventHandler
Focusable
VisualElement
Canvas
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 Canvas : VisualElement, IEventHandler, IStylePropertyAnimations, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle

Constructors

Canvas()

Instantiates a Canvas element.

Declaration
public Canvas()

Fields

backgroundUssClassName

USS class name of the background element of this type.

Declaration
public static readonly string backgroundUssClassName
Field Value
Type Description
String

horizontalScrollerUssClassName

USS class name of the horizontal scroller element of this type.

Declaration
public static readonly string horizontalScrollerUssClassName
Field Value
Type Description
String

ussClassName

USS class name of elements of this type.

Declaration
public const string ussClassName = "appui-canvas"
Field Value
Type Description
String

verticalScrollerUssClassName

USS class name of the vertical scroller element of this type.

Declaration
public static readonly string verticalScrollerUssClassName
Field Value
Type Description
String

viewportContainerUssClassName

USS class name of the viewport container element of this type.

Declaration
public static readonly string viewportContainerUssClassName
Field Value
Type Description
String

viewportUssClassName

USS class name of the viewport element of this type.

Declaration
public static readonly string viewportUssClassName
Field Value
Type Description
String

Properties

contentContainer

The content container of the Canvas.

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

controlScheme

The current control scheme of the canvas.

Declaration
public CanvasControlScheme controlScheme { get; set; }
Property Value
Type Description
CanvasControlScheme

frameContainer

The container used for framing the Canvas.

Declaration
public Rect frameContainer { get; set; }
Property Value
Type Description
Rect
Remarks

The container rect value must be defined in the Canvas' local coordinates.

frameMargin

The margin applied when framing the Canvas.

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

grabMode

The current grab state of the canvas (to pan).

Declaration
public GrabMode grabMode { get; }
Property Value
Type Description
GrabMode

maxZoom

The maximum zoom factor of the Canvas.

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

minZoom

The minimum zoom factor of the Canvas.

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

panMultiplier

The pan multiplier when Shift key is hold.

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

scrollDirection

The scroll direction of the Canvas. See ScrollDirection for more information.

Declaration
public ScrollDirection scrollDirection { get; set; }
Property Value
Type Description
ScrollDirection

scrollOffset

The scroll coordinates of the Canvas.

Declaration
public Vector2 scrollOffset { get; set; }
Property Value
Type Description
Vector2

scrollSpeed

The scroll speed of the Canvas.

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

zoom

The zoom factor of the Canvas.

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

zoomMultiplier

The zoom speed multiplier when Shift key is hold.

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

zoomSpeed

The zoom speed of the Canvas.

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

Methods

FrameAll()

Frame the Canvas to see all elements.

Declaration
public void FrameAll()

FrameArea(Rect)

Frame the Canvas to the given area. The area is in the Viewport's local coordinates.

Declaration
public void FrameArea(Rect viewportArea)
Parameters
Type Name Description
Rect viewportArea

The area to frame.

FrameElement(VisualElement)

Frame the Canvas to the given element. The element is in the Viewport's local coordinates.

Declaration
public void FrameElement(VisualElement element)
Parameters
Type Name Description
VisualElement element

The element to frame.

FrameWorldRect(Rect)

Frame the Canvas to the given world area. The area is in world coordinates.

Declaration
public void FrameWorldRect(Rect worldRect)
Parameters
Type Name Description
Rect worldRect

The area to frame.

Extension Methods