跳到主要内容

nativeImage

使用 PNG 或 JPG 文件创建托盘、停靠栏和应用程序图标。

进程：主进程，渲染进程

nativeImage 模块提供了一个统一的接口来操作系统图像。如果你想提供相同图标的多个缩放版本或利用 macOS 模板图像，这些图像可能会很有用。

接受图像文件的 Electron API 接受文件路径或 NativeImage 实例。当传递 null 时，将使用空且透明的图像。

例如，在创建 托盘 或设置 BrowserWindow 的图标时，你可以将图像文件路径作为字符串传递

主进程
const { BrowserWindow, Tray } = require('electron')

const tray = new Tray('/Users/somebody/images/icon.png')
const win = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })

或从同一个文件生成一个 NativeImage 实例

主进程
const { BrowserWindow, nativeImage, Tray } = require('electron')

const trayIcon = nativeImage.createFromPath('/Users/somebody/images/icon.png')
const appIcon = nativeImage.createFromPath('/Users/somebody/images/window.png')
const tray = new Tray(trayIcon)
const win = new BrowserWindow({ icon: appIcon })

支持的格式​

目前，所有平台都支持 PNG 和 JPEG 图像格式。建议使用 PNG，因为它支持透明度和无损压缩。

在 Windows 上，你还可以从文件路径加载 ICO 图标。为了获得最佳视觉效果，我们建议至少包含以下尺寸

  • 小图标
    • 16x16（100% DPI 缩放比例）
    • 20x20（125% DPI 缩放比例）
    • 24x24（150% DPI 缩放比例）
    • 32x32（200% DPI 缩放比例）
  • 大图标
    • 32x32（100% DPI 缩放比例）
    • 40x40（125% DPI 缩放比例）
    • 48x48（150% DPI 缩放比例）
    • 64x64（200% DPI 缩放比例）
    • 256x256

请查看 Windows 应用程序图标构建 参考中的“图标缩放”部分。

注意

目前不支持 EXIF 元数据，在图像编码和解码期间不会考虑它。

高分辨率图像​

在支持高像素密度显示器（如 Apple Retina）的平台上，你可以在图像基本文件名后添加 @2x，将其标记为 2x 缩放比例的高分辨率图像。

例如，如果 icon.png 是具有标准分辨率的普通图像，那么 [email protected] 将被视为具有双倍每英寸点数 (DPI) 密度的 高分辨率图像。

如果你想同时支持具有不同 DPI 密度的显示器，你可以在同一个文件夹中放置具有不同尺寸的图像，并在 Electron 中使用没有 DPI 后缀的文件名。例如

images/
├── icon.png
├── [email protected]
└── [email protected]
主进程
const { Tray } = require('electron')
const appTray = new Tray('/Users/somebody/images/icon.png')

以下 DPI 后缀也受支持

  • @1x
  • @1.25x
  • @1.33x
  • @1.4x
  • @1.5x
  • @1.8x
  • @2x
  • @2.5x
  • @3x
  • @4x
  • @5x

模板图像 macOS​

在 macOS 上，模板图像 由黑色和 alpha 通道组成。模板图像不适合用作独立图像，通常与其他内容混合以创建所需的最终外观。

最常见的情况是将模板图像用于菜单栏（托盘）图标，以便它可以适应浅色和深色菜单栏。

要将图像标记为模板图像，其基本文件名应以单词 Template 结尾（例如 xxxTemplate.png）。你还可以指定不同 DPI 密度的模板图像（例如 [email protected]）。

方法​

nativeImage 模块具有以下方法，所有这些方法都返回 NativeImage 类的实例

nativeImage.createEmpty()​

返回 NativeImage

创建一个空的 NativeImage 实例。

nativeImage.createThumbnailFromPath(path, size) macOS Windows​

  • path string - 我们打算从中构建缩略图的文件路径。
  • size Size - 缩略图的所需宽度和高度（正数）。

返回 Promise<NativeImage> - 成功返回文件的缩略图预览图像，这是一个 NativeImage。

注意：Windows 实现将忽略 size.height，并根据 size.width 缩放高度。

nativeImage.createFromPath(path)​

  • path string - 我们打算从中构建图像的文件路径。

返回 NativeImage

从位于 path 的文件中创建一个新的 NativeImage 实例。如果 path 不存在、无法读取或不是有效的图像，此方法将返回一个空图像。

const { nativeImage } = require('electron')

const image = nativeImage.createFromPath('/Users/somebody/images/icon.png')
console.log(image)

nativeImage.createFromBitmap(buffer, options)​

  • buffer Buffer
  • options Object
    • width Integer
    • height Integer
    • scaleFactor Number (optional) - 默认值为 1.0。

返回 NativeImage

从 buffer 中创建一个新的 NativeImage 实例，该实例包含 toBitmap() 返回的原始位图像素数据。具体格式取决于平台。

nativeImage.createFromBuffer(buffer[, options])​

  • buffer Buffer
  • options Object (optional)
    • width Integer (optional) - 位图缓冲区需要此参数。
    • height Integer (optional) - 位图缓冲区需要此参数。
    • scaleFactor Number (optional) - 默认值为 1.0。

返回 NativeImage

从 buffer 中创建一个新的 NativeImage 实例。首先尝试解码为 PNG 或 JPEG。

nativeImage.createFromDataURL(dataURL)​

  • dataURL string

返回 NativeImage

从 dataUrl 创建一个新的 NativeImage 实例，dataUrl 是一个使用 Base 64 编码的 数据 URL 字符串。

nativeImage.createFromNamedImage(imageName[, hslShift]) macOS​

  • imageName string
  • hslShift number[] (optional)

返回 NativeImage

从映射到给定图像名的 NSImage 中创建一个新的 NativeImage 实例。有关可能值的列表，请参阅 Apple 的 NSImageName 文档。

hslShift 将根据以下规则应用于图像

  • hsl_shift[0]（色调）：图像的绝对色调值 - 0 和 1 映射到色调色轮上的 0 和 360（红色）。
  • hsl_shift[1]（饱和度）：图像的饱和度偏移，具有以下关键值：0 = 移除所有颜色。0.5 = 保持不变。1 = 使图像完全饱和。
  • hsl_shift[2]（亮度）：图像的亮度偏移，具有以下关键值：0 = 移除所有亮度（使所有像素变黑）。0.5 = 保持不变。1 = 全亮度（使所有像素变白）。

这意味着 [-1, 0, 1] 将使图像完全变白，而 [-1, 1, 0] 将使图像完全变黑。

在某些情况下，NSImageName 不与其字符串表示形式匹配；一个例子是 NSFolderImageName，其字符串表示形式实际上是 NSFolder。因此，您需要在传入图像之前确定正确的字符串表示形式。可以使用以下方法：

echo -e '#import <Cocoa/Cocoa.h>\nint main() { NSLog(@"%@", SYSTEM_IMAGE_NAME); }' | clang -otest -x objective-c -framework Cocoa - && ./test

其中 SYSTEM_IMAGE_NAME 应替换为 此列表 中的任何值。

类：NativeImage​

原生包装图像，例如托盘、坞站和应用程序图标。

进程：主进程，渲染进程
此类未从 'electron' 模块导出。它只能作为 Electron API 中其他方法的返回值使用。

实例方法​

以下方法适用于 NativeImage 类的实例。

image.toPNG([options])​

  • options Object (optional)
    • scaleFactor Number (optional) - 默认值为 1.0。

返回 Buffer - 包含图像 PNG 编码数据的 Buffer。

image.toJPEG(quality)​

  • quality 整数 - 介于 0 到 100 之间。

返回 Buffer - 包含图像 JPEG 编码数据的 Buffer。

image.toBitmap([options])​

  • options Object (optional)
    • scaleFactor Number (optional) - 默认值为 1.0。

返回 Buffer - 包含图像原始位图像素数据的副本的 Buffer。

image.toDataURL([options])​

历史
  • options Object (optional)
    • scaleFactor Number (optional) - 默认值为 1.0。

返回 string - 图像的 Data URL。

image.getBitmap([options])​

  • options Object (optional)
    • scaleFactor Number (optional) - 默认值为 1.0。

返回 Buffer - 包含图像原始位图像素数据的 Buffer。

getBitmap() 和 toBitmap() 之间的区别在于 getBitmap() 不会复制位图数据，因此您必须在当前事件循环滴答中立即使用返回的 Buffer；否则数据可能会发生更改或被破坏。

image.getNativeHandle() macOS​

返回 Buffer - 一个 Buffer，它存储指向图像底层原生句柄的 C 指针。在 macOS 上，会返回指向 NSImage 实例的指针。

请注意，返回的指针是底层原生图像的弱指针，而不是副本，因此您必须确保保持相关 nativeImage 实例。

image.isEmpty()​

返回 boolean - 图像是否为空。

image.getSize([scaleFactor])​

  • scaleFactor Number (optional) - 默认值为 1.0。

返回 Size。

如果传递了 scaleFactor，这将返回与最接近传递值的图像表示形式相对应的尺寸。

image.setTemplateImage(option)​

  • option 布尔值

将图像标记为 macOS 模板图像。

image.isTemplateImage()​

返回 boolean - 图像是否为 macOS 模板图像。

image.crop(rect)​

  • rect Rectangle - 要裁剪的图像区域。

返回 NativeImage - 裁剪后的图像。

image.resize(options)​

  • options Object
    • width 整数（可选） - 默认值为图像的宽度。
    • height 整数（可选） - 默认值为图像的高度。
    • quality 字符串（可选） - 重置图像所需的质量。可能的值包括 good、better 或 best。默认值为 best。这些值表示所需的质量/速度权衡。它们被转换为特定于算法的方法，该方法取决于底层平台的功能（CPU、GPU）。所有三种方法都可能被映射到给定平台上的同一算法。

返回 NativeImage - 重置后的图像。

如果只指定了 height 或 width，则重置后的图像将保留当前纵横比。

image.getAspectRatio([scaleFactor])​

  • scaleFactor Number (optional) - 默认值为 1.0。

返回 Number - 图像的纵横比（宽度除以高度）。

如果传递了 scaleFactor，这将返回与最接近传递值的图像表示形式相对应的纵横比。

image.getScaleFactors()​

返回 Number[] - 与给定 NativeImage 的表示形式相对应的所有比例因子的数组。

image.addRepresentation(options)​

  • options Object
    • scaleFactor 数字（可选） - 要添加图像表示形式的比例因子。
    • width 整数（可选） - 默认值为 0。如果指定位图缓冲区作为 buffer，则需要此参数。
    • height 整数（可选） - 默认值为 0。如果指定位图缓冲区作为 buffer，则需要此参数。
    • buffer 缓冲区（可选） - 包含原始图像数据的缓冲区。
    • dataURL 字符串（可选） - 包含 base 64 编码的 PNG 或 JPEG 图像的 Data URL。

为特定比例因子添加图像表示形式。这可用于以编程方式将不同的比例因子表示形式添加到图像中。这可以在空图像上调用。

实例属性​

nativeImage.isMacTemplateImage macOS​

一个 boolean 属性，用于确定图像是否被视为 模板图像。

请注意，此属性仅对 macOS 有效。