CustomWindowConfig

Config used to open a Custom Window

TypeScript

export interface

Properties

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

React, Angular or Vue Framework component to use for Custom Window content

TypeScript

frameworkComponent?: AdaptableFrameworkComponent;

Icon to display in Custom Window header

TypeScript

icon?: AdaptableSystemIconName;

Unique identifier for Custom Window

TypeScript

id: string;

string

Callback function invoked when framework component is destroyed

TypeScript

onFrameworkComponentDestroyed?: () => void;

() => void

Position of window in pixels (provided as x, y)

TypeScript

position?: WindowPosition;

Render function to display content in Custom Window (if not using a framework component)

TypeScript

render?: (customRenderContext: CustomRenderContext) => string | null;

(customRenderContext:CustomRenderContext) => string | null

Size of window in pixels (provided as width, height)

TypeScript

size?: WindowSize;

Title of Custom Window

TypeScript

title?: string;

string