Editor API
Return to top
ImageInfo
Edit

UI / ImageInfo

ImageInfo Class ​

Image information

Table of contents ​

Accessors ​

assetICON(): AssetIconData other
Retrieve icon data for ImageInfo
color(): Readonly<LinearColor> other
Retrieve the color of ImageInfo
drawType(): SlateBrushDrawType other
Get the drawing type of ImageInfo
id(): string other
Get the ID of ImageInfo
margin(): Readonly<Margin> other
Obtain the margin of ImageInfo
size(): Readonly<Vector2> other
Retrieve the size of ImageInfo

Methods ​

asyncSetByID(id: string, bUseSRGB?: boolean): Promise<boolean> other
Set image information through ID
setByAssetIcon(assetId: string, size: AssetIconSize, bUseSRGB?: boolean): Promise<boolean> other
Set the icon with the specified ID and resolution

Accessors ​

assetICON ​

• get assetICON(): AssetIconData other

Retrieve icon data for ImageInfo

Returns ​

AssetIconDataIcon Data Structure

color ​

• get color(): Readonly<LinearColor> other

• set color(value): void other

Retrieve the color of ImageInfo

Returns ​

Readonly<LinearColor>Return Type LinearColor color value

Set the color of ImageInfo

Parameters ​

value Readonly<LinearColor>MW. LinearColor color value

drawType ​

• get drawType(): SlateBrushDrawType other

• set drawType(value): void other

Get the drawing type of ImageInfo

Returns ​

SlateBrushDrawTypeDrawing type

Set the drawing type of ImageInfo

Parameters ​

value SlateBrushDrawTypeDrawing type

id ​

• get id(): string other

Get the ID of ImageInfo

Returns ​

stringID of ImageInfo

margin ​

• get margin(): Readonly<Margin> other

• set margin(value): void other

Obtain the margin of ImageInfo

Returns ​

Readonly<Margin>margin

Set the margin for ImageInfo

Parameters ​

value Readonly<Margin>Designated margin

size ​

• get size(): Readonly<Vector2> other

• set size(value): void other

Retrieve the size of ImageInfo

Returns ​

Readonly<Vector2>Size of ImageInfo

Set the size of ImageInfo

Parameters ​

value Readonly<Vector2>The specified size

Methods ​

asyncSetByID ​

• asyncSetByID(id, bUseSRGB?): Promise<boolean> other

Set image information through ID

Parameters ​

id stringImage ID
range: depends on the length of the ID
bUseSRGB? booleanWhether to use SRGB mode for texture

Returns ​

Promise<boolean>Is the setting successful

setByAssetIcon ​

• setByAssetIcon(assetId, size, bUseSRGB?): Promise<boolean> other

Set the icon with the specified ID and resolution

Parameters ​

assetId stringThe asset id of the incoming icon
size AssetIconSizeEnumeration of resolution of incoming icon
bUseSRGB? booleanWhether to use SRGB or not

Returns ​

Promise<boolean>