About
Support
Developer Guide
Version 22.3.18
Preparing search index...
The search index is not available
OpenFin Workspace Platform API
OpenFin Workspace Platform API
Image
Interface Image
Detailed metadata describing an image.
interface
Image
{
purpose
?:
string
;
size
?:
string
;
src
:
string
;
type
?:
string
;
}
Index
Properties
purpose?
size?
src
type?
Properties
Optional
purpose
purpose
?:
string
Optional
size
size
?:
string
src
src
:
string
Optional
type
type
?:
string
Settings
Theme
OS
Light
Dark
On This Page
Properties
purpose
size
src
type
OpenFin Workspace Platform API
Dock
DockInitOptions
init
AppManifestType
BrowserButtonType
ColorSchemeOptionType
CustomActionCallerType
GlobalContextMenuOptionType
PageChangeEventType
PageTabContextMenuOptionType
PanelPosition
SaveButtonContextMenuOptionType
ViewTabMenuOptionType
WindowType
Dock3Provider
AddToChanel
AnalyticsConfig
App
AppearanceContextMenuItemData
AppIntent
ApplySnapshotOptions
ApplyWorkspaceOptions
BaseThemeOptions
BrowserBookmarks
BrowserCreateViewPayload
BrowserCreateViewRequest
BrowserCreateWindowRequest
BrowserInitConfig
BrowserSnapshot
BrowserViewState
BrowserWindowFactory
BrowserWindowModule
BrowserWorkspacePlatformViewOptions
BrowserWorkspacePlatformWindowOptions
ContextMenuItemData
CopyPagePayload
CreateSavedPageRequest
CreateSavedWorkspaceRequest
CustomActionsMap
CustomActionSpecifier
CustomBrowserButtonConfig
CustomButtonActionPayload
CustomButtonConfig
CustomDropdownItemActionPayload
CustomPaletteSet
Dock3Config
GetCurrentWorkspaceOptions
GlobalContextMenuItemData
GlobalContextMenuOptionActionPayload
HandlePageChangesPayload
HandleSaveModalOnPageClosePayload
Image
LaunchAppRequest
LaunchBookmarkPayload
ModifiedPageState
NotificationIndicatorColorsSet
NotificationIndicatorColorsSetDarkScheme
NotificationIndicatorColorsSetLightScheme
OpenGlobalContextMenuRequest
OpenPageTabContextMenuRequest
OpenSaveButtonContextMenuRequest
OpenSaveContextMenuOptionActionPayload
OpenViewTabContextMenuRequest
Page
PageContextAddedDetails
PageContextRemovedDetails
PageLayoutDetails
PageTabContextMenuItemData
PageTabContextMenuItemTemplate
PageTabContextMenuOptionActionPayload
PanelConfigHorizontal
PanelConfigVertical
PreDefinedButtonConfig
ReorderPagesRequest
ReparentPageRequest
SaveButtonContextMenuItemData
SaveButtonContextMenuItemTemplate
SaveModalOnPageCloseResult
SetActivePageForWindowPayload
ShouldPageClosePayload
ShouldPageCloseResult
StoreCustomButtonActionPayload
ThemeApi
ThemeExtension
ToolbarOptions
UpdateAttachedPageRequest
UpdateSavedPageRequest
UpdateSavedWorkspaceRequest
UrlChangeDetails
ViewAddedDetails
ViewRemovedDetails
ViewsPreventingUnloadPayload
ViewTabCustomActionPayload
ViewTabMenuData
WindowStateButtonOptions
WorkflowIntegration
Workspace
WorkspaceContextMenuItemData
WorkspacePlatformInitConfig
WorkspacePlatformModule
WorkspacePlatformProvider
WorkspacePlatformStorage
WorkspaceThemeSet
AnalyticsEvent
ApplyWorkspacePayload
AttachedPage
BookmarkDockEntryPayload
BrowserOverrideCallback
BrowserSnapshotWindow
CustomActionPayload
CustomThemeOptions
CustomThemeOptionsWithScheme
CustomThemes
Dock3Button
Dock3ConstructorOverride
DockAllowedWindowOptions
ExtendedPanelConfig
GlobalContextMenuItemTemplate
IconSize
IconType
LaunchDockEntryPayload
Locale
LockUnlockPageConfig
NotificationIndicatorColorsWithScheme
OpenGlobalContextMenuPayload
OpenPageTabContextMenuPayload
OpenSaveButtonContextMenuPayload
OpenSaveWorkspaceMenuRequest
OpenViewTabContextMenuPayload
PageChangeEventDetails
PageLayout
PageWithUpdatableRuntimeAttribs
PanelConfig
RestoreLastSavedWorkspaceResult
SearchProviderFilter
ShowHideTabsConfig
TaskbarIcon
ToolbarButton
ViewTabContextMenuTemplate
WindowStateButton
WindowTitle
WorkspaceAsarAssetConfig
WorkspaceAsarPathConfig
WorkspacePlatformOverrideCallback
SUPPORTED_LANGUAGES
getCurrentSync
init
wrapSync
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R
Detailed metadata describing an image.