CustomWindowConfig
Config used to open a Custom Window
TypeScript
export interfaceProperties
| Property | Description |
|---|---|
| frameworkComponent | React, Angular or Vue Framework component to use for Custom Window content |
| icon | Icon to display in Custom Window header |
| id | Unique identifier for Custom Window |
| onFrameworkComponentDestroyed | Callback function invoked when framework component is destroyed |
| position | Position of window in pixels (provided as x, y) |
| render | Render function to display content in Custom Window (if not using a framework component) |
| size | Size of window in pixels (provided as width, height) |
| title | Title of Custom Window |
Property Details
frameworkComponent
React, Angular or Vue Framework component to use for Custom Window content
TypeScript
frameworkComponent?: AdaptableFrameworkComponent;Property Value
icon
Icon to display in Custom Window header
TypeScript
icon?: AdaptableSystemIconName;Property Value
id
Unique identifier for Custom Window
TypeScript
id: string;Property Value
string
onFrameworkComponentDestroyed
Callback function invoked when framework component is destroyed
TypeScript
onFrameworkComponentDestroyed?: () => void;Property Value
() => void
position
Position of window in pixels (provided as x, y)
TypeScript
position?: WindowPosition;Property Value
render
Render function to display content in Custom Window (if not using a framework component)
TypeScript
render?: (customRenderContext: CustomRenderContext) => string | null;Property Value
(customRenderContext:CustomRenderContext) => string | null
size
Size of window in pixels (provided as width, height)
TypeScript
size?: WindowSize;Property Value
title
Title of Custom Window
TypeScript
title?: string;Property Value
string