Skip to main content

ElectronAPI

FitFileViewer - API Documentation v29.8.0

FitFileViewer - API Documentation / preload / ElectronAPI

Interface: ElectronAPI

Defined in: preload.js:87

Properties​

approveRecentFile()​

approveRecentFile: (filePath: string) => Promise<boolean>

Defined in: preload.js:88

Parameters​

filePath​

string

Returns​

Promise<boolean>

openFile()​

openFile: () => Promise<string | null>

Defined in: preload.js:89

Returns​

Promise<string | null>

openFileDialog()​

openFileDialog: () => Promise<string | null>

Defined in: preload.js:90

Returns​

Promise<string | null>

openFolderDialog()​

openFolderDialog: () => Promise<string | null>

Defined in: preload.js:91

Returns​

Promise<string | null>

openOverlayDialog()​

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

Defined in: preload.js:92

Returns​

Promise<string[]>

readFile()​

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

Defined in: preload.js:93

Parameters​

filePath​

string

Returns​

Promise<ArrayBuffer>

parseFitFile()​

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

Defined in: preload.js:94

Parameters​

arrayBuffer​

ArrayBuffer

Returns​

Promise<any>

decodeFitFile()​

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

Defined in: preload.js:95

Parameters​

arrayBuffer​

ArrayBuffer

Returns​

Promise<any>

getFitBrowserFolder()​

getFitBrowserFolder: () => Promise<string | null>

Defined in: preload.js:96

Returns​

Promise<string | null>

listFitBrowserFolder()​

listFitBrowserFolder: (relPath?: string) => Promise<any>

Defined in: preload.js:97

Parameters​

relPath?​

string

Returns​

Promise<any>

isFitBrowserEnabled()​

isFitBrowserEnabled: () => Promise<boolean>

Defined in: preload.js:98

Returns​

Promise<boolean>

setFitBrowserEnabled()​

setFitBrowserEnabled: (enabled: boolean) => Promise<boolean>

Defined in: preload.js:99

Parameters​

enabled​

boolean

Returns​

Promise<boolean>

setFitBrowserFolder()​

setFitBrowserFolder: (folderPath: string) => Promise<boolean>

Defined in: preload.js:100

Parameters​

folderPath​

string

Returns​

Promise<boolean>

recentFiles()​

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

Defined in: preload.js:101

Returns​

Promise<string[]>

addRecentFile()​

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

Defined in: preload.js:102

Parameters​

filePath​

string

Returns​

Promise<string[]>

getTheme()​

getTheme: () => Promise<string>

Defined in: preload.js:103

Returns​

Promise<string>

sendThemeChanged()​

sendThemeChanged: (theme: string) => void

Defined in: preload.js:104

Parameters​

theme​

string

Returns​

void

getAppVersion()​

getAppVersion: () => Promise<string>

Defined in: preload.js:105

Returns​

Promise<string>

getElectronVersion()​

getElectronVersion: () => Promise<string>

Defined in: preload.js:106

Returns​

Promise<string>

getNodeVersion()​

getNodeVersion: () => Promise<string>

Defined in: preload.js:107

Returns​

Promise<string>

getChromeVersion()​

getChromeVersion: () => Promise<string>

Defined in: preload.js:108

Returns​

Promise<string>

getLicenseInfo()​

getLicenseInfo: () => Promise<string>

Defined in: preload.js:109

Returns​

Promise<string>

getPlatformInfo()​

getPlatformInfo: () => Promise<PlatformInfo>

Defined in: preload.js:110

Returns​

Promise<PlatformInfo>

openExternal()​

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

Defined in: preload.js:111

Parameters​

url​

string

Returns​

Promise<boolean>

startGyazoServer()​

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

Defined in: preload.js:112

Parameters​

port​

number

Returns​

Promise<GyazoServerStartResult>

stopGyazoServer()​

stopGyazoServer: () => Promise<GyazoServerStopResult>

Defined in: preload.js:113

Returns​

Promise<GyazoServerStopResult>

onMenuOpenFile()​

onMenuOpenFile: (callback: () => void) => () => void

Defined in: preload.js:114

Parameters​

callback​

() => void

Returns​

(): void

Returns​

void

onMenuOpenOverlay()​

onMenuOpenOverlay: (callback: () => void) => () => void

Defined in: preload.js:115

Parameters​

callback​

() => void

Returns​

(): void

Returns​

void

onOpenRecentFile()​

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

Defined in: preload.js:116

Parameters​

callback​

(filePath: string) => void

Returns​

(): void

Returns​

void

onSetTheme()​

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

Defined in: preload.js:117

Parameters​

callback​

(theme: string) => void

Returns​

(): void

Returns​

void

onOpenSummaryColumnSelector()​

onOpenSummaryColumnSelector: (callback: () => void) => () => void

Defined in: preload.js:118

Parameters​

callback​

() => void

Returns​

(): void

Returns​

void

onUpdateEvent()​

onUpdateEvent: (eventName: string, callback: (...args: any[]) => void) => () => void

Defined in: preload.js:119

Parameters​

eventName​

string

callback​

(...args: any[]) => void

Returns​

(): void

Returns​

void

checkForUpdates()​

checkForUpdates: () => void

Defined in: preload.js:120

Returns​

void

installUpdate()​

installUpdate: () => void

Defined in: preload.js:121

Returns​

void

setFullScreen()​

setFullScreen: (flag: boolean) => void

Defined in: preload.js:122

Parameters​

flag​

boolean

Returns​

void

onIpc()​

onIpc: (channel: string, callback: (event: object, ...args: any[]) => void) => void | () => void

Defined in: preload.js:123

Parameters​

channel​

string

callback​

(event: object, ...args: any[]) => void

Returns​

void | () => void

send()​

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

Defined in: preload.js:124

Parameters​

channel​

string

args​

...any[]

Returns​

void

invoke()​

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

Defined in: preload.js:125

Parameters​

channel​

string

args​

...any[]

Returns​

Promise<any>

notifyFitFileLoaded()​

notifyFitFileLoaded: (filePath: string | null) => void

Defined in: preload.js:126

Parameters​

filePath​

string | null

Returns​

void

injectMenu()​

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

Defined in: preload.js:127

Parameters​

theme?​

string | null

fitFilePath?​

string | null

Returns​

Promise<boolean>

getMainState()​

getMainState: (path?: string) => Promise<any>

Defined in: preload.js:128

Parameters​

path?​

string

Returns​

Promise<any>

setMainState()​

setMainState: (path: string, value: any, options?: any) => Promise<boolean>

Defined in: preload.js:129

Parameters​

path​

string

value​

any

options?​

any

Returns​

Promise<boolean>

listenToMainState()​

listenToMainState: (path: string, callback: (change: any) => void) => Promise<boolean>

Defined in: preload.js:130

Parameters​

path​

string

callback​

(change: any) => void

Returns​

Promise<boolean>

unlistenFromMainState()​

unlistenFromMainState: (path: string, callback: (change: any) => void) => Promise<boolean>

Defined in: preload.js:131

Parameters​

path​

string

callback​

(change: any) => void

Returns​

Promise<boolean>

subscribeToMainState()​

subscribeToMainState: (path: string, callback: (change: any) => void) => Promise<() => Promise<boolean>>

Defined in: preload.js:132

Parameters​

path​

string

callback​

(change: any) => void

Returns​

Promise<() => Promise<boolean>>

getOperation()​

getOperation: (operationId: string) => Promise<any>

Defined in: preload.js:133

Parameters​

operationId​

string

Returns​

Promise<any>

getOperations()​

getOperations: () => Promise<any>

Defined in: preload.js:134

Returns​

Promise<any>

getErrors()​

getErrors: (limit?: number) => Promise<any>

Defined in: preload.js:135

Parameters​

limit?​

number

Returns​

Promise<any>

getMetrics()​

getMetrics: () => Promise<any>

Defined in: preload.js:136

Returns​

Promise<any>

getChannelInfo()​

getChannelInfo: () => ChannelInfo

Defined in: preload.js:137

Returns​

ChannelInfo

validateAPI()​

validateAPI: () => boolean

Defined in: preload.js:138

Returns​

boolean