y5 API: Класс y5.Color

Класс для работы с цветом: равенство, разность, контраст, изменения цвета в пространстве HSL, RGB <-> HSL
См: http://www.wat-c.org/tools/CCA/1.1/#aert.

Требует загрузки модуля Color.

new

new y5.Color(color)

Имя аргумента	Тип	Описание
color	String	цвет в формате RGB (http://www.w3.org/TR/CSS21/syndata.html#value-def-color)

Пример:

new y5.Color().setRGB(51,51,255).alterLightness(20).getRGB();
// -> rgb(153,153,255)

alterBlue

y5.Color.alterBlue(diff) -> y5.Color

Изменяет значение синего канала.

Имя аргумента	Тип	Описание
diff	Number	величина, на которую надо изменить параметр

alterGreen

y5.Color.alterGreen(green) -> y5.Color

Изменяет значение зеленого канала.

Имя аргумента	Тип	Описание
green	Number	величина, на которую надо изменить параметр

alterHSL

y5.Color.alterHSL(huse, saturation, lightness) -> y5.Color

Изменяет значения цветов HSL.

Имя аргумента	Тип	Описание
huse	Number	величина, на которую надо изменить параметр
saturation	Number	величина, на которую надо изменить параметр
lightness	Number	величина, на которую надо изменить параметр

Пример:

new y5.Color('rgb(51,51,255)').alterHSL(0,0,20).getRGB();
// -> rgb(153,153,255)

alterHue

y5.Color.alterHue(diff) -> y5.Color

Изменяет значение тона.

Имя аргумента	Тип	Описание
diff	Number	величина, на которую надо изменить параметр

Пример:

new y5.Color('#7f7f00').alterHue(200).getHSL();
// -> hsl(260,100,25)

alterLightness

y5.Color.alterLightness(diff) -> y5.Color

Изменяет значение яркости.

Имя аргумента	Тип	Описание
diff	Number	величина, на которую надо изменить параметр

alterRGB

y5.Color.alterRGB(red, blue, green) -> y5.Color

Изменяет значение каждого канала RGB.

Имя аргумента	Тип	Описание
red	Number	величина, на которую надо изменить параметр
blue	Number	величина, на которую надо изменить параметр
green	Number	величина, на которую надо изменить параметр

Пример:

new y5.Color().setRGB(255,255,0).alterRGB(-55,-55,10).getRGB();
// -> rgb(200,200,10)

alterRed

y5.Color.alterRed(diff) -> y5.Color

Изменяет значение красного канала.

Имя аргумента	Тип	Описание
diff	Number	величина, на которую надо изменить параметр

alterSaturation

y5.Color.alterSaturation(diff) -> y5.Color

Изменяет значение насыщенности.

Имя аргумента	Тип	Описание
diff	Number	величина, на которую надо изменить параметр

brightness

brightness() -> Number — значение яркости

Возвращает значение яркости цвета.

Пример:

new y5.Color('#000').brightness();
// -> 0
new y5.Color('#fff').brightness();
// -> 255
new y5.Color('#7f7f7f').brightness();
// -> 127

brightnessDiff

brightnessDiff(color) -> Number — разность яркости цветов

Возвращает абсолютное значение разности между яркостью двух цветов.

Имя аргумента	Тип	Описание
color	y5.Color, String	цвет для сравнения

Пример:

new y5.Color('#000').brightnessDiff(new y5.Color('#00f'));
// -> 29

clone

clone() -> y5.Color — копия объекта

Создает новый объект y5.Color из данного.

contrast

contrast(color) -> Boolean — контраст/не контраст

Проверка на контрастность двух цветов.

Имя аргумента	Тип	Описание
color	y5.Color, String	цвет для сравнения

Пример:

new y5.Color('#fff').contrast(new y5.Color('#000'));
// -> true

difference

difference(color) -> Number — разность цвета

Возвращает значение разности двух цветов.

Имя аргумента	Тип	Описание
color	y5.Color, String	цвет для сравнения

Пример:

new y5.Color('#fff').difference(new y5.Color('#00f'))
// -> 510

equals

equals(color) -> Boolean — один цвет

Проверка на идентичность.

Имя аргумента	Тип	Описание
color	y5.Color, String	цвет для сравнения

Пример:

new y5.Color('#fff').equals(new y5.Color('rgb(255,255,255)'));
// -> true

getBlue

y5.Color.getBlue() -> Number — blue

Возвращает значение синего канала.

getGreen

y5.Color.getGreen() -> Number — green

Возвращает значение зеленого канала.

getHSL

y5.Color.getHSL() -> String — hsl(H,S,L)

Возвращает значение цвета в формате hsl(H,S,L).

Пример:

new y5.Color('#7f7f00').getHSL();
// -> hsl(60, 100, 25)

getHex

getHex() -> String — цвет в hex

Вернуть значение цвета в HEX

getHue

y5.Color.getHue() -> Number — тон

Возвращает значение тона.

Пример:

new y5.Color('#7f7f00').getHue();
// -> 60

getLightness

y5.Color.getLightness() -> Number — яркость

Возвращает значение яркости.

Пример:

new y5.Color('#7f7f00').getSaturation();
// -> 0.24901960784313726

getRGB

y5.Color.getRGB() -> String — rgb(R,G,B)

Возвращает значение цвета в формате rgb(R,G,B).

Пример:

new y5.Color('#7f7f00').getRGB();
// -> rgb(127,127,0)

getRed

y5.Color.getRed() -> Number — red

Возвращает значение красного канала.

getSaturation

y5.Color.getSaturation() -> Number — насыщенность

Возвращает значение насыщенности.

Пример:

new y5.Color('#7f7f00').getSaturation();
// -> 100

gray

gray() -> y5.Color — новый цвет

Возвращает серый цвет для данного.

Пример:

new y5.Color('#7f7f00').gray().getRGB();
// -> rgb(113,113,113)

invert

invert() -> y5.Color — новый цвет

Возвращает противоположный цвет для данного.

Пример:

new y5.Color('#7f7f00').invert().getRGB();
// -> rgb(128,128,255)

isValid

y5.Color.isValid(color) -> Boolean — результат проверки

Проверка, что данный цвет является валидным

Имя аргумента	Тип	Описание
color	String	цвет в формате #hhh или #hhhhhh

isValid3

y5.Color.isValid3(color) -> Boolean — результат проверки

Проверка, что данный цвет является 3-значным и валидным

Имя аргумента	Тип	Описание
color	String	цвет в формате #hhh

isValid6

y5.Color.isValid6(color) -> Boolean — результат проверки

Проверка, что данный цвет является 6-значным и валидным

Имя аргумента	Тип	Описание
color	String	цвет в формате #hhhhhh

isValidRGB

y5.Color.isValidRGB(color) -> Boolean — результат проверки

Проверка, что данный цвет является rbg и валидным

Имя аргумента	Тип	Описание
color	String	цвет в формате rgb(R, G, B)

setBlue

y5.Color.setBlue(blue) -> y5.Color

Устанавливает значение синего канала.

Имя аргумента	Тип	Описание
blue	Number	синий (0..255)

setGreen

y5.Color.setGreen(diff) -> y5.Color

Устанавливает значение зеленого канала.

Имя аргумента	Тип	Описание
diff	Number	зеленый (0..255)

setHEX

setHEX(hex) -> y5.Color

Установить значение цвета в hex-формате

Имя аргумента	Тип	Описание
hex	String	цвет в hex-формате

setHSL

y5.Color.setHSL(hue, saturation, lightness) -> y5.Color

Устанавливает значения цветов HSL.

Имя аргумента	Тип	Описание
hue	Number	тон (0..360)
saturation	Number	насыщенность (0..100)
lightness	Number	светлота (0..100)

Пример:

new y5.Color().setHSL(240,100,60).getRGB();
// -> rgb(51,51,255)

setHue

y5.Color.setHue(hue) -> y5.Color

Устанавливает значение тона.

Имя аргумента	Тип	Описание
hue	Number	тон (0..360)

Пример:

new y5.Color('#7f7f00').setHue(140).getBlue();
// -> 43

setLightness

y5.Color.setLightness(lightness) -> y5.Color

Устанавливает значение яркости.

Имя аргумента	Тип	Описание
lightness	Number	яркость (0..100)

setRGB

y5.Color.setRGB(red, blue, green) -> y5.Color

Устанавливает значения цветов RGB.

Имя аргумента	Тип	Описание
red	Number	красный (0..255)
blue	Number	синий (0..255)
green	Number	зеленый (0..255)

Пример:

new y5.Color().setRGB(255,255,0).getHex();
// -> #FFFF00

setRed

y5.Color.setRed(red) -> y5.Color

Устанавливает значение красного канала.

Имя аргумента	Тип	Описание
red	Number	красный (0..255)

setSaturaton

y5.Color.setSaturaton(saturation) -> y5.Color

Устанавливает значение насыщенности.

Имя аргумента	Тип	Описание
saturation	Number	насыщенность (0..100)

toString

toString() -> String — цвет

Возвращает строковое представление цвета #rrggbb.