@openfin/remote-adapter 36.80.11 → 36.80.25

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,6 +42,15 @@ 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
+
45
54
  /**
46
55
  * Options to use when adding a view to a {@link TabStack}.
47
56
  *
@@ -99,7 +108,7 @@ declare type ApiInjection = DomainApiSettings;
99
108
  * Generated when a new Platform's API becomes responsive.
100
109
  * @interface
101
110
  */
102
- declare type ApiReadyEvent = BaseEvent & {
111
+ declare type ApiReadyEvent = BaseEvents.BaseEvent & {
103
112
  topic: 'application';
104
113
  type: 'platform-api-ready';
105
114
  };
@@ -942,7 +951,7 @@ declare namespace ApplicationEvents {
942
951
  PropagatedApplicationEvent,
943
952
  PropagatedEventType_3 as PropagatedEventType,
944
953
  PropagatedApplicationEventType,
945
- Payload_4 as Payload,
954
+ Payload_5 as Payload,
946
955
  ByType_3 as ByType
947
956
  }
948
957
  }
@@ -1184,9 +1193,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1184
1193
  */
1185
1194
  mainWindowOptions: WindowCreationOptions;
1186
1195
  /**
1187
- * The name of the application (and the application's main window).
1196
+ * The name of the application.
1197
+ *
1198
+ * @remarks
1199
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1200
+ * any special characters, spaces or international characters. It's also used in error messages, API
1201
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1188
1202
  *
1189
- * If provided, _must_ match `uuid`.
1203
+ * This property will be deprecated in the future.
1190
1204
  */
1191
1205
  name: string;
1192
1206
  /**
@@ -1216,9 +1230,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1216
1230
  url: string;
1217
1231
  /**
1218
1232
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1219
- * running in the OpenFin Runtime.
1220
- *
1221
- * Note that `name` and `uuid` must match.
1233
+ * running in the OpenFin Runtime.
1222
1234
  */
1223
1235
  uuid: string;
1224
1236
  /**
@@ -1804,7 +1816,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1804
1816
  * A base Channel event.
1805
1817
  * @interface
1806
1818
  */
1807
- declare type BaseEvent_2 = NamedEvent & {
1819
+ declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1808
1820
  channelName: string;
1809
1821
  channelId: string;
1810
1822
  };
@@ -1874,6 +1886,7 @@ declare namespace BaseEvents {
1874
1886
  NotCloseRequested,
1875
1887
  PropagatedEventType,
1876
1888
  PropagatedEvent,
1889
+ Payload_2 as Payload,
1877
1890
  EventHandler,
1878
1891
  BaseEvent,
1879
1892
  IdentityEvent,
@@ -2007,48 +2020,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
2007
2020
  behavior: 'browser';
2008
2021
  };
2009
2022
 
2010
- declare interface BrowserWindow {
2011
- /**
2012
- * True if the window has been opened and its GoldenLayout instance initialised.
2013
- */
2014
- isInitialised: boolean;
2015
-
2016
- /**
2017
- * Creates a window configuration object from the Popout.
2018
- */
2019
- toConfig(): {
2020
- dimensions: {
2021
- width: number;
2022
- height: number;
2023
- left: number;
2024
- top: number;
2025
- };
2026
- content: Config;
2027
- parentId: string;
2028
- indexInParent: number;
2029
- };
2030
-
2031
- /**
2032
- * Returns the GoldenLayout instance from the child window
2033
- */
2034
- getGlInstance(): GoldenLayout_2;
2035
-
2036
- /**
2037
- * Returns the native Window object
2038
- */
2039
- getWindow(): Window;
2040
-
2041
- /**
2042
- * Closes the popout
2043
- */
2044
- close(): void;
2045
-
2046
- /**
2047
- * Returns the popout to its original position as specified in parentId and indexInParent
2048
- */
2049
- popIn(): void;
2050
- }
2051
-
2052
2023
  /**
2053
2024
  * Extracts a single event type matching the given key from the View {@link Event} union.
2054
2025
  *
@@ -2056,7 +2027,7 @@ declare interface BrowserWindow {
2056
2027
  *
2057
2028
  * @typeParam Type String key specifying the event to extract
2058
2029
  */
2059
- declare type ByType<Type extends EventType> = Payload_2<Type>;
2030
+ declare type ByType<Type extends EventType> = Payload_3<Type>;
2060
2031
 
2061
2032
  /**
2062
2033
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -2065,7 +2036,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
2065
2036
  *
2066
2037
  * @typeParam Type String key specifying the event to extract
2067
2038
  */
2068
- declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
2039
+ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
2069
2040
 
2070
2041
  /**
2071
2042
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -2074,7 +2045,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
2074
2045
  *
2075
2046
  * @typeParam Type String key specifying the event to extract
2076
2047
  */
2077
- declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
2048
+ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
2078
2049
 
2079
2050
  /**
2080
2051
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -2083,7 +2054,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
2083
2054
  *
2084
2055
  * @typeParam Type String key specifying the event to extract
2085
2056
  */
2086
- declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2057
+ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
2087
2058
 
2088
2059
  /**
2089
2060
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -2092,7 +2063,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2092
2063
  *
2093
2064
  * @typeParam Type String key specifying the event to extract
2094
2065
  */
2095
- declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2066
+ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
2096
2067
 
2097
2068
  /**
2098
2069
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -2101,7 +2072,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2101
2072
  *
2102
2073
  * @typeParam Type String key specifying the event to extract
2103
2074
  */
2104
- declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2075
+ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
2105
2076
 
2106
2077
  /**
2107
2078
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -2110,7 +2081,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2110
2081
  *
2111
2082
  * @typeParam Type String key specifying the event to extract
2112
2083
  */
2113
- declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2084
+ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
2114
2085
 
2115
2086
  /**
2116
2087
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -2119,7 +2090,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2119
2090
  *
2120
2091
  * @typeParam Type String key specifying the event to extract
2121
2092
  */
2122
- declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2093
+ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
2123
2094
 
2124
2095
  /**
2125
2096
  * Configuration for page capture.
@@ -3491,31 +3462,6 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3491
3462
  close(): Promise<void>;
3492
3463
  }
3493
3464
 
3494
- declare interface ComponentConfig extends ItemConfig {
3495
- /**
3496
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3497
- */
3498
- componentName: string;
3499
-
3500
- /**
3501
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3502
- * container.getState().
3503
- */
3504
- componentState?: any;
3505
- }
3506
-
3507
- declare interface Config {
3508
- settings?: Settings;
3509
- dimensions?: Dimensions;
3510
- labels?: Labels;
3511
- content?: ItemConfigType[];
3512
- /**
3513
- * (Only on layout config object)
3514
- * Id of the currently maximised content item
3515
- */
3516
- maximisedItemId?: string;
3517
- }
3518
-
3519
3465
  declare type ConfigWithRuntime = BaseConfig & {
3520
3466
  runtime: RuntimeConfig;
3521
3467
  };
@@ -3827,7 +3773,9 @@ declare type ConstWindowOptions = {
3827
3773
  */
3828
3774
  preloadScripts: PreloadScript[];
3829
3775
  /**
3830
- * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
3776
+ * String tag that attempts to group like-tagged renderers together.
3777
+ * 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.
3778
+ * @remarks Will only be used if pages are on the same origin.
3831
3779
  */
3832
3780
  processAffinity: string;
3833
3781
  /**
@@ -3917,103 +3865,6 @@ declare type ConstWindowOptions = {
3917
3865
  inheritance?: Partial<InheritableOptions>;
3918
3866
  };
3919
3867
 
3920
- declare interface Container extends EventEmitter_2 {
3921
- /**
3922
- * The current width of the container in pixel
3923
- */
3924
- width: number;
3925
-
3926
- /**
3927
- * The current height of the container in pixel
3928
- */
3929
- height: number;
3930
-
3931
- /**
3932
- * A reference to the component-item that controls this container
3933
- */
3934
- parent: ContentItem;
3935
-
3936
- /**
3937
- * A reference to the tab that controls this container. Will initially be null
3938
- * (and populated once a tab event has been fired).
3939
- */
3940
- tab: Tab;
3941
-
3942
- /**
3943
- * The current title of the container
3944
- */
3945
- title: string;
3946
-
3947
- /*
3948
- * A reference to the GoldenLayout instance this container belongs to
3949
- */
3950
- layoutManager: GoldenLayout_2;
3951
-
3952
- /**
3953
- * True if the item is currently hidden
3954
- */
3955
- isHidden: boolean;
3956
-
3957
- /**
3958
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3959
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3960
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3961
- * constructor function. It will also be used when the component is opened in a new window.
3962
- * @param state A serialisable object
3963
- */
3964
- setState(state: any): void;
3965
-
3966
- /**
3967
- * The same as setState but does not emit 'stateChanged' event
3968
- * @param {serialisable} state
3969
- */
3970
- setStateSkipEvent(state: any): void;
3971
-
3972
- /**
3973
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3974
- * @param state A serialisable object
3975
- */
3976
- extendState(state: any): void;
3977
-
3978
- /**
3979
- * Returns the current state.
3980
- */
3981
- getState(): any;
3982
-
3983
- /**
3984
- * Returns the container's inner element as a jQuery element
3985
- */
3986
- getElement(): JQuery;
3987
-
3988
- /**
3989
- * hides the container or returns false if hiding it is not possible
3990
- */
3991
- hide(): boolean;
3992
-
3993
- /**
3994
- * shows the container or returns false if showing it is not possible
3995
- */
3996
- show(): boolean;
3997
-
3998
- /**
3999
- * Sets the container to the specified size or returns false if that's not possible
4000
- * @param width the new width in pixel
4001
- * @param height the new height in pixel
4002
- */
4003
- setSize(width: number, height: number): boolean;
4004
-
4005
- /**
4006
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4007
- * @param title the new title
4008
- */
4009
- setTitle(title: string): void;
4010
-
4011
- /**
4012
- * Closes the container or returns false if that is not possible
4013
- */
4014
- close(): boolean;
4015
- }
4016
-
4017
3868
  declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
4018
3869
 
4019
3870
  /**
@@ -4076,218 +3927,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
4076
3927
  disposition: string;
4077
3928
  };
4078
3929
 
4079
- declare interface ContentItem extends EventEmitter_2 {
4080
- instance: any;
4081
- header: any;
4082
- _splitter: any;
4083
- /**
4084
- * This items configuration in its current state
4085
- */
4086
- config: ItemConfigType;
4087
-
4088
- /**
4089
- * The type of the item. Can be row, column, stack, component or root
4090
- */
4091
- type: ItemType;
4092
-
4093
- /**
4094
- * An array of items that are children of this item
4095
- */
4096
- contentItems: ContentItem[];
4097
-
4098
- container: Container;
4099
- /**
4100
- * The item that is this item's parent (or null if the item is root)
4101
- */
4102
- parent: ContentItem;
4103
-
4104
- /**
4105
- * A String or array of identifiers if provided in the configuration
4106
- */
4107
- id: string;
4108
-
4109
- /**
4110
- * True if the item had been initialised
4111
- */
4112
- isInitialised: boolean;
4113
-
4114
- /**
4115
- * True if the item is maximised
4116
- */
4117
- isMaximised: boolean;
4118
-
4119
- /**
4120
- * True if the item is the layout's root item
4121
- */
4122
- isRoot: boolean;
4123
-
4124
- /**
4125
- * True if the item is a row
4126
- */
4127
- isRow: boolean;
4128
-
4129
- /**
4130
- * True if the item is a column
4131
- */
4132
- isColumn: boolean;
4133
-
4134
- /**
4135
- * True if the item is a stack
4136
- */
4137
- isStack: boolean;
4138
-
4139
- /**
4140
- * True if the item is a component
4141
- */
4142
- isComponent: boolean;
4143
-
4144
- /**
4145
- * A reference to the layoutManager that controls this item
4146
- */
4147
- layoutManager: any;
4148
-
4149
- /**
4150
- * The item's outer element
4151
- */
4152
- element: JQuery;
4153
-
4154
- /**
4155
- * The item's inner element. Can be the same as the outer element.
4156
- */
4157
- childElementContainer: Container;
4158
-
4159
- /**
4160
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4161
- * from its original position before adding it to this item.
4162
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4163
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4164
- */
4165
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4166
-
4167
- /**
4168
- * Destroys the item and all it's children
4169
- * @param contentItem The contentItem that should be removed
4170
- * @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.
4171
- */
4172
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4173
-
4174
- /**
4175
- * The contentItem that should be removed
4176
- * @param oldChild ContentItem The contentItem that should be removed
4177
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4178
- */
4179
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4180
-
4181
- /**
4182
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4183
- */
4184
- setSize(): void;
4185
-
4186
- /**
4187
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4188
- * @param title the new title
4189
- */
4190
- setTitle(title: string): void;
4191
-
4192
- /**
4193
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4194
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4195
- * @param functionName The name of the method to invoke
4196
- * @param functionArguments An array of arguments to pass to every function
4197
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4198
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4199
- */
4200
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4201
-
4202
- /**
4203
- * 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.
4204
- */
4205
- emitBubblingEvent(name: string): void;
4206
-
4207
- /**
4208
- * Convenience method for item.parent.removeChild( item )
4209
- */
4210
- remove(): void;
4211
-
4212
- /**
4213
- * Removes the item from its current position in the layout and opens it in a window
4214
- */
4215
- popout(): BrowserWindow;
4216
-
4217
- /**
4218
- * Maximises the item or minimises it if it's already maximised
4219
- */
4220
- toggleMaximise(): void;
4221
-
4222
- /**
4223
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4224
- */
4225
- select(): void;
4226
-
4227
- /**
4228
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4229
- */
4230
- deselect(): void;
4231
-
4232
- /**
4233
- * Returns true if the item has the specified id or false if not
4234
- * @param id An id to check for
4235
- */
4236
- hasId(id: string): boolean;
4237
-
4238
- /**
4239
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4240
- * @param contentItem The new active content item
4241
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4242
- */
4243
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4244
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4245
-
4246
- /**
4247
- * Only Stacks have this method! Returns the currently selected contentItem.
4248
- */
4249
- getActiveContentItem(): ContentItem;
4250
-
4251
- /**
4252
- * Adds an id to an item or does nothing if the id is already present
4253
- * @param id The id to be added
4254
- */
4255
- addId(id: string): void;
4256
-
4257
- /**
4258
- * Removes an id from an item or throws an error if the id couldn't be found
4259
- * @param id The id to be removed
4260
- */
4261
- removeId(id: string): void;
4262
-
4263
- /**
4264
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4265
- * @param filterFunction A function that determines whether an item matches certain criteria
4266
- */
4267
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4268
-
4269
- /**
4270
- * Returns all items with the specified id.
4271
- * @param id An id specified in the itemConfig
4272
- */
4273
- getItemsById(id: string | string[]): ContentItem[];
4274
-
4275
- /**
4276
- * Returns all items with the specified type
4277
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4278
- */
4279
- getItemsByType(type: string): ContentItem[];
4280
-
4281
- /**
4282
- * Returns all instances of the component with the specified componentName
4283
- * @param componentName a componentName as specified in the itemConfig
4284
- */
4285
- getComponentsByName(componentName: string): any;
4286
-
4287
- _contentAreaDimensions: any;
4288
- _$getArea: () => any;
4289
- }
4290
-
4291
3930
  /**
4292
3931
  * Restrict navigation to URLs that match an allowed pattern.
4293
3932
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4772,46 +4411,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4772
4411
  type: 'did-finish-load';
4773
4412
  };
4774
4413
 
4775
- declare interface Dimensions {
4776
- /**
4777
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4778
- * than the visible one, making it safe to set this to small values without affecting usability.
4779
- * Default: 5
4780
- */
4781
- borderWidth?: number;
4782
-
4783
- /**
4784
- * The minimum height an item can be resized to (in pixel).
4785
- * Default: 10
4786
- */
4787
- minItemHeight?: number;
4788
-
4789
- /**
4790
- * The minimum width an item can be resized to (in pixel).
4791
- * Default: 10
4792
- */
4793
- minItemWidth?: number;
4794
-
4795
- /**
4796
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4797
- * adjusted accordingly.
4798
- * Default: 20
4799
- */
4800
- headerHeight?: number;
4801
-
4802
- /**
4803
- * The width of the element that appears when an item is dragged (in pixel).
4804
- * Default: 300
4805
- */
4806
- dragProxyWidth?: number;
4807
-
4808
- /**
4809
- * The height of the element that appears when an item is dragged (in pixel).
4810
- * Default: 200
4811
- */
4812
- dragProxyHeight?: number;
4813
- }
4814
-
4815
4414
  /**
4816
4415
  * @interface
4817
4416
  */
@@ -5108,8 +4707,6 @@ declare type Dpi = {
5108
4707
  vertical?: number;
5109
4708
  };
5110
4709
 
5111
- declare interface DragSource {}
5112
-
5113
4710
  /**
5114
4711
  * Generated when a window has been embedded.
5115
4712
  * @interface
@@ -5382,7 +4979,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5382
4979
  */
5383
4980
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5384
4981
  target: OpenFin.Identity;
5385
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4982
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
5386
4983
 
5387
4984
  /**
5388
4985
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -5426,51 +5023,12 @@ declare class EventAggregator extends EmitterMap {
5426
5023
  dispatchEvent: (message: Message<any>) => boolean;
5427
5024
  }
5428
5025
 
5429
- declare interface EventEmitter_2 {
5430
- [x: string]: any;
5431
- /**
5432
- * Subscribe to an event
5433
- * @param eventName The name of the event to describe to
5434
- * @param callback The function that should be invoked when the event occurs
5435
- * @param context The value of the this pointer in the callback function
5436
- */
5437
- on(eventName: string, callback: Function, context?: any): void;
5438
-
5439
- /**
5440
- * Notify listeners of an event and pass arguments along
5441
- * @param eventName The name of the event to emit
5442
- */
5443
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5444
-
5445
- /**
5446
- * Alias for emit
5447
- */
5448
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5449
-
5450
- /**
5451
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5452
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5453
- * arguments.
5454
- * @param eventName The name of the event to unsubscribe from
5455
- * @param callback The function that should be invoked when the event occurs
5456
- * @param context The value of the this pointer in the callback function
5457
- */
5458
- unbind(eventName: string, callback?: Function, context?: any): void;
5459
-
5460
- /**
5461
- * Alias for unbind
5462
- */
5463
- off(eventName: string, callback?: Function, context?: any): void;
5464
- }
5465
-
5466
5026
  /**
5467
5027
  * Handler for an event on an EventEmitter.
5468
5028
  * @remarks Selects the correct type for the event
5469
5029
  * payload from the provided union based on the provided string literal type.
5470
5030
  */
5471
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5472
- type: EventType;
5473
- }>, ...args: any[]) => void;
5031
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
5474
5032
 
5475
5033
  declare namespace Events {
5476
5034
  export {
@@ -5622,7 +5180,7 @@ declare namespace ExternalApplicationEvents {
5622
5180
  ExternalApplicationEvent,
5623
5181
  EventType_4 as EventType,
5624
5182
  ExternalApplicationEventType,
5625
- Payload_5 as Payload,
5183
+ Payload_6 as Payload,
5626
5184
  ByType_4 as ByType
5627
5185
  }
5628
5186
  }
@@ -6069,7 +5627,7 @@ declare namespace FrameEvents {
6069
5627
  FrameEvent,
6070
5628
  EventType_5 as EventType,
6071
5629
  FrameEventType,
6072
- Payload_6 as Payload,
5630
+ Payload_7 as Payload,
6073
5631
  ByType_5 as ByType
6074
5632
  }
6075
5633
  }
@@ -6266,297 +5824,64 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
6266
5824
  *
6267
5825
  * @remarks Raises the `unregistered` event for each hotkey unregistered.
6268
5826
  *
6269
- * @example
6270
- * ```js
6271
- * fin.GlobalHotkey.unregisterAll()
6272
- * .then(() => {
6273
- * console.log('Success');
6274
- * })
6275
- * .catch(err => {
6276
- * console.log('Error unregistering all hotkeys for this application', err);
6277
- * });
6278
- * ```
6279
- */
6280
- unregisterAll(): Promise<void>;
6281
- /**
6282
- * Checks if a given hotkey has been registered by an application within the current runtime.
6283
- * @param hotkey a hotkey string
6284
- *
6285
- * @example
6286
- * ```js
6287
- * const hotkey = 'CommandOrControl+X';
6288
- *
6289
- * fin.GlobalHotkey.isRegistered(hotkey)
6290
- * .then((registered) => {
6291
- * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
6292
- * })
6293
- * .catch(err => {
6294
- * console.log('Error unregistering the hotkey', err);
6295
- * });
6296
- * ```
6297
- */
6298
- isRegistered(hotkey: string): Promise<boolean>;
6299
- }
6300
-
6301
- /**
6302
- * @deprecated Renamed to {@link Event}.
6303
- */
6304
- declare type GlobalHotkeyEvent = Event_9;
6305
-
6306
- declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6307
-
6308
- declare namespace GlobalHotkeyEvents {
6309
- export {
6310
- BaseEvent_8 as BaseEvent,
6311
- RegisteredEvent,
6312
- UnregisteredEvent,
6313
- Event_9 as Event,
6314
- GlobalHotkeyEvent,
6315
- EventType_6 as EventType,
6316
- GlobalHotkeyEventType,
6317
- Payload_7 as Payload,
6318
- ByType_6 as ByType
6319
- }
6320
- }
6321
-
6322
- /**
6323
- * @deprecated Renamed to {@link EventType}.
6324
- */
6325
- declare type GlobalHotkeyEventType = EventType_6;
6326
-
6327
- declare namespace GoldenLayout {
6328
- export {
6329
- GoldenLayout_2 as GoldenLayout,
6330
- ItemConfigType,
6331
- Settings,
6332
- Dimensions,
6333
- Labels,
6334
- ItemType,
6335
- ItemConfig,
6336
- ComponentConfig,
6337
- ReactComponentConfig,
6338
- Config,
6339
- ContentItem,
6340
- Container,
6341
- DragSource,
6342
- BrowserWindow,
6343
- Header,
6344
- TabDragListener,
6345
- Tab,
6346
- EventEmitter_2 as EventEmitter
6347
- }
6348
- }
6349
-
6350
- declare class GoldenLayout_2 implements EventEmitter_2 {
6351
- /**
6352
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6353
- * object and of goldenLayout.root as the document.
6354
- */
6355
- root: ContentItem;
6356
-
6357
- /**
6358
- * A reference to the (jQuery) DOM element containing the layout
6359
- */
6360
- container: JQuery;
6361
-
6362
- /**
6363
- * True once the layout item tree has been created and the initialised event has been fired
6364
- */
6365
- isInitialised: boolean;
6366
-
6367
- /**
6368
- * A reference to the current, extended top level config.
6369
- *
6370
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6371
- */
6372
- config: Config;
6373
-
6374
- /**
6375
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6376
- * to true.
6377
- */
6378
- selectedItem: ContentItem;
6379
-
6380
- /**
6381
- * The current outer width of the layout in pixels.
6382
- */
6383
- width: number;
6384
-
6385
- /**
6386
- * The current outer height of the layout in pixels.
6387
- */
6388
- height: number;
6389
-
6390
- /**
6391
- * An array of BrowserWindow instances
6392
- */
6393
- openPopouts: BrowserWindow[];
6394
-
6395
- /**
6396
- * True if the layout has been opened as a popout by another layout.
6397
- */
6398
- isSubWindow: boolean;
6399
-
6400
- /**
6401
- * A singleton instance of EventEmitter that works across windows
6402
- */
6403
- eventHub: EventEmitter_2;
6404
-
6405
- _dragProxy: any;
6406
-
6407
- dropTargetIndicator: any;
6408
-
6409
- /**
6410
- * @param config A GoldenLayout configuration object
6411
- * @param container The DOM element the layout will be initialised in. Default: document.body
6412
- */
6413
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6414
-
6415
- /*
6416
- * @param name The name of the component, as referred to by componentName in the component configuration.
6417
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6418
- * containerobject and a component state
6419
- */
6420
- registerComponent(name: String, component: any): void;
6421
-
6422
- /**
6423
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6424
- * a listener to the document and executes once it becomes ready.
6425
- */
6426
- init(): void;
6427
-
6428
- /**
6429
- * Returns the current state of the layout and its components as a serialisable object.
6430
- */
6431
- toConfig(): Config;
6432
-
6433
- /**
6434
- * Returns a component that was previously registered with layout.registerComponent().
6435
- * @param name The name of a previously registered component
6436
- */
6437
- getComponent(name: string): any;
6438
-
6439
- /**
6440
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6441
- * @param width The outer width the layout should be resized to. Default: The container elements width
6442
- * @param height The outer height the layout should be resized to. Default: The container elements height
6443
- */
6444
- updateSize(width?: number, height?: number): void;
6445
-
6446
- /**
6447
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6448
- * listeners and finally removes itself from the DOM.
6449
- */
6450
- destroy(): void;
6451
-
6452
- /**
6453
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6454
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6455
- * all call this method implicitly.
6456
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6457
- * @param parent A parent item
6458
- */
6459
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6460
-
6461
- /**
6462
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6463
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6464
- * provided its config will be read, if config is provided, only the content key
6465
- * will be used
6466
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6467
- * place the window in another screen.
6468
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6469
- * when popIn is clicked
6470
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6471
- */
6472
- createPopout(
6473
- configOrContentItem: ItemConfigType | ContentItem,
6474
- dimensions: {
6475
- width: number;
6476
- height: number;
6477
- left: number;
6478
- top: number;
6479
- },
6480
- parentId?: string,
6481
- indexInParent?: number
6482
- ): void;
6483
-
6484
- /**
6485
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6486
- * where it turns into a contentItem.
6487
- * @param element The DOM element that will be turned into a dragSource
6488
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6489
- * @return the dragSource that was created. This can be used to remove the
6490
- * dragSource from the layout later.
6491
- */
6492
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6493
-
6494
- /**
6495
- * Removes a dragSource from the layout.
6496
- *
6497
- * @param dragSource The dragSource to remove
6498
- */
6499
- removeDragSource(dragSource: DragSource): void;
6500
-
6501
- /**
6502
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6503
- * @param contentItem A ContentItem instance
6504
- */
6505
- selectItem(contentItem: ContentItem): void;
6506
-
6507
- /**
6508
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6509
- * and replace frequent keys and values with single letter substitutes.
6510
- * @param config A GoldenLayout configuration object
6511
- */
6512
- static minifyConfig(config: any): any;
6513
-
6514
- /**
6515
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6516
- * @param minifiedConfig A minified GoldenLayout configuration object
6517
- */
6518
- static unminifyConfig(minifiedConfig: any): any;
6519
-
6520
- /**
6521
- * Subscribe to an event
6522
- * @param eventName The name of the event to describe to
6523
- * @param callback The function that should be invoked when the event occurs
6524
- * @param context The value of the this pointer in the callback function
6525
- */
6526
- on(eventName: string, callback: Function, context?: any): void;
6527
-
6528
- /**
6529
- * Notify listeners of an event and pass arguments along
6530
- * @param eventName The name of the event to emit
5827
+ * @example
5828
+ * ```js
5829
+ * fin.GlobalHotkey.unregisterAll()
5830
+ * .then(() => {
5831
+ * console.log('Success');
5832
+ * })
5833
+ * .catch(err => {
5834
+ * console.log('Error unregistering all hotkeys for this application', err);
5835
+ * });
5836
+ * ```
6531
5837
  */
6532
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6533
-
5838
+ unregisterAll(): Promise<void>;
6534
5839
  /**
6535
- * Alias for emit
5840
+ * Checks if a given hotkey has been registered by an application within the current runtime.
5841
+ * @param hotkey a hotkey string
5842
+ *
5843
+ * @example
5844
+ * ```js
5845
+ * const hotkey = 'CommandOrControl+X';
5846
+ *
5847
+ * fin.GlobalHotkey.isRegistered(hotkey)
5848
+ * .then((registered) => {
5849
+ * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
5850
+ * })
5851
+ * .catch(err => {
5852
+ * console.log('Error unregistering the hotkey', err);
5853
+ * });
5854
+ * ```
6536
5855
  */
6537
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5856
+ isRegistered(hotkey: string): Promise<boolean>;
5857
+ }
6538
5858
 
6539
- /**
6540
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6541
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6542
- * arguments.
6543
- * @param eventName The name of the event to unsubscribe from
6544
- * @param callback The function that should be invoked when the event occurs
6545
- * @param context The value of the this pointer in the callback function
6546
- */
6547
- unbind(eventName: string, callback?: Function, context?: any): void;
5859
+ /**
5860
+ * @deprecated Renamed to {@link Event}.
5861
+ */
5862
+ declare type GlobalHotkeyEvent = Event_9;
6548
5863
 
6549
- /**
6550
- * Alias for unbind
6551
- */
6552
- off(eventName: string, callback?: Function, context?: any): void;
5864
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6553
5865
 
6554
- /**
6555
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6556
- */
6557
- _$createRootItemAreas(): void;
5866
+ declare namespace GlobalHotkeyEvents {
5867
+ export {
5868
+ BaseEvent_8 as BaseEvent,
5869
+ RegisteredEvent,
5870
+ UnregisteredEvent,
5871
+ Event_9 as Event,
5872
+ GlobalHotkeyEvent,
5873
+ EventType_6 as EventType,
5874
+ GlobalHotkeyEventType,
5875
+ Payload_8 as Payload,
5876
+ ByType_6 as ByType
5877
+ }
6558
5878
  }
6559
5879
 
5880
+ /**
5881
+ * @deprecated Renamed to {@link EventType}.
5882
+ */
5883
+ declare type GlobalHotkeyEventType = EventType_6;
5884
+
6560
5885
  /**
6561
5886
  * @interface
6562
5887
  */
@@ -6564,62 +5889,6 @@ declare type GpuInfo = {
6564
5889
  name: string;
6565
5890
  };
6566
5891
 
6567
- declare interface Header {
6568
- /**
6569
- * A reference to the LayoutManager instance
6570
- */
6571
- layoutManager: GoldenLayout_2;
6572
-
6573
- /**
6574
- * A reference to the Stack this Header belongs to
6575
- */
6576
- parent: ContentItem;
6577
-
6578
- /**
6579
- * An array of the Tabs within this header
6580
- */
6581
- tabs: Tab[];
6582
-
6583
- /**
6584
- * The currently selected activeContentItem
6585
- */
6586
- activeContentItem: ContentItem;
6587
-
6588
- /**
6589
- * The outer (jQuery) DOM element of this Header
6590
- */
6591
- element: JQuery;
6592
-
6593
- /**
6594
- * The (jQuery) DOM element containing the tabs
6595
- */
6596
- tabsContainer: JQuery;
6597
-
6598
- /**
6599
- * The (jQuery) DOM element containing the close, maximise and popout button
6600
- */
6601
- controlsContainer: JQuery;
6602
-
6603
- /**
6604
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6605
- * @param contentItem The content item that will be selected
6606
- */
6607
- setActiveContentItem(contentItem: ContentItem): void;
6608
-
6609
- /**
6610
- * Creates a new tab and associates it with a content item
6611
- * @param contentItem The content item the tab will be associated with
6612
- * @param index A zero based index, specifying the position of the new tab
6613
- */
6614
- createTab(contentItem: ContentItem, index?: number): void;
6615
-
6616
- /**
6617
- * Finds a tab by its contentItem and removes it
6618
- * @param contentItem The content item the tab is associated with
6619
- */
6620
- removeTab(contentItem: ContentItem): void;
6621
- }
6622
-
6623
5892
  /**
6624
5893
  * Generated when a View is hidden.
6625
5894
  * @interface
@@ -8335,50 +7604,6 @@ declare class InteropModule extends Base {
8335
7604
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8336
7605
  }
8337
7606
 
8338
- declare interface ItemConfig {
8339
- /**
8340
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8341
- */
8342
- type: ItemType;
8343
-
8344
- /**
8345
- * An array of configurations for items that will be created as children of this item.
8346
- */
8347
- content?: ItemConfigType[];
8348
-
8349
- /**
8350
- * The width of this item, relative to the other children of its parent in percent
8351
- */
8352
- width?: number;
8353
-
8354
- /**
8355
- * The height of this item, relative to the other children of its parent in percent
8356
- */
8357
- height?: number;
8358
-
8359
- /**
8360
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8361
- */
8362
- id?: string | string[];
8363
-
8364
- /**
8365
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8366
- * will return false
8367
- * Default: true
8368
- */
8369
- isClosable?: boolean;
8370
-
8371
- /**
8372
- * The title of the item as displayed on its tab and on popout windows
8373
- * Default: componentName or ''
8374
- */
8375
- title?: string;
8376
- }
8377
-
8378
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8379
-
8380
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8381
-
8382
7607
  /**
8383
7608
  * @interface
8384
7609
  */
@@ -8436,32 +7661,6 @@ declare type JumpListTask = {
8436
7661
  iconIndex?: number;
8437
7662
  };
8438
7663
 
8439
- declare interface Labels {
8440
- /**
8441
- * The tooltip text that appears when hovering over the close icon.
8442
- * Default: 'close'
8443
- */
8444
- close?: string;
8445
-
8446
- /**
8447
- * The tooltip text that appears when hovering over the maximise icon.
8448
- * Default: 'maximise'
8449
- */
8450
- maximise?: string;
8451
-
8452
- /**
8453
- * The tooltip text that appears when hovering over the minimise icon.
8454
- * Default: 'minimise'
8455
- */
8456
- minimise?: string;
8457
-
8458
- /**
8459
- * The tooltip text that appears when hovering over the popout icon.
8460
- * Default: 'open in new window'
8461
- */
8462
- popout?: string;
8463
- }
8464
-
8465
7664
  /**
8466
7665
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8467
7666
  *
@@ -8893,7 +8092,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8893
8092
  entityId: string;
8894
8093
  };
8895
8094
 
8896
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
8095
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8897
8096
 
8898
8097
  /**
8899
8098
  * @interface
@@ -10693,76 +9892,100 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10693
9892
  };
10694
9893
 
10695
9894
  /**
10696
- * Extracts a single event type matching the given key from the View {@link Event} union.
9895
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9896
+ *
9897
+ * @see {@link ByType}
10697
9898
  *
10698
9899
  * @typeParam Type String key specifying the event to extract
10699
9900
  */
10700
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10701
- type: Type;
9901
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9902
+
9903
+ /**
9904
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9905
+ *
9906
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9907
+ * the appropriate payload union for that namespace.
9908
+ *
9909
+ * @typeParam Event Union of payloads for events on the given emitter
9910
+ * @see {@link ByType}
9911
+ *
9912
+ * @typeParam Type String key specifying the event to extract from the union
9913
+ *
9914
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9915
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9916
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
9917
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9918
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
9919
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
9920
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
9921
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
9922
+ */
9923
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9924
+ type: EventType;
10702
9925
  }>;
10703
9926
 
9927
+ /**
9928
+ * Extracts a single event type matching the given key from the View {@link Event} union.
9929
+ *
9930
+ * @see {@link ByType}
9931
+ *
9932
+ * @typeParam Type String key specifying the event to extract
9933
+ */
9934
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
9935
+
10704
9936
  /**
10705
9937
  * Extracts a single event type matching the given key from the Window {@link Event} union.
10706
9938
  *
9939
+ * @see {@link ByType}
9940
+ *
10707
9941
  * @typeParam Type String key specifying the event to extract
10708
9942
  */
10709
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10710
- type: Type;
10711
- }>;
9943
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
10712
9944
 
10713
9945
  /**
10714
9946
  * Extracts a single event type matching the given key from the Application {@link Event} union.
10715
9947
  *
9948
+ * @see {@link ByType}
9949
+ *
10716
9950
  * @typeParam Type String key specifying the event to extract
10717
9951
  */
10718
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10719
- type: Type;
10720
- }>;
9952
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
10721
9953
 
10722
9954
  /**
10723
9955
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10724
9956
  *
9957
+ * @see {@link ByType}
9958
+ *
10725
9959
  * @typeParam Type String key specifying the event to extract
10726
9960
  */
10727
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10728
- type: Type;
10729
- }>;
9961
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
10730
9962
 
10731
9963
  /**
10732
9964
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
10733
9965
  *
9966
+ * @see {@link ByType}
9967
+ *
10734
9968
  * @typeParam Type String key specifying the event to extract
10735
9969
  */
10736
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10737
- type: Type;
10738
- }>;
9970
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
10739
9971
 
10740
9972
  /**
10741
9973
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10742
9974
  *
9975
+ * @see {@link ByType}
9976
+ *
10743
9977
  * @typeParam Type String key specifying the event to extract
10744
9978
  */
10745
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10746
- type: Type;
10747
- }>;
9979
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
10748
9980
 
10749
9981
  /**
10750
9982
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
10751
9983
  *
10752
- * @typeParam Type String key specifying the event to extract
10753
- */
10754
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10755
- type: Type;
10756
- }>;
10757
-
10758
- /**
10759
- * Extracts a single event type matching the given key from the System {@link Event} union.
9984
+ * @see {@link ByType}
10760
9985
  *
10761
9986
  * @typeParam Type String key specifying the event to extract
10762
9987
  */
10763
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10764
- type: Type;
10765
- }>;
9988
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
10766
9989
 
10767
9990
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
10768
9991
 
@@ -11456,7 +10679,7 @@ declare namespace PlatformEvents {
11456
10679
  PlatformEvent,
11457
10680
  EventType_7 as EventType,
11458
10681
  PlatformEventType,
11459
- Payload_8 as Payload,
10682
+ Payload_9 as Payload,
11460
10683
  ByType_7 as ByType
11461
10684
  }
11462
10685
  }
@@ -13088,18 +12311,6 @@ declare type QueryPermissionResult = {
13088
12311
  rawValue?: unknown;
13089
12312
  };
13090
12313
 
13091
- declare interface ReactComponentConfig extends ItemConfig {
13092
- /**
13093
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
13094
- */
13095
- component: string;
13096
-
13097
- /**
13098
- * Properties that will be passed to the component and accessible using this.props.
13099
- */
13100
- props?: any;
13101
- }
13102
-
13103
12314
  /**
13104
12315
  * @interface
13105
12316
  */
@@ -13187,6 +12398,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
13187
12398
  token: string;
13188
12399
  }
13189
12400
 
12401
+ /**
12402
+ * Generated when a View is removed from a layout.
12403
+ * @interface
12404
+ */
12405
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12406
+ type: 'removed-from-layout';
12407
+ layoutIdentity: OpenFin.LayoutIdentity;
12408
+ };
12409
+
13190
12410
  /**
13191
12411
  * @interface
13192
12412
  */
@@ -13606,97 +12826,6 @@ declare type SessionContextGroup = {
13606
12826
  }>;
13607
12827
  };
13608
12828
 
13609
- declare interface Settings {
13610
- preventSplitterResize?: boolean;
13611
-
13612
- newTabButton?: {
13613
- url?: string;
13614
- };
13615
-
13616
- /**
13617
- * If true, tabs can't be dragged into the window.
13618
- * Default: false
13619
- */
13620
- preventDragIn?: boolean;
13621
-
13622
- /**
13623
- * If true, tabs can't be dragged out of the window.
13624
- * Default: false
13625
- */
13626
- preventDragOut?: boolean;
13627
-
13628
- /**
13629
- * If true, stack headers are the only areas where tabs can be dropped.
13630
- * Default: false
13631
- */
13632
- constrainDragToHeaders?: boolean;
13633
- /**
13634
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13635
- * Default: true
13636
- */
13637
- hasHeaders?: boolean;
13638
-
13639
- /**
13640
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13641
- * automatically when layout.createDragSource() is called.
13642
- * Default: true
13643
- */
13644
- constrainDragToContainer?: boolean;
13645
-
13646
- /**
13647
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13648
- * Default: true
13649
- */
13650
- reorderEnabled?: boolean;
13651
-
13652
- /**
13653
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13654
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13655
- * Default: false
13656
- */
13657
- selectionEnabled?: boolean;
13658
-
13659
- /**
13660
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13661
- * be transferred to the new window, if false only the active component will be opened.
13662
- * Default: false
13663
- */
13664
- popoutWholeStack?: boolean;
13665
-
13666
- /**
13667
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13668
- * If false, the popout call will fail silently.
13669
- * Default: true
13670
- */
13671
- blockedPopoutsThrowError?: boolean;
13672
-
13673
- /**
13674
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13675
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13676
- * addition, any changes made to popouts won't be stored after the parent is closed.
13677
- * Default: true
13678
- */
13679
- closePopoutsOnUnload?: boolean;
13680
-
13681
- /**
13682
- * Specifies if the popout icon should be displayed in the header-bar.
13683
- * Default: true
13684
- */
13685
- showPopoutIcon?: boolean;
13686
-
13687
- /**
13688
- * Specifies if the maximise icon should be displayed in the header-bar.
13689
- * Default: true
13690
- */
13691
- showMaximiseIcon?: boolean;
13692
-
13693
- /**
13694
- * Specifies if the close icon should be displayed in the header-bar.
13695
- * Default: true
13696
- */
13697
- showCloseIcon?: boolean;
13698
- }
13699
-
13700
12829
  /**
13701
12830
  * @interface
13702
12831
  */
@@ -13920,7 +13049,7 @@ declare type Snapshot = {
13920
13049
  * _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.
13921
13050
  * @interface
13922
13051
  */
13923
- declare type SnapshotAppliedEvent = BaseEvent & {
13052
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13924
13053
  topic: 'application';
13925
13054
  type: 'platform-snapshot-applied';
13926
13055
  };
@@ -15532,7 +14661,7 @@ declare namespace SystemEvents {
15532
14661
  SystemEvent,
15533
14662
  EventType_8 as EventType,
15534
14663
  SystemEventType,
15535
- Payload_9 as Payload,
14664
+ Payload_10 as Payload,
15536
14665
  ByType_8 as ByType
15537
14666
  }
15538
14667
  }
@@ -15605,59 +14734,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15605
14734
  proceed: () => void;
15606
14735
  }) => void;
15607
14736
 
15608
- declare interface Tab {
15609
- _dragListener: TabDragListener;
15610
-
15611
- /**
15612
- * True if this tab is the selected tab
15613
- */
15614
- isActive: boolean;
15615
-
15616
- /**
15617
- * A reference to the header this tab is a child of
15618
- */
15619
- header: Header;
15620
-
15621
- /**
15622
- * A reference to the content item this tab relates to
15623
- */
15624
- contentItem: ContentItem;
15625
-
15626
- /**
15627
- * The tabs outer (jQuery) DOM element
15628
- */
15629
- element: JQuery;
15630
-
15631
- /**
15632
- * The (jQuery) DOM element containing the title
15633
- */
15634
- titleElement: JQuery;
15635
-
15636
- /**
15637
- * The (jQuery) DOM element that closes the tab
15638
- */
15639
- closeElement: JQuery;
15640
-
15641
- /**
15642
- * Sets the tab's title. Does not affect the contentItem's title!
15643
- * @param title The new title
15644
- */
15645
- setTitle(title: string): void;
15646
-
15647
- /**
15648
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15649
- * @param isActive Whether the tab is active
15650
- */
15651
- setActive(isActive: boolean): void;
15652
- }
15653
-
15654
- declare interface TabDragListener extends EventEmitter_2 {
15655
- /**
15656
- * A reference to the content item this tab relates to
15657
- */
15658
- contentItem: ContentItem;
15659
- }
15660
-
15661
14737
  /**
15662
14738
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15663
14739
  */
@@ -16635,6 +15711,8 @@ declare namespace ViewEvents {
16635
15711
  BaseEvent_4 as BaseEvent,
16636
15712
  BaseViewEvent,
16637
15713
  TargetChangedEvent,
15714
+ AddedToLayoutEvent,
15715
+ RemovedFromLayoutEvent,
16638
15716
  NonPropagatedViewEvent,
16639
15717
  CreatedEvent,
16640
15718
  DestroyedEvent,
@@ -16651,7 +15729,7 @@ declare namespace ViewEvents {
16651
15729
  PropagatedViewEvent,
16652
15730
  PropagatedEventType_2 as PropagatedEventType,
16653
15731
  PropagatedViewEventType,
16654
- Payload_2 as Payload,
15732
+ Payload_3 as Payload,
16655
15733
  ByType
16656
15734
  }
16657
15735
  }
@@ -19130,7 +18208,7 @@ declare namespace WindowEvents {
19130
18208
  PropagatedEvent_3 as PropagatedEvent,
19131
18209
  PropagatedWindowEvent,
19132
18210
  PropagatedWindowEventType,
19133
- Payload_3 as Payload,
18211
+ Payload_4 as Payload,
19134
18212
  ByType_2 as ByType
19135
18213
  }
19136
18214
  }