@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
  };
@@ -936,7 +945,7 @@ declare namespace ApplicationEvents {
936
945
  PropagatedApplicationEvent,
937
946
  PropagatedEventType_3 as PropagatedEventType,
938
947
  PropagatedApplicationEventType,
939
- Payload_4 as Payload,
948
+ Payload_5 as Payload,
940
949
  ByType_3 as ByType
941
950
  }
942
951
  }
@@ -1178,9 +1187,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1178
1187
  */
1179
1188
  mainWindowOptions: WindowCreationOptions;
1180
1189
  /**
1181
- * The name of the application (and the application's main window).
1190
+ * The name of the application.
1191
+ *
1192
+ * @remarks
1193
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1194
+ * any special characters, spaces or international characters. It's also used in error messages, API
1195
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1182
1196
  *
1183
- * If provided, _must_ match `uuid`.
1197
+ * This property will be deprecated in the future.
1184
1198
  */
1185
1199
  name: string;
1186
1200
  /**
@@ -1210,9 +1224,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1210
1224
  url: string;
1211
1225
  /**
1212
1226
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1213
- * running in the OpenFin Runtime.
1214
- *
1215
- * Note that `name` and `uuid` must match.
1227
+ * running in the OpenFin Runtime.
1216
1228
  */
1217
1229
  uuid: string;
1218
1230
  /**
@@ -1772,7 +1784,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
1772
1784
  * A base Channel event.
1773
1785
  * @interface
1774
1786
  */
1775
- declare type BaseEvent_2 = NamedEvent & {
1787
+ declare type BaseEvent_2 = BaseEvents.NamedEvent & {
1776
1788
  channelName: string;
1777
1789
  channelId: string;
1778
1790
  };
@@ -1842,6 +1854,7 @@ declare namespace BaseEvents {
1842
1854
  NotCloseRequested,
1843
1855
  PropagatedEventType,
1844
1856
  PropagatedEvent,
1857
+ Payload_2 as Payload,
1845
1858
  EventHandler,
1846
1859
  BaseEvent,
1847
1860
  IdentityEvent,
@@ -1975,48 +1988,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1975
1988
  behavior: 'browser';
1976
1989
  };
1977
1990
 
1978
- declare interface BrowserWindow {
1979
- /**
1980
- * True if the window has been opened and its GoldenLayout instance initialised.
1981
- */
1982
- isInitialised: boolean;
1983
-
1984
- /**
1985
- * Creates a window configuration object from the Popout.
1986
- */
1987
- toConfig(): {
1988
- dimensions: {
1989
- width: number;
1990
- height: number;
1991
- left: number;
1992
- top: number;
1993
- };
1994
- content: Config;
1995
- parentId: string;
1996
- indexInParent: number;
1997
- };
1998
-
1999
- /**
2000
- * Returns the GoldenLayout instance from the child window
2001
- */
2002
- getGlInstance(): GoldenLayout_2;
2003
-
2004
- /**
2005
- * Returns the native Window object
2006
- */
2007
- getWindow(): Window;
2008
-
2009
- /**
2010
- * Closes the popout
2011
- */
2012
- close(): void;
2013
-
2014
- /**
2015
- * Returns the popout to its original position as specified in parentId and indexInParent
2016
- */
2017
- popIn(): void;
2018
- }
2019
-
2020
1991
  /**
2021
1992
  * Extracts a single event type matching the given key from the View {@link Event} union.
2022
1993
  *
@@ -2024,7 +1995,7 @@ declare interface BrowserWindow {
2024
1995
  *
2025
1996
  * @typeParam Type String key specifying the event to extract
2026
1997
  */
2027
- declare type ByType<Type extends EventType> = Payload_2<Type>;
1998
+ declare type ByType<Type extends EventType> = Payload_3<Type>;
2028
1999
 
2029
2000
  /**
2030
2001
  * Extracts a single event type matching the given key from the Window {@link Event} union.
@@ -2033,7 +2004,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
2033
2004
  *
2034
2005
  * @typeParam Type String key specifying the event to extract
2035
2006
  */
2036
- declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
2007
+ declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
2037
2008
 
2038
2009
  /**
2039
2010
  * Extracts a single event type matching the given key from the Application {@link Event} union.
@@ -2042,7 +2013,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
2042
2013
  *
2043
2014
  * @typeParam Type String key specifying the event to extract
2044
2015
  */
2045
- declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
2016
+ declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
2046
2017
 
2047
2018
  /**
2048
2019
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
@@ -2051,7 +2022,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
2051
2022
  *
2052
2023
  * @typeParam Type String key specifying the event to extract
2053
2024
  */
2054
- declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2025
+ declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
2055
2026
 
2056
2027
  /**
2057
2028
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
@@ -2060,7 +2031,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
2060
2031
  *
2061
2032
  * @typeParam Type String key specifying the event to extract
2062
2033
  */
2063
- declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2034
+ declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
2064
2035
 
2065
2036
  /**
2066
2037
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
@@ -2069,7 +2040,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
2069
2040
  *
2070
2041
  * @typeParam Type String key specifying the event to extract
2071
2042
  */
2072
- declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2043
+ declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
2073
2044
 
2074
2045
  /**
2075
2046
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
@@ -2078,7 +2049,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
2078
2049
  *
2079
2050
  * @typeParam Type String key specifying the event to extract
2080
2051
  */
2081
- declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2052
+ declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
2082
2053
 
2083
2054
  /**
2084
2055
  * Extracts a single event type matching the given key from the System {@link Event} union.
@@ -2087,7 +2058,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
2087
2058
  *
2088
2059
  * @typeParam Type String key specifying the event to extract
2089
2060
  */
2090
- declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
2061
+ declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
2091
2062
 
2092
2063
  /**
2093
2064
  * Configuration for page capture.
@@ -3436,31 +3407,6 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3436
3407
  close(): Promise<void>;
3437
3408
  }
3438
3409
 
3439
- declare interface ComponentConfig extends ItemConfig {
3440
- /**
3441
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3442
- */
3443
- componentName: string;
3444
-
3445
- /**
3446
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3447
- * container.getState().
3448
- */
3449
- componentState?: any;
3450
- }
3451
-
3452
- declare interface Config {
3453
- settings?: Settings;
3454
- dimensions?: Dimensions;
3455
- labels?: Labels;
3456
- content?: ItemConfigType[];
3457
- /**
3458
- * (Only on layout config object)
3459
- * Id of the currently maximised content item
3460
- */
3461
- maximisedItemId?: string;
3462
- }
3463
-
3464
3410
  declare type ConfigWithRuntime = BaseConfig & {
3465
3411
  runtime: RuntimeConfig;
3466
3412
  };
@@ -3752,7 +3698,9 @@ declare type ConstWindowOptions = {
3752
3698
  */
3753
3699
  preloadScripts: PreloadScript[];
3754
3700
  /**
3755
- * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
3701
+ * String tag that attempts to group like-tagged renderers together.
3702
+ * 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.
3703
+ * @remarks Will only be used if pages are on the same origin.
3756
3704
  */
3757
3705
  processAffinity: string;
3758
3706
  /**
@@ -3842,103 +3790,6 @@ declare type ConstWindowOptions = {
3842
3790
  inheritance?: Partial<InheritableOptions>;
3843
3791
  };
3844
3792
 
3845
- declare interface Container extends EventEmitter_2 {
3846
- /**
3847
- * The current width of the container in pixel
3848
- */
3849
- width: number;
3850
-
3851
- /**
3852
- * The current height of the container in pixel
3853
- */
3854
- height: number;
3855
-
3856
- /**
3857
- * A reference to the component-item that controls this container
3858
- */
3859
- parent: ContentItem;
3860
-
3861
- /**
3862
- * A reference to the tab that controls this container. Will initially be null
3863
- * (and populated once a tab event has been fired).
3864
- */
3865
- tab: Tab;
3866
-
3867
- /**
3868
- * The current title of the container
3869
- */
3870
- title: string;
3871
-
3872
- /*
3873
- * A reference to the GoldenLayout instance this container belongs to
3874
- */
3875
- layoutManager: GoldenLayout_2;
3876
-
3877
- /**
3878
- * True if the item is currently hidden
3879
- */
3880
- isHidden: boolean;
3881
-
3882
- /**
3883
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3884
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3885
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3886
- * constructor function. It will also be used when the component is opened in a new window.
3887
- * @param state A serialisable object
3888
- */
3889
- setState(state: any): void;
3890
-
3891
- /**
3892
- * The same as setState but does not emit 'stateChanged' event
3893
- * @param {serialisable} state
3894
- */
3895
- setStateSkipEvent(state: any): void;
3896
-
3897
- /**
3898
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3899
- * @param state A serialisable object
3900
- */
3901
- extendState(state: any): void;
3902
-
3903
- /**
3904
- * Returns the current state.
3905
- */
3906
- getState(): any;
3907
-
3908
- /**
3909
- * Returns the container's inner element as a jQuery element
3910
- */
3911
- getElement(): JQuery;
3912
-
3913
- /**
3914
- * hides the container or returns false if hiding it is not possible
3915
- */
3916
- hide(): boolean;
3917
-
3918
- /**
3919
- * shows the container or returns false if showing it is not possible
3920
- */
3921
- show(): boolean;
3922
-
3923
- /**
3924
- * Sets the container to the specified size or returns false if that's not possible
3925
- * @param width the new width in pixel
3926
- * @param height the new height in pixel
3927
- */
3928
- setSize(width: number, height: number): boolean;
3929
-
3930
- /**
3931
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3932
- * @param title the new title
3933
- */
3934
- setTitle(title: string): void;
3935
-
3936
- /**
3937
- * Closes the container or returns false if that is not possible
3938
- */
3939
- close(): boolean;
3940
- }
3941
-
3942
3793
  declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3943
3794
 
3944
3795
  /**
@@ -4001,218 +3852,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
4001
3852
  disposition: string;
4002
3853
  };
4003
3854
 
4004
- declare interface ContentItem extends EventEmitter_2 {
4005
- instance: any;
4006
- header: any;
4007
- _splitter: any;
4008
- /**
4009
- * This items configuration in its current state
4010
- */
4011
- config: ItemConfigType;
4012
-
4013
- /**
4014
- * The type of the item. Can be row, column, stack, component or root
4015
- */
4016
- type: ItemType;
4017
-
4018
- /**
4019
- * An array of items that are children of this item
4020
- */
4021
- contentItems: ContentItem[];
4022
-
4023
- container: Container;
4024
- /**
4025
- * The item that is this item's parent (or null if the item is root)
4026
- */
4027
- parent: ContentItem;
4028
-
4029
- /**
4030
- * A String or array of identifiers if provided in the configuration
4031
- */
4032
- id: string;
4033
-
4034
- /**
4035
- * True if the item had been initialised
4036
- */
4037
- isInitialised: boolean;
4038
-
4039
- /**
4040
- * True if the item is maximised
4041
- */
4042
- isMaximised: boolean;
4043
-
4044
- /**
4045
- * True if the item is the layout's root item
4046
- */
4047
- isRoot: boolean;
4048
-
4049
- /**
4050
- * True if the item is a row
4051
- */
4052
- isRow: boolean;
4053
-
4054
- /**
4055
- * True if the item is a column
4056
- */
4057
- isColumn: boolean;
4058
-
4059
- /**
4060
- * True if the item is a stack
4061
- */
4062
- isStack: boolean;
4063
-
4064
- /**
4065
- * True if the item is a component
4066
- */
4067
- isComponent: boolean;
4068
-
4069
- /**
4070
- * A reference to the layoutManager that controls this item
4071
- */
4072
- layoutManager: any;
4073
-
4074
- /**
4075
- * The item's outer element
4076
- */
4077
- element: JQuery;
4078
-
4079
- /**
4080
- * The item's inner element. Can be the same as the outer element.
4081
- */
4082
- childElementContainer: Container;
4083
-
4084
- /**
4085
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4086
- * from its original position before adding it to this item.
4087
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4088
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4089
- */
4090
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4091
-
4092
- /**
4093
- * Destroys the item and all it's children
4094
- * @param contentItem The contentItem that should be removed
4095
- * @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.
4096
- */
4097
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4098
-
4099
- /**
4100
- * The contentItem that should be removed
4101
- * @param oldChild ContentItem The contentItem that should be removed
4102
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4103
- */
4104
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4105
-
4106
- /**
4107
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4108
- */
4109
- setSize(): void;
4110
-
4111
- /**
4112
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4113
- * @param title the new title
4114
- */
4115
- setTitle(title: string): void;
4116
-
4117
- /**
4118
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4119
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4120
- * @param functionName The name of the method to invoke
4121
- * @param functionArguments An array of arguments to pass to every function
4122
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4123
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4124
- */
4125
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4126
-
4127
- /**
4128
- * 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.
4129
- */
4130
- emitBubblingEvent(name: string): void;
4131
-
4132
- /**
4133
- * Convenience method for item.parent.removeChild( item )
4134
- */
4135
- remove(): void;
4136
-
4137
- /**
4138
- * Removes the item from its current position in the layout and opens it in a window
4139
- */
4140
- popout(): BrowserWindow;
4141
-
4142
- /**
4143
- * Maximises the item or minimises it if it's already maximised
4144
- */
4145
- toggleMaximise(): void;
4146
-
4147
- /**
4148
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4149
- */
4150
- select(): void;
4151
-
4152
- /**
4153
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4154
- */
4155
- deselect(): void;
4156
-
4157
- /**
4158
- * Returns true if the item has the specified id or false if not
4159
- * @param id An id to check for
4160
- */
4161
- hasId(id: string): boolean;
4162
-
4163
- /**
4164
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4165
- * @param contentItem The new active content item
4166
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4167
- */
4168
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4169
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4170
-
4171
- /**
4172
- * Only Stacks have this method! Returns the currently selected contentItem.
4173
- */
4174
- getActiveContentItem(): ContentItem;
4175
-
4176
- /**
4177
- * Adds an id to an item or does nothing if the id is already present
4178
- * @param id The id to be added
4179
- */
4180
- addId(id: string): void;
4181
-
4182
- /**
4183
- * Removes an id from an item or throws an error if the id couldn't be found
4184
- * @param id The id to be removed
4185
- */
4186
- removeId(id: string): void;
4187
-
4188
- /**
4189
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4190
- * @param filterFunction A function that determines whether an item matches certain criteria
4191
- */
4192
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4193
-
4194
- /**
4195
- * Returns all items with the specified id.
4196
- * @param id An id specified in the itemConfig
4197
- */
4198
- getItemsById(id: string | string[]): ContentItem[];
4199
-
4200
- /**
4201
- * Returns all items with the specified type
4202
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4203
- */
4204
- getItemsByType(type: string): ContentItem[];
4205
-
4206
- /**
4207
- * Returns all instances of the component with the specified componentName
4208
- * @param componentName a componentName as specified in the itemConfig
4209
- */
4210
- getComponentsByName(componentName: string): any;
4211
-
4212
- _contentAreaDimensions: any;
4213
- _$getArea: () => any;
4214
- }
4215
-
4216
3855
  /**
4217
3856
  * Restrict navigation to URLs that match an allowed pattern.
4218
3857
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4697,46 +4336,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4697
4336
  type: 'did-finish-load';
4698
4337
  };
4699
4338
 
4700
- declare interface Dimensions {
4701
- /**
4702
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4703
- * than the visible one, making it safe to set this to small values without affecting usability.
4704
- * Default: 5
4705
- */
4706
- borderWidth?: number;
4707
-
4708
- /**
4709
- * The minimum height an item can be resized to (in pixel).
4710
- * Default: 10
4711
- */
4712
- minItemHeight?: number;
4713
-
4714
- /**
4715
- * The minimum width an item can be resized to (in pixel).
4716
- * Default: 10
4717
- */
4718
- minItemWidth?: number;
4719
-
4720
- /**
4721
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4722
- * adjusted accordingly.
4723
- * Default: 20
4724
- */
4725
- headerHeight?: number;
4726
-
4727
- /**
4728
- * The width of the element that appears when an item is dragged (in pixel).
4729
- * Default: 300
4730
- */
4731
- dragProxyWidth?: number;
4732
-
4733
- /**
4734
- * The height of the element that appears when an item is dragged (in pixel).
4735
- * Default: 200
4736
- */
4737
- dragProxyHeight?: number;
4738
- }
4739
-
4740
4339
  /**
4741
4340
  * @interface
4742
4341
  */
@@ -5033,8 +4632,6 @@ declare type Dpi = {
5033
4632
  vertical?: number;
5034
4633
  };
5035
4634
 
5036
- declare interface DragSource {}
5037
-
5038
4635
  /**
5039
4636
  * Generated when a window has been embedded.
5040
4637
  * @interface
@@ -5302,7 +4899,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5302
4899
  */
5303
4900
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5304
4901
  target: OpenFin.Identity;
5305
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4902
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
5306
4903
 
5307
4904
  /**
5308
4905
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -5346,51 +4943,12 @@ declare class EventAggregator extends EmitterMap {
5346
4943
  dispatchEvent: (message: Message<any>) => boolean;
5347
4944
  }
5348
4945
 
5349
- declare interface EventEmitter_2 {
5350
- [x: string]: any;
5351
- /**
5352
- * Subscribe to an event
5353
- * @param eventName The name of the event to describe to
5354
- * @param callback The function that should be invoked when the event occurs
5355
- * @param context The value of the this pointer in the callback function
5356
- */
5357
- on(eventName: string, callback: Function, context?: any): void;
5358
-
5359
- /**
5360
- * Notify listeners of an event and pass arguments along
5361
- * @param eventName The name of the event to emit
5362
- */
5363
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5364
-
5365
- /**
5366
- * Alias for emit
5367
- */
5368
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5369
-
5370
- /**
5371
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5372
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5373
- * arguments.
5374
- * @param eventName The name of the event to unsubscribe from
5375
- * @param callback The function that should be invoked when the event occurs
5376
- * @param context The value of the this pointer in the callback function
5377
- */
5378
- unbind(eventName: string, callback?: Function, context?: any): void;
5379
-
5380
- /**
5381
- * Alias for unbind
5382
- */
5383
- off(eventName: string, callback?: Function, context?: any): void;
5384
- }
5385
-
5386
4946
  /**
5387
4947
  * Handler for an event on an EventEmitter.
5388
4948
  * @remarks Selects the correct type for the event
5389
4949
  * payload from the provided union based on the provided string literal type.
5390
4950
  */
5391
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5392
- type: EventType;
5393
- }>, ...args: any[]) => void;
4951
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
5394
4952
 
5395
4953
  declare namespace Events {
5396
4954
  export {
@@ -5521,7 +5079,7 @@ declare namespace ExternalApplicationEvents {
5521
5079
  ExternalApplicationEvent,
5522
5080
  EventType_4 as EventType,
5523
5081
  ExternalApplicationEventType,
5524
- Payload_5 as Payload,
5082
+ Payload_6 as Payload,
5525
5083
  ByType_4 as ByType
5526
5084
  }
5527
5085
  }
@@ -5971,7 +5529,7 @@ declare namespace FrameEvents {
5971
5529
  FrameEvent,
5972
5530
  EventType_5 as EventType,
5973
5531
  FrameEventType,
5974
- Payload_6 as Payload,
5532
+ Payload_7 as Payload,
5975
5533
  ByType_5 as ByType
5976
5534
  }
5977
5535
  }
@@ -6165,297 +5723,64 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
6165
5723
  *
6166
5724
  * @remarks Raises the `unregistered` event for each hotkey unregistered.
6167
5725
  *
6168
- * @example
6169
- * ```js
6170
- * fin.GlobalHotkey.unregisterAll()
6171
- * .then(() => {
6172
- * console.log('Success');
6173
- * })
6174
- * .catch(err => {
6175
- * console.log('Error unregistering all hotkeys for this application', err);
6176
- * });
6177
- * ```
6178
- */
6179
- unregisterAll(): Promise<void>;
6180
- /**
6181
- * Checks if a given hotkey has been registered by an application within the current runtime.
6182
- * @param hotkey a hotkey string
6183
- *
6184
- * @example
6185
- * ```js
6186
- * const hotkey = 'CommandOrControl+X';
6187
- *
6188
- * fin.GlobalHotkey.isRegistered(hotkey)
6189
- * .then((registered) => {
6190
- * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
6191
- * })
6192
- * .catch(err => {
6193
- * console.log('Error unregistering the hotkey', err);
6194
- * });
6195
- * ```
6196
- */
6197
- isRegistered(hotkey: string): Promise<boolean>;
6198
- }
6199
-
6200
- /**
6201
- * @deprecated Renamed to {@link Event}.
6202
- */
6203
- declare type GlobalHotkeyEvent = Event_9;
6204
-
6205
- declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6206
-
6207
- declare namespace GlobalHotkeyEvents {
6208
- export {
6209
- BaseEvent_8 as BaseEvent,
6210
- RegisteredEvent,
6211
- UnregisteredEvent,
6212
- Event_9 as Event,
6213
- GlobalHotkeyEvent,
6214
- EventType_6 as EventType,
6215
- GlobalHotkeyEventType,
6216
- Payload_7 as Payload,
6217
- ByType_6 as ByType
6218
- }
6219
- }
6220
-
6221
- /**
6222
- * @deprecated Renamed to {@link EventType}.
6223
- */
6224
- declare type GlobalHotkeyEventType = EventType_6;
6225
-
6226
- declare namespace GoldenLayout {
6227
- export {
6228
- GoldenLayout_2 as GoldenLayout,
6229
- ItemConfigType,
6230
- Settings,
6231
- Dimensions,
6232
- Labels,
6233
- ItemType,
6234
- ItemConfig,
6235
- ComponentConfig,
6236
- ReactComponentConfig,
6237
- Config,
6238
- ContentItem,
6239
- Container,
6240
- DragSource,
6241
- BrowserWindow,
6242
- Header,
6243
- TabDragListener,
6244
- Tab,
6245
- EventEmitter_2 as EventEmitter
6246
- }
6247
- }
6248
-
6249
- declare class GoldenLayout_2 implements EventEmitter_2 {
6250
- /**
6251
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6252
- * object and of goldenLayout.root as the document.
6253
- */
6254
- root: ContentItem;
6255
-
6256
- /**
6257
- * A reference to the (jQuery) DOM element containing the layout
6258
- */
6259
- container: JQuery;
6260
-
6261
- /**
6262
- * True once the layout item tree has been created and the initialised event has been fired
6263
- */
6264
- isInitialised: boolean;
6265
-
6266
- /**
6267
- * A reference to the current, extended top level config.
6268
- *
6269
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6270
- */
6271
- config: Config;
6272
-
6273
- /**
6274
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6275
- * to true.
6276
- */
6277
- selectedItem: ContentItem;
6278
-
6279
- /**
6280
- * The current outer width of the layout in pixels.
6281
- */
6282
- width: number;
6283
-
6284
- /**
6285
- * The current outer height of the layout in pixels.
6286
- */
6287
- height: number;
6288
-
6289
- /**
6290
- * An array of BrowserWindow instances
6291
- */
6292
- openPopouts: BrowserWindow[];
6293
-
6294
- /**
6295
- * True if the layout has been opened as a popout by another layout.
6296
- */
6297
- isSubWindow: boolean;
6298
-
6299
- /**
6300
- * A singleton instance of EventEmitter that works across windows
6301
- */
6302
- eventHub: EventEmitter_2;
6303
-
6304
- _dragProxy: any;
6305
-
6306
- dropTargetIndicator: any;
6307
-
6308
- /**
6309
- * @param config A GoldenLayout configuration object
6310
- * @param container The DOM element the layout will be initialised in. Default: document.body
6311
- */
6312
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6313
-
6314
- /*
6315
- * @param name The name of the component, as referred to by componentName in the component configuration.
6316
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6317
- * containerobject and a component state
6318
- */
6319
- registerComponent(name: String, component: any): void;
6320
-
6321
- /**
6322
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6323
- * a listener to the document and executes once it becomes ready.
6324
- */
6325
- init(): void;
6326
-
6327
- /**
6328
- * Returns the current state of the layout and its components as a serialisable object.
6329
- */
6330
- toConfig(): Config;
6331
-
6332
- /**
6333
- * Returns a component that was previously registered with layout.registerComponent().
6334
- * @param name The name of a previously registered component
6335
- */
6336
- getComponent(name: string): any;
6337
-
6338
- /**
6339
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6340
- * @param width The outer width the layout should be resized to. Default: The container elements width
6341
- * @param height The outer height the layout should be resized to. Default: The container elements height
6342
- */
6343
- updateSize(width?: number, height?: number): void;
6344
-
6345
- /**
6346
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6347
- * listeners and finally removes itself from the DOM.
6348
- */
6349
- destroy(): void;
6350
-
6351
- /**
6352
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6353
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6354
- * all call this method implicitly.
6355
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6356
- * @param parent A parent item
6357
- */
6358
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6359
-
6360
- /**
6361
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6362
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6363
- * provided its config will be read, if config is provided, only the content key
6364
- * will be used
6365
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6366
- * place the window in another screen.
6367
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6368
- * when popIn is clicked
6369
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6370
- */
6371
- createPopout(
6372
- configOrContentItem: ItemConfigType | ContentItem,
6373
- dimensions: {
6374
- width: number;
6375
- height: number;
6376
- left: number;
6377
- top: number;
6378
- },
6379
- parentId?: string,
6380
- indexInParent?: number
6381
- ): void;
6382
-
6383
- /**
6384
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6385
- * where it turns into a contentItem.
6386
- * @param element The DOM element that will be turned into a dragSource
6387
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6388
- * @return the dragSource that was created. This can be used to remove the
6389
- * dragSource from the layout later.
6390
- */
6391
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6392
-
6393
- /**
6394
- * Removes a dragSource from the layout.
6395
- *
6396
- * @param dragSource The dragSource to remove
6397
- */
6398
- removeDragSource(dragSource: DragSource): void;
6399
-
6400
- /**
6401
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6402
- * @param contentItem A ContentItem instance
6403
- */
6404
- selectItem(contentItem: ContentItem): void;
6405
-
6406
- /**
6407
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6408
- * and replace frequent keys and values with single letter substitutes.
6409
- * @param config A GoldenLayout configuration object
6410
- */
6411
- static minifyConfig(config: any): any;
6412
-
6413
- /**
6414
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6415
- * @param minifiedConfig A minified GoldenLayout configuration object
6416
- */
6417
- static unminifyConfig(minifiedConfig: any): any;
6418
-
6419
- /**
6420
- * Subscribe to an event
6421
- * @param eventName The name of the event to describe to
6422
- * @param callback The function that should be invoked when the event occurs
6423
- * @param context The value of the this pointer in the callback function
6424
- */
6425
- on(eventName: string, callback: Function, context?: any): void;
6426
-
6427
- /**
6428
- * Notify listeners of an event and pass arguments along
6429
- * @param eventName The name of the event to emit
5726
+ * @example
5727
+ * ```js
5728
+ * fin.GlobalHotkey.unregisterAll()
5729
+ * .then(() => {
5730
+ * console.log('Success');
5731
+ * })
5732
+ * .catch(err => {
5733
+ * console.log('Error unregistering all hotkeys for this application', err);
5734
+ * });
5735
+ * ```
6430
5736
  */
6431
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6432
-
5737
+ unregisterAll(): Promise<void>;
6433
5738
  /**
6434
- * Alias for emit
5739
+ * Checks if a given hotkey has been registered by an application within the current runtime.
5740
+ * @param hotkey a hotkey string
5741
+ *
5742
+ * @example
5743
+ * ```js
5744
+ * const hotkey = 'CommandOrControl+X';
5745
+ *
5746
+ * fin.GlobalHotkey.isRegistered(hotkey)
5747
+ * .then((registered) => {
5748
+ * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
5749
+ * })
5750
+ * .catch(err => {
5751
+ * console.log('Error unregistering the hotkey', err);
5752
+ * });
5753
+ * ```
6435
5754
  */
6436
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5755
+ isRegistered(hotkey: string): Promise<boolean>;
5756
+ }
6437
5757
 
6438
- /**
6439
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6440
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6441
- * arguments.
6442
- * @param eventName The name of the event to unsubscribe from
6443
- * @param callback The function that should be invoked when the event occurs
6444
- * @param context The value of the this pointer in the callback function
6445
- */
6446
- unbind(eventName: string, callback?: Function, context?: any): void;
5758
+ /**
5759
+ * @deprecated Renamed to {@link Event}.
5760
+ */
5761
+ declare type GlobalHotkeyEvent = Event_9;
6447
5762
 
6448
- /**
6449
- * Alias for unbind
6450
- */
6451
- off(eventName: string, callback?: Function, context?: any): void;
5763
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6452
5764
 
6453
- /**
6454
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6455
- */
6456
- _$createRootItemAreas(): void;
5765
+ declare namespace GlobalHotkeyEvents {
5766
+ export {
5767
+ BaseEvent_8 as BaseEvent,
5768
+ RegisteredEvent,
5769
+ UnregisteredEvent,
5770
+ Event_9 as Event,
5771
+ GlobalHotkeyEvent,
5772
+ EventType_6 as EventType,
5773
+ GlobalHotkeyEventType,
5774
+ Payload_8 as Payload,
5775
+ ByType_6 as ByType
5776
+ }
6457
5777
  }
6458
5778
 
5779
+ /**
5780
+ * @deprecated Renamed to {@link EventType}.
5781
+ */
5782
+ declare type GlobalHotkeyEventType = EventType_6;
5783
+
6459
5784
  /**
6460
5785
  * @interface
6461
5786
  */
@@ -6463,62 +5788,6 @@ declare type GpuInfo = {
6463
5788
  name: string;
6464
5789
  };
6465
5790
 
6466
- declare interface Header {
6467
- /**
6468
- * A reference to the LayoutManager instance
6469
- */
6470
- layoutManager: GoldenLayout_2;
6471
-
6472
- /**
6473
- * A reference to the Stack this Header belongs to
6474
- */
6475
- parent: ContentItem;
6476
-
6477
- /**
6478
- * An array of the Tabs within this header
6479
- */
6480
- tabs: Tab[];
6481
-
6482
- /**
6483
- * The currently selected activeContentItem
6484
- */
6485
- activeContentItem: ContentItem;
6486
-
6487
- /**
6488
- * The outer (jQuery) DOM element of this Header
6489
- */
6490
- element: JQuery;
6491
-
6492
- /**
6493
- * The (jQuery) DOM element containing the tabs
6494
- */
6495
- tabsContainer: JQuery;
6496
-
6497
- /**
6498
- * The (jQuery) DOM element containing the close, maximise and popout button
6499
- */
6500
- controlsContainer: JQuery;
6501
-
6502
- /**
6503
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6504
- * @param contentItem The content item that will be selected
6505
- */
6506
- setActiveContentItem(contentItem: ContentItem): void;
6507
-
6508
- /**
6509
- * Creates a new tab and associates it with a content item
6510
- * @param contentItem The content item the tab will be associated with
6511
- * @param index A zero based index, specifying the position of the new tab
6512
- */
6513
- createTab(contentItem: ContentItem, index?: number): void;
6514
-
6515
- /**
6516
- * Finds a tab by its contentItem and removes it
6517
- * @param contentItem The content item the tab is associated with
6518
- */
6519
- removeTab(contentItem: ContentItem): void;
6520
- }
6521
-
6522
5791
  /**
6523
5792
  * Generated when a View is hidden.
6524
5793
  * @interface
@@ -8187,50 +7456,6 @@ declare class InteropModule extends Base {
8187
7456
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8188
7457
  }
8189
7458
 
8190
- declare interface ItemConfig {
8191
- /**
8192
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8193
- */
8194
- type: ItemType;
8195
-
8196
- /**
8197
- * An array of configurations for items that will be created as children of this item.
8198
- */
8199
- content?: ItemConfigType[];
8200
-
8201
- /**
8202
- * The width of this item, relative to the other children of its parent in percent
8203
- */
8204
- width?: number;
8205
-
8206
- /**
8207
- * The height of this item, relative to the other children of its parent in percent
8208
- */
8209
- height?: number;
8210
-
8211
- /**
8212
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8213
- */
8214
- id?: string | string[];
8215
-
8216
- /**
8217
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8218
- * will return false
8219
- * Default: true
8220
- */
8221
- isClosable?: boolean;
8222
-
8223
- /**
8224
- * The title of the item as displayed on its tab and on popout windows
8225
- * Default: componentName or ''
8226
- */
8227
- title?: string;
8228
- }
8229
-
8230
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8231
-
8232
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8233
-
8234
7459
  /**
8235
7460
  * @interface
8236
7461
  */
@@ -8288,32 +7513,6 @@ declare type JumpListTask = {
8288
7513
  iconIndex?: number;
8289
7514
  };
8290
7515
 
8291
- declare interface Labels {
8292
- /**
8293
- * The tooltip text that appears when hovering over the close icon.
8294
- * Default: 'close'
8295
- */
8296
- close?: string;
8297
-
8298
- /**
8299
- * The tooltip text that appears when hovering over the maximise icon.
8300
- * Default: 'maximise'
8301
- */
8302
- maximise?: string;
8303
-
8304
- /**
8305
- * The tooltip text that appears when hovering over the minimise icon.
8306
- * Default: 'minimise'
8307
- */
8308
- minimise?: string;
8309
-
8310
- /**
8311
- * The tooltip text that appears when hovering over the popout icon.
8312
- * Default: 'open in new window'
8313
- */
8314
- popout?: string;
8315
- }
8316
-
8317
7516
  export declare function launch(config: ConnectConfig): Promise<number>;
8318
7517
 
8319
7518
  /**
@@ -8741,7 +7940,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8741
7940
  entityId: string;
8742
7941
  };
8743
7942
 
8744
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7943
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8745
7944
 
8746
7945
  /**
8747
7946
  * @interface
@@ -10350,76 +9549,100 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10350
9549
  };
10351
9550
 
10352
9551
  /**
10353
- * Extracts a single event type matching the given key from the View {@link Event} union.
9552
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9553
+ *
9554
+ * @see {@link ByType}
10354
9555
  *
10355
9556
  * @typeParam Type String key specifying the event to extract
10356
9557
  */
10357
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10358
- type: Type;
9558
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9559
+
9560
+ /**
9561
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9562
+ *
9563
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9564
+ * the appropriate payload union for that namespace.
9565
+ *
9566
+ * @typeParam Event Union of payloads for events on the given emitter
9567
+ * @see {@link ByType}
9568
+ *
9569
+ * @typeParam Type String key specifying the event to extract from the union
9570
+ *
9571
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9572
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9573
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
9574
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9575
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
9576
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
9577
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
9578
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
9579
+ */
9580
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9581
+ type: EventType;
10359
9582
  }>;
10360
9583
 
9584
+ /**
9585
+ * Extracts a single event type matching the given key from the View {@link Event} union.
9586
+ *
9587
+ * @see {@link ByType}
9588
+ *
9589
+ * @typeParam Type String key specifying the event to extract
9590
+ */
9591
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
9592
+
10361
9593
  /**
10362
9594
  * Extracts a single event type matching the given key from the Window {@link Event} union.
10363
9595
  *
9596
+ * @see {@link ByType}
9597
+ *
10364
9598
  * @typeParam Type String key specifying the event to extract
10365
9599
  */
10366
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10367
- type: Type;
10368
- }>;
9600
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
10369
9601
 
10370
9602
  /**
10371
9603
  * Extracts a single event type matching the given key from the Application {@link Event} union.
10372
9604
  *
9605
+ * @see {@link ByType}
9606
+ *
10373
9607
  * @typeParam Type String key specifying the event to extract
10374
9608
  */
10375
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10376
- type: Type;
10377
- }>;
9609
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
10378
9610
 
10379
9611
  /**
10380
9612
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10381
9613
  *
9614
+ * @see {@link ByType}
9615
+ *
10382
9616
  * @typeParam Type String key specifying the event to extract
10383
9617
  */
10384
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10385
- type: Type;
10386
- }>;
9618
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
10387
9619
 
10388
9620
  /**
10389
9621
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
10390
9622
  *
9623
+ * @see {@link ByType}
9624
+ *
10391
9625
  * @typeParam Type String key specifying the event to extract
10392
9626
  */
10393
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10394
- type: Type;
10395
- }>;
9627
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
10396
9628
 
10397
9629
  /**
10398
9630
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10399
9631
  *
9632
+ * @see {@link ByType}
9633
+ *
10400
9634
  * @typeParam Type String key specifying the event to extract
10401
9635
  */
10402
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10403
- type: Type;
10404
- }>;
9636
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
10405
9637
 
10406
9638
  /**
10407
9639
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
10408
9640
  *
10409
- * @typeParam Type String key specifying the event to extract
10410
- */
10411
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10412
- type: Type;
10413
- }>;
10414
-
10415
- /**
10416
- * Extracts a single event type matching the given key from the System {@link Event} union.
9641
+ * @see {@link ByType}
10417
9642
  *
10418
9643
  * @typeParam Type String key specifying the event to extract
10419
9644
  */
10420
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10421
- type: Type;
10422
- }>;
9645
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
10423
9646
 
10424
9647
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
10425
9648
 
@@ -11083,7 +10306,7 @@ declare namespace PlatformEvents {
11083
10306
  PlatformEvent,
11084
10307
  EventType_7 as EventType,
11085
10308
  PlatformEventType,
11086
- Payload_8 as Payload,
10309
+ Payload_9 as Payload,
11087
10310
  ByType_7 as ByType
11088
10311
  }
11089
10312
  }
@@ -12667,18 +11890,6 @@ declare type QueryPermissionResult = {
12667
11890
  rawValue?: unknown;
12668
11891
  };
12669
11892
 
12670
- declare interface ReactComponentConfig extends ItemConfig {
12671
- /**
12672
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12673
- */
12674
- component: string;
12675
-
12676
- /**
12677
- * Properties that will be passed to the component and accessible using this.props.
12678
- */
12679
- props?: any;
12680
- }
12681
-
12682
11893
  /**
12683
11894
  * @interface
12684
11895
  */
@@ -12766,6 +11977,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
12766
11977
  token: string;
12767
11978
  }
12768
11979
 
11980
+ /**
11981
+ * Generated when a View is removed from a layout.
11982
+ * @interface
11983
+ */
11984
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
11985
+ type: 'removed-from-layout';
11986
+ layoutIdentity: OpenFin.LayoutIdentity;
11987
+ };
11988
+
12769
11989
  /**
12770
11990
  * @interface
12771
11991
  */
@@ -13185,97 +12405,6 @@ declare type SessionContextGroup = {
13185
12405
  }>;
13186
12406
  };
13187
12407
 
13188
- declare interface Settings {
13189
- preventSplitterResize?: boolean;
13190
-
13191
- newTabButton?: {
13192
- url?: string;
13193
- };
13194
-
13195
- /**
13196
- * If true, tabs can't be dragged into the window.
13197
- * Default: false
13198
- */
13199
- preventDragIn?: boolean;
13200
-
13201
- /**
13202
- * If true, tabs can't be dragged out of the window.
13203
- * Default: false
13204
- */
13205
- preventDragOut?: boolean;
13206
-
13207
- /**
13208
- * If true, stack headers are the only areas where tabs can be dropped.
13209
- * Default: false
13210
- */
13211
- constrainDragToHeaders?: boolean;
13212
- /**
13213
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13214
- * Default: true
13215
- */
13216
- hasHeaders?: boolean;
13217
-
13218
- /**
13219
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13220
- * automatically when layout.createDragSource() is called.
13221
- * Default: true
13222
- */
13223
- constrainDragToContainer?: boolean;
13224
-
13225
- /**
13226
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13227
- * Default: true
13228
- */
13229
- reorderEnabled?: boolean;
13230
-
13231
- /**
13232
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13233
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13234
- * Default: false
13235
- */
13236
- selectionEnabled?: boolean;
13237
-
13238
- /**
13239
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13240
- * be transferred to the new window, if false only the active component will be opened.
13241
- * Default: false
13242
- */
13243
- popoutWholeStack?: boolean;
13244
-
13245
- /**
13246
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13247
- * If false, the popout call will fail silently.
13248
- * Default: true
13249
- */
13250
- blockedPopoutsThrowError?: boolean;
13251
-
13252
- /**
13253
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13254
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13255
- * addition, any changes made to popouts won't be stored after the parent is closed.
13256
- * Default: true
13257
- */
13258
- closePopoutsOnUnload?: boolean;
13259
-
13260
- /**
13261
- * Specifies if the popout icon should be displayed in the header-bar.
13262
- * Default: true
13263
- */
13264
- showPopoutIcon?: boolean;
13265
-
13266
- /**
13267
- * Specifies if the maximise icon should be displayed in the header-bar.
13268
- * Default: true
13269
- */
13270
- showMaximiseIcon?: boolean;
13271
-
13272
- /**
13273
- * Specifies if the close icon should be displayed in the header-bar.
13274
- * Default: true
13275
- */
13276
- showCloseIcon?: boolean;
13277
- }
13278
-
13279
12408
  /**
13280
12409
  * @interface
13281
12410
  */
@@ -13499,7 +12628,7 @@ declare type Snapshot = {
13499
12628
  * _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.
13500
12629
  * @interface
13501
12630
  */
13502
- declare type SnapshotAppliedEvent = BaseEvent & {
12631
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13503
12632
  topic: 'application';
13504
12633
  type: 'platform-snapshot-applied';
13505
12634
  };
@@ -15105,7 +14234,7 @@ declare namespace SystemEvents {
15105
14234
  SystemEvent,
15106
14235
  EventType_8 as EventType,
15107
14236
  SystemEventType,
15108
- Payload_9 as Payload,
14237
+ Payload_10 as Payload,
15109
14238
  ByType_8 as ByType
15110
14239
  }
15111
14240
  }
@@ -15172,59 +14301,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15172
14301
  proceed: () => void;
15173
14302
  }) => void;
15174
14303
 
15175
- declare interface Tab {
15176
- _dragListener: TabDragListener;
15177
-
15178
- /**
15179
- * True if this tab is the selected tab
15180
- */
15181
- isActive: boolean;
15182
-
15183
- /**
15184
- * A reference to the header this tab is a child of
15185
- */
15186
- header: Header;
15187
-
15188
- /**
15189
- * A reference to the content item this tab relates to
15190
- */
15191
- contentItem: ContentItem;
15192
-
15193
- /**
15194
- * The tabs outer (jQuery) DOM element
15195
- */
15196
- element: JQuery;
15197
-
15198
- /**
15199
- * The (jQuery) DOM element containing the title
15200
- */
15201
- titleElement: JQuery;
15202
-
15203
- /**
15204
- * The (jQuery) DOM element that closes the tab
15205
- */
15206
- closeElement: JQuery;
15207
-
15208
- /**
15209
- * Sets the tab's title. Does not affect the contentItem's title!
15210
- * @param title The new title
15211
- */
15212
- setTitle(title: string): void;
15213
-
15214
- /**
15215
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15216
- * @param isActive Whether the tab is active
15217
- */
15218
- setActive(isActive: boolean): void;
15219
- }
15220
-
15221
- declare interface TabDragListener extends EventEmitter_2 {
15222
- /**
15223
- * A reference to the content item this tab relates to
15224
- */
15225
- contentItem: ContentItem;
15226
- }
15227
-
15228
14304
  /**
15229
14305
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15230
14306
  */
@@ -16164,6 +15240,8 @@ declare namespace ViewEvents {
16164
15240
  BaseEvent_4 as BaseEvent,
16165
15241
  BaseViewEvent,
16166
15242
  TargetChangedEvent,
15243
+ AddedToLayoutEvent,
15244
+ RemovedFromLayoutEvent,
16167
15245
  NonPropagatedViewEvent,
16168
15246
  CreatedEvent,
16169
15247
  DestroyedEvent,
@@ -16180,7 +15258,7 @@ declare namespace ViewEvents {
16180
15258
  PropagatedViewEvent,
16181
15259
  PropagatedEventType_2 as PropagatedEventType,
16182
15260
  PropagatedViewEventType,
16183
- Payload_2 as Payload,
15261
+ Payload_3 as Payload,
16184
15262
  ByType
16185
15263
  }
16186
15264
  }
@@ -18656,7 +17734,7 @@ declare namespace WindowEvents {
18656
17734
  PropagatedEvent_3 as PropagatedEvent,
18657
17735
  PropagatedWindowEvent,
18658
17736
  PropagatedWindowEventType,
18659
- Payload_3 as Payload,
17737
+ Payload_4 as Payload,
18660
17738
  ByType_2 as ByType
18661
17739
  }
18662
17740
  }