Image

Based on UIView

Description

View that displays an image sprite. Based on the UGUI ImageComponent. Adjusts its size and image type (spliced, etc) to the native sprite if not explicitly set.

Dependency Properties

Name	Type	Description
Alignment	ElementAlignment	Used to align the view relative to the layout parent region it resides in.
Alpha	float	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.
AlphaHitTestMinimumThreshold	float	Alpha values less than the threshold will cause raycast events to pass through the view.
BubbleNotifyChildLayoutChanged	bool	Boolean indicating if parent always should be notified when the child changes layout.
Color	Color	Color of the image. Color values can be specified by name (Red, Blue, Coral, etc), hexcode (#aarrggbb or #rrggbb) or rgb/rgba value (“1.0,0.0,0.5” or “1,1,1,0.5”).
DisableLayoutUpdate	bool	Boolean indicating if automatic layout updates for this view should be disabled. When disabled the view doesn’t call UpdateLayout() when properties such as Width, Height, etc. changes.
EnableScriptEvents	bool	Boolean indicating if unity script events (Update, LateUpdate, Awake, etc) should be relayed to the view code-behind through the corresponding methods that can be overriden.
FillAmount	float	Amount of the view shown when Type is set to Filled.
FillCenter	bool	Boolean indicating if the center of a Tiled or Sliced sprite should be rendered.
FillClockwise	bool	Boolean indicating if the sprite should be filled clockwise or counter-clockwise.
FillMethod	FillMethod	Enum indicating the background fill method.
FillOrigin	int	Point of origin of the Fill process. Value means different things with each fill method.
GameObject	GameObject	GameObject in the hierarchy that corresponds to the view.
Height	ElementSize	The height of the view in pixels or percents.
IgnoreFlip	bool	Used when doing localization override default behavior of flipping the view Right to Left or Left to Rigth.
IgnoreObject	bool	Boolean indicating if the view should be ignored. Ignored objects don’t run any load logic and don’t respond to property changed events.
IsActive	bool	Boolean indicating if the view is active. Deactivated views deactivates corresponding game object, components, renderers and scripts.
IsMaskingGraphic	bool	Boolean indicating if image is a masking graphic.
IsVisible	bool	Boolean indicating if view is visible or hidden. Invisible views still take up space but aren’t interactable and have their alpha set to 0.
LoadMode	LoadMode	Enum flags indicating when and how the view should be loaded by the framework. Can be changed when e.g. the view is to be loaded on-demand.
Margin	ElementMargin	Adding margins to a view changes the size of the area in which its content resides, but it does not change the width or height of the view.
Maskable	bool	Boolean indicating if the graphic allows masking.
Material	Material	Material used by the sprite.
Offset	ElementMargin	Determines the offset of the view.
OffsetFromParent	ElementMargin	Offset set by a parent view. Used by views like Group to arrange children without changing their own Offset values.
OnCullStateChanged	CullStateChangedEvent	Callback called when the culling state of this graphic either becomes culled or visible.
OverrideHeight	ElementSize	Overrides regular Height value. Used to e.g. automatically size items without changing the default Height value set.
OverrideSprite	Sprite	Overrides the default sprite used by this view.
OverrideWidth	ElementSize	Overrides regular Width value. Used to e.g. automatically size items without changing the default Width value set.
Pivot	Vector2	The pivot point of the view.
PixelsPerUnitMultiplier	float	Pixel per unit modifier to change how sliced sprites are generated.
Position	Vector3	Directly sets the local position of the view relative to parent. Position otherwise set using the Alignment and Offset properties.
PreserveAspect	bool	Boolean indicating if this sprite should preserve its aspect ratio.
RaycastBlockMode	RaycastBlockMode	Enum indicating if raycasts should be blocked.
RaycastTarget	bool	Boolean indicating if the graphic should be considered a target for raycasting.
Rotation	Quaternion	Rotation of the view.
Scale	Vector3	Scale of the view.
Sprite	Sprite	The sprite of the view. The value is the name of the sprite asset file without extension, e.g. “mysprite”.
Type	Type	Enum indicating what type of sprite the background is.
UseFastShader	bool	Boolean indicating if the default UI shader should be replaced by a simpler and faster one. The faster shader does not support masking and clipping.
UseSpriteMesh	bool	Boolean indicating if the view should use mesh generated by TextureImporter or a simple quad mesh.
Width	ElementSize	The width of the view in pixels or percents.