hs.image

Таблица массивов, содержащих имена дополнительных внутренних системных изображений, которые также могут быть доступны для использования с hs.drawing.image и hs.image.imageFromName.

• Список этих изображений был взят из коллекции, расположенной в репозиториях по адресу https://github.com/hetima?tab=repositories. Поскольку эти имена изображений (в основном) не формально указаны в документации Apple или опубликованных API, их использование не гарантируется во всех версиях OS X. Если вы обнаружите какие-либо изображения, которые могут отсутствовать или могут быть добавлены, пожалуйста, создайте вопрос на https://github.com/Hammerspoon/hammerspoon.

Таблица, содержащая имена внутренних системных изображений для использования с hs.drawing.image

• Имена изображений взяты из NSImage.h
• Эта таблица имеет метаметод __tostring(), который позволяет перечислить её содержимое в консоли Hammerspoon, набрав hs.image.systemImageNames.

Получает метаданные EXIF из файла изображения.

• path - Путь к файлу изображения.

• Таблица метаданных EXIF или nil, если метаданные не найдены или путь к файлу недействителен.

Создаёт объект hs.image для указанного файла или файлов.

• file - путь к файлу или массиву файлов для создания значка.

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

Создаёт объект hs.image значка для указанного типа файла.

• fileType - тип файла, указанный как расширение имени файла или универсальный идентификатор типа (UTI).

• Объект hs.image или nil, если произошла ошибка

Создаёт объект hs.image, используя значок из приложения.

• bundleID - строка, содержащая идентификатор пакета приложения.

• Объект hs.image или nil, если значок приложения не найден.

Создаёт изображение из ASCII-представления с указанным контекстом.

• ascii - строка, содержащая представление изображения.
• context - необязательная таблица, содержащая контекст для каждой фигуры на изображении. Фигура рассматривается как единый элемент рисования (точка, эллипс, линия или многоугольник), как определено в https://github.com/cparnot/ASCIImage и http://cocoamine.net/blog/2015/03/20/replacing-photoshop-with-nsstring/.
  • Таблица контекста — необязательный (возможно, разреженный) массив, в котором индекс представляет порядок определения фигур. Последний (наибольший) индекс в разреженном массиве определяет параметры по умолчанию для любого не указанного индекса и любые параметры, которые не явным образом установлены в любом другом заданном индексе.
  • Каждый индекс состоит из таблицы, которая может содержать один или несколько из следующих ключей: * fillColor - цвет, которым будет заполнена фигура (по умолчанию чёрный). Цвет определяется в таблице, содержащей значения цветовых компонентов от 0,0 до 1,0 для каждого из ключей: * red (по умолчанию 0,0) * green (по умолчанию 0,0) * blue (по умолчанию 0,0) * alpha (по умолчанию 1,0) * strokeColor - цвет, которым будет обведена фигура (по умолчанию чёрный) * lineWidth - ширина линии (число) для обводки фигуры (по умолчанию 1, если включено сглаживание, или (√2)/2, если оно выключено — приблизительно 0,7) * shouldClose - логическое значение, указывающее, следует ли закрывать фигуру (по умолчанию true) * antialias - логическое значение, указывающее, следует ли применять сглаживание (по умолчанию true)

• Объект hs.image, или nil, если произошла ошибка

• Для использования поддержки ASCII-диаграмм изображений см. https://github.com/cparnot/ASCIImage и http://cocoamine.net/blog/2015/03/20/replacing-photoshop-with-nsstring
• Значение по умолчанию для lineWidth, когда сглаживание выключено, определено в библиотеке ASCIImage. Геометрически оно представляет собой половину гипотенузы единичного прямоугольного треугольника и является более точным представлением "фактического" размера точки при работе с произвольными углами и линиями, чем 1,0.

Создаёт объект hs.image из видеофайла или обложки альбома аудиофайла или директории.

• file - строка, содержащая путь к аудио- или видеофайлу или директории альбома.

• Объект hs.image

• Если для видеофайла можно сгенерировать миниатюру, она возвращается как объект hs.image, в противном случае значок типа файла.
• Для аудиофайлов эта функция сначала определяет содержащую директорию (если это не уже директория).
• Она проверяет наличие следующих общих имён файлов обложек альбомов:
• cover.jpg
• front.jpg
• art.jpg
• album.jpg
• folder.jpg
• Если найдено одно из общих имён файлов обложек альбомов, оно возвращается как объект hs.image.
• Это быстрее, чем извлечение метаданных изображения, и позволяет получить обложку, связанную с форматами файлов, такими как .flac/.ogg
• Если общие имена файлов обложек альбомов не найдены, она пытается извлечь метаданные изображения из файла. Это работает для файлов .mp3/.m4a
• Если встроены метаданные изображения, они возвращаются как объект hs.image или значок типа файла

Возвращает объект hs.image для указанного имени, если он существует.

• Name - имя возвращаемого изображения.

• Объект hs.image или nil, если изображение с указанным именем не найдено.

• Некоторые предопределённые метки, соответствующие изображениям по умолчанию ОС X, можно найти в hs.image.systemImageNames.
• Имена не обязательно должны быть уникальными: порядок поиска следующий, и возвращается первое найденное совпадение:
  • изображение, имя которого было явно задано методом setName с момента последней полной перезагрузки Hammerspoon
  • главный пакет приложения Hammerspoon
  • фреймворк Application Kit (здесь расположено большинство изображений, перечисленных в hs.image.systemImageNames)
• Имена изображений могут быть назначены создателем изображения или вызовом метода hs.image:setName для объекта hs.image.

Загружает файл изображения

• path - Строка, содержащая путь к файлу изображения на диске

• Объект hs.image или nil, если произошла ошибка

Создаёт объект hs.image из содержимого указанного URL.

• url - веб-URL, указывающий расположение изображения для извлечения
• callbackFn - необязательная функция обратного вызова, которая вызывается по завершении извлечения изображения

• Объект hs.image или nil, если URL не указывает содержимое изображения или недоступен, или если предоставлена функция обратного вызова

• Если предоставлена функция обратного вызова, эта функция вернёт nil немедленно, и изображение будет извлечено асинхронно

Создаёт новое битовое представление изображения и возвращает его как новый объект hs.image.

• size - необязательная таблица, определяющая высоту и ширину, к которым должно быть масштабировано изображение в битовом представлении. Размер задаётся таблицей с ключами h и w. По умолчанию используется размер исходного объекта изображения.
• gray - необязательный булевый параметр, по умолчанию false, указывающий, нужно ли преобразовать битовое изображение в оттенки серого (true) или оставить в формате RGB (false).

• новый объект hs.image

• Битовое представление изображения отображается в заданном (или унаследованном) размере при его создании. Если вы позже измените его размер, битовое изображение будет масштабироваться как увеличенные или уменьшенные пиксели, а не плавно.

• Этот метод может быть полезен при подготовке изображений для других устройств (например, hs.streamdeck).

Считывает цвет пикселя в указанном месте.

• point - hs.geometry.point

• Объект hs.drawing.color

Возвращает копию изображения

• Нет

• новый объект hs.image

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

• rectangle - таблица с ключами 'x', 'y', 'h' и 'w', определяющая часть изображения для возвращения в новом изображении.

• копия части указанного изображения

Возвращает битовое представление изображения в виде строки URL с кодировкой base64.

• scale - необязательный булевый параметр, по умолчанию false, который указывает, что размер изображения (который macOS представляет как точки) должен быть масштабирован до пикселей. Для изображений с представлениями Retina масштаба это может привести к кодированию изображения, которое масштабируется по сравнению с оригиналом.
• type - необязательный параметр типа строки (регистронезависимый), определяющий тип битового изображения для закодированной строки (по умолчанию PNG)
  • PNG - сохранить в формате Portable Network Graphics (PNG)
  • TIFF - сохранить в формате Tagged Image File Format (TIFF)
  • BMP - сохранить в формате Windows bitmap image (BMP)
  • GIF - сохранить в формате Graphics Image Format (GIF)
  • JPEG - сохранить в формате Joint Photographic Experts Group (JPEG)

• представление битового изображения как строки с кодировкой Base64

• Вы можете преобразовать строку обратно в объект изображения с помощью hs.image.imageFromURL, например, hs.image.imageFromURL(string)

Получение или установка имени изображения, представленного объектом hs.image.

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

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

• см. также hs.image:setName для варианта, возвращающего вместо этого булево значение.

Сохраняет объект hs.image как изображение типа filetype в указанный файл.

• filename - путь и имя сохраняемого файла.
• scale - необязательный булевый параметр, по умолчанию false, который указывает, что размер изображения (которое macOS представляет как точки) должен быть масштабирован до пикселей. Для изображений с представлениями Retina масштаба это может привести к сохранению изображения, которое масштабируется по сравнению с исходным.
• filetype - необязательный параметр типа строки (регистронезависимый), определяющий тип файла для сохранения (по умолчанию PNG)
  • PNG - сохранить в формате Portable Network Graphics (PNG)
  • TIFF - сохранить в формате Tagged Image File Format (TIFF)
  • BMP - сохранить в формате Windows bitmap image (BMP)
  • GIF - сохранить в формате Graphics Image Format (GIF)
  • JPEG - сохранить в формате Joint Photographic Experts Group (JPEG)

• Статус - булево значение, указывающее на успех (true) или неудачу (false)

• Сохраняет изображение в размерах в точках (или пикселях, если scale имеет значение true), как указано в hs.image:size() для объекта изображения

Присваивает имя объекту hs.image.

• Имя - имя, которое нужно присвоить объекту hs.image.

• Статус - булево значение, указывающее на успех (true) или неудачу (false) при присвоении указанного имени.

• Этот метод включён для обратной совместимости и считается устаревшим. Он эквивалентен hs.image:name(name) and true or false.

Возвращает копию изображения, изменённую в соответствии с высотой и шириной, указанными в таблице размеров.

• размер - таблица с ключами 'h' и 'w', определяющими размер нового изображения.
• абсолютный - необязательный булев параметр, указывающий, следует ли изменять размеры скопированного изображения до указанной высоты и ширины (true) или масштабировать скопированное изображение пропорционально, чтобы оно вписалось в указанные высоту и ширину (false). По умолчанию false.

• копию объекта изображения с новыми размерами

• Этот метод включён для обратной совместимости и считается устаревшим. Он эквивалентен hs.image:copy():size(size, [absolute]).

Получение или установка размера изображения, представленного объектом hs.image.

• size - необязательная таблица с ключами 'h' и 'w', определяющими размер изображения.
• absolute - при указании нового размера, необязательный булев параметр, по умолчанию false, определяющий, следует ли изменять размеры изображения до указанной высоты и ширины (true), или масштабировать скопированное изображение пропорционально, чтобы оно вписалось в указанные высоту и ширину (false).

• Если параметры предоставлены, возвращает объект hs.image; в противном случае возвращает текущий размер

• См. также hs.image:setSize для создания копии изображения с новыми размерами.

Получение или установка значения, указывающего, является ли изображение шаблоном.

• state - необязательный булев параметр, указывающий, должно ли изображение быть шаблоном.

• если параметр предоставлен, возвращает объект hs.image; в противном случае возвращает текущее значение

• Шаблоны изображений состоят из чёрного и прозрачного цветов (и канала альфа). Шаблонные изображения не предназначены для использования в качестве самостоятельных изображений и обычно комбинируются с другим контентом для создания желаемого конечного внешнего вида.
• Изображения с этим флагом, установленным в true, обычно выглядят светлее, чем с флагом, установленным в false.

Преобразует изображение в ASCII-представление в виде строки.

• ширина - необязательная ширина в пикселях (по умолчанию ширина изображения, если не указано).
• высота - необязательная высота в пикселях (по умолчанию высота изображения, если не указано).

• Строка.