Electron 문서1.4.1

Docs / API

API 참고서

API프로세스설명
크롬 명령줄 스위치 지원 Electron에서 지원하는 커맨드 명령줄 스위치입니다.
환경 변수 애플리케이션의 구성과 동작을 코드 변경 없이 제어합니다.
로케일 app.getLocale()에서 반환되는 로케일 값.
개요 Node.js와 Electron API를 사용하는 방법.
Accelerator 메인 프로세스 키보드 단축키를 정의합니다.
app 메인 프로세스 애플리케이션의 이벤트 생명주기를 제어합니다.
autoUpdater 메인 프로세스 애플리케이션이 자동으로 업데이트를 진행할 수 있도록 기능을 활성화합니다.
BrowserWindow 메인 프로세스 브라우저 윈도우를 생성하고 제어합니다.
Certificate Object

Certificate Object

  • data String - PEM 인코딩된 데이터
  • issuerName String - 인증서 발급자의 공통 이름
  • subjectName String - 대상의 공통 이름
  • serialNumber String - 문자열로 표현된 hex 값
  • validStart Integer - 초 단위의 인증서가 유효하기 시작한 날짜
  • validExpiry Integer - 초 단위의 인증서가 만료되는 날짜
  • fingerprint String - 인증서의 지문
clipboard 메인 프로세스, 렌더러 프로세스 시스템 클립보드에 복사와 붙여넣기를 수행합니다.
contentTracing 메인 프로세스 성능상의 병목 현상과 느린 작업을 찾기 위해 Chromium의 콘텐츠 모듈에서 추적 데이터를 수집합니다.
crashReporter 메인 프로세스, 렌더러 프로세스 원격 서버에 오류 보고를 제출합니다.
desktopCapturer 렌더러 프로세스 멀티미디어 소스에 대해 접근하고 navigator.webkitGetUserMedia API를 통해 오디오나 비디오를 데스크톱으로부터 캡쳐할 수 있도록 합니다.
dialog 메인 프로세스 파일을 열거나 저장하고, 알림을 표시하기 위한 네이티브 시스템 대화 상자를 표시합니다.
Display Object

Display Object

  • id Number - 디스플레이와 관련된 고유 식별자.
  • rotation Number - 0, 90, 180, 270, 시계 방향의 화면 회전을 표시.
  • scaleFactor Number - 출력 장치의 화소 배율.
  • touchSupport String - available, unavailable, unknown.
  • bounds Rectangle
  • size Object
    • height Number
    • width Number
  • workArea Rectangle
  • workAreaSize Object
    • height Number
    • width Number

Display 객체는 시스템에 연결된 물리 디스플레이입니다. 머리가 없는 시스템에서는 가짜 Display 가 존재할 수 있습니다. 또는 Display 는 원격 가상 디스플레이일 수 있습니다.

DownloadItem 메인 프로세스 원격 소스로부터의 파일 다운로드를 제어합니다.
File 객체 HTML5 File API를 기본적인 파일 시스템의 파일처럼 사용합니다.
Frameless 윈도우 툴바, 테두리, 시각적인 "chrome" 없이 윈도우를 엽니다.
globalSortcut 애플리케이션에 키보드 포커스가 없을 때도 키보드 이벤트를 받을 수 있도록 합니다.
ipcMain 메인 프로세스 메인 프로세스에서 렌더러 프로세스로 비동기 통신을 합니다.
ipcRenderer 렌더러 프로세스 렌더러 프로세스에서 메인 프로세스로 비동기 통신을 합니다.
JumpListCategory Object

JumpListCategory Object

  • type String - 다음 중 하나:
    • tasks - 이 카테고리의 항목은 표준 Tasks 카테고리에 위치할 것 입니다. 이 카테고리는 하나만 존재하며, 항상 점프 목록의 하단에 보여집니다.
    • frequent - 앱에 의해 자주 열린 파일의 목록을 보여줍니다. 카테고리의 이름과 항목들은 윈도우에 의해 설정 됩니다.
    • recent - 앱에 의해 최근에 열린 파일의 목록을 보여줍니다. 카테고리의 이름과 항목들은 윈도우에 의해 설정 됩니다. app.addRecentDocument(path) 을 사용하면 간접적으로 이 카테고리에 항목이 추가될 것 입니다.
    • custom - 작업 또는 파일 링크를 보여주며, 앱에 의해 name 설정되어야 합니다.
  • name String - typecustom 이면 꼭 설정되어야 하고, 그 외는 생략합니다.
  • items JumpListItem[] - typetasks 또는 custom 이면 [JumpListItem] (jump-list-item.md) 객체의 배열, 그 외는 생략합니다.

참고: JumpListCategory 객체가 type, name 속성 둘 다 없다면 typetasks 로 가정합니다. name 속성이 설정되었지만 type 속성이 생략된 경우 typecustom 으로 가정합니다.

JumpListItem Object

JumpListItem Object

  • type String - 다음 중 하나:
    • task - 특정 인수로 앱을 실행시킬 작업.
    • separator - 표준 Tasks 범주에서 항목을 구분하는데 사용할 수 있습니다.
    • file - 점프 목록을 만든 앱을 사용하여 파일을 열 파일 링크. 이것이 동작하려면 그 파일 형식을 앱이 처리할 수 있게 등록되있어야 한다. (하지만, 그것이 기본 처리기일 필요는 없습니다.).
  • path String - 파일을 열기 위한 경로. typefile 경우에만 설정되어야 한다.
  • program String - 실행하기 위한 프로그램의 경로. 일반적으로 현재 프로그램을 열기 위해 process.execPath 를 지정해야 합니다. typetask 일 경우만 설정되어야 한다.
  • args String - program 이 실행됐을 때의 명령줄 인수. typetask 일 경우만 설정되어야 한다.
  • title String - 점프 목록에서 항목에 표시될 글자. typetask 일 경우만 설정되어야 한다.
  • description String - 작업의 설명 (툴팁으로 표시된다). typetask 일 경우만 설정되어야 한다.
  • iconPath String - 점프 목록에서 보여질 아이콘의 절대 경로. 아이콘을 포함하는 임의의 자원 파일 경로일 수 있습니다. (예. .ico, .exe, .dll). 일반적으로 프로그램 아이콘을 보여주기 위해 process.execPath 를 명시할 수 있습니다.
  • iconIndex Integer - 리소스 파일의 아이콘 인덱스. 리소스 파일이 여러 아이콘을 포함하고 있다면 이 작업을 위해 표시되어야 할 아이콘의 0 기준 인덱스를 명시할 수 있다. 리소스 파일이 하나의 아이콘만 가지고 있다면 이 속성은 0 이어야 한다.
MemoryUsageDetails Object

MemoryUsageDetails Object

  • count Number
  • size Number
  • liveSize Number
  • decodedSize Number
  • purgedSize Number
  • purgeableSize Number
Menu 메인 프로세스 네이티브 애플리케이션 메뉴와 컨텍스트 메뉴를 생성합니다.
MenuItem 메인 프로세스 네이티브 애플리케이션 메뉴와 컨텍스트 메뉴에 아이템을 추가합니다.
nativeImage 메인 프로세스, 렌더러 프로세스 PNG 또는 JPG 파일을 사용하여 트레이, 독, 애플리케이션 아이콘을 생성합니다.
powerMonitor 메인 프로세스 파워의 상태 변경을 모니터링합니다.
powerSaveBlocker 메인 프로세스 시스템이 저전력 (슬립) 모드로 진입하는 것을 막습니다.
process process 객체에 대한 확장 기능.
protocol 메인 프로세스 커스텀 프로토콜을 등록하거나 이미 존재하능 프로토콜의 요청의 동작을 변경합니다.
Rectangle Object

Rectangle Object

  • x Number - 사각형의 원점 x 좌표
  • y Number - 사각형의 원점 y 좌표
  • width Number
  • height Number
remote 렌더러 프로세스 메인 프로세스 모듈을 렌더러 프로세스에서 사용합니다.
screen 메인 프로세스, 렌더러 프로세스 화면 크기, 디스플레이, 커서 위치 등의 정보를 가져옵니다.
session 메인 프로세스 브라우저 세션, 쿠키, 캐시, 프록시 설정 등을 관리합니다.
shell 메인 프로세스, 렌더러 프로세스 파일과 URL을 각 기본 애플리케이션을 통해 관리합니다.
ShortcutDetails Object

ShortcutDetails Object

  • target String - 이 바로가기로부터 실행될 대상입니다.
  • cwd String (optional) - 작업 디렉토리입니다. 기본값은 없습니다.
  • args String (optional) - 이 바로가기로부터 실행될 때 target에 적용될 인수 값입니다. 기본값은 없습니다.
  • description String (optional) - 바로가기의 설명입니다. 기본값은 없습니다.
  • icon String (optional) - 아이콘의 경로입니다. DLL 또는 EXE가 될 수 있습니다. iconiconIndex는 항상 같이 설정되어야 합니다. 기본값은 없으며 target의 아이콘을 사용합니다.
  • iconIndex Integer (optional) - icon이 DLL 또는 EXE일 때 사용되는 아이콘의 리소스 ID이며 기본값은 0입니다.
  • appUserModelId String (optional) - 애플리케이션 사용자 모델 ID입니다. 기본값은 없습니다.
systemPreferences 메인 프로세스 시스템 설정을 가져옵니다.
Task Object

Task Object

  • program String - 실행할 프로그램의 경로. 보통 현재 작동중인 애플리케이션의 경로인 process.execPath를 지정합니다.
  • arguments String - program이 실행될 때 사용될 명령줄 인수.
  • title String - JumpList에 표시할 문자열.
  • description String - 이 작업에 대한 설명.
  • iconPath String - JumpList에 표시될 아이콘의 절대 경로. 아이콘을 포함하고 있는 임의의 리소스 파일을 사용할 수 있습니다. 보통 애플리케이션의 아이콘을 그대로 사용하기 위해 process.execPath를 지정합니다.
  • iconIndex Integer - 아이콘 파일의 인덱스. 만약 아이콘 파일이 두 개 이상의 아이콘을 가지고 있을 경우, 사용할 아이콘의 인덱스를 이 옵션으로 지정해 주어야 합니다. 단, 아이콘을 하나만 포함하고 있는 경우 0을 지정하면 됩니다.
ThumbarButton Object

ThumbarButton Object

  • icon NativeImage - The icon showing in thumbnail toolbar.
  • click Function
  • tooltip String (optional) - 버튼 툴팁 글자.
  • flags String[] (optional) - 버튼의 컨트롤 특유의 상태와 행동. 기본값은 ['enabled'].

flags 는 다음 String 들을 포함할 수 있는 배열입니다:

  • enabled - 버튼이 활성화되어 사용자가 이용할 수 있다.
  • disabled - 버튼이 비활성화 되어있습니다. 존재하지만 사용자 동작에 반응할 수 없는 시각 상태를 표시합니다.
  • dismissonclick - 버튼이 눌렸을 때 미리보기 창을 즉시 닫습니다.
  • nobackground - 버튼 테두리를 그리지 않고 이미지만 사용합니다.
  • hidden - 버튼이 사용자에게 보이지 않습니다.
  • noninteractive - 버튼이 활성화되어있지만 상호작용하지 않습니다; 눌려지지않은 버튼 상태로 그려집니다. 이 값은 버튼이 알림에 사용되는 경우를 위한 것입니다.
Tray 메인 프로세스 아이콘과 컨텍스트 메뉴를 시스템 알림 영역에 추가합니다.
webContents 메인 프로세스 웹 페이지를 렌더링하고 제어합니다.
webFrame 렌더러 프로세스 현재 웹 페이지의 렌더링 상태를 커스터마이즈합니다.
<webview> 태그 외부 웹 콘텐츠를 고립된 프레임과 프로세스에서 표시합니다.
window.open 함수 새 윈도우를 열고 URL을 로드합니다.