Plugin API
简体中文
简体中文
  • 入門
    • 简介
    • 你的第一个插件
    • 文件结构概述
    • 插件类型
      • 窗口
      • 背景服務
      • 格式扩展
      • 检查器
    • 调试插件
    • 开发交流群
  • 部署
    • 准备插件
    • 打包插件
    • 发布插件
    • 更新插件
    • 开发者政策
    • 插件图标模板
  • 开发指南
    • manifest.json 完整配置
    • 取得数据
    • 修改数据
    • 存取本地文件
    • 发出网路请求
    • 使用 Node.js 原生 API
    • 使用第三方模快
    • 多国语言(i18n)
    • 无边框窗口
  • API 参考
    • event(事件)
    • item(项目)
    • folder(文件夾)
    • tag(标签)
    • tagGroup(标签群组)
    • library(资源库)
    • window(窗口)
    • app(应用)
    • os(操作系统)
    • screen(屏幕)
    • notification(通知)
    • contextMenu(右鍵菜單)
    • dialog(对话框)
    • clipboard(剪贴板)
    • drag(拖拽文件)
    • shell(壳)
    • log(日志)
  • 额外组件
    • FFmpeg
由 GitBook 提供支持
在本页
  • 方法
  • isDarkColors()
  • getPath(name)
  • getFileIcon(path[, options])
  • createThumbnailFromPath(path, maxSize)
  • 屬性
  • version
  • build
  • locale
  • arch
  • platform
  • env
  • execPath
  • pid
  • isWindows
  • isMac
  • runningUnderARM64Translation
  • theme
  1. API 参考

app(应用)

获取 Eagle 应用程序版本、架构、语系等属性。

下面示例为 app 的常用属性:

console.log(eagle.app.version);				// Eagle 版本
console.log(eagle.app.build);				// Eagle Build 号
console.log(eagle.app.locale);				// 应用界面语系,en/zh_CN/zh_TW/ja_JP
console.log(eagle.app.arch);				// x86 | x64
console.log(eagle.app.platform);			// darwin | win32
console.log(eagle.app.isWindows);			// true | false, 操作系统是否为 Windows
console.log(eagle.app.isMac);				// true | false, 操作系统是否为 Mac
console.log(eagle.app.runningUnderARM64Translation);	// 是否运行在 rosetta 转译模式

方法

isDarkColors()

确认当前系统是否处于深色(Dark)模式。

  • 返回 boolean - 当前系统是否正在处于 Dark 模式。

eagle.app.isDarkColors();		// true | false

getPath(name)

您可以通过名称请求以下路径

  • name string - 您可以通过名称请求以下路径

    • home - 用户的 home 文件夹(主目录)

    • appData - 每个用户的应用程序数据目录,默认情况下指向:

    • userData - 储存你应用程序配置文件的文件夹,默认是 appData 文件夹附加应用的名称 按照习惯用户存储的数据文件应该写在此目录,同时不建议在这写大文件,因为某些环境会备份此目录到云端存储。

    • temp - 临时文件夹

    • exe - 当前的可执行文件

    • desktop - 当前用户的桌面文件夹

    • documents - 用户文档目录的路径

    • downloads - 用户下载目录的路径

    • music - 用户音乐目录的路径

    • pictures - 用户图片目录的路径

    • videos - 用户视频目录的路径

    • recent - 用户最近文件的目录 (仅限 Windows)。

  • 返回 Promise<path: string> - path 查询路径结果。

await eagle.app.getPath('appData');	// 'C:\Users\User\AppData\Roaming'
await eagle.app.getPath('pictures');	// 'C:\Users\User\Pictures'
await eagle.app.getPath('desktop');	// 'C:\Users\User\Desktop'

getFileIcon(path[, options])

取得指定路径文件关联的图标。

  • path string - 欲取得图示之文件路径

  • options Object(可选)

    • size string

    • small - 16x16

    • normal - 32x32

    • large - Windows 为 32x32, macOS 不支持。

  • 返回 Promise<img: NativeImage>

let img = await eagle.app.getFileIcon('path_to_file', { size: 'small' });

// 取得图像信息
let base64 = img.toDataURL();
let size = img.getSize();	// {'width': 16, height: 16}

// 保存到电脑
let buffer = img.toPNG();
require('fs').writeFileSync('output_path/example.png', buffer);

createThumbnailFromPath(path, maxSize)

取得指定路径文件关联的图标。

  • path string - 欲取得缩略图之文件路径

  • maxSize Size - 返回缩略图的最大宽度和高度(正数)。 在 Windows 平台下将忽略 maxSize.height 并根据 maxSize.width 缩放高度

  • 返回 Promise<img: NativeImage>

let img = await eagle.app.createThumbnailFromPath('path_to_file', { 
    height: 200, 
    width: 200 
});

// 取得图像信息
let base64 = img.toDataURL();
let size = img.getSize();	// {'width': 200, height: 150}

// 保存到电脑
let buffer = img.toPNG();
require('fs').writeFileSync('output_path/example.png', buffer);

屬性

version

string 属性,获取当前 Eagle 应用程序版本。

build

number 属性,获取当前 Eagle 应用程序 Build Number。

locale

string 属性,获取当前 Eagle 应用程序界面语系。

  • en - 英文

  • zh_CN - 简体中文

  • zh_TW - 繁体中文

  • ja_JP - 日文

  • ko_KR - 韩文

  • es_ES - 西班牙文

  • de_DE - 德文

  • ru_RU - 俄文

arch

string 属性,返回操作系統 CPU 架構。

  • x64

  • arm64

  • x86

platform

string 属性,返回一個標識操作系統平台的字符串。

  • darwin - macOS 操作系统

  • win32 - Windows 操作系统

env

Object 属性,返回环境变量的对象。

console.log(eagle.app.env);

{
  APPDATA: "C:\\Users\\User\\AppData\\Roaming",
  HOMEDRIVE: "C:",
  HOMEPATH: "\\Users\\User",
  LANG: "zh_TW.UTF-8",
  TEMP: "C:\\Users\\User\\AppData\\Local\\Temp"
}
console.log(eagle.app.env['TEMP']);

"C:\\Users\\User\\AppData\\Local\\Temp"

execPath

string 属性,当前应用程序执行路径。

console.log(eagle.app.execPath);

"C:\\Program Files\\Eagle\\Eagle.exe"

pid

number 属性,当前插件进程 id。

isWindows

boolean 属性,是否当前为 Window 操作系统。

isMac

boolean 属性,是否当前为 Mac 操作系统。

runningUnderARM64Translation

theme

string 属性, - 当前主题配色的名称,如 LIGHT、LIGHTGRAY、GRAY、DARK、BLUE、PURPLE。

上一页window(窗口)下一页os(操作系统)

最后更新于11个月前

备注:此功能与 Electron API 的 功能类似。

img - 一个 NativeImage 类型的应用图标。

备注:此功能与 Electron API 的 功能类似。

img - 文件的缩略图预览图像。

备注:此功能与 Electron API 的 功能类似。

boolean 属性,为 true 时表明当前应用正在使用 ARM64 运行环境 (比如 macOS 或者 Windows ).

提示:此功能与 Electron API 的 功能类似,您可以使用此属性来提示用户下载应用程序的 arm64 版本,当用户错误地在转译环境下运行 x64 版本。

app.getPath
NativeImage
app.getAppIcon
NativeImage
nativeImage.createThumbnailFromPath(path, maxSize)
Rosetta Translator Environment
WOW
app.runningUnderARM64Translation