ElectronFitBrowserApi
FitFileViewer - API Documentation v30.0.1
FitFileViewer - API Documentation / shared/preloadApiDomains / ElectronFitBrowserApi
Interface: ElectronFitBrowserApi
Defined in: shared/preloadApiDomains.ts:114
Extended by
Properties
getFitBrowserFolder
getFitBrowserFolder: () =>
Promise<string|null>
Defined in: shared/preloadApiDomains.ts:116
Get the persisted FIT browser folder (main process setting).
Returns
Promise<string | null>
isFitBrowserEnabled
isFitBrowserEnabled: () =>
Promise<FitBrowserEnabledResponse>
Defined in: shared/preloadApiDomains.ts:117
Returns
Promise<FitBrowserEnabledResponse>
listFitBrowserFolder
listFitBrowserFolder: (
relPath?:string) =>Promise<FitBrowserListFolderResult>
Defined in: shared/preloadApiDomains.ts:119
List entries under the persisted FIT browser folder.
Parameters
relPath?
string
Returns
Promise<FitBrowserListFolderResult>
onFitBrowserEnabledChanged
onFitBrowserEnabledChanged: (
callback: (enabled:boolean) =>void) => () =>void
Defined in: shared/preloadApiDomains.ts:122
Parameters
callback
(enabled: boolean) => void
Returns
() => void
setFitBrowserEnabled
setFitBrowserEnabled: (
enabled:boolean) =>Promise<FitBrowserEnabledResponse>
Defined in: shared/preloadApiDomains.ts:125
Parameters
enabled
boolean
Returns
Promise<FitBrowserEnabledResponse>
setFitBrowserFolder
setFitBrowserFolder: (
folderPath:string) =>Promise<boolean>
Defined in: shared/preloadApiDomains.ts:128
Parameters
folderPath
string
Returns
Promise<boolean>