ImageLabel¶
A 2D user interface element that displays a single non-interactive image.
Description¶
An ImageLabel renders a rectangle, like a Frame does, with an
image asset. The display of the image can be manipulated through the
ImageColor3 and
ImageTransparency properties. To display
only the image and hide the rectangle, set
GuiObject.BackgroundTransparency to 1.
Advanced ImageLabel usage includes:
-
Tiled images can be created by setting ScaleType to ScaleType.Tile, then TileSize to the size of rendered tiles.
-
9-slice images can be created by setting ScaleType to ScaleType.Slice, then SliceCenter to the center area of the 9‑slice image.
-
Sprite sheets can be implemented through the use of ImageRectOffset and ImageRectSize. Packing multiple images into one and using this property can make your experience's image assets load much quicker, especially if you use many small icons in your GUIs.
Inheritance¶
Object → Instance → GuiBase → GuiBase2d → GuiObject → GuiLabel → ImageLabel
Nova inheritance: Instance → GuiBase → GuiBase2d → GuiObject → GuiLabel → ImageLabel
Properties¶
Image Supported Property The image content displayed by the UI element. Reads and writes to ImageContent.
The image content displayed by the UI element. Reads and writes to ImageContent.
This property is a content-type property that should hold the asset ID of a decal or image uploaded to Roblox. It functions identically to Decal.Texture with regards to loading the image from Roblox. The rendered image can be modified using ImageColor3 and ImageTransparency.
ImageColor3 Supported Property Determines how a rendered image will be colorized.
Determines how a rendered image will be colorized.
This property determines how an image is colorized. When set to white, no colorization occurs. This property is very useful for reusing image assets; if the source image is completely white with transparency, you can set the entire color of the image at once with this property.
ImageRectOffset Supported Property The offset in pixels of the sub-area of an image to be displayed.
The offset in pixels of the sub-area of an image to be displayed.
Allows the partial display of an image in conjunction with ImageRectSize. This property determines the pixel offset (from the top-left) of the image area to be displayed.
ImageRectSize Supported Property Determines the size in pixels of the sub-area of an image to be displayed.
Determines the size in pixels of the sub-area of an image to be displayed.
Allows the partial display of an image in conjunction with
ImageRectOffset. This property
determines the pixel size of the image area to be displayed. If either
dimension is set to 0, the entire image is displayed instead.
ImageTransparency Supported Property Determines the transparency of the rendered image.
Determines the transparency of the rendered image.
This property determines the alpha of a UI element's rendered image. A
value of 0 is completely opaque and a value of 1 is completely
transparent (invisible).
ResampleMode Supported Property Selects the image resampling mode for the label.
Selects the image resampling mode for the label.
Determines how the image looks when it is scaled. By default, the image smooths out texturing when displayed on the screen larger or smaller than its size in texture memory. When set to Enum.ResamplerMode.Pixelated, the image preserves the sharp edges of pixels.
ScaleType Supported Property Determines how an image will scale if displayed in a UI element whose size differs from the source image.
Determines how an image will scale if displayed in a UI element whose size differs from the source image.
This property determines in what way an ImageLabel.Image is rendered when the UI element's absolute size differs from the source image's size.
By default, this property is ScaleType.Stretch which will simply stretch/compact the image dimensions so it fits the UI element's space exactly. Since transparent pixels are set to black when uploading to Roblox, transparent images should apply alpha blending to avoid a blackish outline around scaled images.
For ScaleType.Slice, the SliceCenter property will be revealed in the Properties window. This is for nine-slice UI: when scaling up, the corners will remain the source image size. The edges of the image will stretch to the width/height of the image. Finally, the center of the image will stretch to fill the center area of the image.
Finally, for ScaleType.Tile, the TileSize property will be revealed in the Properties window. This is for tiled images, where the size of each image tile is determined by the TileSize property.
SliceCenter Supported Property Sets the slice boundaries of a 9-sliced image.
Sets the slice boundaries of a 9-sliced image.
This property sets the slice boundaries of a 9-sliced image when ScaleType is set to Enum.ScaleType.Slice. Please note that this property is only visible in the Properties window under this condition.
To learn more about 9-slice images, see UI 9 Slice Design.
SliceScale Supported Property Scales the 9-slice edges by the specified ratio.
Scales the 9-slice edges by the specified ratio. This means that the edges
around the 9-slice will grow as if you'd uploaded a new version of the
texture upscaled. Defaults to 1.0.
See also ScaleType, SliceCenter, and SliceScale.
TileSize Supported Property Sets the tiling size of the ImageLabel.
Sets the tiling size of the ImageLabel.
This property sets the tiling size of the ImageLabel with a
default of
Datatype.UDim2.new(1, 0, 1, 0)
Inherited members¶
Inherited from GuiLabel: 45 properties, 39 methods, 25 events. They are documented on the base class page.
4 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's ImageLabel class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Properties¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
ImageContent |
ImageContent: Content |
Not yet | The image content displayed by the UI element. Supports asset URIs and EditableImage obj… | — |
IsLoaded |
IsLoaded: bool |
Not yet | Indicates whether the image has finished loading from Roblox. | ReadOnly, NotReplicated |
LocalizedImageContent |
LocalizedImageContent: Content |
Not yet | — | ReadOnly, NotReplicated, RobloxScriptSecurity |
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
SetEnableContentImageSizeChangedEvents |
ImageLabel:SetEnableContentImageSizeChangedEvents(enabled: bool): null |
Not yet | — | RobloxScriptSecurity |
Roblox reference: ImageLabel
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.