Kreator

# colorFormat 颜色处理方法

# Api域：

const colorFormat = kreator.utils.colorFormat:

# colorFormat.getHex(r, g , b)

将rgb格式的颜色转换为16进制颜色值。r，g，b分别为红、绿、蓝三色的色值。
类似getHex(255,255,255)将返回#FFFFFF。

属性 类型 默认值 必填 说明
r number '' 是 红色色值
g number '' 是 绿色色值
b number '' 是 蓝色色值

# 返回值

string 16位颜色色值字符串

# colorFormat.getHexWithSingle(rgb: string)

将rgb格式的颜色转换为16进制颜色值。与getHex不同的是，该方法只需传入一个参数即字符串rgb(r, g, b)。
类似getHexWithSingle('rgb(255, 255, 255)')将返回#FFFFFF。

属性 类型 默认值 必填 说明
rgb string '' 是 rgb格式色值

# 返回值

string 16位颜色色值字符串

# colorFormat.getRgb(hex)

将16进制颜色值转换为rgb格式的颜色。

属性 类型 默认值 必填 说明
hex string '' 是 16位颜色色值

# 返回值

string rgb格式色值

# colorFormat.getRgba(hex:string,alpha:number)

将16进制颜色值转换为rgba格式的颜色值，同时可指定透明度。
alpha为0-1之间的一个小数，为透明度的值。
当你需要为一个动态获取的颜色增加一定透明度时，这个方法非常适用。

属性 类型 默认值 必填 说明
hex string '' 是 16位颜色色值
alpha number 1 否 透明度

# 返回值

string rgba格式色值

# colorFormat.getRgbaFromRgb(rgb: string, alpha: number)

将rgb颜色值转换为rgba格式的颜色值，同时可指定透明度。
alpha为0-1之间的一个小数，为透明度的值。
相比于getRgba，该方法适用于在只有rgb色值的情况下增添透明度的场景。

属性 类型 默认值 必填 说明
rgb string '' 是 Rgb颜色色值
alpha number 1 否 透明度

# 返回值

string rgba格式色值

# colorFormat.getTheme()

返回当前客户端的主题色对象。此处色值为rgb格式。

# 返回值

ThemeResponse 主题色对象

字段名称 类型 描述
mainColor string D1色值
secondColor string D2色值
iconColor string D3色值
graColor string D4渐变色的结束色值
graStartColor string D4渐变色的起始色值

# colorFormat.getImageFirstColor(src: string, position: string)

获取某图片的指定方位的颜色。

属性 类型 默认值 必填 说明
src string '' 是 图片链接
position string lt 否 图片方位

position存在4种枚举：

lt 左上角
rt 右上角 rb 右下角 lb 左下角

该方法的含义是，获取指定方位的第一个像素点的色值。例如传入lt时，返回的是图片左上角第一个像素点的色值。

# 返回值

Promise 16进制色值

← numberFormat 数字处理方法 →