@openfin/remote-adapter 38.81.31 → 38.81.34

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.
@@ -1161,9 +1161,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1161
1161
  */
1162
1162
  mainWindowOptions: WindowCreationOptions;
1163
1163
  /**
1164
- * The name of the application (and the application's main window).
1164
+ * The name of the application.
1165
1165
  *
1166
- * If provided, _must_ match `uuid`.
1166
+ * @remarks
1167
+ * This property is only used for naming the application logging folder, which will be sanitized to remove
1168
+ * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1169
+ * during startup with the UUID of the application.
1170
+ *
1171
+ * This property will be deprecated in the future.
1167
1172
  */
1168
1173
  name: string;
1169
1174
  /**
@@ -1193,9 +1198,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1193
1198
  url: string;
1194
1199
  /**
1195
1200
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1196
- * running in the OpenFin Runtime.
1197
- *
1198
- * Note that `name` and `uuid` must match.
1201
+ * running in the OpenFin Runtime.
1199
1202
  */
1200
1203
  uuid: string;
1201
1204
  /**
@@ -1904,48 +1907,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1904
1907
  behavior: 'browser';
1905
1908
  };
1906
1909
 
1907
- declare interface BrowserWindow {
1908
- /**
1909
- * True if the window has been opened and its GoldenLayout instance initialised.
1910
- */
1911
- isInitialised: boolean;
1912
-
1913
- /**
1914
- * Creates a window configuration object from the Popout.
1915
- */
1916
- toConfig(): {
1917
- dimensions: {
1918
- width: number;
1919
- height: number;
1920
- left: number;
1921
- top: number;
1922
- };
1923
- content: Config;
1924
- parentId: string;
1925
- indexInParent: number;
1926
- };
1927
-
1928
- /**
1929
- * Returns the GoldenLayout instance from the child window
1930
- */
1931
- getGlInstance(): GoldenLayout_2;
1932
-
1933
- /**
1934
- * Returns the native Window object
1935
- */
1936
- getWindow(): Window;
1937
-
1938
- /**
1939
- * Closes the popout
1940
- */
1941
- close(): void;
1942
-
1943
- /**
1944
- * Returns the popout to its original position as specified in parentId and indexInParent
1945
- */
1946
- popIn(): void;
1947
- }
1948
-
1949
1910
  /**
1950
1911
  * Extracts a single event type matching the given key from the View {@link Event} union.
1951
1912
  *
@@ -3326,31 +3287,6 @@ declare class ColumnOrRow extends LayoutNode {
3326
3287
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3327
3288
  }
3328
3289
 
3329
- declare interface ComponentConfig extends ItemConfig {
3330
- /**
3331
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3332
- */
3333
- componentName: string;
3334
-
3335
- /**
3336
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3337
- * container.getState().
3338
- */
3339
- componentState?: any;
3340
- }
3341
-
3342
- declare interface Config {
3343
- settings?: Settings;
3344
- dimensions?: Dimensions;
3345
- labels?: Labels;
3346
- content?: ItemConfigType[];
3347
- /**
3348
- * (Only on layout config object)
3349
- * Id of the currently maximised content item
3350
- */
3351
- maximisedItemId?: string;
3352
- }
3353
-
3354
3290
  declare type ConfigWithRuntime = BaseConfig & {
3355
3291
  runtime: RuntimeConfig;
3356
3292
  };
@@ -3766,103 +3702,6 @@ declare type ConstWindowOptions = {
3766
3702
  inheritance?: Partial<InheritableOptions>;
3767
3703
  };
3768
3704
 
3769
- declare interface Container extends EventEmitter_2 {
3770
- /**
3771
- * The current width of the container in pixel
3772
- */
3773
- width: number;
3774
-
3775
- /**
3776
- * The current height of the container in pixel
3777
- */
3778
- height: number;
3779
-
3780
- /**
3781
- * A reference to the component-item that controls this container
3782
- */
3783
- parent: ContentItem;
3784
-
3785
- /**
3786
- * A reference to the tab that controls this container. Will initially be null
3787
- * (and populated once a tab event has been fired).
3788
- */
3789
- tab: Tab;
3790
-
3791
- /**
3792
- * The current title of the container
3793
- */
3794
- title: string;
3795
-
3796
- /*
3797
- * A reference to the GoldenLayout instance this container belongs to
3798
- */
3799
- layoutManager: GoldenLayout_2;
3800
-
3801
- /**
3802
- * True if the item is currently hidden
3803
- */
3804
- isHidden: boolean;
3805
-
3806
- /**
3807
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3808
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3809
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3810
- * constructor function. It will also be used when the component is opened in a new window.
3811
- * @param state A serialisable object
3812
- */
3813
- setState(state: any): void;
3814
-
3815
- /**
3816
- * The same as setState but does not emit 'stateChanged' event
3817
- * @param {serialisable} state
3818
- */
3819
- setStateSkipEvent(state: any): void;
3820
-
3821
- /**
3822
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3823
- * @param state A serialisable object
3824
- */
3825
- extendState(state: any): void;
3826
-
3827
- /**
3828
- * Returns the current state.
3829
- */
3830
- getState(): any;
3831
-
3832
- /**
3833
- * Returns the container's inner element as a jQuery element
3834
- */
3835
- getElement(): JQuery;
3836
-
3837
- /**
3838
- * hides the container or returns false if hiding it is not possible
3839
- */
3840
- hide(): boolean;
3841
-
3842
- /**
3843
- * shows the container or returns false if showing it is not possible
3844
- */
3845
- show(): boolean;
3846
-
3847
- /**
3848
- * Sets the container to the specified size or returns false if that's not possible
3849
- * @param width the new width in pixel
3850
- * @param height the new height in pixel
3851
- */
3852
- setSize(width: number, height: number): boolean;
3853
-
3854
- /**
3855
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3856
- * @param title the new title
3857
- */
3858
- setTitle(title: string): void;
3859
-
3860
- /**
3861
- * Closes the container or returns false if that is not possible
3862
- */
3863
- close(): boolean;
3864
- }
3865
-
3866
3705
  /**
3867
3706
  * Generated when a Layout Container Component was created.
3868
3707
  * @interface
@@ -3944,218 +3783,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3944
3783
  disposition: string;
3945
3784
  };
3946
3785
 
3947
- declare interface ContentItem extends EventEmitter_2 {
3948
- instance: any;
3949
- header: any;
3950
- _splitter: any;
3951
- /**
3952
- * This items configuration in its current state
3953
- */
3954
- config: ItemConfigType;
3955
-
3956
- /**
3957
- * The type of the item. Can be row, column, stack, component or root
3958
- */
3959
- type: ItemType;
3960
-
3961
- /**
3962
- * An array of items that are children of this item
3963
- */
3964
- contentItems: ContentItem[];
3965
-
3966
- container: Container;
3967
- /**
3968
- * The item that is this item's parent (or null if the item is root)
3969
- */
3970
- parent: ContentItem;
3971
-
3972
- /**
3973
- * A String or array of identifiers if provided in the configuration
3974
- */
3975
- id: string;
3976
-
3977
- /**
3978
- * True if the item had been initialised
3979
- */
3980
- isInitialised: boolean;
3981
-
3982
- /**
3983
- * True if the item is maximised
3984
- */
3985
- isMaximised: boolean;
3986
-
3987
- /**
3988
- * True if the item is the layout's root item
3989
- */
3990
- isRoot: boolean;
3991
-
3992
- /**
3993
- * True if the item is a row
3994
- */
3995
- isRow: boolean;
3996
-
3997
- /**
3998
- * True if the item is a column
3999
- */
4000
- isColumn: boolean;
4001
-
4002
- /**
4003
- * True if the item is a stack
4004
- */
4005
- isStack: boolean;
4006
-
4007
- /**
4008
- * True if the item is a component
4009
- */
4010
- isComponent: boolean;
4011
-
4012
- /**
4013
- * A reference to the layoutManager that controls this item
4014
- */
4015
- layoutManager: any;
4016
-
4017
- /**
4018
- * The item's outer element
4019
- */
4020
- element: JQuery;
4021
-
4022
- /**
4023
- * The item's inner element. Can be the same as the outer element.
4024
- */
4025
- childElementContainer: Container;
4026
-
4027
- /**
4028
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4029
- * from its original position before adding it to this item.
4030
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4031
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4032
- */
4033
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4034
-
4035
- /**
4036
- * Destroys the item and all it's children
4037
- * @param contentItem The contentItem that should be removed
4038
- * @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.
4039
- */
4040
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4041
-
4042
- /**
4043
- * The contentItem that should be removed
4044
- * @param oldChild ContentItem The contentItem that should be removed
4045
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4046
- */
4047
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4048
-
4049
- /**
4050
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4051
- */
4052
- setSize(): void;
4053
-
4054
- /**
4055
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4056
- * @param title the new title
4057
- */
4058
- setTitle(title: string): void;
4059
-
4060
- /**
4061
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4062
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4063
- * @param functionName The name of the method to invoke
4064
- * @param functionArguments An array of arguments to pass to every function
4065
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4066
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4067
- */
4068
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4069
-
4070
- /**
4071
- * 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.
4072
- */
4073
- emitBubblingEvent(name: string): void;
4074
-
4075
- /**
4076
- * Convenience method for item.parent.removeChild( item )
4077
- */
4078
- remove(): void;
4079
-
4080
- /**
4081
- * Removes the item from its current position in the layout and opens it in a window
4082
- */
4083
- popout(): BrowserWindow;
4084
-
4085
- /**
4086
- * Maximises the item or minimises it if it's already maximised
4087
- */
4088
- toggleMaximise(): void;
4089
-
4090
- /**
4091
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4092
- */
4093
- select(): void;
4094
-
4095
- /**
4096
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4097
- */
4098
- deselect(): void;
4099
-
4100
- /**
4101
- * Returns true if the item has the specified id or false if not
4102
- * @param id An id to check for
4103
- */
4104
- hasId(id: string): boolean;
4105
-
4106
- /**
4107
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4108
- * @param contentItem The new active content item
4109
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4110
- */
4111
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4112
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4113
-
4114
- /**
4115
- * Only Stacks have this method! Returns the currently selected contentItem.
4116
- */
4117
- getActiveContentItem(): ContentItem;
4118
-
4119
- /**
4120
- * Adds an id to an item or does nothing if the id is already present
4121
- * @param id The id to be added
4122
- */
4123
- addId(id: string): void;
4124
-
4125
- /**
4126
- * Removes an id from an item or throws an error if the id couldn't be found
4127
- * @param id The id to be removed
4128
- */
4129
- removeId(id: string): void;
4130
-
4131
- /**
4132
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4133
- * @param filterFunction A function that determines whether an item matches certain criteria
4134
- */
4135
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4136
-
4137
- /**
4138
- * Returns all items with the specified id.
4139
- * @param id An id specified in the itemConfig
4140
- */
4141
- getItemsById(id: string | string[]): ContentItem[];
4142
-
4143
- /**
4144
- * Returns all items with the specified type
4145
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4146
- */
4147
- getItemsByType(type: string): ContentItem[];
4148
-
4149
- /**
4150
- * Returns all instances of the component with the specified componentName
4151
- * @param componentName a componentName as specified in the itemConfig
4152
- */
4153
- getComponentsByName(componentName: string): any;
4154
-
4155
- _contentAreaDimensions: any;
4156
- _$getArea: () => any;
4157
- }
4158
-
4159
3786
  /**
4160
3787
  * Restrict navigation to URLs that match an allowed pattern.
4161
3788
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4594,46 +4221,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4594
4221
  type: 'did-finish-load';
4595
4222
  };
4596
4223
 
4597
- declare interface Dimensions {
4598
- /**
4599
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4600
- * than the visible one, making it safe to set this to small values without affecting usability.
4601
- * Default: 5
4602
- */
4603
- borderWidth?: number;
4604
-
4605
- /**
4606
- * The minimum height an item can be resized to (in pixel).
4607
- * Default: 10
4608
- */
4609
- minItemHeight?: number;
4610
-
4611
- /**
4612
- * The minimum width an item can be resized to (in pixel).
4613
- * Default: 10
4614
- */
4615
- minItemWidth?: number;
4616
-
4617
- /**
4618
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4619
- * adjusted accordingly.
4620
- * Default: 20
4621
- */
4622
- headerHeight?: number;
4623
-
4624
- /**
4625
- * The width of the element that appears when an item is dragged (in pixel).
4626
- * Default: 300
4627
- */
4628
- dragProxyWidth?: number;
4629
-
4630
- /**
4631
- * The height of the element that appears when an item is dragged (in pixel).
4632
- * Default: 200
4633
- */
4634
- dragProxyHeight?: number;
4635
- }
4636
-
4637
4224
  /**
4638
4225
  * @interface
4639
4226
  */
@@ -4894,8 +4481,6 @@ declare type Dpi = {
4894
4481
  vertical?: number;
4895
4482
  };
4896
4483
 
4897
- declare interface DragSource {}
4898
-
4899
4484
  /**
4900
4485
  * Generated when a window has been embedded.
4901
4486
  * @interface
@@ -5208,43 +4793,6 @@ declare class EventAggregator extends EmitterMap {
5208
4793
  dispatchEvent: (message: Message<any>) => boolean;
5209
4794
  }
5210
4795
 
5211
- declare interface EventEmitter_2 {
5212
- [x: string]: any;
5213
- /**
5214
- * Subscribe to an event
5215
- * @param eventName The name of the event to describe to
5216
- * @param callback The function that should be invoked when the event occurs
5217
- * @param context The value of the this pointer in the callback function
5218
- */
5219
- on(eventName: string, callback: Function, context?: any): void;
5220
-
5221
- /**
5222
- * Notify listeners of an event and pass arguments along
5223
- * @param eventName The name of the event to emit
5224
- */
5225
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5226
-
5227
- /**
5228
- * Alias for emit
5229
- */
5230
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5231
-
5232
- /**
5233
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5234
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5235
- * arguments.
5236
- * @param eventName The name of the event to unsubscribe from
5237
- * @param callback The function that should be invoked when the event occurs
5238
- * @param context The value of the this pointer in the callback function
5239
- */
5240
- unbind(eventName: string, callback?: Function, context?: any): void;
5241
-
5242
- /**
5243
- * Alias for unbind
5244
- */
5245
- off(eventName: string, callback?: Function, context?: any): void;
5246
- }
5247
-
5248
4796
  /**
5249
4797
  * Handler for an event on an EventEmitter.
5250
4798
  * @remarks Selects the correct type for the event
@@ -6081,253 +5629,6 @@ declare namespace GlobalHotkeyEvents {
6081
5629
  */
6082
5630
  declare type GlobalHotkeyEventType = EventType_6;
6083
5631
 
6084
- declare namespace GoldenLayout {
6085
- export {
6086
- GoldenLayout_2 as GoldenLayout,
6087
- ItemConfigType,
6088
- Settings,
6089
- Dimensions,
6090
- Labels,
6091
- ItemType,
6092
- ItemConfig,
6093
- ComponentConfig,
6094
- ReactComponentConfig,
6095
- Config,
6096
- ContentItem,
6097
- Container,
6098
- DragSource,
6099
- BrowserWindow,
6100
- Header,
6101
- TabDragListener,
6102
- Tab,
6103
- EventEmitter_2 as EventEmitter
6104
- }
6105
- }
6106
-
6107
- declare class GoldenLayout_2 implements EventEmitter_2 {
6108
- /**
6109
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6110
- * object and of goldenLayout.root as the document.
6111
- */
6112
- root: ContentItem;
6113
-
6114
- /**
6115
- * A reference to the (jQuery) DOM element containing the layout
6116
- */
6117
- container: JQuery;
6118
-
6119
- /**
6120
- * True once the layout item tree has been created and the initialised event has been fired
6121
- */
6122
- isInitialised: boolean;
6123
-
6124
- /**
6125
- * A reference to the current, extended top level config.
6126
- *
6127
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6128
- */
6129
- config: Config;
6130
-
6131
- /**
6132
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6133
- * to true.
6134
- */
6135
- selectedItem: ContentItem;
6136
-
6137
- /**
6138
- * The current outer width of the layout in pixels.
6139
- */
6140
- width: number;
6141
-
6142
- /**
6143
- * The current outer height of the layout in pixels.
6144
- */
6145
- height: number;
6146
-
6147
- /**
6148
- * An array of BrowserWindow instances
6149
- */
6150
- openPopouts: BrowserWindow[];
6151
-
6152
- /**
6153
- * True if the layout has been opened as a popout by another layout.
6154
- */
6155
- isSubWindow: boolean;
6156
-
6157
- /**
6158
- * A singleton instance of EventEmitter that works across windows
6159
- */
6160
- eventHub: EventEmitter_2;
6161
-
6162
- _dragProxy: any;
6163
-
6164
- dropTargetIndicator: any;
6165
-
6166
- _isFullPage: boolean;
6167
-
6168
- _onUnload: any;
6169
-
6170
- tabDropPlaceholder: any;
6171
-
6172
- transitionIndicator: any;
6173
-
6174
- _dragSources: any;
6175
-
6176
- _resizeFunction: any;
6177
-
6178
- _unloadFunction: any;
6179
-
6180
- /**
6181
- * @param config A GoldenLayout configuration object
6182
- * @param container The DOM element the layout will be initialised in. Default: document.body
6183
- */
6184
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6185
-
6186
- /*
6187
- * @param name The name of the component, as referred to by componentName in the component configuration.
6188
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6189
- * containerobject and a component state
6190
- */
6191
- registerComponent(name: String, component: any): void;
6192
-
6193
- /**
6194
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6195
- * a listener to the document and executes once it becomes ready.
6196
- */
6197
- init(): void;
6198
-
6199
- /**
6200
- * Returns the current state of the layout and its components as a serialisable object.
6201
- */
6202
- toConfig(): Config;
6203
-
6204
- /**
6205
- * Returns a component that was previously registered with layout.registerComponent().
6206
- * @param name The name of a previously registered component
6207
- */
6208
- getComponent(name: string): any;
6209
-
6210
- /**
6211
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6212
- * @param width The outer width the layout should be resized to. Default: The container elements width
6213
- * @param height The outer height the layout should be resized to. Default: The container elements height
6214
- */
6215
- updateSize(width?: number, height?: number): void;
6216
-
6217
- /**
6218
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6219
- * listeners and finally removes itself from the DOM.
6220
- */
6221
- destroy(): void;
6222
-
6223
- /**
6224
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6225
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6226
- * all call this method implicitly.
6227
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6228
- * @param parent A parent item
6229
- */
6230
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6231
-
6232
- /**
6233
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6234
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6235
- * provided its config will be read, if config is provided, only the content key
6236
- * will be used
6237
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6238
- * place the window in another screen.
6239
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6240
- * when popIn is clicked
6241
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6242
- */
6243
- createPopout(
6244
- configOrContentItem: ItemConfigType | ContentItem,
6245
- dimensions: {
6246
- width: number;
6247
- height: number;
6248
- left: number;
6249
- top: number;
6250
- },
6251
- parentId?: string,
6252
- indexInParent?: number
6253
- ): void;
6254
-
6255
- /**
6256
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6257
- * where it turns into a contentItem.
6258
- * @param element The DOM element that will be turned into a dragSource
6259
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6260
- * @return the dragSource that was created. This can be used to remove the
6261
- * dragSource from the layout later.
6262
- */
6263
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6264
-
6265
- /**
6266
- * Removes a dragSource from the layout.
6267
- *
6268
- * @param dragSource The dragSource to remove
6269
- */
6270
- removeDragSource(dragSource: DragSource): void;
6271
-
6272
- /**
6273
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6274
- * @param contentItem A ContentItem instance
6275
- */
6276
- selectItem(contentItem: ContentItem): void;
6277
-
6278
- /**
6279
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6280
- * and replace frequent keys and values with single letter substitutes.
6281
- * @param config A GoldenLayout configuration object
6282
- */
6283
- static minifyConfig(config: any): any;
6284
-
6285
- /**
6286
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6287
- * @param minifiedConfig A minified GoldenLayout configuration object
6288
- */
6289
- static unminifyConfig(minifiedConfig: any): any;
6290
-
6291
- /**
6292
- * Subscribe to an event
6293
- * @param eventName The name of the event to describe to
6294
- * @param callback The function that should be invoked when the event occurs
6295
- * @param context The value of the this pointer in the callback function
6296
- */
6297
- on(eventName: string, callback: Function, context?: any): void;
6298
-
6299
- /**
6300
- * Notify listeners of an event and pass arguments along
6301
- * @param eventName The name of the event to emit
6302
- */
6303
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6304
-
6305
- /**
6306
- * Alias for emit
6307
- */
6308
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6309
-
6310
- /**
6311
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6312
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6313
- * arguments.
6314
- * @param eventName The name of the event to unsubscribe from
6315
- * @param callback The function that should be invoked when the event occurs
6316
- * @param context The value of the this pointer in the callback function
6317
- */
6318
- unbind(eventName: string, callback?: Function, context?: any): void;
6319
-
6320
- /**
6321
- * Alias for unbind
6322
- */
6323
- off(eventName: string, callback?: Function, context?: any): void;
6324
-
6325
- /**
6326
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6327
- */
6328
- _$createRootItemAreas(): void;
6329
- }
6330
-
6331
5632
  /**
6332
5633
  * @interface
6333
5634
  */
@@ -6335,62 +5636,6 @@ declare type GpuInfo = {
6335
5636
  name: string;
6336
5637
  };
6337
5638
 
6338
- declare interface Header {
6339
- /**
6340
- * A reference to the LayoutManager instance
6341
- */
6342
- layoutManager: GoldenLayout_2;
6343
-
6344
- /**
6345
- * A reference to the Stack this Header belongs to
6346
- */
6347
- parent: ContentItem;
6348
-
6349
- /**
6350
- * An array of the Tabs within this header
6351
- */
6352
- tabs: Tab[];
6353
-
6354
- /**
6355
- * The currently selected activeContentItem
6356
- */
6357
- activeContentItem: ContentItem;
6358
-
6359
- /**
6360
- * The outer (jQuery) DOM element of this Header
6361
- */
6362
- element: JQuery;
6363
-
6364
- /**
6365
- * The (jQuery) DOM element containing the tabs
6366
- */
6367
- tabsContainer: JQuery;
6368
-
6369
- /**
6370
- * The (jQuery) DOM element containing the close, maximise and popout button
6371
- */
6372
- controlsContainer: JQuery;
6373
-
6374
- /**
6375
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6376
- * @param contentItem The content item that will be selected
6377
- */
6378
- setActiveContentItem(contentItem: ContentItem): void;
6379
-
6380
- /**
6381
- * Creates a new tab and associates it with a content item
6382
- * @param contentItem The content item the tab will be associated with
6383
- * @param index A zero based index, specifying the position of the new tab
6384
- */
6385
- createTab(contentItem: ContentItem, index?: number): void;
6386
-
6387
- /**
6388
- * Finds a tab by its contentItem and removes it
6389
- * @param contentItem The content item the tab is associated with
6390
- */
6391
- removeTab(contentItem: ContentItem): void;
6392
- }
6393
-
6394
5639
  /**
6395
5640
  * Generated when a View is hidden.
6396
5641
  * @interface
@@ -7998,50 +7243,6 @@ declare class InteropModule extends Base {
7998
7243
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7999
7244
  }
8000
7245
 
8001
- declare interface ItemConfig {
8002
- /**
8003
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8004
- */
8005
- type: ItemType;
8006
-
8007
- /**
8008
- * An array of configurations for items that will be created as children of this item.
8009
- */
8010
- content?: ItemConfigType[];
8011
-
8012
- /**
8013
- * The width of this item, relative to the other children of its parent in percent
8014
- */
8015
- width?: number;
8016
-
8017
- /**
8018
- * The height of this item, relative to the other children of its parent in percent
8019
- */
8020
- height?: number;
8021
-
8022
- /**
8023
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8024
- */
8025
- id?: string | string[];
8026
-
8027
- /**
8028
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8029
- * will return false
8030
- * Default: true
8031
- */
8032
- isClosable?: boolean;
8033
-
8034
- /**
8035
- * The title of the item as displayed on its tab and on popout windows
8036
- * Default: componentName or ''
8037
- */
8038
- title?: string;
8039
- }
8040
-
8041
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8042
-
8043
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8044
-
8045
7246
  /**
8046
7247
  * @interface
8047
7248
  */
@@ -8099,32 +7300,6 @@ declare type JumpListTask = {
8099
7300
  iconIndex?: number;
8100
7301
  };
8101
7302
 
8102
- declare interface Labels {
8103
- /**
8104
- * The tooltip text that appears when hovering over the close icon.
8105
- * Default: 'close'
8106
- */
8107
- close?: string;
8108
-
8109
- /**
8110
- * The tooltip text that appears when hovering over the maximise icon.
8111
- * Default: 'maximise'
8112
- */
8113
- maximise?: string;
8114
-
8115
- /**
8116
- * The tooltip text that appears when hovering over the minimise icon.
8117
- * Default: 'minimise'
8118
- */
8119
- minimise?: string;
8120
-
8121
- /**
8122
- * The tooltip text that appears when hovering over the popout icon.
8123
- * Default: 'open in new window'
8124
- */
8125
- popout?: string;
8126
- }
8127
-
8128
7303
  /**
8129
7304
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8130
7305
  *
@@ -8576,7 +7751,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8576
7751
  entityId: string;
8577
7752
  };
8578
7753
 
8579
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7754
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8580
7755
 
8581
7756
  /**
8582
7757
  * @interface
@@ -12512,18 +11687,6 @@ declare type QueryPermissionResult = {
12512
11687
  rawValue?: unknown;
12513
11688
  };
12514
11689
 
12515
- declare interface ReactComponentConfig extends ItemConfig {
12516
- /**
12517
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12518
- */
12519
- component: string;
12520
-
12521
- /**
12522
- * Properties that will be passed to the component and accessible using this.props.
12523
- */
12524
- props?: any;
12525
- }
12526
-
12527
11690
  /**
12528
11691
  * @interface
12529
11692
  */
@@ -13000,97 +12163,6 @@ declare type SessionContextGroup = {
13000
12163
  }>;
13001
12164
  };
13002
12165
 
13003
- declare interface Settings {
13004
- preventSplitterResize?: boolean;
13005
-
13006
- newTabButton?: {
13007
- url?: string;
13008
- };
13009
-
13010
- /**
13011
- * If true, tabs can't be dragged into the window.
13012
- * Default: false
13013
- */
13014
- preventDragIn?: boolean;
13015
-
13016
- /**
13017
- * If true, tabs can't be dragged out of the window.
13018
- * Default: false
13019
- */
13020
- preventDragOut?: boolean;
13021
-
13022
- /**
13023
- * If true, stack headers are the only areas where tabs can be dropped.
13024
- * Default: false
13025
- */
13026
- constrainDragToHeaders?: boolean;
13027
- /**
13028
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13029
- * Default: true
13030
- */
13031
- hasHeaders?: boolean;
13032
-
13033
- /**
13034
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13035
- * automatically when layout.createDragSource() is called.
13036
- * Default: true
13037
- */
13038
- constrainDragToContainer?: boolean;
13039
-
13040
- /**
13041
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13042
- * Default: true
13043
- */
13044
- reorderEnabled?: boolean;
13045
-
13046
- /**
13047
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13048
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13049
- * Default: false
13050
- */
13051
- selectionEnabled?: boolean;
13052
-
13053
- /**
13054
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13055
- * be transferred to the new window, if false only the active component will be opened.
13056
- * Default: false
13057
- */
13058
- popoutWholeStack?: boolean;
13059
-
13060
- /**
13061
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13062
- * If false, the popout call will fail silently.
13063
- * Default: true
13064
- */
13065
- blockedPopoutsThrowError?: boolean;
13066
-
13067
- /**
13068
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13069
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13070
- * addition, any changes made to popouts won't be stored after the parent is closed.
13071
- * Default: true
13072
- */
13073
- closePopoutsOnUnload?: boolean;
13074
-
13075
- /**
13076
- * Specifies if the popout icon should be displayed in the header-bar.
13077
- * Default: true
13078
- */
13079
- showPopoutIcon?: boolean;
13080
-
13081
- /**
13082
- * Specifies if the maximise icon should be displayed in the header-bar.
13083
- * Default: true
13084
- */
13085
- showMaximiseIcon?: boolean;
13086
-
13087
- /**
13088
- * Specifies if the close icon should be displayed in the header-bar.
13089
- * Default: true
13090
- */
13091
- showCloseIcon?: boolean;
13092
- }
13093
-
13094
12166
  /**
13095
12167
  * @interface
13096
12168
  */
@@ -14986,52 +14058,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14986
14058
  proceed: () => void;
14987
14059
  }) => void;
14988
14060
 
14989
- declare interface Tab {
14990
- _dragListener: TabDragListener;
14991
-
14992
- /**
14993
- * True if this tab is the selected tab
14994
- */
14995
- isActive: boolean;
14996
-
14997
- /**
14998
- * A reference to the header this tab is a child of
14999
- */
15000
- header: Header;
15001
-
15002
- /**
15003
- * A reference to the content item this tab relates to
15004
- */
15005
- contentItem: ContentItem;
15006
-
15007
- /**
15008
- * The tabs outer (jQuery) DOM element
15009
- */
15010
- element: JQuery;
15011
-
15012
- /**
15013
- * The (jQuery) DOM element containing the title
15014
- */
15015
- titleElement: JQuery;
15016
-
15017
- /**
15018
- * The (jQuery) DOM element that closes the tab
15019
- */
15020
- closeElement: JQuery;
15021
-
15022
- /**
15023
- * Sets the tab's title. Does not affect the contentItem's title!
15024
- * @param title The new title
15025
- */
15026
- setTitle(title: string): void;
15027
-
15028
- /**
15029
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15030
- * @param isActive Whether the tab is active
15031
- */
15032
- setActive(isActive: boolean): void;
15033
- }
15034
-
15035
14061
  /**
15036
14062
  * Generated when a Layout Tab Component was closed.
15037
14063
  * @interface
@@ -15049,13 +14075,6 @@ declare type TabCreatedEvent = LayoutDOMEvent & {
15049
14075
  type: 'tab-created';
15050
14076
  };
15051
14077
 
15052
- declare interface TabDragListener extends EventEmitter_2 {
15053
- /**
15054
- * A reference to the content item this tab relates to
15055
- */
15056
- contentItem: ContentItem;
15057
- }
15058
-
15059
14078
  /**
15060
14079
  * Generated when a Layout Tab Component was dropped.
15061
14080
  * @interface