@openfin/fdc3-api 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
  };
@@ -3748,7 +3694,9 @@ declare type ConstWindowOptions = {
3748
3694
  */
3749
3695
  preloadScripts: PreloadScript[];
3750
3696
  /**
3751
- * String tag that attempts to group like-tagged renderers together. Will only be used if pages are on the same origin.
3697
+ * String tag that attempts to group like-tagged renderers together.
3698
+ * However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.
3699
+ * @remarks Will only be used if pages are on the same origin.
3752
3700
  */
3753
3701
  processAffinity: string;
3754
3702
  /**
@@ -3838,103 +3786,6 @@ declare type ConstWindowOptions = {
3838
3786
  inheritance?: Partial<InheritableOptions>;
3839
3787
  };
3840
3788
 
3841
- declare interface Container extends EventEmitter_2 {
3842
- /**
3843
- * The current width of the container in pixel
3844
- */
3845
- width: number;
3846
-
3847
- /**
3848
- * The current height of the container in pixel
3849
- */
3850
- height: number;
3851
-
3852
- /**
3853
- * A reference to the component-item that controls this container
3854
- */
3855
- parent: ContentItem;
3856
-
3857
- /**
3858
- * A reference to the tab that controls this container. Will initially be null
3859
- * (and populated once a tab event has been fired).
3860
- */
3861
- tab: Tab;
3862
-
3863
- /**
3864
- * The current title of the container
3865
- */
3866
- title: string;
3867
-
3868
- /*
3869
- * A reference to the GoldenLayout instance this container belongs to
3870
- */
3871
- layoutManager: GoldenLayout_2;
3872
-
3873
- /**
3874
- * True if the item is currently hidden
3875
- */
3876
- isHidden: boolean;
3877
-
3878
- /**
3879
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3880
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3881
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3882
- * constructor function. It will also be used when the component is opened in a new window.
3883
- * @param state A serialisable object
3884
- */
3885
- setState(state: any): void;
3886
-
3887
- /**
3888
- * The same as setState but does not emit 'stateChanged' event
3889
- * @param {serialisable} state
3890
- */
3891
- setStateSkipEvent(state: any): void;
3892
-
3893
- /**
3894
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3895
- * @param state A serialisable object
3896
- */
3897
- extendState(state: any): void;
3898
-
3899
- /**
3900
- * Returns the current state.
3901
- */
3902
- getState(): any;
3903
-
3904
- /**
3905
- * Returns the container's inner element as a jQuery element
3906
- */
3907
- getElement(): JQuery;
3908
-
3909
- /**
3910
- * hides the container or returns false if hiding it is not possible
3911
- */
3912
- hide(): boolean;
3913
-
3914
- /**
3915
- * shows the container or returns false if showing it is not possible
3916
- */
3917
- show(): boolean;
3918
-
3919
- /**
3920
- * Sets the container to the specified size or returns false if that's not possible
3921
- * @param width the new width in pixel
3922
- * @param height the new height in pixel
3923
- */
3924
- setSize(width: number, height: number): boolean;
3925
-
3926
- /**
3927
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3928
- * @param title the new title
3929
- */
3930
- setTitle(title: string): void;
3931
-
3932
- /**
3933
- * Closes the container or returns false if that is not possible
3934
- */
3935
- close(): boolean;
3936
- }
3937
-
3938
3789
  declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3939
3790
 
3940
3791
  /**
@@ -3997,218 +3848,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3997
3848
  disposition: string;
3998
3849
  };
3999
3850
 
4000
- declare interface ContentItem extends EventEmitter_2 {
4001
- instance: any;
4002
- header: any;
4003
- _splitter: any;
4004
- /**
4005
- * This items configuration in its current state
4006
- */
4007
- config: ItemConfigType;
4008
-
4009
- /**
4010
- * The type of the item. Can be row, column, stack, component or root
4011
- */
4012
- type: ItemType;
4013
-
4014
- /**
4015
- * An array of items that are children of this item
4016
- */
4017
- contentItems: ContentItem[];
4018
-
4019
- container: Container;
4020
- /**
4021
- * The item that is this item's parent (or null if the item is root)
4022
- */
4023
- parent: ContentItem;
4024
-
4025
- /**
4026
- * A String or array of identifiers if provided in the configuration
4027
- */
4028
- id: string;
4029
-
4030
- /**
4031
- * True if the item had been initialised
4032
- */
4033
- isInitialised: boolean;
4034
-
4035
- /**
4036
- * True if the item is maximised
4037
- */
4038
- isMaximised: boolean;
4039
-
4040
- /**
4041
- * True if the item is the layout's root item
4042
- */
4043
- isRoot: boolean;
4044
-
4045
- /**
4046
- * True if the item is a row
4047
- */
4048
- isRow: boolean;
4049
-
4050
- /**
4051
- * True if the item is a column
4052
- */
4053
- isColumn: boolean;
4054
-
4055
- /**
4056
- * True if the item is a stack
4057
- */
4058
- isStack: boolean;
4059
-
4060
- /**
4061
- * True if the item is a component
4062
- */
4063
- isComponent: boolean;
4064
-
4065
- /**
4066
- * A reference to the layoutManager that controls this item
4067
- */
4068
- layoutManager: any;
4069
-
4070
- /**
4071
- * The item's outer element
4072
- */
4073
- element: JQuery;
4074
-
4075
- /**
4076
- * The item's inner element. Can be the same as the outer element.
4077
- */
4078
- childElementContainer: Container;
4079
-
4080
- /**
4081
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4082
- * from its original position before adding it to this item.
4083
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4084
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4085
- */
4086
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4087
-
4088
- /**
4089
- * Destroys the item and all it's children
4090
- * @param contentItem The contentItem that should be removed
4091
- * @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.
4092
- */
4093
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4094
-
4095
- /**
4096
- * The contentItem that should be removed
4097
- * @param oldChild ContentItem The contentItem that should be removed
4098
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4099
- */
4100
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4101
-
4102
- /**
4103
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4104
- */
4105
- setSize(): void;
4106
-
4107
- /**
4108
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4109
- * @param title the new title
4110
- */
4111
- setTitle(title: string): void;
4112
-
4113
- /**
4114
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4115
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4116
- * @param functionName The name of the method to invoke
4117
- * @param functionArguments An array of arguments to pass to every function
4118
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4119
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4120
- */
4121
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4122
-
4123
- /**
4124
- * 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.
4125
- */
4126
- emitBubblingEvent(name: string): void;
4127
-
4128
- /**
4129
- * Convenience method for item.parent.removeChild( item )
4130
- */
4131
- remove(): void;
4132
-
4133
- /**
4134
- * Removes the item from its current position in the layout and opens it in a window
4135
- */
4136
- popout(): BrowserWindow;
4137
-
4138
- /**
4139
- * Maximises the item or minimises it if it's already maximised
4140
- */
4141
- toggleMaximise(): void;
4142
-
4143
- /**
4144
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4145
- */
4146
- select(): void;
4147
-
4148
- /**
4149
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4150
- */
4151
- deselect(): void;
4152
-
4153
- /**
4154
- * Returns true if the item has the specified id or false if not
4155
- * @param id An id to check for
4156
- */
4157
- hasId(id: string): boolean;
4158
-
4159
- /**
4160
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4161
- * @param contentItem The new active content item
4162
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4163
- */
4164
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4165
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4166
-
4167
- /**
4168
- * Only Stacks have this method! Returns the currently selected contentItem.
4169
- */
4170
- getActiveContentItem(): ContentItem;
4171
-
4172
- /**
4173
- * Adds an id to an item or does nothing if the id is already present
4174
- * @param id The id to be added
4175
- */
4176
- addId(id: string): void;
4177
-
4178
- /**
4179
- * Removes an id from an item or throws an error if the id couldn't be found
4180
- * @param id The id to be removed
4181
- */
4182
- removeId(id: string): void;
4183
-
4184
- /**
4185
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4186
- * @param filterFunction A function that determines whether an item matches certain criteria
4187
- */
4188
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4189
-
4190
- /**
4191
- * Returns all items with the specified id.
4192
- * @param id An id specified in the itemConfig
4193
- */
4194
- getItemsById(id: string | string[]): ContentItem[];
4195
-
4196
- /**
4197
- * Returns all items with the specified type
4198
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4199
- */
4200
- getItemsByType(type: string): ContentItem[];
4201
-
4202
- /**
4203
- * Returns all instances of the component with the specified componentName
4204
- * @param componentName a componentName as specified in the itemConfig
4205
- */
4206
- getComponentsByName(componentName: string): any;
4207
-
4208
- _contentAreaDimensions: any;
4209
- _$getArea: () => any;
4210
- }
4211
-
4212
3851
  /**
4213
3852
  * Restrict navigation to URLs that match an allowed pattern.
4214
3853
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4693,46 +4332,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4693
4332
  type: 'did-finish-load';
4694
4333
  };
4695
4334
 
4696
- declare interface Dimensions {
4697
- /**
4698
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4699
- * than the visible one, making it safe to set this to small values without affecting usability.
4700
- * Default: 5
4701
- */
4702
- borderWidth?: number;
4703
-
4704
- /**
4705
- * The minimum height an item can be resized to (in pixel).
4706
- * Default: 10
4707
- */
4708
- minItemHeight?: number;
4709
-
4710
- /**
4711
- * The minimum width an item can be resized to (in pixel).
4712
- * Default: 10
4713
- */
4714
- minItemWidth?: number;
4715
-
4716
- /**
4717
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4718
- * adjusted accordingly.
4719
- * Default: 20
4720
- */
4721
- headerHeight?: number;
4722
-
4723
- /**
4724
- * The width of the element that appears when an item is dragged (in pixel).
4725
- * Default: 300
4726
- */
4727
- dragProxyWidth?: number;
4728
-
4729
- /**
4730
- * The height of the element that appears when an item is dragged (in pixel).
4731
- * Default: 200
4732
- */
4733
- dragProxyHeight?: number;
4734
- }
4735
-
4736
4335
  /**
4737
4336
  * @interface
4738
4337
  */
@@ -5029,8 +4628,6 @@ declare type Dpi = {
5029
4628
  vertical?: number;
5030
4629
  };
5031
4630
 
5032
- declare interface DragSource {}
5033
-
5034
4631
  /**
5035
4632
  * Generated when a window has been embedded.
5036
4633
  * @interface
@@ -5298,7 +4895,7 @@ declare type Event_3 = ViewEvents.PropagatedEvent<'application'> | WindowEvents.
5298
4895
  */
5299
4896
  declare type Event_4 = (WebContentsEvents.Event<'view'> & {
5300
4897
  target: OpenFin.Identity;
5301
- }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent;
4898
+ }) | CreatedEvent | DestroyedEvent | HiddenEvent | HotkeyEvent | ShownEvent | TargetChangedEvent | HostContextChangedEvent | AddedToLayoutEvent | RemovedFromLayoutEvent;
5302
4899
 
5303
4900
  /**
5304
4901
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing events shared by all WebContents elements
@@ -5342,51 +4939,12 @@ declare class EventAggregator extends EmitterMap {
5342
4939
  dispatchEvent: (message: Message<any>) => boolean;
5343
4940
  }
5344
4941
 
5345
- declare interface EventEmitter_2 {
5346
- [x: string]: any;
5347
- /**
5348
- * Subscribe to an event
5349
- * @param eventName The name of the event to describe to
5350
- * @param callback The function that should be invoked when the event occurs
5351
- * @param context The value of the this pointer in the callback function
5352
- */
5353
- on(eventName: string, callback: Function, context?: any): void;
5354
-
5355
- /**
5356
- * Notify listeners of an event and pass arguments along
5357
- * @param eventName The name of the event to emit
5358
- */
5359
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5360
-
5361
- /**
5362
- * Alias for emit
5363
- */
5364
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5365
-
5366
- /**
5367
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5368
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5369
- * arguments.
5370
- * @param eventName The name of the event to unsubscribe from
5371
- * @param callback The function that should be invoked when the event occurs
5372
- * @param context The value of the this pointer in the callback function
5373
- */
5374
- unbind(eventName: string, callback?: Function, context?: any): void;
5375
-
5376
- /**
5377
- * Alias for unbind
5378
- */
5379
- off(eventName: string, callback?: Function, context?: any): void;
5380
- }
5381
-
5382
4942
  /**
5383
4943
  * Handler for an event on an EventEmitter.
5384
4944
  * @remarks Selects the correct type for the event
5385
4945
  * payload from the provided union based on the provided string literal type.
5386
4946
  */
5387
- declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Extract<EmitterEvent, {
5388
- type: EventType;
5389
- }>, ...args: any[]) => void;
4947
+ declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
5390
4948
 
5391
4949
  declare namespace Events {
5392
4950
  export {
@@ -5517,7 +5075,7 @@ declare namespace ExternalApplicationEvents {
5517
5075
  ExternalApplicationEvent,
5518
5076
  EventType_4 as EventType,
5519
5077
  ExternalApplicationEventType,
5520
- Payload_5 as Payload,
5078
+ Payload_6 as Payload,
5521
5079
  ByType_4 as ByType
5522
5080
  }
5523
5081
  }
@@ -6297,7 +5855,7 @@ declare namespace FrameEvents {
6297
5855
  FrameEvent,
6298
5856
  EventType_5 as EventType,
6299
5857
  FrameEventType,
6300
- Payload_6 as Payload,
5858
+ Payload_7 as Payload,
6301
5859
  ByType_5 as ByType
6302
5860
  }
6303
5861
  }
@@ -6491,297 +6049,64 @@ declare class GlobalHotkey extends EmitterBase<OpenFin.GlobalHotkeyEvent> {
6491
6049
  *
6492
6050
  * @remarks Raises the `unregistered` event for each hotkey unregistered.
6493
6051
  *
6494
- * @example
6495
- * ```js
6496
- * fin.GlobalHotkey.unregisterAll()
6497
- * .then(() => {
6498
- * console.log('Success');
6499
- * })
6500
- * .catch(err => {
6501
- * console.log('Error unregistering all hotkeys for this application', err);
6502
- * });
6503
- * ```
6504
- */
6505
- unregisterAll(): Promise<void>;
6506
- /**
6507
- * Checks if a given hotkey has been registered by an application within the current runtime.
6508
- * @param hotkey a hotkey string
6509
- *
6510
- * @example
6511
- * ```js
6512
- * const hotkey = 'CommandOrControl+X';
6513
- *
6514
- * fin.GlobalHotkey.isRegistered(hotkey)
6515
- * .then((registered) => {
6516
- * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
6517
- * })
6518
- * .catch(err => {
6519
- * console.log('Error unregistering the hotkey', err);
6520
- * });
6521
- * ```
6522
- */
6523
- isRegistered(hotkey: string): Promise<boolean>;
6524
- }
6525
-
6526
- /**
6527
- * @deprecated Renamed to {@link Event}.
6528
- */
6529
- declare type GlobalHotkeyEvent = Event_9;
6530
-
6531
- declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6532
-
6533
- declare namespace GlobalHotkeyEvents {
6534
- export {
6535
- BaseEvent_8 as BaseEvent,
6536
- RegisteredEvent,
6537
- UnregisteredEvent,
6538
- Event_9 as Event,
6539
- GlobalHotkeyEvent,
6540
- EventType_6 as EventType,
6541
- GlobalHotkeyEventType,
6542
- Payload_7 as Payload,
6543
- ByType_6 as ByType
6544
- }
6545
- }
6546
-
6547
- /**
6548
- * @deprecated Renamed to {@link EventType}.
6549
- */
6550
- declare type GlobalHotkeyEventType = EventType_6;
6551
-
6552
- declare namespace GoldenLayout {
6553
- export {
6554
- GoldenLayout_2 as GoldenLayout,
6555
- ItemConfigType,
6556
- Settings,
6557
- Dimensions,
6558
- Labels,
6559
- ItemType,
6560
- ItemConfig,
6561
- ComponentConfig,
6562
- ReactComponentConfig,
6563
- Config,
6564
- ContentItem,
6565
- Container,
6566
- DragSource,
6567
- BrowserWindow,
6568
- Header,
6569
- TabDragListener,
6570
- Tab,
6571
- EventEmitter_2 as EventEmitter
6572
- }
6573
- }
6574
-
6575
- declare class GoldenLayout_2 implements EventEmitter_2 {
6576
- /**
6577
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6578
- * object and of goldenLayout.root as the document.
6579
- */
6580
- root: ContentItem;
6581
-
6582
- /**
6583
- * A reference to the (jQuery) DOM element containing the layout
6584
- */
6585
- container: JQuery;
6586
-
6587
- /**
6588
- * True once the layout item tree has been created and the initialised event has been fired
6589
- */
6590
- isInitialised: boolean;
6591
-
6592
- /**
6593
- * A reference to the current, extended top level config.
6594
- *
6595
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6596
- */
6597
- config: Config;
6598
-
6599
- /**
6600
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6601
- * to true.
6602
- */
6603
- selectedItem: ContentItem;
6604
-
6605
- /**
6606
- * The current outer width of the layout in pixels.
6607
- */
6608
- width: number;
6609
-
6610
- /**
6611
- * The current outer height of the layout in pixels.
6612
- */
6613
- height: number;
6614
-
6615
- /**
6616
- * An array of BrowserWindow instances
6617
- */
6618
- openPopouts: BrowserWindow[];
6619
-
6620
- /**
6621
- * True if the layout has been opened as a popout by another layout.
6622
- */
6623
- isSubWindow: boolean;
6624
-
6625
- /**
6626
- * A singleton instance of EventEmitter that works across windows
6627
- */
6628
- eventHub: EventEmitter_2;
6629
-
6630
- _dragProxy: any;
6631
-
6632
- dropTargetIndicator: any;
6633
-
6634
- /**
6635
- * @param config A GoldenLayout configuration object
6636
- * @param container The DOM element the layout will be initialised in. Default: document.body
6637
- */
6638
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6639
-
6640
- /*
6641
- * @param name The name of the component, as referred to by componentName in the component configuration.
6642
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6643
- * containerobject and a component state
6644
- */
6645
- registerComponent(name: String, component: any): void;
6646
-
6647
- /**
6648
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6649
- * a listener to the document and executes once it becomes ready.
6650
- */
6651
- init(): void;
6652
-
6653
- /**
6654
- * Returns the current state of the layout and its components as a serialisable object.
6655
- */
6656
- toConfig(): Config;
6657
-
6658
- /**
6659
- * Returns a component that was previously registered with layout.registerComponent().
6660
- * @param name The name of a previously registered component
6661
- */
6662
- getComponent(name: string): any;
6663
-
6664
- /**
6665
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6666
- * @param width The outer width the layout should be resized to. Default: The container elements width
6667
- * @param height The outer height the layout should be resized to. Default: The container elements height
6668
- */
6669
- updateSize(width?: number, height?: number): void;
6670
-
6671
- /**
6672
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6673
- * listeners and finally removes itself from the DOM.
6674
- */
6675
- destroy(): void;
6676
-
6677
- /**
6678
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6679
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6680
- * all call this method implicitly.
6681
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6682
- * @param parent A parent item
6683
- */
6684
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6685
-
6686
- /**
6687
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6688
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6689
- * provided its config will be read, if config is provided, only the content key
6690
- * will be used
6691
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6692
- * place the window in another screen.
6693
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6694
- * when popIn is clicked
6695
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6696
- */
6697
- createPopout(
6698
- configOrContentItem: ItemConfigType | ContentItem,
6699
- dimensions: {
6700
- width: number;
6701
- height: number;
6702
- left: number;
6703
- top: number;
6704
- },
6705
- parentId?: string,
6706
- indexInParent?: number
6707
- ): void;
6708
-
6709
- /**
6710
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6711
- * where it turns into a contentItem.
6712
- * @param element The DOM element that will be turned into a dragSource
6713
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6714
- * @return the dragSource that was created. This can be used to remove the
6715
- * dragSource from the layout later.
6716
- */
6717
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6718
-
6719
- /**
6720
- * Removes a dragSource from the layout.
6721
- *
6722
- * @param dragSource The dragSource to remove
6723
- */
6724
- removeDragSource(dragSource: DragSource): void;
6725
-
6726
- /**
6727
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6728
- * @param contentItem A ContentItem instance
6729
- */
6730
- selectItem(contentItem: ContentItem): void;
6731
-
6732
- /**
6733
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6734
- * and replace frequent keys and values with single letter substitutes.
6735
- * @param config A GoldenLayout configuration object
6736
- */
6737
- static minifyConfig(config: any): any;
6738
-
6739
- /**
6740
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6741
- * @param minifiedConfig A minified GoldenLayout configuration object
6742
- */
6743
- static unminifyConfig(minifiedConfig: any): any;
6744
-
6745
- /**
6746
- * Subscribe to an event
6747
- * @param eventName The name of the event to describe to
6748
- * @param callback The function that should be invoked when the event occurs
6749
- * @param context The value of the this pointer in the callback function
6750
- */
6751
- on(eventName: string, callback: Function, context?: any): void;
6752
-
6753
- /**
6754
- * Notify listeners of an event and pass arguments along
6755
- * @param eventName The name of the event to emit
6052
+ * @example
6053
+ * ```js
6054
+ * fin.GlobalHotkey.unregisterAll()
6055
+ * .then(() => {
6056
+ * console.log('Success');
6057
+ * })
6058
+ * .catch(err => {
6059
+ * console.log('Error unregistering all hotkeys for this application', err);
6060
+ * });
6061
+ * ```
6756
6062
  */
6757
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6758
-
6063
+ unregisterAll(): Promise<void>;
6759
6064
  /**
6760
- * Alias for emit
6065
+ * Checks if a given hotkey has been registered by an application within the current runtime.
6066
+ * @param hotkey a hotkey string
6067
+ *
6068
+ * @example
6069
+ * ```js
6070
+ * const hotkey = 'CommandOrControl+X';
6071
+ *
6072
+ * fin.GlobalHotkey.isRegistered(hotkey)
6073
+ * .then((registered) => {
6074
+ * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
6075
+ * })
6076
+ * .catch(err => {
6077
+ * console.log('Error unregistering the hotkey', err);
6078
+ * });
6079
+ * ```
6761
6080
  */
6762
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6081
+ isRegistered(hotkey: string): Promise<boolean>;
6082
+ }
6763
6083
 
6764
- /**
6765
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6766
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6767
- * arguments.
6768
- * @param eventName The name of the event to unsubscribe from
6769
- * @param callback The function that should be invoked when the event occurs
6770
- * @param context The value of the this pointer in the callback function
6771
- */
6772
- unbind(eventName: string, callback?: Function, context?: any): void;
6084
+ /**
6085
+ * @deprecated Renamed to {@link Event}.
6086
+ */
6087
+ declare type GlobalHotkeyEvent = Event_9;
6773
6088
 
6774
- /**
6775
- * Alias for unbind
6776
- */
6777
- off(eventName: string, callback?: Function, context?: any): void;
6089
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6778
6090
 
6779
- /**
6780
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6781
- */
6782
- _$createRootItemAreas(): void;
6091
+ declare namespace GlobalHotkeyEvents {
6092
+ export {
6093
+ BaseEvent_8 as BaseEvent,
6094
+ RegisteredEvent,
6095
+ UnregisteredEvent,
6096
+ Event_9 as Event,
6097
+ GlobalHotkeyEvent,
6098
+ EventType_6 as EventType,
6099
+ GlobalHotkeyEventType,
6100
+ Payload_8 as Payload,
6101
+ ByType_6 as ByType
6102
+ }
6783
6103
  }
6784
6104
 
6105
+ /**
6106
+ * @deprecated Renamed to {@link EventType}.
6107
+ */
6108
+ declare type GlobalHotkeyEventType = EventType_6;
6109
+
6785
6110
  /**
6786
6111
  * @interface
6787
6112
  */
@@ -6789,62 +6114,6 @@ declare type GpuInfo = {
6789
6114
  name: string;
6790
6115
  };
6791
6116
 
6792
- declare interface Header {
6793
- /**
6794
- * A reference to the LayoutManager instance
6795
- */
6796
- layoutManager: GoldenLayout_2;
6797
-
6798
- /**
6799
- * A reference to the Stack this Header belongs to
6800
- */
6801
- parent: ContentItem;
6802
-
6803
- /**
6804
- * An array of the Tabs within this header
6805
- */
6806
- tabs: Tab[];
6807
-
6808
- /**
6809
- * The currently selected activeContentItem
6810
- */
6811
- activeContentItem: ContentItem;
6812
-
6813
- /**
6814
- * The outer (jQuery) DOM element of this Header
6815
- */
6816
- element: JQuery;
6817
-
6818
- /**
6819
- * The (jQuery) DOM element containing the tabs
6820
- */
6821
- tabsContainer: JQuery;
6822
-
6823
- /**
6824
- * The (jQuery) DOM element containing the close, maximise and popout button
6825
- */
6826
- controlsContainer: JQuery;
6827
-
6828
- /**
6829
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6830
- * @param contentItem The content item that will be selected
6831
- */
6832
- setActiveContentItem(contentItem: ContentItem): void;
6833
-
6834
- /**
6835
- * Creates a new tab and associates it with a content item
6836
- * @param contentItem The content item the tab will be associated with
6837
- * @param index A zero based index, specifying the position of the new tab
6838
- */
6839
- createTab(contentItem: ContentItem, index?: number): void;
6840
-
6841
- /**
6842
- * Finds a tab by its contentItem and removes it
6843
- * @param contentItem The content item the tab is associated with
6844
- */
6845
- removeTab(contentItem: ContentItem): void;
6846
- }
6847
-
6848
6117
  /**
6849
6118
  * Generated when a View is hidden.
6850
6119
  * @interface
@@ -8513,50 +7782,6 @@ declare class InteropModule extends Base {
8513
7782
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8514
7783
  }
8515
7784
 
8516
- declare interface ItemConfig {
8517
- /**
8518
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8519
- */
8520
- type: ItemType;
8521
-
8522
- /**
8523
- * An array of configurations for items that will be created as children of this item.
8524
- */
8525
- content?: ItemConfigType[];
8526
-
8527
- /**
8528
- * The width of this item, relative to the other children of its parent in percent
8529
- */
8530
- width?: number;
8531
-
8532
- /**
8533
- * The height of this item, relative to the other children of its parent in percent
8534
- */
8535
- height?: number;
8536
-
8537
- /**
8538
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8539
- */
8540
- id?: string | string[];
8541
-
8542
- /**
8543
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8544
- * will return false
8545
- * Default: true
8546
- */
8547
- isClosable?: boolean;
8548
-
8549
- /**
8550
- * The title of the item as displayed on its tab and on popout windows
8551
- * Default: componentName or ''
8552
- */
8553
- title?: string;
8554
- }
8555
-
8556
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8557
-
8558
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8559
-
8560
7785
  /**
8561
7786
  * @interface
8562
7787
  */
@@ -8614,32 +7839,6 @@ declare type JumpListTask = {
8614
7839
  iconIndex?: number;
8615
7840
  };
8616
7841
 
8617
- declare interface Labels {
8618
- /**
8619
- * The tooltip text that appears when hovering over the close icon.
8620
- * Default: 'close'
8621
- */
8622
- close?: string;
8623
-
8624
- /**
8625
- * The tooltip text that appears when hovering over the maximise icon.
8626
- * Default: 'maximise'
8627
- */
8628
- maximise?: string;
8629
-
8630
- /**
8631
- * The tooltip text that appears when hovering over the minimise icon.
8632
- * Default: 'minimise'
8633
- */
8634
- minimise?: string;
8635
-
8636
- /**
8637
- * The tooltip text that appears when hovering over the popout icon.
8638
- * Default: 'open in new window'
8639
- */
8640
- popout?: string;
8641
- }
8642
-
8643
7842
  /**
8644
7843
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8645
7844
  *
@@ -9065,7 +8264,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
9065
8264
  entityId: string;
9066
8265
  };
9067
8266
 
9068
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
8267
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
9069
8268
 
9070
8269
  /**
9071
8270
  * @interface
@@ -10673,76 +9872,100 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
10673
9872
  };
10674
9873
 
10675
9874
  /**
10676
- * Extracts a single event type matching the given key from the View {@link Event} union.
9875
+ * Extracts a single event type matching the given key from the System {@link Event} union.
9876
+ *
9877
+ * @see {@link ByType}
10677
9878
  *
10678
9879
  * @typeParam Type String key specifying the event to extract
10679
9880
  */
10680
- declare type Payload_2<Type extends EventType> = Extract<Event_4, {
10681
- type: Type;
9881
+ declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
9882
+
9883
+ /**
9884
+ * Extracts a single event type matching the given type key from the provided EmitterEvent union.
9885
+ *
9886
+ * @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
9887
+ * the appropriate payload union for that namespace.
9888
+ *
9889
+ * @typeParam Event Union of payloads for events on the given emitter
9890
+ * @see {@link ByType}
9891
+ *
9892
+ * @typeParam Type String key specifying the event to extract from the union
9893
+ *
9894
+ * @see {@link OpenFin.Events.ApplicationEvents.Payload}
9895
+ * @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
9896
+ * @see {@link OpenFin.Events.FrameEvents.Payload}
9897
+ * @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
9898
+ * @see {@link OpenFin.Events.PlatformEvents.Payload}
9899
+ * @see {@link OpenFin.Events.SystemEvents.Payload}
9900
+ * @see {@link OpenFin.Events.ViewEvents.Payload}
9901
+ * @see {@link OpenFin.Events.WindowEvents.Payload}
9902
+ */
9903
+ declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
9904
+ type: EventType;
10682
9905
  }>;
10683
9906
 
9907
+ /**
9908
+ * Extracts a single event type matching the given key from the View {@link Event} union.
9909
+ *
9910
+ * @see {@link ByType}
9911
+ *
9912
+ * @typeParam Type String key specifying the event to extract
9913
+ */
9914
+ declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
9915
+
10684
9916
  /**
10685
9917
  * Extracts a single event type matching the given key from the Window {@link Event} union.
10686
9918
  *
9919
+ * @see {@link ByType}
9920
+ *
10687
9921
  * @typeParam Type String key specifying the event to extract
10688
9922
  */
10689
- declare type Payload_3<Type extends EventType_2> = Extract<Event_6, {
10690
- type: Type;
10691
- }>;
9923
+ declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
10692
9924
 
10693
9925
  /**
10694
9926
  * Extracts a single event type matching the given key from the Application {@link Event} union.
10695
9927
  *
9928
+ * @see {@link ByType}
9929
+ *
10696
9930
  * @typeParam Type String key specifying the event to extract
10697
9931
  */
10698
- declare type Payload_4<Type extends EventType_3> = Extract<Event_3, {
10699
- type: Type;
10700
- }>;
9932
+ declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
10701
9933
 
10702
9934
  /**
10703
9935
  * Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
10704
9936
  *
9937
+ * @see {@link ByType}
9938
+ *
10705
9939
  * @typeParam Type String key specifying the event to extract
10706
9940
  */
10707
- declare type Payload_5<Type extends EventType_4> = Extract<Event_7, {
10708
- type: Type;
10709
- }>;
9941
+ declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
10710
9942
 
10711
9943
  /**
10712
9944
  * Extracts a single event type matching the given key from the Frame {@link Event} union.
10713
9945
  *
9946
+ * @see {@link ByType}
9947
+ *
10714
9948
  * @typeParam Type String key specifying the event to extract
10715
9949
  */
10716
- declare type Payload_6<Type extends EventType_5> = Extract<Event_8, {
10717
- type: Type;
10718
- }>;
9950
+ declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
10719
9951
 
10720
9952
  /**
10721
9953
  * Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
10722
9954
  *
9955
+ * @see {@link ByType}
9956
+ *
10723
9957
  * @typeParam Type String key specifying the event to extract
10724
9958
  */
10725
- declare type Payload_7<Type extends EventType_6> = Extract<Event_9, {
10726
- type: Type;
10727
- }>;
9959
+ declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
10728
9960
 
10729
9961
  /**
10730
9962
  * Extracts a single event type matching the given key from the Platform {@link Event} union.
10731
9963
  *
10732
- * @typeParam Type String key specifying the event to extract
10733
- */
10734
- declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
10735
- type: Type;
10736
- }>;
10737
-
10738
- /**
10739
- * Extracts a single event type matching the given key from the System {@link Event} union.
9964
+ * @see {@link ByType}
10740
9965
  *
10741
9966
  * @typeParam Type String key specifying the event to extract
10742
9967
  */
10743
- declare type Payload_9<Type extends EventType_8> = Extract<Event_11, {
10744
- type: Type;
10745
- }>;
9968
+ declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
10746
9969
 
10747
9970
  declare type PayloadTypeByStrategy<T extends ChannelStrategy<unknown>> = T extends ChannelStrategy<infer U> ? U : never;
10748
9971
 
@@ -11406,7 +10629,7 @@ declare namespace PlatformEvents {
11406
10629
  PlatformEvent,
11407
10630
  EventType_7 as EventType,
11408
10631
  PlatformEventType,
11409
- Payload_8 as Payload,
10632
+ Payload_9 as Payload,
11410
10633
  ByType_7 as ByType
11411
10634
  }
11412
10635
  }
@@ -12990,18 +12213,6 @@ declare type QueryPermissionResult = {
12990
12213
  rawValue?: unknown;
12991
12214
  };
12992
12215
 
12993
- declare interface ReactComponentConfig extends ItemConfig {
12994
- /**
12995
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12996
- */
12997
- component: string;
12998
-
12999
- /**
13000
- * Properties that will be passed to the component and accessible using this.props.
13001
- */
13002
- props?: any;
13003
- }
13004
-
13005
12216
  /**
13006
12217
  * @interface
13007
12218
  */
@@ -13089,6 +12300,15 @@ declare interface RemoteConfig extends ExistingConnectConfig {
13089
12300
  token: string;
13090
12301
  }
13091
12302
 
12303
+ /**
12304
+ * Generated when a View is removed from a layout.
12305
+ * @interface
12306
+ */
12307
+ declare type RemovedFromLayoutEvent = BaseEvent_4 & {
12308
+ type: 'removed-from-layout';
12309
+ layoutIdentity: OpenFin.LayoutIdentity;
12310
+ };
12311
+
13092
12312
  /**
13093
12313
  * @interface
13094
12314
  */
@@ -13508,97 +12728,6 @@ declare type SessionContextGroup = {
13508
12728
  }>;
13509
12729
  };
13510
12730
 
13511
- declare interface Settings {
13512
- preventSplitterResize?: boolean;
13513
-
13514
- newTabButton?: {
13515
- url?: string;
13516
- };
13517
-
13518
- /**
13519
- * If true, tabs can't be dragged into the window.
13520
- * Default: false
13521
- */
13522
- preventDragIn?: boolean;
13523
-
13524
- /**
13525
- * If true, tabs can't be dragged out of the window.
13526
- * Default: false
13527
- */
13528
- preventDragOut?: boolean;
13529
-
13530
- /**
13531
- * If true, stack headers are the only areas where tabs can be dropped.
13532
- * Default: false
13533
- */
13534
- constrainDragToHeaders?: boolean;
13535
- /**
13536
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13537
- * Default: true
13538
- */
13539
- hasHeaders?: boolean;
13540
-
13541
- /**
13542
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13543
- * automatically when layout.createDragSource() is called.
13544
- * Default: true
13545
- */
13546
- constrainDragToContainer?: boolean;
13547
-
13548
- /**
13549
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13550
- * Default: true
13551
- */
13552
- reorderEnabled?: boolean;
13553
-
13554
- /**
13555
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13556
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13557
- * Default: false
13558
- */
13559
- selectionEnabled?: boolean;
13560
-
13561
- /**
13562
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13563
- * be transferred to the new window, if false only the active component will be opened.
13564
- * Default: false
13565
- */
13566
- popoutWholeStack?: boolean;
13567
-
13568
- /**
13569
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13570
- * If false, the popout call will fail silently.
13571
- * Default: true
13572
- */
13573
- blockedPopoutsThrowError?: boolean;
13574
-
13575
- /**
13576
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13577
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13578
- * addition, any changes made to popouts won't be stored after the parent is closed.
13579
- * Default: true
13580
- */
13581
- closePopoutsOnUnload?: boolean;
13582
-
13583
- /**
13584
- * Specifies if the popout icon should be displayed in the header-bar.
13585
- * Default: true
13586
- */
13587
- showPopoutIcon?: boolean;
13588
-
13589
- /**
13590
- * Specifies if the maximise icon should be displayed in the header-bar.
13591
- * Default: true
13592
- */
13593
- showMaximiseIcon?: boolean;
13594
-
13595
- /**
13596
- * Specifies if the close icon should be displayed in the header-bar.
13597
- * Default: true
13598
- */
13599
- showCloseIcon?: boolean;
13600
- }
13601
-
13602
12731
  /**
13603
12732
  * @interface
13604
12733
  */
@@ -13822,7 +12951,7 @@ declare type Snapshot = {
13822
12951
  * _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.
13823
12952
  * @interface
13824
12953
  */
13825
- declare type SnapshotAppliedEvent = BaseEvent & {
12954
+ declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
13826
12955
  topic: 'application';
13827
12956
  type: 'platform-snapshot-applied';
13828
12957
  };
@@ -15428,7 +14557,7 @@ declare namespace SystemEvents {
15428
14557
  SystemEvent,
15429
14558
  EventType_8 as EventType,
15430
14559
  SystemEventType,
15431
- Payload_9 as Payload,
14560
+ Payload_10 as Payload,
15432
14561
  ByType_8 as ByType
15433
14562
  }
15434
14563
  }
@@ -15495,59 +14624,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15495
14624
  proceed: () => void;
15496
14625
  }) => void;
15497
14626
 
15498
- declare interface Tab {
15499
- _dragListener: TabDragListener;
15500
-
15501
- /**
15502
- * True if this tab is the selected tab
15503
- */
15504
- isActive: boolean;
15505
-
15506
- /**
15507
- * A reference to the header this tab is a child of
15508
- */
15509
- header: Header;
15510
-
15511
- /**
15512
- * A reference to the content item this tab relates to
15513
- */
15514
- contentItem: ContentItem;
15515
-
15516
- /**
15517
- * The tabs outer (jQuery) DOM element
15518
- */
15519
- element: JQuery;
15520
-
15521
- /**
15522
- * The (jQuery) DOM element containing the title
15523
- */
15524
- titleElement: JQuery;
15525
-
15526
- /**
15527
- * The (jQuery) DOM element that closes the tab
15528
- */
15529
- closeElement: JQuery;
15530
-
15531
- /**
15532
- * Sets the tab's title. Does not affect the contentItem's title!
15533
- * @param title The new title
15534
- */
15535
- setTitle(title: string): void;
15536
-
15537
- /**
15538
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15539
- * @param isActive Whether the tab is active
15540
- */
15541
- setActive(isActive: boolean): void;
15542
- }
15543
-
15544
- declare interface TabDragListener extends EventEmitter_2 {
15545
- /**
15546
- * A reference to the content item this tab relates to
15547
- */
15548
- contentItem: ContentItem;
15549
- }
15550
-
15551
14627
  /**
15552
14628
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15553
14629
  */
@@ -16487,6 +15563,8 @@ declare namespace ViewEvents {
16487
15563
  BaseEvent_4 as BaseEvent,
16488
15564
  BaseViewEvent,
16489
15565
  TargetChangedEvent,
15566
+ AddedToLayoutEvent,
15567
+ RemovedFromLayoutEvent,
16490
15568
  NonPropagatedViewEvent,
16491
15569
  CreatedEvent,
16492
15570
  DestroyedEvent,
@@ -16503,7 +15581,7 @@ declare namespace ViewEvents {
16503
15581
  PropagatedViewEvent,
16504
15582
  PropagatedEventType_2 as PropagatedEventType,
16505
15583
  PropagatedViewEventType,
16506
- Payload_2 as Payload,
15584
+ Payload_3 as Payload,
16507
15585
  ByType
16508
15586
  }
16509
15587
  }
@@ -18979,7 +18057,7 @@ declare namespace WindowEvents {
18979
18057
  PropagatedEvent_3 as PropagatedEvent,
18980
18058
  PropagatedWindowEvent,
18981
18059
  PropagatedWindowEventType,
18982
- Payload_3 as Payload,
18060
+ Payload_4 as Payload,
18983
18061
  ByType_2 as ByType
18984
18062
  }
18985
18063
  }