Spec-Zone.ru › Hammerspoon

hs.drawing.color

Предоставляет доступ к системным спискам цветов и более широкому разнообразию способов представления цветов в Hammerspoon.

Цвет в Hammerspoon представлен таблицей, содержащей ключи, которые указывают Hammerspoon, как задан цвет. Вы можете указать цвет одним из следующих способов, в зависимости от ключей, которые вы предоставляете в таблице:

  • В виде комбинации элементов Красный, Зеленый и Синий (цвет RGB):

    • red - красный компонент цвета, заданный числом от 0,0 до 1,0.
    • green - зелёный компонент цвета, заданный числом от 0,0 до 1,0.
    • blue - синий компонент цвета, заданный числом от 0,0 до 1,0.
    • alpha - прозрачность цвета от 0,0 (полностью прозрачный) до 1,0 (полностью непрозрачный)
  • В виде комбинации Цвета, Насыщенности и Яркости (цвет HSB или HSV):

    • hue - компонент цвета, заданный числом от 0,0 до 1,0.
    • saturation - компонент насыщенности цвета, заданный числом от 0,0 до 1,0.
    • brightness - компонент яркости цвета, заданный числом от 0,0 до 1,0.
    • alpha - прозрачность цвета от 0,0 (полностью прозрачный) до 1,0 (полностью непрозрачный)
  • В виде градации серого (цвет Градаций серого):

    • white - отношение белого к черному от 0,0 (полностью черный) до 1,0 (полностью белый)
    • alpha - прозрачность цвета от 0,0 (полностью прозрачный) до 1,0 (полностью непрозрачный)
  • Из системных или списков цветов Hammerspoon:

    • list - имя системного списка цветов или списка коллекции, определённого в hs.drawing.color
    • name - имя цвета в указанном списке цветов
  • В виде спецификации цвета HTML в шестнадцатеричном формате:

    • hex - строка формата "#rrggbb" или "#rgb", где r, g, и b являются шестнадцатеричными цифрами (т. е. 0-9, A-F)
    • alpha - прозрачность цвета от 0,0 (полностью прозрачный) до 1,0 (полностью непрозрачный)
  • Из изображения, используемого в качестве повторяющегося рисунка:

    • image - объект hs.image, представляющий изображение, используемое в качестве повторяющегося рисунка

Любая комбинация вышеперечисленных ключей может быть указана в таблице цветов, и они будут оцениваться в следующем порядке:

  1. если указан ключ image, он будет использован для создания повторяющегося рисунка.
  2. Если указаны ключи list и name, и если они могут быть сопоставлены с существующим цветом в системных списках цветов, используется этот цвет.
  3. Если указан ключ hue, цвет генерируется как цвет HSB.
  4. Если указан ключ white, цвет генерируется как цвет градаций серого.
  5. В противном случае генерируется цвет RGB.

За исключением случаев, указанных выше для указания используемой цветовой модели, любой ключ, который не указан, по умолчанию имеет значение 0,0, за исключением alpha, который по умолчанию имеет значение 1,0. Это означает, что указание пустой таблицы в качестве цвета приведет к непрозрачному черному цвету.

Обзор API

  • Константы - полезные значения, которые нельзя изменить
    • definedCollections
  • Переменные - настраиваемые значения
    • ansiTerminalColors
    • hammerspoon
    • x11
  • Функции - вызовы API, предлагаемые непосредственно расширением
    • asHSB
    • asRGB
    • colorsFor
    • lists

Документация API

Константы

definedCollections
Подпись hs.drawing.color.definedCollections
Тип Константа
Описание

Эта таблица содержит этот список определённых коллекций цветов, предоставленных модулем hs.drawing.color. Коллекции отличаются от системных списков цветов тем, что вы можете изменить значения цветов, которые содержатся в их членах, изменив таблицу по адресу hs.drawing.color.<collection>.<color>, и будущие ссылки на этот цвет будут отражать новые изменения, что позволит вам настроить цветовые палитры для вашей установки.

Примечания
  • Этот список является константой, но члены, на которые он ссылается, нет.
Источник extensions/drawing/color/drawing_color.lua строка 361

Переменные

ansiTerminalColors
Подпись hs.drawing.color.ansiTerminalColors
Тип Переменная
Описание

Коллекция цветов, представляющих ANSI последовательности цветов терминала. Определения цветов основаны на коде, найденном в файле /NerdTool/classes/ANSIEscapeHelper.m по адресу https://github.com/balthamos/geektool-3.

Примечания
  • Это не константа, поэтому вы можете при необходимости настроить цвета во время работы вашей установки.
Источник extensions/drawing/color/drawing_color.lua строка 129
hammerspoon
Подпись hs.drawing.color.hammerspoon
Тип Переменная
Описание

Эта таблица содержит набор различных полезных предопределённых цветов:

Примечания
  • Это не константа, поэтому вы можете при необходимости настроить цвета во время работы вашей установки.

  • Предыдущие версии Hammerspoon включали эти цвета по пути hs.drawing.color; для обратной совместимости ключи этой таблицы дублируются по этому пути, если они не конфликтуют с какой-либо другой цветовой коллекцией или функцией в модуле hs.drawing.color. Вам следует пересмотреть свой код, чтобы использовать коллекцию, так как это может измениться в будущем.

Источник extensions/drawing/color/drawing_color.lua строка 330
x11
Подпись hs.drawing.color.x11
Тип Переменная
Описание

Коллекция цветов, представляющих имена цветов X11, как определено в https://en.wikipedia.org/wiki/Web_colors#X11_color_names (имена в нижнем регистре)

Примечания
  • Это не константа, поэтому вы можете при необходимости настроить цвета во время работы вашей установки.
Источник extensions/drawing/color/drawing_color.lua строка 170

Функции

asHSB
Подпись hs.drawing.color.asHSB(color) -> table | string
Тип Функция
Описание

Возвращает таблицу, содержащую представление HSB указанного цвета.

Параметры
  • color - таблица, определяющая цвет, как описано в определении модуля (см. hs.drawing.color в онлайн справке или документации Dash)
Возвращаемое значение
  • таблица, содержащая ключи оттенка, насыщенности, яркости и альфа, представляющие указанный цвет как HSB, или строка, описывающая цветовое пространство цвета, если преобразование невозможно.
Примечания
  • См. также hs.drawing.color.asRGB
Источник extensions/drawing/color/libdrawing_color.m строка 66
asRGB
Подпись hs.drawing.color.asRGB(color) -> table | string
Тип Функция
Описание

Возвращает таблицу, содержащую представление RGB указанного цвета.

Параметры
  • color - таблица, определяющая цвет, как описано в определении модуля (см. hs.drawing.color в онлайн справке или документации Dash)
Возвращаемое значение
  • таблица, содержащая ключи красный, синий, зелёный и альфа, представляющие указанный цвет как RGB, или строка, описывающая цветовое пространство цвета, если преобразование невозможно.
Примечания
  • См. также hs.drawing.color.asHSB
Источник extensions/drawing/color/libdrawing_color.m строка 34
colorsFor
Подпись hs.drawing.color.colorsFor(list) -> table
Тип Функция
Описание

Возвращает таблицу, содержащую цвета для указанного системного списка цветов или коллекции hs.drawing.color.

Параметры
  • list - имя списка, для которого нужны цвета
Возвращаемое значение
  • таблица, ключами которой являются цвета, предоставленные списком цветов, или nil, если список не существует.
Примечания
  • Когда это возможно, каждый узел цвета предоставляется как его представление RGB. Если это невозможно, узел цвета содержит ключи list и name, которые идентифицируют указанный цвет. Это означает, что вы можете использовать следующее там, где ожидается параметр цвета: hs.drawing.color.colorsFor(list)["color-name"]
  • Эта функция предоставляет метод metatable tostring, который позволяет вывести определённые цвета в списке в консоли Hammerspoon: hs.drawing.colorsFor(list)
  • См. также hs.drawing.color.lists
Источник extensions/drawing/color/drawing_color.lua строка 100
списки
Подпись hs.drawing.color.lists() -> table
Тип Функция
Описание

Возвращает таблицу, содержащую списки системных цветов и коллекции hs.drawing.color с их определёнными цветами.

Параметры
  • Нет
Возвращает
  • таблицу, ключи которой составлены из текущих определённых списков системных цветов и коллекций hs.drawing.color. Каждый ключ списка цветов ссылается на таблицу, ключи которой представляют собой цвета, предоставленные конкретным списком цветов.
Примечания
  • По возможности, каждый узел цвета предоставляется в виде его представления в формате RGB. Если это невозможно, узел цвета содержит ключи list и name, которые идентифицируют указанный цвет. Это означает, что вы можете использовать следующее там, где ожидается параметр цвета: hs.drawing.color.lists()["list-name"]["color-name"]
  • Эта функция предоставляет метод метатаблицы tostring, который позволяет отображать определённые списки цветов в консоли Hammerspoon с помощью: hs.drawing.color.lists()
  • См. также hs.drawing.color.colorsFor
Источник extensions/drawing/color/libdrawing_color.m строка 8

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.drawing.color.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API