@openfin/node-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
  };
@@ -3807,7 +3753,9 @@ declare type ConstWindowOptions = {
3807
3753
  */
3808
3754
  preloadScripts: PreloadScript[];
3809
3755
  /**
3810
- * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
3756
+ * String tag that attempts to group like-tagged renderers together.
3757
+ * 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.
3758
+ * @remarks Will only be used if pages are on the same origin.
3811
3759
  */
3812
3760
  processAffinity: string;
3813
3761
  /**
@@ -3897,103 +3845,6 @@ declare type ConstWindowOptions = {
3897
3845
  inheritance?: Partial<InheritableOptions>;
3898
3846
  };
3899
3847
 
3900
- declare interface Container extends EventEmitter_2 {
3901
- /**
3902
- * The current width of the container in pixel
3903
- */
3904
- width: number;
3905
-
3906
- /**
3907
- * The current height of the container in pixel
3908
- */
3909
- height: number;
3910
-
3911
- /**
3912
- * A reference to the component-item that controls this container
3913
- */
3914
- parent: ContentItem;
3915
-
3916
- /**
3917
- * A reference to the tab that controls this container. Will initially be null
3918
- * (and populated once a tab event has been fired).
3919
- */
3920
- tab: Tab;
3921
-
3922
- /**
3923
- * The current title of the container
3924
- */
3925
- title: string;
3926
-
3927
- /*
3928
- * A reference to the GoldenLayout instance this container belongs to
3929
- */
3930
- layoutManager: GoldenLayout_2;
3931
-
3932
- /**
3933
- * True if the item is currently hidden
3934
- */
3935
- isHidden: boolean;
3936
-
3937
- /**
3938
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3939
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3940
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3941
- * constructor function. It will also be used when the component is opened in a new window.
3942
- * @param state A serialisable object
3943
- */
3944
- setState(state: any): void;
3945
-
3946
- /**
3947
- * The same as setState but does not emit 'stateChanged' event
3948
- * @param {serialisable} state
3949
- */
3950
- setStateSkipEvent(state: any): void;
3951
-
3952
- /**
3953
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3954
- * @param state A serialisable object
3955
- */
3956
- extendState(state: any): void;
3957
-
3958
- /**
3959
- * Returns the current state.
3960
- */
3961
- getState(): any;
3962
-
3963
- /**
3964
- * Returns the container's inner element as a jQuery element
3965
- */
3966
- getElement(): JQuery;
3967
-
3968
- /**
3969
- * hides the container or returns false if hiding it is not possible
3970
- */
3971
- hide(): boolean;
3972
-
3973
- /**
3974
- * shows the container or returns false if showing it is not possible
3975
- */
3976
- show(): boolean;
3977
-
3978
- /**
3979
- * Sets the container to the specified size or returns false if that's not possible
3980
- * @param width the new width in pixel
3981
- * @param height the new height in pixel
3982
- */
3983
- setSize(width: number, height: number): boolean;
3984
-
3985
- /**
3986
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3987
- * @param title the new title
3988
- */
3989
- setTitle(title: string): void;
3990
-
3991
- /**
3992
- * Closes the container or returns false if that is not possible
3993
- */
3994
- close(): boolean;
3995
- }
3996
-
3997
3848
  declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3998
3849
 
3999
3850
  /**
@@ -4056,218 +3907,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
4056
3907
  disposition: string;
4057
3908
  };
4058
3909
 
4059
- declare interface ContentItem extends EventEmitter_2 {
4060
- instance: any;
4061
- header: any;
4062
- _splitter: any;
4063
- /**
4064
- * This items configuration in its current state
4065
- */
4066
- config: ItemConfigType;
4067
-
4068
- /**
4069
- * The type of the item. Can be row, column, stack, component or root
4070
- */
4071
- type: ItemType;
4072
-
4073
- /**
4074
- * An array of items that are children of this item
4075
- */
4076
- contentItems: ContentItem[];
4077
-
4078
- container: Container;
4079
- /**
4080
- * The item that is this item's parent (or null if the item is root)
4081
- */
4082
- parent: ContentItem;
4083
-
4084
- /**
4085
- * A String or array of identifiers if provided in the configuration
4086
- */
4087
- id: string;
4088
-
4089
- /**
4090
- * True if the item had been initialised
4091
- */
4092
- isInitialised: boolean;
4093
-
4094
- /**
4095
- * True if the item is maximised
4096
- */
4097
- isMaximised: boolean;
4098
-
4099
- /**
4100
- * True if the item is the layout's root item
4101
- */
4102
- isRoot: boolean;
4103
-
4104
- /**
4105
- * True if the item is a row
4106
- */
4107
- isRow: boolean;
4108
-
4109
- /**
4110
- * True if the item is a column
4111
- */
4112
- isColumn: boolean;
4113
-
4114
- /**
4115
- * True if the item is a stack
4116
- */
4117
- isStack: boolean;
4118
-
4119
- /**
4120
- * True if the item is a component
4121
- */
4122
- isComponent: boolean;
4123
-
4124
- /**
4125
- * A reference to the layoutManager that controls this item
4126
- */
4127
- layoutManager: any;
4128
-
4129
- /**
4130
- * The item's outer element
4131
- */
4132
- element: JQuery;
4133
-
4134
- /**
4135
- * The item's inner element. Can be the same as the outer element.
4136
- */
4137
- childElementContainer: Container;
4138
-
4139
- /**
4140
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4141
- * from its original position before adding it to this item.
4142
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4143
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4144
- */
4145
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4146
-
4147
- /**
4148
- * Destroys the item and all it's children
4149
- * @param contentItem The contentItem that should be removed
4150
- * @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.
4151
- */
4152
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4153
-
4154
- /**
4155
- * The contentItem that should be removed
4156
- * @param oldChild ContentItem The contentItem that should be removed
4157
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4158
- */
4159
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4160
-
4161
- /**
4162
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4163
- */
4164
- setSize(): void;
4165
-
4166
- /**
4167
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4168
- * @param title the new title
4169
- */
4170
- setTitle(title: string): void;
4171
-
4172
- /**
4173
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4174
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4175
- * @param functionName The name of the method to invoke
4176
- * @param functionArguments An array of arguments to pass to every function
4177
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4178
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4179
- */
4180
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4181
-
4182
- /**
4183
- * 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.
4184
- */
4185
- emitBubblingEvent(name: string): void;
4186
-
4187
- /**
4188
- * Convenience method for item.parent.removeChild( item )
4189
- */
4190
- remove(): void;
4191
-
4192
- /**
4193
- * Removes the item from its current position in the layout and opens it in a window
4194
- */
4195
- popout(): BrowserWindow;
4196
-
4197
- /**
4198
- * Maximises the item or minimises it if it's already maximised
4199
- */
4200
- toggleMaximise(): void;
4201
-
4202
- /**
4203
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4204
- */
4205
- select(): void;
4206
-
4207
- /**
4208
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4209
- */
4210
- deselect(): void;
4211
-
4212
- /**
4213
- * Returns true if the item has the specified id or false if not
4214
- * @param id An id to check for
4215
- */
4216
- hasId(id: string): boolean;
4217
-
4218
- /**
4219
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4220
- * @param contentItem The new active content item
4221
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4222
- */
4223
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4224
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4225
-
4226
- /**
4227
- * Only Stacks have this method! Returns the currently selected contentItem.
4228
- */
4229
- getActiveContentItem(): ContentItem;
4230
-
4231
- /**
4232
- * Adds an id to an item or does nothing if the id is already present
4233
- * @param id The id to be added
4234
- */
4235
- addId(id: string): void;
4236
-
4237
- /**
4238
- * Removes an id from an item or throws an error if the id couldn't be found
4239
- * @param id The id to be removed
4240
- */
4241
- removeId(id: string): void;
4242
-
4243
- /**
4244
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4245
- * @param filterFunction A function that determines whether an item matches certain criteria
4246
- */
4247
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4248
-
4249
- /**
4250
- * Returns all items with the specified id.
4251
- * @param id An id specified in the itemConfig
4252
- */
4253
- getItemsById(id: string | string[]): ContentItem[];
4254
-
4255
- /**
4256
- * Returns all items with the specified type
4257
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4258
- */
4259
- getItemsByType(type: string): ContentItem[];
4260
-
4261
- /**
4262
- * Returns all instances of the component with the specified componentName
4263
- * @param componentName a componentName as specified in the itemConfig
4264
- */
4265
- getComponentsByName(componentName: string): any;
4266
-
4267
- _contentAreaDimensions: any;
4268
- _$getArea: () => any;
4269
- }
4270
-
4271
3910
  /**
4272
3911
  * Restrict navigation to URLs that match an allowed pattern.
4273
3912
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4752,46 +4391,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4752
4391
  type: 'did-finish-load';
4753
4392
  };
4754
4393
 
4755
- declare interface Dimensions {
4756
- /**
4757
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4758
- * than the visible one, making it safe to set this to small values without affecting usability.
4759
- * Default: 5
4760
- */
4761
- borderWidth?: number;
4762
-
4763
- /**
4764
- * The minimum height an item can be resized to (in pixel).
4765
- * Default: 10
4766
- */
4767
- minItemHeight?: number;
4768
-
4769
- /**
4770
- * The minimum width an item can be resized to (in pixel).
4771
- * Default: 10
4772
- */
4773
- minItemWidth?: number;
4774
-
4775
- /**
4776
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4777
- * adjusted accordingly.
4778
- * Default: 20
4779
- */
4780
- headerHeight?: number;
4781
-
4782
- /**
4783
- * The width of the element that appears when an item is dragged (in pixel).
4784
- * Default: 300
4785
- */
4786
- dragProxyWidth?: number;
4787
-
4788
- /**
4789
- * The height of the element that appears when an item is dragged (in pixel).
4790
- * Default: 200
4791
- */
4792
- dragProxyHeight?: number;
4793
- }
4794
-
4795
4394
  /**
4796
4395
  * @interface
4797
4396
  */
@@ -5088,8 +4687,6 @@ declare type Dpi = {
5088
4687
  vertical?: number;
5089
4688
  };
5090
4689
 
5091
- declare interface DragSource {}
5092
-
5093
4690
  /**
5094
4691
  * Generated when a window has been embedded.
5095
4692
  * @interface
@@ -5362,7 +4959,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5362
4959
  */
5363
4960
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5364
4961
  target: OpenFin.Identity;
5365
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4962
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
5366
4963
 
5367
4964
  /**
5368
4965
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -5406,51 +5003,12 @@ declare class EventAggregator extends EmitterMap {
5406
5003
  dispatchEvent: (message: Message<any>) => boolean;
5407
5004
  }
5408
5005
 
5409
- declare interface EventEmitter_2 {
5410
- [x: string]: any;
5411
- /**
5412
- * Subscribe to an event
5413
- * @param eventName The name of the event to describe to
5414
- * @param callback The function that should be invoked when the event occurs
5415
- * @param context The value of the this pointer in the callback function
5416
- */
5417
- on(eventName: string, callback: Function, context?: any): void;
5418
-
5419
- /**
5420
- * Notify listeners of an event and pass arguments along
5421
- * @param eventName The name of the event to emit
5422
- */
5423
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5424
-
5425
- /**
5426
- * Alias for emit
5427
- */
5428
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5429
-
5430
- /**
5431
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5432
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5433
- * arguments.
5434
- * @param eventName The name of the event to unsubscribe from
5435
- * @param callback The function that should be invoked when the event occurs
5436
- * @param context The value of the this pointer in the callback function
5437
- */
5438
- unbind(eventName: string, callback?: Function, context?: any): void;
5439
-
5440
- /**
5441
- * Alias for unbind
5442
- */
5443
- off(eventName: string, callback?: Function, context?: any): void;
5444
- }
5445
-
5446
5006
  /**
5447
5007
  * Handler for an event on an EventEmitter.
5448
5008
  * @remarks Selects the correct type for the event
5449
5009
  * payload from the provided union based on the provided string literal type.
5450
5010
  */
5451
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5452
- type: EventType;
5453
- }>, ...args: any[]) => void;
5011
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
5454
5012
 
5455
5013
  declare namespace Events {
5456
5014
  export {
@@ -5602,7 +5160,7 @@ declare namespace ExternalApplicationEvents {
5602
5160
  ExternalApplicationEvent,
5603
5161
  EventType_4 as EventType,
5604
5162
  ExternalApplicationEventType,
5605
- Payload_5 as Payload,
5163
+ Payload_6 as Payload,
5606
5164
  ByType_4 as ByType
5607
5165
  }
5608
5166
  }
@@ -6077,7 +5635,7 @@ declare namespace FrameEvents {
6077
5635
  FrameEvent,
6078
5636
  EventType_5 as EventType,
6079
5637
  FrameEventType,
6080
- Payload_6 as Payload,
5638
+ Payload_7 as Payload,
6081
5639
  ByType_5 as ByType
6082
5640
  }
6083
5641
  }
@@ -6274,297 +5832,64 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
6274
5832
  *
6275
5833
  * @remarks Raises the `unregistered` event for each hotkey unregistered.
6276
5834
  *
6277
- * @example
6278
- * ```js
6279
- * fin.GlobalHotkey.unregisterAll()
6280
- * .then(() => {
6281
- * console.log('Success');
6282
- * })
6283
- * .catch(err => {
6284
- * console.log('Error unregistering all hotkeys for this application', err);
6285
- * });
6286
- * ```
6287
- */
6288
- unregisterAll(): Promise<void>;
6289
- /**
6290
- * Checks if a given hotkey has been registered by an application within the current runtime.
6291
- * @param hotkey a hotkey string
6292
- *
6293
- * @example
6294
- * ```js
6295
- * const hotkey = 'CommandOrControl+X';
6296
- *
6297
- * fin.GlobalHotkey.isRegistered(hotkey)
6298
- * .then((registered) => {
6299
- * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
6300
- * })
6301
- * .catch(err => {
6302
- * console.log('Error unregistering the hotkey', err);
6303
- * });
6304
- * ```
6305
- */
6306
- isRegistered(hotkey: string): Promise<boolean>;
6307
- }
6308
-
6309
- /**
6310
- * @deprecated Renamed to {@link Event}.
6311
- */
6312
- declare type GlobalHotkeyEvent = Event_9;
6313
-
6314
- declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6315
-
6316
- declare namespace GlobalHotkeyEvents {
6317
- export {
6318
- BaseEvent_8 as BaseEvent,
6319
- RegisteredEvent,
6320
- UnregisteredEvent,
6321
- Event_9 as Event,
6322
- GlobalHotkeyEvent,
6323
- EventType_6 as EventType,
6324
- GlobalHotkeyEventType,
6325
- Payload_7 as Payload,
6326
- ByType_6 as ByType
6327
- }
6328
- }
6329
-
6330
- /**
6331
- * @deprecated Renamed to {@link EventType}.
6332
- */
6333
- declare type GlobalHotkeyEventType = EventType_6;
6334
-
6335
- declare namespace GoldenLayout {
6336
- export {
6337
- GoldenLayout_2 as GoldenLayout,
6338
- ItemConfigType,
6339
- Settings,
6340
- Dimensions,
6341
- Labels,
6342
- ItemType,
6343
- ItemConfig,
6344
- ComponentConfig,
6345
- ReactComponentConfig,
6346
- Config,
6347
- ContentItem,
6348
- Container,
6349
- DragSource,
6350
- BrowserWindow,
6351
- Header,
6352
- TabDragListener,
6353
- Tab,
6354
- EventEmitter_2 as EventEmitter
6355
- }
6356
- }
6357
-
6358
- declare class GoldenLayout_2 implements EventEmitter_2 {
6359
- /**
6360
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6361
- * object and of goldenLayout.root as the document.
6362
- */
6363
- root: ContentItem;
6364
-
6365
- /**
6366
- * A reference to the (jQuery) DOM element containing the layout
6367
- */
6368
- container: JQuery;
6369
-
6370
- /**
6371
- * True once the layout item tree has been created and the initialised event has been fired
6372
- */
6373
- isInitialised: boolean;
6374
-
6375
- /**
6376
- * A reference to the current, extended top level config.
6377
- *
6378
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6379
- */
6380
- config: Config;
6381
-
6382
- /**
6383
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6384
- * to true.
6385
- */
6386
- selectedItem: ContentItem;
6387
-
6388
- /**
6389
- * The current outer width of the layout in pixels.
6390
- */
6391
- width: number;
6392
-
6393
- /**
6394
- * The current outer height of the layout in pixels.
6395
- */
6396
- height: number;
6397
-
6398
- /**
6399
- * An array of BrowserWindow instances
6400
- */
6401
- openPopouts: BrowserWindow[];
6402
-
6403
- /**
6404
- * True if the layout has been opened as a popout by another layout.
6405
- */
6406
- isSubWindow: boolean;
6407
-
6408
- /**
6409
- * A singleton instance of EventEmitter that works across windows
6410
- */
6411
- eventHub: EventEmitter_2;
6412
-
6413
- _dragProxy: any;
6414
-
6415
- dropTargetIndicator: any;
6416
-
6417
- /**
6418
- * @param config A GoldenLayout configuration object
6419
- * @param container The DOM element the layout will be initialised in. Default: document.body
6420
- */
6421
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6422
-
6423
- /*
6424
- * @param name The name of the component, as referred to by componentName in the component configuration.
6425
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6426
- * containerobject and a component state
6427
- */
6428
- registerComponent(name: String, component: any): void;
6429
-
6430
- /**
6431
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6432
- * a listener to the document and executes once it becomes ready.
6433
- */
6434
- init(): void;
6435
-
6436
- /**
6437
- * Returns the current state of the layout and its components as a serialisable object.
6438
- */
6439
- toConfig(): Config;
6440
-
6441
- /**
6442
- * Returns a component that was previously registered with layout.registerComponent().
6443
- * @param name The name of a previously registered component
6444
- */
6445
- getComponent(name: string): any;
6446
-
6447
- /**
6448
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6449
- * @param width The outer width the layout should be resized to. Default: The container elements width
6450
- * @param height The outer height the layout should be resized to. Default: The container elements height
6451
- */
6452
- updateSize(width?: number, height?: number): void;
6453
-
6454
- /**
6455
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6456
- * listeners and finally removes itself from the DOM.
6457
- */
6458
- destroy(): void;
6459
-
6460
- /**
6461
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6462
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6463
- * all call this method implicitly.
6464
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6465
- * @param parent A parent item
6466
- */
6467
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6468
-
6469
- /**
6470
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6471
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6472
- * provided its config will be read, if config is provided, only the content key
6473
- * will be used
6474
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6475
- * place the window in another screen.
6476
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6477
- * when popIn is clicked
6478
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6479
- */
6480
- createPopout(
6481
- configOrContentItem: ItemConfigType | ContentItem,
6482
- dimensions: {
6483
- width: number;
6484
- height: number;
6485
- left: number;
6486
- top: number;
6487
- },
6488
- parentId?: string,
6489
- indexInParent?: number
6490
- ): void;
6491
-
6492
- /**
6493
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6494
- * where it turns into a contentItem.
6495
- * @param element The DOM element that will be turned into a dragSource
6496
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6497
- * @return the dragSource that was created. This can be used to remove the
6498
- * dragSource from the layout later.
6499
- */
6500
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6501
-
6502
- /**
6503
- * Removes a dragSource from the layout.
6504
- *
6505
- * @param dragSource The dragSource to remove
6506
- */
6507
- removeDragSource(dragSource: DragSource): void;
6508
-
6509
- /**
6510
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6511
- * @param contentItem A ContentItem instance
6512
- */
6513
- selectItem(contentItem: ContentItem): void;
6514
-
6515
- /**
6516
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6517
- * and replace frequent keys and values with single letter substitutes.
6518
- * @param config A GoldenLayout configuration object
6519
- */
6520
- static minifyConfig(config: any): any;
6521
-
6522
- /**
6523
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6524
- * @param minifiedConfig A minified GoldenLayout configuration object
6525
- */
6526
- static unminifyConfig(minifiedConfig: any): any;
6527
-
6528
- /**
6529
- * Subscribe to an event
6530
- * @param eventName The name of the event to describe to
6531
- * @param callback The function that should be invoked when the event occurs
6532
- * @param context The value of the this pointer in the callback function
6533
- */
6534
- on(eventName: string, callback: Function, context?: any): void;
6535
-
6536
- /**
6537
- * Notify listeners of an event and pass arguments along
6538
- * @param eventName The name of the event to emit
5835
+ * @example
5836
+ * ```js
5837
+ * fin.GlobalHotkey.unregisterAll()
5838
+ * .then(() => {
5839
+ * console.log('Success');
5840
+ * })
5841
+ * .catch(err => {
5842
+ * console.log('Error unregistering all hotkeys for this application', err);
5843
+ * });
5844
+ * ```
6539
5845
  */
6540
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6541
-
5846
+ unregisterAll(): Promise<void>;
6542
5847
  /**
6543
- * Alias for emit
5848
+ * Checks if a given hotkey has been registered by an application within the current runtime.
5849
+ * @param hotkey a hotkey string
5850
+ *
5851
+ * @example
5852
+ * ```js
5853
+ * const hotkey = 'CommandOrControl+X';
5854
+ *
5855
+ * fin.GlobalHotkey.isRegistered(hotkey)
5856
+ * .then((registered) => {
5857
+ * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
5858
+ * })
5859
+ * .catch(err => {
5860
+ * console.log('Error unregistering the hotkey', err);
5861
+ * });
5862
+ * ```
6544
5863
  */
6545
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5864
+ isRegistered(hotkey: string): Promise<boolean>;
5865
+ }
6546
5866
 
6547
- /**
6548
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6549
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6550
- * arguments.
6551
- * @param eventName The name of the event to unsubscribe from
6552
- * @param callback The function that should be invoked when the event occurs
6553
- * @param context The value of the this pointer in the callback function
6554
- */
6555
- unbind(eventName: string, callback?: Function, context?: any): void;
5867
+ /**
5868
+ * @deprecated Renamed to {@link Event}.
5869
+ */
5870
+ declare type GlobalHotkeyEvent = Event_9;
6556
5871
 
6557
- /**
6558
- * Alias for unbind
6559
- */
6560
- off(eventName: string, callback?: Function, context?: any): void;
5872
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6561
5873
 
6562
- /**
6563
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6564
- */
6565
- _$createRootItemAreas(): void;
5874
+ declare namespace GlobalHotkeyEvents {
5875
+ export {
5876
+ BaseEvent_8 as BaseEvent,
5877
+ RegisteredEvent,
5878
+ UnregisteredEvent,
5879
+ Event_9 as Event,
5880
+ GlobalHotkeyEvent,
5881
+ EventType_6 as EventType,
5882
+ GlobalHotkeyEventType,
5883
+ Payload_8 as Payload,
5884
+ ByType_6 as ByType
5885
+ }
6566
5886
  }
6567
5887
 
5888
+ /**
5889
+ * @deprecated Renamed to {@link EventType}.
5890
+ */
5891
+ declare type GlobalHotkeyEventType = EventType_6;
5892
+
6568
5893
  /**
6569
5894
  * @interface
6570
5895
  */
@@ -6572,62 +5897,6 @@ declare type GpuInfo = {
6572
5897
  name: string;
6573
5898
  };
6574
5899
 
6575
- declare interface Header {
6576
- /**
6577
- * A reference to the LayoutManager instance
6578
- */
6579
- layoutManager: GoldenLayout_2;
6580
-
6581
- /**
6582
- * A reference to the Stack this Header belongs to
6583
- */
6584
- parent: ContentItem;
6585
-
6586
- /**
6587
- * An array of the Tabs within this header
6588
- */
6589
- tabs: Tab[];
6590
-
6591
- /**
6592
- * The currently selected activeContentItem
6593
- */
6594
- activeContentItem: ContentItem;
6595
-
6596
- /**
6597
- * The outer (jQuery) DOM element of this Header
6598
- */
6599
- element: JQuery;
6600
-
6601
- /**
6602
- * The (jQuery) DOM element containing the tabs
6603
- */
6604
- tabsContainer: JQuery;
6605
-
6606
- /**
6607
- * The (jQuery) DOM element containing the close, maximise and popout button
6608
- */
6609
- controlsContainer: JQuery;
6610
-
6611
- /**
6612
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6613
- * @param contentItem The content item that will be selected
6614
- */
6615
- setActiveContentItem(contentItem: ContentItem): void;
6616
-
6617
- /**
6618
- * Creates a new tab and associates it with a content item
6619
- * @param contentItem The content item the tab will be associated with
6620
- * @param index A zero based index, specifying the position of the new tab
6621
- */
6622
- createTab(contentItem: ContentItem, index?: number): void;
6623
-
6624
- /**
6625
- * Finds a tab by its contentItem and removes it
6626
- * @param contentItem The content item the tab is associated with
6627
- */
6628
- removeTab(contentItem: ContentItem): void;
6629
- }
6630
-
6631
5900
  /**
6632
5901
  * Generated when a View is hidden.
6633
5902
  * @interface
@@ -8322,50 +7591,6 @@ declare class InteropModule extends Base {
8322
7591
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8323
7592
  }
8324
7593
 
8325
- declare interface ItemConfig {
8326
- /**
8327
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8328
- */
8329
- type: ItemType;
8330
-
8331
- /**
8332
- * An array of configurations for items that will be created as children of this item.
8333
- */
8334
- content?: ItemConfigType[];
8335
-
8336
- /**
8337
- * The width of this item, relative to the other children of its parent in percent
8338
- */
8339
- width?: number;
8340
-
8341
- /**
8342
- * The height of this item, relative to the other children of its parent in percent
8343
- */
8344
- height?: number;
8345
-
8346
- /**
8347
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8348
- */
8349
- id?: string | string[];
8350
-
8351
- /**
8352
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8353
- * will return false
8354
- * Default: true
8355
- */
8356
- isClosable?: boolean;
8357
-
8358
- /**
8359
- * The title of the item as displayed on its tab and on popout windows
8360
- * Default: componentName or ''
8361
- */
8362
- title?: string;
8363
- }
8364
-
8365
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8366
-
8367
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8368
-
8369
7594
  /**
8370
7595
  * @interface
8371
7596
  */
@@ -8423,32 +7648,6 @@ declare type JumpListTask = {
8423
7648
  iconIndex?: number;
8424
7649
  };
8425
7650
 
8426
- declare interface Labels {
8427
- /**
8428
- * The tooltip text that appears when hovering over the close icon.
8429
- * Default: 'close'
8430
- */
8431
- close?: string;
8432
-
8433
- /**
8434
- * The tooltip text that appears when hovering over the maximise icon.
8435
- * Default: 'maximise'
8436
- */
8437
- maximise?: string;
8438
-
8439
- /**
8440
- * The tooltip text that appears when hovering over the minimise icon.
8441
- * Default: 'minimise'
8442
- */
8443
- minimise?: string;
8444
-
8445
- /**
8446
- * The tooltip text that appears when hovering over the popout icon.
8447
- * Default: 'open in new window'
8448
- */
8449
- popout?: string;
8450
- }
8451
-
8452
7651
  export declare function launch(config: ConnectConfig): Promise<number>;
8453
7652
 
8454
7653
  /**
@@ -8882,7 +8081,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8882
8081
  entityId: string;
8883
8082
  };
8884
8083
 
8885
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
8084
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8886
8085
 
8887
8086
  /**
8888
8087
  * @interface
@@ -10683,76 +9882,100 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10683
9882
  };
10684
9883
 
10685
9884
  /**
10686
- * Extracts a single event type matching the given key from the View {@link Event} union.
9885
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9886
+ *
9887
+ * @see {@link ByType}
10687
9888
  *
10688
9889
  * @typeParam Type String key specifying the event to extract
10689
9890
  */
10690
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10691
- type: Type;
9891
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9892
+
9893
+ /**
9894
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9895
+ *
9896
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9897
+ * the appropriate payload union for that namespace.
9898
+ *
9899
+ * @typeParam Event Union of payloads for events on the given emitter
9900
+ * @see {@link ByType}
9901
+ *
9902
+ * @typeParam Type String key specifying the event to extract from the union
9903
+ *
9904
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9905
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9906
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
9907
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9908
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
9909
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
9910
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
9911
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
9912
+ */
9913
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9914
+ type: EventType;
10692
9915
  }>;
10693
9916
 
9917
+ /**
9918
+ * Extracts a single event type matching the given key from the View {@link Event} union.
9919
+ *
9920
+ * @see {@link ByType}
9921
+ *
9922
+ * @typeParam Type String key specifying the event to extract
9923
+ */
9924
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
9925
+
10694
9926
  /**
10695
9927
  * Extracts a single event type matching the given key from the Window {@link Event} union.
10696
9928
  *
9929
+ * @see {@link ByType}
9930
+ *
10697
9931
  * @typeParam Type String key specifying the event to extract
10698
9932
  */
10699
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10700
- type: Type;
10701
- }>;
9933
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
10702
9934
 
10703
9935
  /**
10704
9936
  * Extracts a single event type matching the given key from the Application {@link Event} union.
10705
9937
  *
9938
+ * @see {@link ByType}
9939
+ *
10706
9940
  * @typeParam Type String key specifying the event to extract
10707
9941
  */
10708
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10709
- type: Type;
10710
- }>;
9942
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
10711
9943
 
10712
9944
  /**
10713
9945
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10714
9946
  *
9947
+ * @see {@link ByType}
9948
+ *
10715
9949
  * @typeParam Type String key specifying the event to extract
10716
9950
  */
10717
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10718
- type: Type;
10719
- }>;
9951
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
10720
9952
 
10721
9953
  /**
10722
9954
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
10723
9955
  *
9956
+ * @see {@link ByType}
9957
+ *
10724
9958
  * @typeParam Type String key specifying the event to extract
10725
9959
  */
10726
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10727
- type: Type;
10728
- }>;
9960
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
10729
9961
 
10730
9962
  /**
10731
9963
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10732
9964
  *
9965
+ * @see {@link ByType}
9966
+ *
10733
9967
  * @typeParam Type String key specifying the event to extract
10734
9968
  */
10735
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10736
- type: Type;
10737
- }>;
9969
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
10738
9970
 
10739
9971
  /**
10740
9972
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
10741
9973
  *
10742
- * @typeParam Type String key specifying the event to extract
10743
- */
10744
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10745
- type: Type;
10746
- }>;
10747
-
10748
- /**
10749
- * Extracts a single event type matching the given key from the System {@link Event} union.
9974
+ * @see {@link ByType}
10750
9975
  *
10751
9976
  * @typeParam Type String key specifying the event to extract
10752
9977
  */
10753
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10754
- type: Type;
10755
- }>;
9978
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
10756
9979
 
10757
9980
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
10758
9981
 
@@ -11446,7 +10669,7 @@ declare namespace PlatformEvents {
11446
10669
  PlatformEvent,
11447
10670
  EventType_7 as EventType,
11448
10671
  PlatformEventType,
11449
- Payload_8 as Payload,
10672
+ Payload_9 as Payload,
11450
10673
  ByType_7 as ByType
11451
10674
  }
11452
10675
  }
@@ -13078,18 +12301,6 @@ declare type QueryPermissionResult = {
13078
12301
  rawValue?: unknown;
13079
12302
  };
13080
12303
 
13081
- declare interface ReactComponentConfig extends ItemConfig {
13082
- /**
13083
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
13084
- */
13085
- component: string;
13086
-
13087
- /**
13088
- * Properties that will be passed to the component and accessible using this.props.
13089
- */
13090
- props?: any;
13091
- }
13092
-
13093
12304
  /**
13094
12305
  * @interface
13095
12306
  */
@@ -13177,6 +12388,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
13177
12388
  token: string;
13178
12389
  }
13179
12390
 
12391
+ /**
12392
+ * Generated when a View is removed from a layout.
12393
+ * @interface
12394
+ */
12395
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12396
+ type: 'removed-from-layout';
12397
+ layoutIdentity: OpenFin.LayoutIdentity;
12398
+ };
12399
+
13180
12400
  /**
13181
12401
  * @interface
13182
12402
  */
@@ -13596,97 +12816,6 @@ declare type SessionContextGroup = {
13596
12816
  }>;
13597
12817
  };
13598
12818
 
13599
- declare interface Settings {
13600
- preventSplitterResize?: boolean;
13601
-
13602
- newTabButton?: {
13603
- url?: string;
13604
- };
13605
-
13606
- /**
13607
- * If true, tabs can't be dragged into the window.
13608
- * Default: false
13609
- */
13610
- preventDragIn?: boolean;
13611
-
13612
- /**
13613
- * If true, tabs can't be dragged out of the window.
13614
- * Default: false
13615
- */
13616
- preventDragOut?: boolean;
13617
-
13618
- /**
13619
- * If true, stack headers are the only areas where tabs can be dropped.
13620
- * Default: false
13621
- */
13622
- constrainDragToHeaders?: boolean;
13623
- /**
13624
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13625
- * Default: true
13626
- */
13627
- hasHeaders?: boolean;
13628
-
13629
- /**
13630
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13631
- * automatically when layout.createDragSource() is called.
13632
- * Default: true
13633
- */
13634
- constrainDragToContainer?: boolean;
13635
-
13636
- /**
13637
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13638
- * Default: true
13639
- */
13640
- reorderEnabled?: boolean;
13641
-
13642
- /**
13643
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13644
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13645
- * Default: false
13646
- */
13647
- selectionEnabled?: boolean;
13648
-
13649
- /**
13650
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13651
- * be transferred to the new window, if false only the active component will be opened.
13652
- * Default: false
13653
- */
13654
- popoutWholeStack?: boolean;
13655
-
13656
- /**
13657
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13658
- * If false, the popout call will fail silently.
13659
- * Default: true
13660
- */
13661
- blockedPopoutsThrowError?: boolean;
13662
-
13663
- /**
13664
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13665
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13666
- * addition, any changes made to popouts won't be stored after the parent is closed.
13667
- * Default: true
13668
- */
13669
- closePopoutsOnUnload?: boolean;
13670
-
13671
- /**
13672
- * Specifies if the popout icon should be displayed in the header-bar.
13673
- * Default: true
13674
- */
13675
- showPopoutIcon?: boolean;
13676
-
13677
- /**
13678
- * Specifies if the maximise icon should be displayed in the header-bar.
13679
- * Default: true
13680
- */
13681
- showMaximiseIcon?: boolean;
13682
-
13683
- /**
13684
- * Specifies if the close icon should be displayed in the header-bar.
13685
- * Default: true
13686
- */
13687
- showCloseIcon?: boolean;
13688
- }
13689
-
13690
12819
  /**
13691
12820
  * @interface
13692
12821
  */
@@ -13910,7 +13039,7 @@ declare type Snapshot = {
13910
13039
  * _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.
13911
13040
  * @interface
13912
13041
  */
13913
- declare type SnapshotAppliedEvent = BaseEvent & {
13042
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13914
13043
  topic: 'application';
13915
13044
  type: 'platform-snapshot-applied';
13916
13045
  };
@@ -15522,7 +14651,7 @@ declare namespace SystemEvents {
15522
14651
  SystemEvent,
15523
14652
  EventType_8 as EventType,
15524
14653
  SystemEventType,
15525
- Payload_9 as Payload,
14654
+ Payload_10 as Payload,
15526
14655
  ByType_8 as ByType
15527
14656
  }
15528
14657
  }
@@ -15595,59 +14724,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15595
14724
  proceed: () => void;
15596
14725
  }) => void;
15597
14726
 
15598
- declare interface Tab {
15599
- _dragListener: TabDragListener;
15600
-
15601
- /**
15602
- * True if this tab is the selected tab
15603
- */
15604
- isActive: boolean;
15605
-
15606
- /**
15607
- * A reference to the header this tab is a child of
15608
- */
15609
- header: Header;
15610
-
15611
- /**
15612
- * A reference to the content item this tab relates to
15613
- */
15614
- contentItem: ContentItem;
15615
-
15616
- /**
15617
- * The tabs outer (jQuery) DOM element
15618
- */
15619
- element: JQuery;
15620
-
15621
- /**
15622
- * The (jQuery) DOM element containing the title
15623
- */
15624
- titleElement: JQuery;
15625
-
15626
- /**
15627
- * The (jQuery) DOM element that closes the tab
15628
- */
15629
- closeElement: JQuery;
15630
-
15631
- /**
15632
- * Sets the tab's title. Does not affect the contentItem's title!
15633
- * @param title The new title
15634
- */
15635
- setTitle(title: string): void;
15636
-
15637
- /**
15638
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15639
- * @param isActive Whether the tab is active
15640
- */
15641
- setActive(isActive: boolean): void;
15642
- }
15643
-
15644
- declare interface TabDragListener extends EventEmitter_2 {
15645
- /**
15646
- * A reference to the content item this tab relates to
15647
- */
15648
- contentItem: ContentItem;
15649
- }
15650
-
15651
14727
  /**
15652
14728
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15653
14729
  */
@@ -16625,6 +15701,8 @@ declare namespace ViewEvents {
16625
15701
  BaseEvent_4 as BaseEvent,
16626
15702
  BaseViewEvent,
16627
15703
  TargetChangedEvent,
15704
+ AddedToLayoutEvent,
15705
+ RemovedFromLayoutEvent,
16628
15706
  NonPropagatedViewEvent,
16629
15707
  CreatedEvent,
16630
15708
  DestroyedEvent,
@@ -16641,7 +15719,7 @@ declare namespace ViewEvents {
16641
15719
  PropagatedViewEvent,
16642
15720
  PropagatedEventType_2 as PropagatedEventType,
16643
15721
  PropagatedViewEventType,
16644
- Payload_2 as Payload,
15722
+ Payload_3 as Payload,
16645
15723
  ByType
16646
15724
  }
16647
15725
  }
@@ -19120,7 +18198,7 @@ declare namespace WindowEvents {
19120
18198
  PropagatedEvent_3 as PropagatedEvent,
19121
18199
  PropagatedWindowEvent,
19122
18200
  PropagatedWindowEventType,
19123
- Payload_3 as Payload,
18201
+ Payload_4 as Payload,
19124
18202
  ByType_2 as ByType
19125
18203
  }
19126
18204
  }