ElectronAPI

FitFileViewer - API Documentation v29.4.0

---

FitFileViewer - API Documentation / preload / ElectronAPI

Interface: ElectronAPI

Defined in: preload.js:69

Properties

openFile()

openFile: () => Promise<string[]>

Defined in: preload.js:70

Returns

Promise<string[]>

---

openFileDialog()

openFileDialog: () => Promise<string[]>

Defined in: preload.js:71

Returns

Promise<string[]>

---

openOverlayDialog()

openOverlayDialog: () => Promise<string[]>

Defined in: preload.js:72

Returns

Promise<string[]>

---

readFile()

readFile: (filePath: string) => Promise<ArrayBuffer>

Defined in: preload.js:73

Parameters

filePath

string

Returns

Promise<ArrayBuffer>

---

parseFitFile()

parseFitFile: (arrayBuffer: ArrayBuffer) => Promise<any>

Defined in: preload.js:74

Parameters

arrayBuffer

ArrayBuffer

Returns

Promise<any>

---

decodeFitFile()

decodeFitFile: (arrayBuffer: ArrayBuffer) => Promise<any>

Defined in: preload.js:75

Parameters

arrayBuffer

ArrayBuffer

Returns

Promise<any>

---

recentFiles()

recentFiles: () => Promise<string[]>

Defined in: preload.js:76

Returns

Promise<string[]>

---

addRecentFile()

addRecentFile: (filePath: string) => Promise<string[]>

Defined in: preload.js:77

Parameters

filePath

string

Returns

Promise<string[]>

---

getTheme()

getTheme: () => Promise<string>

Defined in: preload.js:78

Returns

Promise<string>

---

sendThemeChanged()

sendThemeChanged: (theme: string) => void

Defined in: preload.js:79

Parameters

theme

string

Returns

void

---

getAppVersion()

getAppVersion: () => Promise<string>

Defined in: preload.js:80

Returns

Promise<string>

---

getElectronVersion()

getElectronVersion: () => Promise<string>

Defined in: preload.js:81

Returns

Promise<string>

---

getNodeVersion()

getNodeVersion: () => Promise<string>

Defined in: preload.js:82

Returns

Promise<string>

---

getChromeVersion()

getChromeVersion: () => Promise<string>

Defined in: preload.js:83

Returns

Promise<string>

---

getLicenseInfo()

getLicenseInfo: () => Promise<string>

Defined in: preload.js:84

Returns

Promise<string>

---

getPlatformInfo()

getPlatformInfo: () => Promise<PlatformInfo>

Defined in: preload.js:85

Returns

Promise<PlatformInfo>

---

openExternal()

openExternal: (url: string) => Promise<boolean>

Defined in: preload.js:86

Parameters

url

string

Returns

Promise<boolean>

---

startGyazoServer()

startGyazoServer: (port: number) => Promise<GyazoServerStartResult>

Defined in: preload.js:87

Parameters

port

number

Returns

Promise<GyazoServerStartResult>

---

stopGyazoServer()

stopGyazoServer: () => Promise<GyazoServerStopResult>

Defined in: preload.js:88

Returns

Promise<GyazoServerStopResult>

---

onMenuOpenFile()

onMenuOpenFile: (callback: Function) => void

Defined in: preload.js:89

Parameters

callback

Function

Returns

void

---

onMenuOpenOverlay()

onMenuOpenOverlay: (callback: Function) => void

Defined in: preload.js:90

Parameters

callback

Function

Returns

void

---

onOpenRecentFile()

onOpenRecentFile: (callback: (filePath: string) => void) => void

Defined in: preload.js:91

Parameters

callback

(filePath: string) => void

Returns

void

---

onSetTheme()

onSetTheme: (callback: (theme: string) => void) => void

Defined in: preload.js:92

Parameters

callback

(theme: string) => void

Returns

void

---

onOpenSummaryColumnSelector()

onOpenSummaryColumnSelector: (callback: Function) => void

Defined in: preload.js:93

Parameters

callback

Function

Returns

void

---

onUpdateEvent()

onUpdateEvent: (eventName: string, callback: Function) => void

Defined in: preload.js:94

Parameters

eventName

string

callback

Function

Returns

void

---

checkForUpdates()

checkForUpdates: () => void

Defined in: preload.js:95

Returns

void

---

installUpdate()

installUpdate: () => void

Defined in: preload.js:96

Returns

void

---

setFullScreen()

setFullScreen: (flag: boolean) => void

Defined in: preload.js:97

Parameters

flag

boolean

Returns

void

---

onIpc()

onIpc: (channel: string, callback: Function) => void

Defined in: preload.js:98

Parameters

channel

string

callback

Function

Returns

void

---

send()

send: (channel: string, ...args: any[]) => void

Defined in: preload.js:99

Parameters

channel

string

args

...any[]

Returns

void

---

invoke()

invoke: (channel: string, ...args: any[]) => Promise<any>

Defined in: preload.js:100

Parameters

channel

string

args

...any[]

Returns

Promise<any>

---

injectMenu()

injectMenu: (theme?: string | null, fitFilePath?: string | null) => Promise<boolean>

Defined in: preload.js:101

Parameters

theme?

string | null

fitFilePath?

string | null

Returns

Promise<boolean>

---

getChannelInfo()

getChannelInfo: () => ChannelInfo

Defined in: preload.js:102

Returns

ChannelInfo

---

validateAPI()

validateAPI: () => boolean

Defined in: preload.js:103

Returns

boolean