@openfin/fdc3-api 36.80.25 → 37.80.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -42,15 +42,6 @@ declare type Accelerator = {
42
42
  zoom: boolean;
43
43
  };
44
44
 
45
- /**
46
- * Generated when a View is added to a layout.
47
- * @interface
48
- */
49
- declare type AddedToLayoutEvent = BaseEvent_4 & {
50
- type: 'added-to-layout';
51
- layoutIdentity: OpenFin.LayoutIdentity;
52
- };
53
-
54
45
  /**
55
46
  * Options to use when adding a view to a {@link TabStack}.
56
47
  *
@@ -85,42 +76,14 @@ declare type AnchorType = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-rig
85
76
 
86
77
  declare type AnyStrategy = ClassicStrategy | RTCStrategy | CombinedStrategy<PayloadTypeByStrategy<RTCStrategy>, PayloadTypeByStrategy<ClassicStrategy>>;
87
78
 
88
- /**
89
- * @deprecated Renamed to {@link ApiSettings}.
90
- */
91
- declare type Api = ApiSettings;
92
-
93
- declare type ApiCall<Request, Response> = {
94
- request: Request;
95
- response: Response;
96
- };
97
-
98
- declare type ApiClient<T extends Record<any, any>> = {
99
- [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
100
- };
101
-
102
- /**
103
- * @deprecated Renamed to {@link DomainApiSettings}.
104
- */
105
- declare type ApiInjection = DomainApiSettings;
106
-
107
- /**
108
- * Generated when a new Platform's API becomes responsive.
109
- * @interface
110
- */
111
- declare type ApiReadyEvent = BaseEvents.BaseEvent & {
112
- topic: 'application';
113
- type: 'platform-api-ready';
114
- };
115
-
116
79
  /**
117
80
  * Configurations for API injection.
118
81
  *
119
82
  * @interface
120
83
  */
121
- declare type ApiSettings = {
84
+ declare type Api = {
122
85
  /**
123
- * Configure conditional injection of OpenFin API into iframes
86
+ * Configure injection of OpenFin API into iframes based on domain
124
87
  */
125
88
  iframe?: {
126
89
  /**
@@ -151,6 +114,41 @@ declare type ApiSettings = {
151
114
  fin?: InjectionType;
152
115
  };
153
116
 
117
+ declare type ApiCall<Request, Response> = {
118
+ request: Request;
119
+ response: Response;
120
+ };
121
+
122
+ declare type ApiClient<T extends Record<any, any>> = {
123
+ [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
124
+ };
125
+
126
+ /**
127
+ * @interface
128
+ *
129
+ * Rules for domain-conditional `fin` API injection.
130
+ */
131
+ declare type ApiInjection = {
132
+ /**
133
+ * Injection setting for the `fin` API for contexts on a matched domain.
134
+ *
135
+ * * 'none': The `fin` API will be not available.
136
+ * * 'global': The entire `fin` API will be available.
137
+ *
138
+ * @defaultValue 'global'
139
+ */
140
+ fin: InjectionType;
141
+ };
142
+
143
+ /**
144
+ * Generated when a new Platform's API becomes responsive.
145
+ * @interface
146
+ */
147
+ declare type ApiReadyEvent = BaseEvent & {
148
+ topic: 'application';
149
+ type: 'platform-api-ready';
150
+ };
151
+
154
152
  /**
155
153
  * @interface
156
154
  */
@@ -945,7 +943,7 @@ declare namespace ApplicationEvents {
945
943
  PropagatedApplicationEvent,
946
944
  PropagatedEventType_3 as PropagatedEventType,
947
945
  PropagatedApplicationEventType,
948
- Payload_5 as Payload,
946
+ Payload_4 as Payload,
949
947
  ByType_3 as ByType
950
948
  }
951
949
  }
@@ -968,7 +966,7 @@ declare type ApplicationIdentity_2 = {
968
966
  * @interface
969
967
  */
970
968
  declare type ApplicationInfo = {
971
- initialOptions: ApplicationCreationOptions | PlatformOptions;
969
+ initialOptions: ApplicationCreationOptions;
972
970
  launchMode: string;
973
971
  manifest: Manifest & {
974
972
  [key: string]: any;
@@ -1187,14 +1185,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1187
1185
  */
1188
1186
  mainWindowOptions: WindowCreationOptions;
1189
1187
  /**
1190
- * The name of the application.
1191
- *
1192
- * @remarks
1193
- * This property is used for naming the application logging folder, which will be sanitized to remove
1194
- * any special characters, spaces or international characters. It's also used in error messages, API
1195
- * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1188
+ * The name of the application (and the application's main window).
1196
1189
  *
1197
- * This property will be deprecated in the future.
1190
+ * If provided, _must_ match `uuid`.
1198
1191
  */
1199
1192
  name: string;
1200
1193
  /**
@@ -1224,7 +1217,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1224
1217
  url: string;
1225
1218
  /**
1226
1219
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1227
- * running in the OpenFin Runtime.
1220
+ * running in the OpenFin Runtime.
1221
+ *
1222
+ * Note that `name` and `uuid` must match.
1228
1223
  */
1229
1224
  uuid: string;
1230
1225
  /**
@@ -1285,10 +1280,6 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1285
1280
  * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1286
1281
  */
1287
1282
  domainSettings: DomainSettings;
1288
- /**
1289
- * The permissions for secured APIs.
1290
- */
1291
- permissions?: Partial<Permissions_2>;
1292
1283
  /**
1293
1284
  * @defaultValue false
1294
1285
  *
@@ -1784,7 +1775,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1784
1775
  * A base Channel event.
1785
1776
  * @interface
1786
1777
  */
1787
- declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1778
+ declare type BaseEvent_2 = NamedEvent & {
1788
1779
  channelName: string;
1789
1780
  channelId: string;
1790
1781
  };
@@ -1854,7 +1845,6 @@ declare namespace BaseEvents {
1854
1845
  NotCloseRequested,
1855
1846
  PropagatedEventType,
1856
1847
  PropagatedEvent,
1857
- Payload_2 as Payload,
1858
1848
  EventHandler,
1859
1849
  BaseEvent,
1860
1850
  IdentityEvent,
@@ -1988,6 +1978,48 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1988
1978
  behavior: 'browser';
1989
1979
  };
1990
1980
 
1981
+ declare interface BrowserWindow {
1982
+ /**
1983
+ * True if the window has been opened and its GoldenLayout instance initialised.
1984
+ */
1985
+ isInitialised: boolean;
1986
+
1987
+ /**
1988
+ * Creates a window configuration object from the Popout.
1989
+ */
1990
+ toConfig(): {
1991
+ dimensions: {
1992
+ width: number;
1993
+ height: number;
1994
+ left: number;
1995
+ top: number;
1996
+ };
1997
+ content: Config;
1998
+ parentId: string;
1999
+ indexInParent: number;
2000
+ };
2001
+
2002
+ /**
2003
+ * Returns the GoldenLayout instance from the child window
2004
+ */
2005
+ getGlInstance(): GoldenLayout_2;
2006
+
2007
+ /**
2008
+ * Returns the native Window object
2009
+ */
2010
+ getWindow(): Window;
2011
+
2012
+ /**
2013
+ * Closes the popout
2014
+ */
2015
+ close(): void;
2016
+
2017
+ /**
2018
+ * Returns the popout to its original position as specified in parentId and indexInParent
2019
+ */
2020
+ popIn(): void;
2021
+ }
2022
+
1991
2023
  /**
1992
2024
  * Extracts a single event type matching the given key from the View {@link Event} union.
1993
2025
  *
@@ -1995,7 +2027,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1995
2027
  *
1996
2028
  * @typeParam Type String key specifying the event to extract
1997
2029
  */
1998
- declare type ByType<Type extends EventType> = Payload_3<Type>;
2030
+ declare type ByType<Type extends EventType> = Payload_2<Type>;
1999
2031
 
2000
2032
  /**
2001
2033
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -2004,7 +2036,7 @@ declare type ByType<Type extends EventType> = Payload_3<Type>;
2004
2036
  *
2005
2037
  * @typeParam Type String key specifying the event to extract
2006
2038
  */
2007
- declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
2039
+ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
2008
2040
 
2009
2041
  /**
2010
2042
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -2013,7 +2045,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
2013
2045
  *
2014
2046
  * @typeParam Type String key specifying the event to extract
2015
2047
  */
2016
- declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
2048
+ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
2017
2049
 
2018
2050
  /**
2019
2051
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -2022,7 +2054,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
2022
2054
  *
2023
2055
  * @typeParam Type String key specifying the event to extract
2024
2056
  */
2025
- declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
2057
+ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2026
2058
 
2027
2059
  /**
2028
2060
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -2031,7 +2063,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
2031
2063
  *
2032
2064
  * @typeParam Type String key specifying the event to extract
2033
2065
  */
2034
- declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
2066
+ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2035
2067
 
2036
2068
  /**
2037
2069
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -2040,7 +2072,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
2040
2072
  *
2041
2073
  * @typeParam Type String key specifying the event to extract
2042
2074
  */
2043
- declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
2075
+ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2044
2076
 
2045
2077
  /**
2046
2078
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -2049,7 +2081,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
2049
2081
  *
2050
2082
  * @typeParam Type String key specifying the event to extract
2051
2083
  */
2052
- declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
2084
+ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2053
2085
 
2054
2086
  /**
2055
2087
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -2058,7 +2090,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
2058
2090
  *
2059
2091
  * @typeParam Type String key specifying the event to extract
2060
2092
  */
2061
- declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
2093
+ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2062
2094
 
2063
2095
  /**
2064
2096
  * Configuration for page capture.
@@ -3407,6 +3439,31 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3407
3439
  close(): Promise<void>;
3408
3440
  }
3409
3441
 
3442
+ declare interface ComponentConfig extends ItemConfig {
3443
+ /**
3444
+ * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3445
+ */
3446
+ componentName: string;
3447
+
3448
+ /**
3449
+ * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3450
+ * container.getState().
3451
+ */
3452
+ componentState?: any;
3453
+ }
3454
+
3455
+ declare interface Config {
3456
+ settings?: Settings;
3457
+ dimensions?: Dimensions;
3458
+ labels?: Labels;
3459
+ content?: ItemConfigType[];
3460
+ /**
3461
+ * (Only on layout config object)
3462
+ * Id of the currently maximised content item
3463
+ */
3464
+ maximisedItemId?: string;
3465
+ }
3466
+
3410
3467
  declare type ConfigWithRuntime = BaseConfig & {
3411
3468
  runtime: RuntimeConfig;
3412
3469
  };
@@ -3461,7 +3518,7 @@ declare type ConstViewOptions = {
3461
3518
  /**
3462
3519
  * Configurations for API injection.
3463
3520
  */
3464
- api: ApiSettings;
3521
+ api: Api;
3465
3522
  /**
3466
3523
  * The name of the view.
3467
3524
  */
@@ -3694,9 +3751,7 @@ declare type ConstWindowOptions = {
3694
3751
  */
3695
3752
  preloadScripts: PreloadScript[];
3696
3753
  /**
3697
- * String tag that attempts to group like-tagged renderers together.
3698
- * However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.
3699
- * @remarks Will only be used if pages are on the same origin.
3754
+ * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
3700
3755
  */
3701
3756
  processAffinity: string;
3702
3757
  /**
@@ -3780,18 +3835,106 @@ declare type ConstWindowOptions = {
3780
3835
  * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
3781
3836
  */
3782
3837
  viewVisibility?: ViewVisibilityOptions;
3838
+ };
3839
+
3840
+ declare interface Container extends EventEmitter_2 {
3783
3841
  /**
3784
- * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3842
+ * The current width of the container in pixel
3785
3843
  */
3786
- inheritance?: Partial<InheritableOptions>;
3787
- };
3844
+ width: number;
3788
3845
 
3789
- declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3846
+ /**
3847
+ * The current height of the container in pixel
3848
+ */
3849
+ height: number;
3790
3850
 
3791
- /**
3792
- * @deprecated Renamed to {@link ContentCreationBehavior}.
3793
- */
3794
- declare type ContentCreationBehaviorNames = ContentCreationBehavior;
3851
+ /**
3852
+ * A reference to the component-item that controls this container
3853
+ */
3854
+ parent: ContentItem;
3855
+
3856
+ /**
3857
+ * A reference to the tab that controls this container. Will initially be null
3858
+ * (and populated once a tab event has been fired).
3859
+ */
3860
+ tab: Tab;
3861
+
3862
+ /**
3863
+ * The current title of the container
3864
+ */
3865
+ title: string;
3866
+
3867
+ /*
3868
+ * A reference to the GoldenLayout instance this container belongs to
3869
+ */
3870
+ layoutManager: GoldenLayout_2;
3871
+
3872
+ /**
3873
+ * True if the item is currently hidden
3874
+ */
3875
+ isHidden: boolean;
3876
+
3877
+ /**
3878
+ * Overwrites the components state with the provided value. To only change parts of the componentState see
3879
+ * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3880
+ * value of componentState when layout.toConfig() is called and will be passed back to the component's
3881
+ * constructor function. It will also be used when the component is opened in a new window.
3882
+ * @param state A serialisable object
3883
+ */
3884
+ setState(state: any): void;
3885
+
3886
+ /**
3887
+ * The same as setState but does not emit 'stateChanged' event
3888
+ * @param {serialisable} state
3889
+ */
3890
+ setStateSkipEvent(state: any): void;
3891
+
3892
+ /**
3893
+ * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3894
+ * @param state A serialisable object
3895
+ */
3896
+ extendState(state: any): void;
3897
+
3898
+ /**
3899
+ * Returns the current state.
3900
+ */
3901
+ getState(): any;
3902
+
3903
+ /**
3904
+ * Returns the container's inner element as a jQuery element
3905
+ */
3906
+ getElement(): JQuery;
3907
+
3908
+ /**
3909
+ * hides the container or returns false if hiding it is not possible
3910
+ */
3911
+ hide(): boolean;
3912
+
3913
+ /**
3914
+ * shows the container or returns false if showing it is not possible
3915
+ */
3916
+ show(): boolean;
3917
+
3918
+ /**
3919
+ * Sets the container to the specified size or returns false if that's not possible
3920
+ * @param width the new width in pixel
3921
+ * @param height the new height in pixel
3922
+ */
3923
+ setSize(width: number, height: number): boolean;
3924
+
3925
+ /**
3926
+ * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3927
+ * @param title the new title
3928
+ */
3929
+ setTitle(title: string): void;
3930
+
3931
+ /**
3932
+ * Closes the container or returns false if that is not possible
3933
+ */
3934
+ close(): boolean;
3935
+ }
3936
+
3937
+ declare type ContentCreationBehaviorNames = 'window' | 'view' | 'block' | 'browser';
3795
3938
 
3796
3939
  /**
3797
3940
  * Configures how new content (e,g, from `window.open` or a link) is opened.
@@ -3815,7 +3958,7 @@ declare type ContentCreationOptions = {
3815
3958
  * @typeParam Behavior The way content governed by this rule will be created. If provided, this type will narrow to
3816
3959
  * the specified `behavior` key.
3817
3960
  */
3818
- declare type ContentCreationRule<Behavior extends ContentCreationBehavior = ContentCreationBehavior> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3961
+ declare type ContentCreationRule<Behavior extends ContentCreationBehaviorNames = ContentCreationBehaviorNames> = Extract<WindowContentCreationRule | ViewContentCreationRule | BrowserContentCreationRule | BlockedContentCreationRule, {
3819
3962
  behavior: Behavior;
3820
3963
  }>;
3821
3964
 
@@ -3848,6 +3991,218 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3848
3991
  disposition: string;
3849
3992
  };
3850
3993
 
3994
+ declare interface ContentItem extends EventEmitter_2 {
3995
+ instance: any;
3996
+ header: any;
3997
+ _splitter: any;
3998
+ /**
3999
+ * This items configuration in its current state
4000
+ */
4001
+ config: ItemConfigType;
4002
+
4003
+ /**
4004
+ * The type of the item. Can be row, column, stack, component or root
4005
+ */
4006
+ type: ItemType;
4007
+
4008
+ /**
4009
+ * An array of items that are children of this item
4010
+ */
4011
+ contentItems: ContentItem[];
4012
+
4013
+ container: Container;
4014
+ /**
4015
+ * The item that is this item's parent (or null if the item is root)
4016
+ */
4017
+ parent: ContentItem;
4018
+
4019
+ /**
4020
+ * A String or array of identifiers if provided in the configuration
4021
+ */
4022
+ id: string;
4023
+
4024
+ /**
4025
+ * True if the item had been initialised
4026
+ */
4027
+ isInitialised: boolean;
4028
+
4029
+ /**
4030
+ * True if the item is maximised
4031
+ */
4032
+ isMaximised: boolean;
4033
+
4034
+ /**
4035
+ * True if the item is the layout's root item
4036
+ */
4037
+ isRoot: boolean;
4038
+
4039
+ /**
4040
+ * True if the item is a row
4041
+ */
4042
+ isRow: boolean;
4043
+
4044
+ /**
4045
+ * True if the item is a column
4046
+ */
4047
+ isColumn: boolean;
4048
+
4049
+ /**
4050
+ * True if the item is a stack
4051
+ */
4052
+ isStack: boolean;
4053
+
4054
+ /**
4055
+ * True if the item is a component
4056
+ */
4057
+ isComponent: boolean;
4058
+
4059
+ /**
4060
+ * A reference to the layoutManager that controls this item
4061
+ */
4062
+ layoutManager: any;
4063
+
4064
+ /**
4065
+ * The item's outer element
4066
+ */
4067
+ element: JQuery;
4068
+
4069
+ /**
4070
+ * The item's inner element. Can be the same as the outer element.
4071
+ */
4072
+ childElementContainer: Container;
4073
+
4074
+ /**
4075
+ * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4076
+ * from its original position before adding it to this item.
4077
+ * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4078
+ * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4079
+ */
4080
+ addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4081
+
4082
+ /**
4083
+ * Destroys the item and all it's children
4084
+ * @param contentItem The contentItem that should be removed
4085
+ * @param keepChild If true the item won't be destroyed. (Use cautiosly, if the item isn't destroyed it's up to you to destroy it later). Default: false.
4086
+ */
4087
+ removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4088
+
4089
+ /**
4090
+ * The contentItem that should be removed
4091
+ * @param oldChild ContentItem The contentItem that should be removed
4092
+ * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4093
+ */
4094
+ replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4095
+
4096
+ /**
4097
+ * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4098
+ */
4099
+ setSize(): void;
4100
+
4101
+ /**
4102
+ * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4103
+ * @param title the new title
4104
+ */
4105
+ setTitle(title: string): void;
4106
+
4107
+ /**
4108
+ * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4109
+ * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4110
+ * @param functionName The name of the method to invoke
4111
+ * @param functionArguments An array of arguments to pass to every function
4112
+ * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4113
+ * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4114
+ */
4115
+ callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4116
+
4117
+ /**
4118
+ * Emits an event that bubbles up the item tree until it reaches the root element (and after a delay the layout manager). Useful e.g. for indicating state changes.
4119
+ */
4120
+ emitBubblingEvent(name: string): void;
4121
+
4122
+ /**
4123
+ * Convenience method for item.parent.removeChild( item )
4124
+ */
4125
+ remove(): void;
4126
+
4127
+ /**
4128
+ * Removes the item from its current position in the layout and opens it in a window
4129
+ */
4130
+ popout(): BrowserWindow;
4131
+
4132
+ /**
4133
+ * Maximises the item or minimises it if it's already maximised
4134
+ */
4135
+ toggleMaximise(): void;
4136
+
4137
+ /**
4138
+ * Selects the item. Only relevant if settings.selectionEnabled is set to true
4139
+ */
4140
+ select(): void;
4141
+
4142
+ /**
4143
+ * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4144
+ */
4145
+ deselect(): void;
4146
+
4147
+ /**
4148
+ * Returns true if the item has the specified id or false if not
4149
+ * @param id An id to check for
4150
+ */
4151
+ hasId(id: string): boolean;
4152
+
4153
+ /**
4154
+ * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4155
+ * @param contentItem The new active content item
4156
+ * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4157
+ */
4158
+ // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4159
+ setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4160
+
4161
+ /**
4162
+ * Only Stacks have this method! Returns the currently selected contentItem.
4163
+ */
4164
+ getActiveContentItem(): ContentItem;
4165
+
4166
+ /**
4167
+ * Adds an id to an item or does nothing if the id is already present
4168
+ * @param id The id to be added
4169
+ */
4170
+ addId(id: string): void;
4171
+
4172
+ /**
4173
+ * Removes an id from an item or throws an error if the id couldn't be found
4174
+ * @param id The id to be removed
4175
+ */
4176
+ removeId(id: string): void;
4177
+
4178
+ /**
4179
+ * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4180
+ * @param filterFunction A function that determines whether an item matches certain criteria
4181
+ */
4182
+ getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4183
+
4184
+ /**
4185
+ * Returns all items with the specified id.
4186
+ * @param id An id specified in the itemConfig
4187
+ */
4188
+ getItemsById(id: string | string[]): ContentItem[];
4189
+
4190
+ /**
4191
+ * Returns all items with the specified type
4192
+ * @param type 'row', 'column', 'stack', 'component' or 'root'
4193
+ */
4194
+ getItemsByType(type: string): ContentItem[];
4195
+
4196
+ /**
4197
+ * Returns all instances of the component with the specified componentName
4198
+ * @param componentName a componentName as specified in the itemConfig
4199
+ */
4200
+ getComponentsByName(componentName: string): any;
4201
+
4202
+ _contentAreaDimensions: any;
4203
+ _$getArea: () => any;
4204
+ }
4205
+
3851
4206
  /**
3852
4207
  * Restrict navigation to URLs that match an allowed pattern.
3853
4208
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4332,6 +4687,46 @@ declare type DidFinishLoadEvent = NamedEvent & {
4332
4687
  type: 'did-finish-load';
4333
4688
  };
4334
4689
 
4690
+ declare interface Dimensions {
4691
+ /**
4692
+ * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4693
+ * than the visible one, making it safe to set this to small values without affecting usability.
4694
+ * Default: 5
4695
+ */
4696
+ borderWidth?: number;
4697
+
4698
+ /**
4699
+ * The minimum height an item can be resized to (in pixel).
4700
+ * Default: 10
4701
+ */
4702
+ minItemHeight?: number;
4703
+
4704
+ /**
4705
+ * The minimum width an item can be resized to (in pixel).
4706
+ * Default: 10
4707
+ */
4708
+ minItemWidth?: number;
4709
+
4710
+ /**
4711
+ * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4712
+ * adjusted accordingly.
4713
+ * Default: 20
4714
+ */
4715
+ headerHeight?: number;
4716
+
4717
+ /**
4718
+ * The width of the element that appears when an item is dragged (in pixel).
4719
+ * Default: 300
4720
+ */
4721
+ dragProxyWidth?: number;
4722
+
4723
+ /**
4724
+ * The height of the element that appears when an item is dragged (in pixel).
4725
+ * Default: 200
4726
+ */
4727
+ dragProxyHeight?: number;
4728
+ }
4729
+
4335
4730
  /**
4336
4731
  * @interface
4337
4732
  */
@@ -4448,25 +4843,6 @@ declare type DisplayMetadata_3 = {
4448
4843
  readonly glyph?: string;
4449
4844
  };
4450
4845
 
4451
- /**
4452
- * @interface
4453
- *
4454
- * Rules for domain-conditional `fin` API injection.
4455
- *
4456
- * @remarks Subset of {@link DomainSettings}.
4457
- */
4458
- declare type DomainApiSettings = {
4459
- /**
4460
- * Injection setting for the `fin` API for contexts on a matched domain.
4461
- *
4462
- * * 'none': The `fin` API will be not available.
4463
- * * 'global': The entire `fin` API will be available.
4464
- *
4465
- * @defaultValue 'global'
4466
- */
4467
- fin: InjectionType;
4468
- };
4469
-
4470
4846
  /**
4471
4847
  * @interface
4472
4848
  * Defines application settings that vary by the domain of the current context.
@@ -4505,7 +4881,7 @@ declare type DomainSettingsRule = {
4505
4881
  /**
4506
4882
  * {@inheritDoc ApiInjection}
4507
4883
  */
4508
- api?: DomainApiSettings;
4884
+ api?: ApiInjection;
4509
4885
  };
4510
4886
  };
4511
4887
 
@@ -4544,19 +4920,18 @@ declare type DownloadPreloadOption = {
4544
4920
  /**
4545
4921
  * @interface
4546
4922
  *
4547
- * A rule that governs download behavior, discriminated by the URL of the download.
4923
+ * A rule governing domain-conditional download behavior.
4548
4924
  */
4549
4925
  declare type DownloadRule = {
4550
4926
  /**
4551
- * {@inheritDoc FileDownloadBehavior}
4927
+ * {@inheritDoc FileDownloadBehaviorNames}
4552
4928
  */
4553
- behavior: FileDownloadBehavior;
4929
+ behavior: FileDownloadBehaviorNames;
4554
4930
  /**
4555
4931
  * Array of [match patterns](https://developer.chrome.com/docs/extensions/develop/concepts/match-patterns) specifying
4556
- * URL(s) of the resource(s) being downloaded.
4932
+ * the domain(s) for which the rule applies.
4557
4933
  *
4558
- * @remarks The match is evaluated against the URL of the *file*, which is not necessarily the same as that
4559
- * of the page in which a file download link is embedded.
4934
+ * @remarks The match is evaluated against the URL of the *download*.
4560
4935
  */
4561
4936
  match: string[];
4562
4937
  };
@@ -4628,6 +5003,8 @@ declare type Dpi = {
4628
5003
  vertical?: number;
4629
5004
  };
4630
5005
 
5006
+ declare interface DragSource {}
5007
+
4631
5008
  /**
4632
5009
  * Generated when a window has been embedded.
4633
5010
  * @interface
@@ -4895,7 +5272,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
4895
5272
  */
4896
5273
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4897
5274
  target: OpenFin.Identity;
4898
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
5275
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4899
5276
 
4900
5277
  /**
4901
5278
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -4903,7 +5280,7 @@ declare type Event_4 = (WebContentsEvents.Event<'view'> & {
4903
5280
  */
4904
5281
  declare type Event_5<Topic extends string> = {
4905
5282
  topic: Topic;
4906
- } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent | WillRedirectEvent);
5283
+ } & (BlurredEvent | CertificateSelectionShownEvent | CrashedEvent_2 | DidChangeThemeColorEvent | FocusedEvent | NavigationRejectedEvent | UrlChangedEvent | DidFailLoadEvent | DidFinishLoadEvent | PageFaviconUpdatedEvent | PageTitleUpdatedEvent | ResourceLoadFailedEvent | ResourceResponseReceivedEvent | ChildContentBlockedEvent | ChildContentOpenedInBrowserEvent | ChildViewCreatedEvent | ChildWindowCreatedEvent | FileDownloadStartedEvent | FileDownloadProgressEvent | FileDownloadCompletedEvent | FoundInPageEvent | CertificateErrorEvent);
4907
5284
 
4908
5285
  /**
4909
5286
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by a {@link Window}. Events are
@@ -4939,12 +5316,51 @@ declare class EventAggregator extends EmitterMap {
4939
5316
  dispatchEvent: (message: Message<any>) => boolean;
4940
5317
  }
4941
5318
 
5319
+ declare interface EventEmitter_2 {
5320
+ [x: string]: any;
5321
+ /**
5322
+ * Subscribe to an event
5323
+ * @param eventName The name of the event to describe to
5324
+ * @param callback The function that should be invoked when the event occurs
5325
+ * @param context The value of the this pointer in the callback function
5326
+ */
5327
+ on(eventName: string, callback: Function, context?: any): void;
5328
+
5329
+ /**
5330
+ * Notify listeners of an event and pass arguments along
5331
+ * @param eventName The name of the event to emit
5332
+ */
5333
+ emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5334
+
5335
+ /**
5336
+ * Alias for emit
5337
+ */
5338
+ trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5339
+
5340
+ /**
5341
+ * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5342
+ * eventName and callback or just a specific callback with a specific context if invoked with all three
5343
+ * arguments.
5344
+ * @param eventName The name of the event to unsubscribe from
5345
+ * @param callback The function that should be invoked when the event occurs
5346
+ * @param context The value of the this pointer in the callback function
5347
+ */
5348
+ unbind(eventName: string, callback?: Function, context?: any): void;
5349
+
5350
+ /**
5351
+ * Alias for unbind
5352
+ */
5353
+ off(eventName: string, callback?: Function, context?: any): void;
5354
+ }
5355
+
4942
5356
  /**
4943
5357
  * Handler for an event on an EventEmitter.
4944
5358
  * @remarks Selects the correct type for the event
4945
5359
  * payload from the provided union based on the provided string literal type.
4946
5360
  */
4947
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
5361
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5362
+ type: EventType;
5363
+ }>, ...args: any[]) => void;
4948
5364
 
4949
5365
  declare namespace Events {
4950
5366
  export {
@@ -5075,7 +5491,7 @@ declare namespace ExternalApplicationEvents {
5075
5491
  ExternalApplicationEvent,
5076
5492
  EventType_4 as EventType,
5077
5493
  ExternalApplicationEventType,
5078
- Payload_6 as Payload,
5494
+ Payload_5 as Payload,
5079
5495
  ByType_4 as ByType
5080
5496
  }
5081
5497
  }
@@ -5557,12 +5973,7 @@ declare type FetchManifestPayload = {
5557
5973
  /**
5558
5974
  * Whether file downloads raise a user prompt.
5559
5975
  */
5560
- declare type FileDownloadBehavior = 'prompt' | 'no-prompt';
5561
-
5562
- /**
5563
- * @deprecated Renamed to {@link FileDownloadBehavior}.
5564
- */
5565
- declare type FileDownloadBehaviorNames = FileDownloadBehavior;
5976
+ declare type FileDownloadBehaviorNames = 'prompt' | 'no-prompt';
5566
5977
 
5567
5978
  /**
5568
5979
  * Generated when a file download has completed.
@@ -5812,8 +6223,6 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5812
6223
  * Returns a frame info object representing the window that the referenced iframe is
5813
6224
  * currently embedded in.
5814
6225
  *
5815
- * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5816
- *
5817
6226
  * @example
5818
6227
  * ```js
5819
6228
  * async function getParentWindow() {
@@ -5855,7 +6264,7 @@ declare namespace FrameEvents {
5855
6264
  FrameEvent,
5856
6265
  EventType_5 as EventType,
5857
6266
  FrameEventType,
5858
- Payload_7 as Payload,
6267
+ Payload_6 as Payload,
5859
6268
  ByType_5 as ByType
5860
6269
  }
5861
6270
  }
@@ -6078,34 +6487,267 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
6078
6487
  * });
6079
6488
  * ```
6080
6489
  */
6081
- isRegistered(hotkey: string): Promise<boolean>;
6082
- }
6490
+ isRegistered(hotkey: string): Promise<boolean>;
6491
+ }
6492
+
6493
+ /**
6494
+ * @deprecated Renamed to {@link Event}.
6495
+ */
6496
+ declare type GlobalHotkeyEvent = Event_9;
6497
+
6498
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6499
+
6500
+ declare namespace GlobalHotkeyEvents {
6501
+ export {
6502
+ BaseEvent_8 as BaseEvent,
6503
+ RegisteredEvent,
6504
+ UnregisteredEvent,
6505
+ Event_9 as Event,
6506
+ GlobalHotkeyEvent,
6507
+ EventType_6 as EventType,
6508
+ GlobalHotkeyEventType,
6509
+ Payload_7 as Payload,
6510
+ ByType_6 as ByType
6511
+ }
6512
+ }
6513
+
6514
+ /**
6515
+ * @deprecated Renamed to {@link EventType}.
6516
+ */
6517
+ declare type GlobalHotkeyEventType = EventType_6;
6518
+
6519
+ declare namespace GoldenLayout {
6520
+ export {
6521
+ GoldenLayout_2 as GoldenLayout,
6522
+ ItemConfigType,
6523
+ Settings,
6524
+ Dimensions,
6525
+ Labels,
6526
+ ItemType,
6527
+ ItemConfig,
6528
+ ComponentConfig,
6529
+ ReactComponentConfig,
6530
+ Config,
6531
+ ContentItem,
6532
+ Container,
6533
+ DragSource,
6534
+ BrowserWindow,
6535
+ Header,
6536
+ TabDragListener,
6537
+ Tab,
6538
+ EventEmitter_2 as EventEmitter
6539
+ }
6540
+ }
6541
+
6542
+ declare class GoldenLayout_2 implements EventEmitter_2 {
6543
+ /**
6544
+ * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6545
+ * object and of goldenLayout.root as the document.
6546
+ */
6547
+ root: ContentItem;
6548
+
6549
+ /**
6550
+ * A reference to the (jQuery) DOM element containing the layout
6551
+ */
6552
+ container: JQuery;
6553
+
6554
+ /**
6555
+ * True once the layout item tree has been created and the initialised event has been fired
6556
+ */
6557
+ isInitialised: boolean;
6558
+
6559
+ /**
6560
+ * A reference to the current, extended top level config.
6561
+ *
6562
+ * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6563
+ */
6564
+ config: Config;
6565
+
6566
+ /**
6567
+ * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6568
+ * to true.
6569
+ */
6570
+ selectedItem: ContentItem;
6571
+
6572
+ /**
6573
+ * The current outer width of the layout in pixels.
6574
+ */
6575
+ width: number;
6576
+
6577
+ /**
6578
+ * The current outer height of the layout in pixels.
6579
+ */
6580
+ height: number;
6581
+
6582
+ /**
6583
+ * An array of BrowserWindow instances
6584
+ */
6585
+ openPopouts: BrowserWindow[];
6586
+
6587
+ /**
6588
+ * True if the layout has been opened as a popout by another layout.
6589
+ */
6590
+ isSubWindow: boolean;
6591
+
6592
+ /**
6593
+ * A singleton instance of EventEmitter that works across windows
6594
+ */
6595
+ eventHub: EventEmitter_2;
6596
+
6597
+ _dragProxy: any;
6598
+
6599
+ dropTargetIndicator: any;
6600
+
6601
+ /**
6602
+ * @param config A GoldenLayout configuration object
6603
+ * @param container The DOM element the layout will be initialised in. Default: document.body
6604
+ */
6605
+ constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6606
+
6607
+ /*
6608
+ * @param name The name of the component, as referred to by componentName in the component configuration.
6609
+ * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6610
+ * containerobject and a component state
6611
+ */
6612
+ registerComponent(name: String, component: any): void;
6613
+
6614
+ /**
6615
+ * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6616
+ * a listener to the document and executes once it becomes ready.
6617
+ */
6618
+ init(): void;
6619
+
6620
+ /**
6621
+ * Returns the current state of the layout and its components as a serialisable object.
6622
+ */
6623
+ toConfig(): Config;
6624
+
6625
+ /**
6626
+ * Returns a component that was previously registered with layout.registerComponent().
6627
+ * @param name The name of a previously registered component
6628
+ */
6629
+ getComponent(name: string): any;
6630
+
6631
+ /**
6632
+ * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6633
+ * @param width The outer width the layout should be resized to. Default: The container elements width
6634
+ * @param height The outer height the layout should be resized to. Default: The container elements height
6635
+ */
6636
+ updateSize(width?: number, height?: number): void;
6637
+
6638
+ /**
6639
+ * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6640
+ * listeners and finally removes itself from the DOM.
6641
+ */
6642
+ destroy(): void;
6643
+
6644
+ /**
6645
+ * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6646
+ * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6647
+ * all call this method implicitly.
6648
+ * @param itemConfiguration An item configuration (can be an entire tree of items)
6649
+ * @param parent A parent item
6650
+ */
6651
+ createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6652
+
6653
+ /**
6654
+ * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6655
+ * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6656
+ * provided its config will be read, if config is provided, only the content key
6657
+ * will be used
6658
+ * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6659
+ * place the window in another screen.
6660
+ * @param parentId The id of the item within the current layout the child window's content will be appended to
6661
+ * when popIn is clicked
6662
+ * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6663
+ */
6664
+ createPopout(
6665
+ configOrContentItem: ItemConfigType | ContentItem,
6666
+ dimensions: {
6667
+ width: number;
6668
+ height: number;
6669
+ left: number;
6670
+ top: number;
6671
+ },
6672
+ parentId?: string,
6673
+ indexInParent?: number
6674
+ ): void;
6675
+
6676
+ /**
6677
+ * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6678
+ * where it turns into a contentItem.
6679
+ * @param element The DOM element that will be turned into a dragSource
6680
+ * @param itemConfiguration An item configuration (can be an entire tree of items)
6681
+ * @return the dragSource that was created. This can be used to remove the
6682
+ * dragSource from the layout later.
6683
+ */
6684
+ createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6685
+
6686
+ /**
6687
+ * Removes a dragSource from the layout.
6688
+ *
6689
+ * @param dragSource The dragSource to remove
6690
+ */
6691
+ removeDragSource(dragSource: DragSource): void;
6692
+
6693
+ /**
6694
+ * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6695
+ * @param contentItem A ContentItem instance
6696
+ */
6697
+ selectItem(contentItem: ContentItem): void;
6698
+
6699
+ /**
6700
+ * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6701
+ * and replace frequent keys and values with single letter substitutes.
6702
+ * @param config A GoldenLayout configuration object
6703
+ */
6704
+ static minifyConfig(config: any): any;
6083
6705
 
6084
- /**
6085
- * @deprecated Renamed to {@link Event}.
6086
- */
6087
- declare type GlobalHotkeyEvent = Event_9;
6706
+ /**
6707
+ * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6708
+ * @param minifiedConfig A minified GoldenLayout configuration object
6709
+ */
6710
+ static unminifyConfig(minifiedConfig: any): any;
6088
6711
 
6089
- declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6712
+ /**
6713
+ * Subscribe to an event
6714
+ * @param eventName The name of the event to describe to
6715
+ * @param callback The function that should be invoked when the event occurs
6716
+ * @param context The value of the this pointer in the callback function
6717
+ */
6718
+ on(eventName: string, callback: Function, context?: any): void;
6090
6719
 
6091
- declare namespace GlobalHotkeyEvents {
6092
- export {
6093
- BaseEvent_8 as BaseEvent,
6094
- RegisteredEvent,
6095
- UnregisteredEvent,
6096
- Event_9 as Event,
6097
- GlobalHotkeyEvent,
6098
- EventType_6 as EventType,
6099
- GlobalHotkeyEventType,
6100
- Payload_8 as Payload,
6101
- ByType_6 as ByType
6102
- }
6103
- }
6720
+ /**
6721
+ * Notify listeners of an event and pass arguments along
6722
+ * @param eventName The name of the event to emit
6723
+ */
6724
+ emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6104
6725
 
6105
- /**
6106
- * @deprecated Renamed to {@link EventType}.
6107
- */
6108
- declare type GlobalHotkeyEventType = EventType_6;
6726
+ /**
6727
+ * Alias for emit
6728
+ */
6729
+ trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6730
+
6731
+ /**
6732
+ * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6733
+ * eventName and callback or just a specific callback with a specific context if invoked with all three
6734
+ * arguments.
6735
+ * @param eventName The name of the event to unsubscribe from
6736
+ * @param callback The function that should be invoked when the event occurs
6737
+ * @param context The value of the this pointer in the callback function
6738
+ */
6739
+ unbind(eventName: string, callback?: Function, context?: any): void;
6740
+
6741
+ /**
6742
+ * Alias for unbind
6743
+ */
6744
+ off(eventName: string, callback?: Function, context?: any): void;
6745
+
6746
+ /**
6747
+ * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6748
+ */
6749
+ _$createRootItemAreas(): void;
6750
+ }
6109
6751
 
6110
6752
  /**
6111
6753
  * @interface
@@ -6114,6 +6756,62 @@ declare type GpuInfo = {
6114
6756
  name: string;
6115
6757
  };
6116
6758
 
6759
+ declare interface Header {
6760
+ /**
6761
+ * A reference to the LayoutManager instance
6762
+ */
6763
+ layoutManager: GoldenLayout_2;
6764
+
6765
+ /**
6766
+ * A reference to the Stack this Header belongs to
6767
+ */
6768
+ parent: ContentItem;
6769
+
6770
+ /**
6771
+ * An array of the Tabs within this header
6772
+ */
6773
+ tabs: Tab[];
6774
+
6775
+ /**
6776
+ * The currently selected activeContentItem
6777
+ */
6778
+ activeContentItem: ContentItem;
6779
+
6780
+ /**
6781
+ * The outer (jQuery) DOM element of this Header
6782
+ */
6783
+ element: JQuery;
6784
+
6785
+ /**
6786
+ * The (jQuery) DOM element containing the tabs
6787
+ */
6788
+ tabsContainer: JQuery;
6789
+
6790
+ /**
6791
+ * The (jQuery) DOM element containing the close, maximise and popout button
6792
+ */
6793
+ controlsContainer: JQuery;
6794
+
6795
+ /**
6796
+ * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6797
+ * @param contentItem The content item that will be selected
6798
+ */
6799
+ setActiveContentItem(contentItem: ContentItem): void;
6800
+
6801
+ /**
6802
+ * Creates a new tab and associates it with a content item
6803
+ * @param contentItem The content item the tab will be associated with
6804
+ * @param index A zero based index, specifying the position of the new tab
6805
+ */
6806
+ createTab(contentItem: ContentItem, index?: number): void;
6807
+
6808
+ /**
6809
+ * Finds a tab by its contentItem and removes it
6810
+ * @param contentItem The content item the tab is associated with
6811
+ */
6812
+ removeTab(contentItem: ContentItem): void;
6813
+ }
6814
+
6117
6815
  /**
6118
6816
  * Generated when a View is hidden.
6119
6817
  * @interface
@@ -6370,13 +7068,6 @@ declare type InfoForIntentOptions<MetadataType = IntentMetadata_3> = {
6370
7068
  metadata?: MetadataType;
6371
7069
  };
6372
7070
 
6373
- declare type InheritableOptions = {
6374
- customContext: boolean;
6375
- customData: boolean;
6376
- icon: boolean;
6377
- preloadScripts: boolean;
6378
- };
6379
-
6380
7071
  /**
6381
7072
  * Generated when an application has initialized.
6382
7073
  * @interface
@@ -6805,15 +7496,6 @@ declare class InteropBroker extends Base {
6805
7496
  setContext({ context }: {
6806
7497
  context: OpenFin.Context;
6807
7498
  }, clientIdentity: OpenFin.ClientIdentity): void;
6808
- /**
6809
- * Sets a context for the context group.
6810
- * @param setContextOptions - New context to set.
6811
- * @param contextGroupId - Context group id.
6812
- *
6813
- */
6814
- setContextForGroup({ context }: {
6815
- context: OpenFin.Context;
6816
- }, contextGroupId: string): void;
6817
7499
  /**
6818
7500
  * Get current context for a client subscribed to a Context Group.
6819
7501
  *
@@ -7782,6 +8464,50 @@ declare class InteropModule extends Base {
7782
8464
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7783
8465
  }
7784
8466
 
8467
+ declare interface ItemConfig {
8468
+ /**
8469
+ * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8470
+ */
8471
+ type: ItemType;
8472
+
8473
+ /**
8474
+ * An array of configurations for items that will be created as children of this item.
8475
+ */
8476
+ content?: ItemConfigType[];
8477
+
8478
+ /**
8479
+ * The width of this item, relative to the other children of its parent in percent
8480
+ */
8481
+ width?: number;
8482
+
8483
+ /**
8484
+ * The height of this item, relative to the other children of its parent in percent
8485
+ */
8486
+ height?: number;
8487
+
8488
+ /**
8489
+ * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8490
+ */
8491
+ id?: string | string[];
8492
+
8493
+ /**
8494
+ * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8495
+ * will return false
8496
+ * Default: true
8497
+ */
8498
+ isClosable?: boolean;
8499
+
8500
+ /**
8501
+ * The title of the item as displayed on its tab and on popout windows
8502
+ * Default: componentName or ''
8503
+ */
8504
+ title?: string;
8505
+ }
8506
+
8507
+ declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8508
+
8509
+ declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8510
+
7785
8511
  /**
7786
8512
  * @interface
7787
8513
  */
@@ -7839,6 +8565,32 @@ declare type JumpListTask = {
7839
8565
  iconIndex?: number;
7840
8566
  };
7841
8567
 
8568
+ declare interface Labels {
8569
+ /**
8570
+ * The tooltip text that appears when hovering over the close icon.
8571
+ * Default: 'close'
8572
+ */
8573
+ close?: string;
8574
+
8575
+ /**
8576
+ * The tooltip text that appears when hovering over the maximise icon.
8577
+ * Default: 'maximise'
8578
+ */
8579
+ maximise?: string;
8580
+
8581
+ /**
8582
+ * The tooltip text that appears when hovering over the minimise icon.
8583
+ * Default: 'minimise'
8584
+ */
8585
+ minimise?: string;
8586
+
8587
+ /**
8588
+ * The tooltip text that appears when hovering over the popout icon.
8589
+ * Default: 'open in new window'
8590
+ */
8591
+ popout?: string;
8592
+ }
8593
+
7842
8594
  /**
7843
8595
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
7844
8596
  *
@@ -7917,7 +8669,6 @@ declare type LaunchExternalProcessRule = {
7917
8669
  */
7918
8670
  declare type LaunchIntoPlatformPayload = {
7919
8671
  manifest: any;
7920
- manifestUrl?: string;
7921
8672
  };
7922
8673
 
7923
8674
  /**
@@ -8264,7 +9015,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8264
9015
  entityId: string;
8265
9016
  };
8266
9017
 
8267
- declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
9018
+ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
8268
9019
 
8269
9020
  /**
8270
9021
  * @interface
@@ -9095,7 +9846,7 @@ declare type MutableViewOptions = {
9095
9846
  /**
9096
9847
  * Configurations for API injection.
9097
9848
  */
9098
- api: ApiSettings;
9849
+ api: Api;
9099
9850
  /**
9100
9851
  * Restrict navigation to URLs that match an allowed pattern.
9101
9852
  * In the lack of an allowlist, navigation to URLs that match a denylisted pattern would be prohibited.
@@ -9548,7 +10299,6 @@ declare namespace OpenFin {
9548
10299
  WindowState,
9549
10300
  AutoplayPolicyOptions,
9550
10301
  ConstWindowOptions,
9551
- InheritableOptions,
9552
10302
  MutableWindowOptions,
9553
10303
  WorkspacePlatformOptions,
9554
10304
  WebRequestHeader,
@@ -9557,7 +10307,6 @@ declare namespace OpenFin {
9557
10307
  ResizeRegion,
9558
10308
  Accelerator,
9559
10309
  Api,
9560
- ApiSettings,
9561
10310
  InjectionType,
9562
10311
  NavigationRules,
9563
10312
  ContentNavigation,
@@ -9709,9 +10458,7 @@ declare namespace OpenFin {
9709
10458
  DefaultDomainSettingsRule,
9710
10459
  DomainSettings,
9711
10460
  ApiInjection,
9712
- DomainApiSettings,
9713
10461
  DomainSettingsRule,
9714
- FileDownloadBehavior,
9715
10462
  FileDownloadBehaviorNames,
9716
10463
  FileDownloadSettings,
9717
10464
  DownloadRule,
@@ -9719,7 +10466,6 @@ declare namespace OpenFin {
9719
10466
  Intent_2 as Intent,
9720
10467
  IntentMetadata_3 as IntentMetadata,
9721
10468
  IntentHandler_2 as IntentHandler,
9722
- ContentCreationBehavior,
9723
10469
  ContentCreationBehaviorNames,
9724
10470
  MatchPattern,
9725
10471
  BaseContentCreationRule,
@@ -9871,101 +10617,77 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
9871
10617
  error?: Success extends false ? ErrorPlainObject | undefined : never;
9872
10618
  };
9873
10619
 
9874
- /**
9875
- * Extracts a single event type matching the given key from the System {@link Event} union.
9876
- *
9877
- * @see {@link ByType}
9878
- *
9879
- * @typeParam Type String key specifying the event to extract
9880
- */
9881
- declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9882
-
9883
- /**
9884
- * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9885
- *
9886
- * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9887
- * the appropriate payload union for that namespace.
9888
- *
9889
- * @typeParam Event Union of payloads for events on the given emitter
9890
- * @see {@link ByType}
9891
- *
9892
- * @typeParam Type String key specifying the event to extract from the union
9893
- *
9894
- * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9895
- * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9896
- * @see {@link OpenFin.Events.FrameEvents.Payload}
9897
- * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9898
- * @see {@link OpenFin.Events.PlatformEvents.Payload}
9899
- * @see {@link OpenFin.Events.SystemEvents.Payload}
9900
- * @see {@link OpenFin.Events.ViewEvents.Payload}
9901
- * @see {@link OpenFin.Events.WindowEvents.Payload}
9902
- */
9903
- declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9904
- type: EventType;
9905
- }>;
9906
-
9907
10620
  /**
9908
10621
  * Extracts a single event type matching the given key from the View {@link Event} union.
9909
10622
  *
9910
- * @see {@link ByType}
9911
- *
9912
10623
  * @typeParam Type String key specifying the event to extract
9913
10624
  */
9914
- declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
10625
+ declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10626
+ type: Type;
10627
+ }>;
9915
10628
 
9916
10629
  /**
9917
10630
  * Extracts a single event type matching the given key from the Window {@link Event} union.
9918
10631
  *
9919
- * @see {@link ByType}
9920
- *
9921
10632
  * @typeParam Type String key specifying the event to extract
9922
10633
  */
9923
- declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
10634
+ declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10635
+ type: Type;
10636
+ }>;
9924
10637
 
9925
10638
  /**
9926
10639
  * Extracts a single event type matching the given key from the Application {@link Event} union.
9927
10640
  *
9928
- * @see {@link ByType}
9929
- *
9930
10641
  * @typeParam Type String key specifying the event to extract
9931
10642
  */
9932
- declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
10643
+ declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10644
+ type: Type;
10645
+ }>;
9933
10646
 
9934
10647
  /**
9935
10648
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
9936
10649
  *
9937
- * @see {@link ByType}
9938
- *
9939
10650
  * @typeParam Type String key specifying the event to extract
9940
10651
  */
9941
- declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
10652
+ declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10653
+ type: Type;
10654
+ }>;
9942
10655
 
9943
10656
  /**
9944
10657
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
9945
10658
  *
9946
- * @see {@link ByType}
9947
- *
9948
10659
  * @typeParam Type String key specifying the event to extract
9949
10660
  */
9950
- declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
10661
+ declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10662
+ type: Type;
10663
+ }>;
9951
10664
 
9952
10665
  /**
9953
10666
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
9954
10667
  *
9955
- * @see {@link ByType}
9956
- *
9957
10668
  * @typeParam Type String key specifying the event to extract
9958
10669
  */
9959
- declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
10670
+ declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10671
+ type: Type;
10672
+ }>;
9960
10673
 
9961
10674
  /**
9962
10675
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
9963
10676
  *
9964
- * @see {@link ByType}
10677
+ * @typeParam Type String key specifying the event to extract
10678
+ */
10679
+ declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10680
+ type: Type;
10681
+ }>;
10682
+
10683
+ /**
10684
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9965
10685
  *
9966
10686
  * @typeParam Type String key specifying the event to extract
9967
10687
  */
9968
- declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
10688
+ declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10689
+ type: Type;
10690
+ }>;
9969
10691
 
9970
10692
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
9971
10693
 
@@ -10629,7 +11351,7 @@ declare namespace PlatformEvents {
10629
11351
  PlatformEvent,
10630
11352
  EventType_7 as EventType,
10631
11353
  PlatformEventType,
10632
- Payload_9 as Payload,
11354
+ Payload_8 as Payload,
10633
11355
  ByType_7 as ByType
10634
11356
  }
10635
11357
  }
@@ -10813,13 +11535,9 @@ declare type PlatformOptions = ApplicationCreationOptions & {
10813
11535
  */
10814
11536
  providerUrl?: string;
10815
11537
  /**
10816
- * @defaultValue true
10817
- *
10818
- * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
10819
- *
10820
- * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11538
+ * The permissions for secured APIs.
10821
11539
  */
10822
- allowLaunchIntoPlatform?: boolean;
11540
+ permissions?: Partial<Permissions_2>;
10823
11541
  };
10824
11542
 
10825
11543
  /**
@@ -11579,7 +12297,7 @@ declare type PreloadScriptInfoRunning = {
11579
12297
  * @interface
11580
12298
  */
11581
12299
  declare type PreloadScriptsStateChangedEvent = PreloadScriptsStateChangeEvent & {
11582
- type: 'preload-scripts-state-changed';
12300
+ type: 'preload-script-state-changed';
11583
12301
  };
11584
12302
 
11585
12303
  /**
@@ -11596,7 +12314,7 @@ declare type PreloadScriptsStateChangeEvent = BaseEvent_5 & {
11596
12314
  * @interface
11597
12315
  */
11598
12316
  declare type PreloadScriptsStateChangingEvent = PreloadScriptsStateChangeEvent & {
11599
- type: 'preload-scripts-state-changing';
12317
+ type: 'preload-script-state-changing';
11600
12318
  };
11601
12319
 
11602
12320
  declare type PresetLayoutOptions = OpenFin.PresetLayoutOptions;
@@ -12022,7 +12740,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
12022
12740
  'interop-broker-remove-client-from-context-group': VoidCall;
12023
12741
  'interop-broker-remove-from-context-group': VoidCall;
12024
12742
  'interop-broker-set-context': VoidCall;
12025
- 'interop-broker-set-context-for-group': VoidCall;
12026
12743
  'query-permission-for-current-context': {
12027
12744
  request: {
12028
12745
  apiName: string;
@@ -12213,6 +12930,18 @@ declare type QueryPermissionResult = {
12213
12930
  rawValue?: unknown;
12214
12931
  };
12215
12932
 
12933
+ declare interface ReactComponentConfig extends ItemConfig {
12934
+ /**
12935
+ * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12936
+ */
12937
+ component: string;
12938
+
12939
+ /**
12940
+ * Properties that will be passed to the component and accessible using this.props.
12941
+ */
12942
+ props?: any;
12943
+ }
12944
+
12216
12945
  /**
12217
12946
  * @interface
12218
12947
  */
@@ -12300,15 +13029,6 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12300
13029
  token: string;
12301
13030
  }
12302
13031
 
12303
- /**
12304
- * Generated when a View is removed from a layout.
12305
- * @interface
12306
- */
12307
- declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12308
- type: 'removed-from-layout';
12309
- layoutIdentity: OpenFin.LayoutIdentity;
12310
- };
12311
-
12312
13032
  /**
12313
13033
  * @interface
12314
13034
  */
@@ -12728,6 +13448,97 @@ declare type SessionContextGroup = {
12728
13448
  }>;
12729
13449
  };
12730
13450
 
13451
+ declare interface Settings {
13452
+ preventSplitterResize?: boolean;
13453
+
13454
+ newTabButton?: {
13455
+ url?: string;
13456
+ };
13457
+
13458
+ /**
13459
+ * If true, tabs can't be dragged into the window.
13460
+ * Default: false
13461
+ */
13462
+ preventDragIn?: boolean;
13463
+
13464
+ /**
13465
+ * If true, tabs can't be dragged out of the window.
13466
+ * Default: false
13467
+ */
13468
+ preventDragOut?: boolean;
13469
+
13470
+ /**
13471
+ * If true, stack headers are the only areas where tabs can be dropped.
13472
+ * Default: false
13473
+ */
13474
+ constrainDragToHeaders?: boolean;
13475
+ /**
13476
+ * Turns headers on or off. If false, the layout will be displayed with splitters only.
13477
+ * Default: true
13478
+ */
13479
+ hasHeaders?: boolean;
13480
+
13481
+ /**
13482
+ * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13483
+ * automatically when layout.createDragSource() is called.
13484
+ * Default: true
13485
+ */
13486
+ constrainDragToContainer?: boolean;
13487
+
13488
+ /**
13489
+ * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13490
+ * Default: true
13491
+ */
13492
+ reorderEnabled?: boolean;
13493
+
13494
+ /**
13495
+ * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13496
+ * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13497
+ * Default: false
13498
+ */
13499
+ selectionEnabled?: boolean;
13500
+
13501
+ /**
13502
+ * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13503
+ * be transferred to the new window, if false only the active component will be opened.
13504
+ * Default: false
13505
+ */
13506
+ popoutWholeStack?: boolean;
13507
+
13508
+ /**
13509
+ * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13510
+ * If false, the popout call will fail silently.
13511
+ * Default: true
13512
+ */
13513
+ blockedPopoutsThrowError?: boolean;
13514
+
13515
+ /**
13516
+ * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13517
+ * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13518
+ * addition, any changes made to popouts won't be stored after the parent is closed.
13519
+ * Default: true
13520
+ */
13521
+ closePopoutsOnUnload?: boolean;
13522
+
13523
+ /**
13524
+ * Specifies if the popout icon should be displayed in the header-bar.
13525
+ * Default: true
13526
+ */
13527
+ showPopoutIcon?: boolean;
13528
+
13529
+ /**
13530
+ * Specifies if the maximise icon should be displayed in the header-bar.
13531
+ * Default: true
13532
+ */
13533
+ showMaximiseIcon?: boolean;
13534
+
13535
+ /**
13536
+ * Specifies if the close icon should be displayed in the header-bar.
13537
+ * Default: true
13538
+ */
13539
+ showCloseIcon?: boolean;
13540
+ }
13541
+
12731
13542
  /**
12732
13543
  * @interface
12733
13544
  */
@@ -12951,7 +13762,7 @@ declare type Snapshot = {
12951
13762
  * _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
12952
13763
  * @interface
12953
13764
  */
12954
- declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13765
+ declare type SnapshotAppliedEvent = BaseEvent & {
12955
13766
  topic: 'application';
12956
13767
  type: 'platform-snapshot-applied';
12957
13768
  };
@@ -14557,7 +15368,7 @@ declare namespace SystemEvents {
14557
15368
  SystemEvent,
14558
15369
  EventType_8 as EventType,
14559
15370
  SystemEventType,
14560
- Payload_10 as Payload,
15371
+ Payload_9 as Payload,
14561
15372
  ByType_8 as ByType
14562
15373
  }
14563
15374
  }
@@ -14624,6 +15435,59 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14624
15435
  proceed: () => void;
14625
15436
  }) => void;
14626
15437
 
15438
+ declare interface Tab {
15439
+ _dragListener: TabDragListener;
15440
+
15441
+ /**
15442
+ * True if this tab is the selected tab
15443
+ */
15444
+ isActive: boolean;
15445
+
15446
+ /**
15447
+ * A reference to the header this tab is a child of
15448
+ */
15449
+ header: Header;
15450
+
15451
+ /**
15452
+ * A reference to the content item this tab relates to
15453
+ */
15454
+ contentItem: ContentItem;
15455
+
15456
+ /**
15457
+ * The tabs outer (jQuery) DOM element
15458
+ */
15459
+ element: JQuery;
15460
+
15461
+ /**
15462
+ * The (jQuery) DOM element containing the title
15463
+ */
15464
+ titleElement: JQuery;
15465
+
15466
+ /**
15467
+ * The (jQuery) DOM element that closes the tab
15468
+ */
15469
+ closeElement: JQuery;
15470
+
15471
+ /**
15472
+ * Sets the tab's title. Does not affect the contentItem's title!
15473
+ * @param title The new title
15474
+ */
15475
+ setTitle(title: string): void;
15476
+
15477
+ /**
15478
+ * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15479
+ * @param isActive Whether the tab is active
15480
+ */
15481
+ setActive(isActive: boolean): void;
15482
+ }
15483
+
15484
+ declare interface TabDragListener extends EventEmitter_2 {
15485
+ /**
15486
+ * A reference to the content item this tab relates to
15487
+ */
15488
+ contentItem: ContentItem;
15489
+ }
15490
+
14627
15491
  /**
14628
15492
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
14629
15493
  */
@@ -15563,8 +16427,6 @@ declare namespace ViewEvents {
15563
16427
  BaseEvent_4 as BaseEvent,
15564
16428
  BaseViewEvent,
15565
16429
  TargetChangedEvent,
15566
- AddedToLayoutEvent,
15567
- RemovedFromLayoutEvent,
15568
16430
  NonPropagatedViewEvent,
15569
16431
  CreatedEvent,
15570
16432
  DestroyedEvent,
@@ -15581,7 +16443,7 @@ declare namespace ViewEvents {
15581
16443
  PropagatedViewEvent,
15582
16444
  PropagatedEventType_2 as PropagatedEventType,
15583
16445
  PropagatedViewEventType,
15584
- Payload_3 as Payload,
16446
+ Payload_2 as Payload,
15585
16447
  ByType
15586
16448
  }
15587
16449
  }
@@ -16764,8 +17626,7 @@ declare namespace WebContentsEvents {
16764
17626
  Event_5 as Event,
16765
17627
  WebContentsEvent,
16766
17628
  WillPropagateWebContentsEvent,
16767
- NonPropagatedWebContentsEvent,
16768
- WillRedirectEvent
17629
+ NonPropagatedWebContentsEvent
16769
17630
  }
16770
17631
  }
16771
17632
 
@@ -16843,15 +17704,14 @@ declare type WillPropagateWebContentsEvent = Event_5<string>;
16843
17704
  declare type WillPropagateWindowEvent = WindowSourcedEvent;
16844
17705
 
16845
17706
  /**
16846
- * Generated whenever a redirection occurs.
17707
+ * Generated when window is being redirected as per contentRedirect allowlist/denylist rules.
16847
17708
  * @interface
16848
17709
  */
16849
- declare type WillRedirectEvent = NamedEvent & {
17710
+ declare type WillRedirectEvent = BaseEvent_5 & {
16850
17711
  type: 'will-redirect';
16851
17712
  blocked: boolean;
16852
17713
  isInPlace: boolean;
16853
17714
  url: string;
16854
- isMainFrame: boolean;
16855
17715
  };
16856
17716
 
16857
17717
  /**
@@ -16873,7 +17733,7 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
16873
17733
  */
16874
17734
  declare class _Window extends WebContents<OpenFin.WindowEvent> {
16875
17735
  /* Excluded from this release type: __constructor */
16876
- createWindow(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
17736
+ /* Excluded from this release type: createWindow */
16877
17737
  /**
16878
17738
  * Retrieves an array of frame info objects representing the main frame and any
16879
17739
  * iframes that are currently on the page.
@@ -17996,6 +18856,7 @@ declare namespace WindowEvents {
17996
18856
  AlertRequestedEvent,
17997
18857
  AuthRequestedEvent,
17998
18858
  EndLoadEvent,
18859
+ WillRedirectEvent,
17999
18860
  ReloadedEvent,
18000
18861
  OptionsChangedEvent,
18001
18862
  WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
@@ -18057,7 +18918,7 @@ declare namespace WindowEvents {
18057
18918
  PropagatedEvent_3 as PropagatedEvent,
18058
18919
  PropagatedWindowEvent,
18059
18920
  PropagatedWindowEventType,
18060
- Payload_4 as Payload,
18921
+ Payload_3 as Payload,
18061
18922
  ByType_2 as ByType
18062
18923
  }
18063
18924
  }
@@ -18243,7 +19104,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18243
19104
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18244
19105
  * from {@link OpenFin.ViewEvents}.
18245
19106
  */
18246
- declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19107
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
18247
19108
 
18248
19109
  /**
18249
19110
  * Generated when a child window starts loading.