UICanvas

Inherits from UIView

Used by: ComboBox

Description

The canvas view is used to render UI components and controls things like draw sort order, scaling and render mode. In order for UIViews to be rendered and positioned correctly they must be put under a parent UICanvas or a subclass of (like UserInterface).

View Fields

NameTypeDescription
AlignmentElementAlignmentView alignment.
Used to align the view relative to the layout parent region it resides in.

Enum Values
NameDescription
CenterElement centered horizontally and vertically.
LeftElement aligned to the left horizontally and centered vertically.
TopElement aligned to the top vertically and centered horizontally.
RightElement aligned to the right horizontally and centered vertically.
BottomElement aligned to the bottom vertically and centered horizontally.
TopLeftElement aligned to the top vertically and to the left horizontally.
TopRightElement aligned to the top vertically and to the right horizontally.
BottomLeftElement aligned to the bottom vertically and to the left horizontally.
BottomRightAlement aligned to the bottom vertically and to the right horizontally.
AlphafloatAlpha value.
Can be used to adjust the alpha color of this view and all its children. E.g. used for fade in/out animations. Is separate from and different from the background color of the view as it affects the children as well.
BackgroundColor UICanvasBackground color of the view.
Background color of the view.
BackgroundImageSpriteAssetBackground image sprite.
The sprite that will be rendered.
BackgroundImageEventAlphaThreshold UICanvasAlpha threshold for letting through events.
The alpha threshold specifying the minimum alpha a pixel must have for the event to be passed through.
BackgroundImageFillAmount UICanvasBackground image fill amount.
Amount of the Image shown when the Image.type is set to Image.Type.Filled.
BackgroundImageFillCenter UICanvasIndicates if center should be filled.
Boolean indicating whether or not to render the center of a Tiled or Sliced image.
BackgroundImageFillClockwise UICanvasIndicates if the image should be filled clockwise.
Whether the Image should be filled clockwise (true) or counter-clockwise (false).
BackgroundImageFillMethod UICanvasBackground image fill method.
Indicates what type of fill method should be used.
BackgroundImageFillOrigin UICanvasBackground image fill origin.
Controls the origin point of the Fill process. Value means different things with each fill method.
BackgroundImageMaskable UICanvasIndicates if the image is maskable.
Indicates if the background image graphic is to be maskable.
BackgroundImageOverrideSpriteSpriteAssetBackground image override sprite.
Set an override sprite to be used for rendering. If set the override sprite is used instead of the regular image sprite.
BackgroundImagePreserveAspect UICanvasPreserve aspect ratio.
Indicates whether this image should preserve its Sprite aspect ratio.
BackgroundImageType UICanvasType of background image.
The type of the image sprite that is to be rendered.
BackgroundMaterial UICanvasBackground image material.
Background image material.
BaseDirectorystringBase directory.
Specifies the base directory to be used by the view and its children. The base directory is used when loading resources such as sprites, fonts, etc.
BasedOnstringBased on style.
Used in style definition to specify which style it's based on.
BlockingObjects BlockingObjects Blocking objects.
Indicates the types of objects that should block the raycasts.

Enum Values
NameDescription
None
TwoD
ThreeD
All
DynamicPixelsPerUnit floatDynamic pixels per unit.
Pixels per unit to use for dynamically generated bitmaps such as text.
HeightElementSizeThe height of the view.
Specifies the height of the view either in pixels or percents.
HideFlags HideFlags Hide flags for the game object.
Bit mask that controls object destruction, saving and visibility in editor.

Enum Values
NameDescription
None
HideInHierarchy
HideInInspector
DontSaveInEditor
NotEditable
DontSaveInBuild
DontUnloadUnusedAsset
DontSave
HideAndDontSave
IdstringThe ID of the view.
Specifies a unique ID for the view. Used to map the view to reference fields on the parent view model. Provides a way to reference the view in data bindings. Is used as selectors in styles.
IgnoreReversedGraphics boolIndicates if reversed graphics should be ignored.
Tells the graphic raycaster to ignore graphical components facing away from the camera.
IsActiveboolIndicates if the view is enabled.
Activates/deactivates the view. If set to false in this or in any parent view, all components are disabled, attached renderers are turned off, etc. Any components attached will no longer have Update() called.
IsDestroyedboolIndicates if the view has been destroyed by GameObject.Destroy().
IsDynamicboolIndicates if the view has been created dynamically.
IsInitializedboolGets or sets bool indicating if the view has been initialized.
IsTemplateboolIndicates if this view is to be used as a template.
A template view is used to create dynamic instances of the view. Used by certain views such as the List and TabPanel.
IsVisibleboolIndicate if the view is visible.
Can be used to adjust the visiblity of the view. If set to false the view is made invisible but unlike when deactivating the view, invisible views are still is active and takes up space.
ItemobjectItem data.
Provides a mechanism to bind to dynamic list data. The item is set, e.g. by the List view on the child views it generates for its dynamic list data. The Item points to the list item data the view is associated with.
LayoutRootUserInterfaceGets layout root canvas.
MarginElementMarginView margin
Determines the size of the content region relative the view's width and height. Adding margins to a view does not change its width or height.
MatchWidthOrHeight floatMatch width or height or in between.
Scale the canvas area with the width as reference (0), the height as reference (1), or something in between (e.g. 0.75).
OffsetElementMarginView offset.
Determines the offset of the content region relative to the view's position.
OffsetFromParentElementMarginView offset from parent.
Used by parent views to adjust the positioning of its children without affecting the internal offset of the children.
OrderInLayer UICanvasCanvas sorting order.
Canvas draw order within a sorting layer.
OverrideHeightElementSizeOverride height.
Used to override the layouting logic of inherited views and set the specified height.
OverridePixelPerfect boolOverride pixel perfect.
Boolean indicating if the pixel perfect setting should be overriden (not inherited from parent canvas).
OverrideSorting boolOverride canvas sort order.
Boolean indicating if the sort order should be overriden (not inherited from parent canvas).
OverrideWidthElementSizeOverride width.
Used to override the layouting logic of inherited views and set the specified width.
Pivot Vector2 View pivot position.
The normalized position that the view rect transform rotates around.
PixelPerfect boolIndicates if rendering should be pixel perfect.
Indicates if the canvas is to be aligned with pixels. Only applied if render mode is set to ScreenSpace.
PlaneDistance floatCanvas distance from camera.
The plane distance determines how far away from the camera the canvas is generated.
Position Vector3 Position of the view.
The local position of the view in relation to the layout parent view transform.
PropagateChildLayoutChangesboolIndicates if the view propagates child layout changes.
Boolean indicating if view propagates child layout changes. Generally set to true whenever a view adjusts its size to child layout changes.
RaycastBlockModeRaycastBlockModeIndicates when raycast should be blocked.
Enum indicating when raycasts should be blocked by the view.

Enum Values
NameDescription
DefaultRaycast is blocked if view is displayed and not transparent.
AlwaysRaycast is always blocked.
NeverRaycast is never blocked.
ReferencePixelsPerUnit floatReference pixels per unit.
If a sprite has 'Pixels Per Unit' setting, one pixel in the sprite will cover one unit in the UI.
ReferenceResolution Vector2 Reference resolution.
The resolution the UI layout is designed for. If the screen resolution is larger, the UI will be scaled up, and if it’s smaller, the UI will be scaled down.
RenderCamera Camera Render camera.
Camera used for sizing the canvas when in render mode set to: Screen Space - Camera. Also used as camera that events will be sent through in world space.
RenderMode RenderMode Canvas render mode.
Specifies the render mode to be used by the canvas.

Enum Values
NameDescription
ScreenSpaceOverlay
ScreenSpaceCamera
WorldSpace
Rotation Quaternion Rotation of the view.
The local rotation of the view in relation to the layout parent view transform. Stored as a Quaternion but specified in XUML as euler angles.
Scale Vector3 Scale of the view.
The scale of the view in relation to the layout parent view transform.
ScaleFactor floatScale factor.
Scales all children within the canvas by this factor.
SortIndexintView sort index.
The sort index is used by views such as Group and List to sort its child views.
SortingLayerId intUnique ID of the canvas sorting layer.
Unique ID of the canvas sorting layer.
SortingLayerName stringName of the canvas sorting layer.
Name of the canvas sorting layer.
SortingOrder intCanvas sorting order.
Canvas draw order within a sorting layer.
StatestringView state.
View state name. Determines state values to be applied to the view. All views start out in the "Default" state and when the state changes the values associated with that state are applied to the view.
StylestringThe style of the view.
Used as selector by the styles. Specifies the name of the style that is to be applied to the view and any children that explicitly inherits its style. The style is applied when the view is created (usually in the editor as the XUML is processed).
ThemestringThe theme of the view.
Specifies the name of the theme that is applied to the view and its children. The theme determines which set of styles are to be considered when applying matching styles to the view.
UIScaleMode ScaleMode UI scale mode.
Determines how the children within the canvas are scaled.

Enum Values
NameDescription
ConstantPixelSize
ScaleWithScreenSize
ConstantPhysicalSize
UnitSizeVector3 Unit size.
Specifies the user-defined unit size to be used by the view and its children. Used when element size is specified in user-defined units to convert it into pixels.
UpdateBackgroundboolIndicates if background is updated.
If set to false the background image and color is not updated by the view. Is used when the background updates is done elsewhere.
UpdateRectTransformboolIndicates if rect transform is updated.
If set to false the rect transform is not updated by the layout logic. It is used when layouting is done elsewhere.
WidthElementSizeThe width of the view.
Specifies the width of the view either in pixels or percents.

View Actions

NameAction DataDescription
CancelnoneCancel view action.
Triggered by the EventSystem when a cancel event occurs.
DeselectnoneDeselect view action.
Triggered by the EventSystem when another view is selected.
DropnoneDrop view action.
Triggered by the EventSystem when the view accepts a drop.
MovenoneMove view action.
Triggered by the EventSystem when a move event occurs.
ClicknoneClick view action.
Triggered by the EventSystem when the user clicks/touches on the view.
BeginDragnoneDrag view action.
Triggered by the EventSystem when the user presses mouse on and starts to drag over the view.
EndDragnoneEnd drag view action.
Triggered by the EventSystem when the user stops dragging mouse over the view.
DragnoneDrag view action.
Triggered by the EventSystem as the user drags the mouse over the view.
InitializePotentialDragnoneInitialize potential drag view action.
Triggered by the EventSystem as the user initiates a potential drag over the view.
MouseDownnoneMouse down view action.
Triggered by the EventSystem when the mouse/touch presses down over the view.
MouseEnternoneMouse enter view action.
Triggered by the EventSystem when the mouse enters the view.
MouseExitnoneMouse exit view action.
Triggered by the EventSystem when the mouse exits the view.
MouseUpnoneMouse up view action.
Triggered by the EventSystem when the mouse/thouch releases over the view.
ScrollnoneScroll view action.
Triggered by the EventSystem when the user scrolls when the view is selected.
SelectnoneSelect view action.
Triggered by the EventSystem when the view is selected.
SubmitnoneSubmit view action.
Triggered by the EventSystem when the user submits while view is selected.
UpdateSelectednoneUpdate selected view action.
Triggered by the EventSystem when the object associated with this EventTrigger is updated.
ActivatednoneActivated view action.
Triggered every time the view is activated. Also triggered once the view is intialized if it starts out activated.
DeactivatednoneDeactivated view action.
Triggered every time the view is deactivated. Also triggered once the view is intialized if it starts out deactivated.





















Join the Announcement List

Be notified when new themes, views, tutorials and updates are available