@openfin/node-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
  };
@@ -3746,103 +3682,6 @@ declare type ConstWindowOptions = {
3746
3682
  inheritance?: Partial<InheritableOptions>;
3747
3683
  };
3748
3684
 
3749
- declare interface Container extends EventEmitter_2 {
3750
- /**
3751
- * The current width of the container in pixel
3752
- */
3753
- width: number;
3754
-
3755
- /**
3756
- * The current height of the container in pixel
3757
- */
3758
- height: number;
3759
-
3760
- /**
3761
- * A reference to the component-item that controls this container
3762
- */
3763
- parent: ContentItem;
3764
-
3765
- /**
3766
- * A reference to the tab that controls this container. Will initially be null
3767
- * (and populated once a tab event has been fired).
3768
- */
3769
- tab: Tab;
3770
-
3771
- /**
3772
- * The current title of the container
3773
- */
3774
- title: string;
3775
-
3776
- /*
3777
- * A reference to the GoldenLayout instance this container belongs to
3778
- */
3779
- layoutManager: GoldenLayout_2;
3780
-
3781
- /**
3782
- * True if the item is currently hidden
3783
- */
3784
- isHidden: boolean;
3785
-
3786
- /**
3787
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3788
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3789
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3790
- * constructor function. It will also be used when the component is opened in a new window.
3791
- * @param state A serialisable object
3792
- */
3793
- setState(state: any): void;
3794
-
3795
- /**
3796
- * The same as setState but does not emit 'stateChanged' event
3797
- * @param {serialisable} state
3798
- */
3799
- setStateSkipEvent(state: any): void;
3800
-
3801
- /**
3802
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3803
- * @param state A serialisable object
3804
- */
3805
- extendState(state: any): void;
3806
-
3807
- /**
3808
- * Returns the current state.
3809
- */
3810
- getState(): any;
3811
-
3812
- /**
3813
- * Returns the container's inner element as a jQuery element
3814
- */
3815
- getElement(): JQuery;
3816
-
3817
- /**
3818
- * hides the container or returns false if hiding it is not possible
3819
- */
3820
- hide(): boolean;
3821
-
3822
- /**
3823
- * shows the container or returns false if showing it is not possible
3824
- */
3825
- show(): boolean;
3826
-
3827
- /**
3828
- * Sets the container to the specified size or returns false if that's not possible
3829
- * @param width the new width in pixel
3830
- * @param height the new height in pixel
3831
- */
3832
- setSize(width: number, height: number): boolean;
3833
-
3834
- /**
3835
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3836
- * @param title the new title
3837
- */
3838
- setTitle(title: string): void;
3839
-
3840
- /**
3841
- * Closes the container or returns false if that is not possible
3842
- */
3843
- close(): boolean;
3844
- }
3845
-
3846
3685
  /**
3847
3686
  * Generated when a Layout Container Component was created.
3848
3687
  * @interface
@@ -3924,218 +3763,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3924
3763
  disposition: string;
3925
3764
  };
3926
3765
 
3927
- declare interface ContentItem extends EventEmitter_2 {
3928
- instance: any;
3929
- header: any;
3930
- _splitter: any;
3931
- /**
3932
- * This items configuration in its current state
3933
- */
3934
- config: ItemConfigType;
3935
-
3936
- /**
3937
- * The type of the item. Can be row, column, stack, component or root
3938
- */
3939
- type: ItemType;
3940
-
3941
- /**
3942
- * An array of items that are children of this item
3943
- */
3944
- contentItems: ContentItem[];
3945
-
3946
- container: Container;
3947
- /**
3948
- * The item that is this item's parent (or null if the item is root)
3949
- */
3950
- parent: ContentItem;
3951
-
3952
- /**
3953
- * A String or array of identifiers if provided in the configuration
3954
- */
3955
- id: string;
3956
-
3957
- /**
3958
- * True if the item had been initialised
3959
- */
3960
- isInitialised: boolean;
3961
-
3962
- /**
3963
- * True if the item is maximised
3964
- */
3965
- isMaximised: boolean;
3966
-
3967
- /**
3968
- * True if the item is the layout's root item
3969
- */
3970
- isRoot: boolean;
3971
-
3972
- /**
3973
- * True if the item is a row
3974
- */
3975
- isRow: boolean;
3976
-
3977
- /**
3978
- * True if the item is a column
3979
- */
3980
- isColumn: boolean;
3981
-
3982
- /**
3983
- * True if the item is a stack
3984
- */
3985
- isStack: boolean;
3986
-
3987
- /**
3988
- * True if the item is a component
3989
- */
3990
- isComponent: boolean;
3991
-
3992
- /**
3993
- * A reference to the layoutManager that controls this item
3994
- */
3995
- layoutManager: any;
3996
-
3997
- /**
3998
- * The item's outer element
3999
- */
4000
- element: JQuery;
4001
-
4002
- /**
4003
- * The item's inner element. Can be the same as the outer element.
4004
- */
4005
- childElementContainer: Container;
4006
-
4007
- /**
4008
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4009
- * from its original position before adding it to this item.
4010
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4011
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4012
- */
4013
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4014
-
4015
- /**
4016
- * Destroys the item and all it's children
4017
- * @param contentItem The contentItem that should be removed
4018
- * @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.
4019
- */
4020
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4021
-
4022
- /**
4023
- * The contentItem that should be removed
4024
- * @param oldChild ContentItem The contentItem that should be removed
4025
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4026
- */
4027
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4028
-
4029
- /**
4030
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4031
- */
4032
- setSize(): void;
4033
-
4034
- /**
4035
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4036
- * @param title the new title
4037
- */
4038
- setTitle(title: string): void;
4039
-
4040
- /**
4041
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4042
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4043
- * @param functionName The name of the method to invoke
4044
- * @param functionArguments An array of arguments to pass to every function
4045
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4046
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4047
- */
4048
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4049
-
4050
- /**
4051
- * 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.
4052
- */
4053
- emitBubblingEvent(name: string): void;
4054
-
4055
- /**
4056
- * Convenience method for item.parent.removeChild( item )
4057
- */
4058
- remove(): void;
4059
-
4060
- /**
4061
- * Removes the item from its current position in the layout and opens it in a window
4062
- */
4063
- popout(): BrowserWindow;
4064
-
4065
- /**
4066
- * Maximises the item or minimises it if it's already maximised
4067
- */
4068
- toggleMaximise(): void;
4069
-
4070
- /**
4071
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4072
- */
4073
- select(): void;
4074
-
4075
- /**
4076
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4077
- */
4078
- deselect(): void;
4079
-
4080
- /**
4081
- * Returns true if the item has the specified id or false if not
4082
- * @param id An id to check for
4083
- */
4084
- hasId(id: string): boolean;
4085
-
4086
- /**
4087
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4088
- * @param contentItem The new active content item
4089
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4090
- */
4091
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4092
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4093
-
4094
- /**
4095
- * Only Stacks have this method! Returns the currently selected contentItem.
4096
- */
4097
- getActiveContentItem(): ContentItem;
4098
-
4099
- /**
4100
- * Adds an id to an item or does nothing if the id is already present
4101
- * @param id The id to be added
4102
- */
4103
- addId(id: string): void;
4104
-
4105
- /**
4106
- * Removes an id from an item or throws an error if the id couldn't be found
4107
- * @param id The id to be removed
4108
- */
4109
- removeId(id: string): void;
4110
-
4111
- /**
4112
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4113
- * @param filterFunction A function that determines whether an item matches certain criteria
4114
- */
4115
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4116
-
4117
- /**
4118
- * Returns all items with the specified id.
4119
- * @param id An id specified in the itemConfig
4120
- */
4121
- getItemsById(id: string | string[]): ContentItem[];
4122
-
4123
- /**
4124
- * Returns all items with the specified type
4125
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4126
- */
4127
- getItemsByType(type: string): ContentItem[];
4128
-
4129
- /**
4130
- * Returns all instances of the component with the specified componentName
4131
- * @param componentName a componentName as specified in the itemConfig
4132
- */
4133
- getComponentsByName(componentName: string): any;
4134
-
4135
- _contentAreaDimensions: any;
4136
- _$getArea: () => any;
4137
- }
4138
-
4139
3766
  /**
4140
3767
  * Restrict navigation to URLs that match an allowed pattern.
4141
3768
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4574,46 +4201,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4574
4201
  type: 'did-finish-load';
4575
4202
  };
4576
4203
 
4577
- declare interface Dimensions {
4578
- /**
4579
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4580
- * than the visible one, making it safe to set this to small values without affecting usability.
4581
- * Default: 5
4582
- */
4583
- borderWidth?: number;
4584
-
4585
- /**
4586
- * The minimum height an item can be resized to (in pixel).
4587
- * Default: 10
4588
- */
4589
- minItemHeight?: number;
4590
-
4591
- /**
4592
- * The minimum width an item can be resized to (in pixel).
4593
- * Default: 10
4594
- */
4595
- minItemWidth?: number;
4596
-
4597
- /**
4598
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4599
- * adjusted accordingly.
4600
- * Default: 20
4601
- */
4602
- headerHeight?: number;
4603
-
4604
- /**
4605
- * The width of the element that appears when an item is dragged (in pixel).
4606
- * Default: 300
4607
- */
4608
- dragProxyWidth?: number;
4609
-
4610
- /**
4611
- * The height of the element that appears when an item is dragged (in pixel).
4612
- * Default: 200
4613
- */
4614
- dragProxyHeight?: number;
4615
- }
4616
-
4617
4204
  /**
4618
4205
  * @interface
4619
4206
  */
@@ -4874,8 +4461,6 @@ declare type Dpi = {
4874
4461
  vertical?: number;
4875
4462
  };
4876
4463
 
4877
- declare interface DragSource {}
4878
-
4879
4464
  /**
4880
4465
  * Generated when a window has been embedded.
4881
4466
  * @interface
@@ -5188,43 +4773,6 @@ declare class EventAggregator extends EmitterMap {
5188
4773
  dispatchEvent: (message: Message<any>) => boolean;
5189
4774
  }
5190
4775
 
5191
- declare interface EventEmitter_2 {
5192
- [x: string]: any;
5193
- /**
5194
- * Subscribe to an event
5195
- * @param eventName The name of the event to describe to
5196
- * @param callback The function that should be invoked when the event occurs
5197
- * @param context The value of the this pointer in the callback function
5198
- */
5199
- on(eventName: string, callback: Function, context?: any): void;
5200
-
5201
- /**
5202
- * Notify listeners of an event and pass arguments along
5203
- * @param eventName The name of the event to emit
5204
- */
5205
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5206
-
5207
- /**
5208
- * Alias for emit
5209
- */
5210
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5211
-
5212
- /**
5213
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5214
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5215
- * arguments.
5216
- * @param eventName The name of the event to unsubscribe from
5217
- * @param callback The function that should be invoked when the event occurs
5218
- * @param context The value of the this pointer in the callback function
5219
- */
5220
- unbind(eventName: string, callback?: Function, context?: any): void;
5221
-
5222
- /**
5223
- * Alias for unbind
5224
- */
5225
- off(eventName: string, callback?: Function, context?: any): void;
5226
- }
5227
-
5228
4776
  /**
5229
4777
  * Handler for an event on an EventEmitter.
5230
4778
  * @remarks Selects the correct type for the event
@@ -6067,253 +5615,6 @@ declare namespace GlobalHotkeyEvents {
6067
5615
  */
6068
5616
  declare type GlobalHotkeyEventType = EventType_6;
6069
5617
 
6070
- declare namespace GoldenLayout {
6071
- export {
6072
- GoldenLayout_2 as GoldenLayout,
6073
- ItemConfigType,
6074
- Settings,
6075
- Dimensions,
6076
- Labels,
6077
- ItemType,
6078
- ItemConfig,
6079
- ComponentConfig,
6080
- ReactComponentConfig,
6081
- Config,
6082
- ContentItem,
6083
- Container,
6084
- DragSource,
6085
- BrowserWindow,
6086
- Header,
6087
- TabDragListener,
6088
- Tab,
6089
- EventEmitter_2 as EventEmitter
6090
- }
6091
- }
6092
-
6093
- declare class GoldenLayout_2 implements EventEmitter_2 {
6094
- /**
6095
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6096
- * object and of goldenLayout.root as the document.
6097
- */
6098
- root: ContentItem;
6099
-
6100
- /**
6101
- * A reference to the (jQuery) DOM element containing the layout
6102
- */
6103
- container: JQuery;
6104
-
6105
- /**
6106
- * True once the layout item tree has been created and the initialised event has been fired
6107
- */
6108
- isInitialised: boolean;
6109
-
6110
- /**
6111
- * A reference to the current, extended top level config.
6112
- *
6113
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6114
- */
6115
- config: Config;
6116
-
6117
- /**
6118
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6119
- * to true.
6120
- */
6121
- selectedItem: ContentItem;
6122
-
6123
- /**
6124
- * The current outer width of the layout in pixels.
6125
- */
6126
- width: number;
6127
-
6128
- /**
6129
- * The current outer height of the layout in pixels.
6130
- */
6131
- height: number;
6132
-
6133
- /**
6134
- * An array of BrowserWindow instances
6135
- */
6136
- openPopouts: BrowserWindow[];
6137
-
6138
- /**
6139
- * True if the layout has been opened as a popout by another layout.
6140
- */
6141
- isSubWindow: boolean;
6142
-
6143
- /**
6144
- * A singleton instance of EventEmitter that works across windows
6145
- */
6146
- eventHub: EventEmitter_2;
6147
-
6148
- _dragProxy: any;
6149
-
6150
- dropTargetIndicator: any;
6151
-
6152
- _isFullPage: boolean;
6153
-
6154
- _onUnload: any;
6155
-
6156
- tabDropPlaceholder: any;
6157
-
6158
- transitionIndicator: any;
6159
-
6160
- _dragSources: any;
6161
-
6162
- _resizeFunction: any;
6163
-
6164
- _unloadFunction: any;
6165
-
6166
- /**
6167
- * @param config A GoldenLayout configuration object
6168
- * @param container The DOM element the layout will be initialised in. Default: document.body
6169
- */
6170
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6171
-
6172
- /*
6173
- * @param name The name of the component, as referred to by componentName in the component configuration.
6174
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6175
- * containerobject and a component state
6176
- */
6177
- registerComponent(name: String, component: any): void;
6178
-
6179
- /**
6180
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6181
- * a listener to the document and executes once it becomes ready.
6182
- */
6183
- init(): void;
6184
-
6185
- /**
6186
- * Returns the current state of the layout and its components as a serialisable object.
6187
- */
6188
- toConfig(): Config;
6189
-
6190
- /**
6191
- * Returns a component that was previously registered with layout.registerComponent().
6192
- * @param name The name of a previously registered component
6193
- */
6194
- getComponent(name: string): any;
6195
-
6196
- /**
6197
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6198
- * @param width The outer width the layout should be resized to. Default: The container elements width
6199
- * @param height The outer height the layout should be resized to. Default: The container elements height
6200
- */
6201
- updateSize(width?: number, height?: number): void;
6202
-
6203
- /**
6204
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6205
- * listeners and finally removes itself from the DOM.
6206
- */
6207
- destroy(): void;
6208
-
6209
- /**
6210
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6211
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6212
- * all call this method implicitly.
6213
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6214
- * @param parent A parent item
6215
- */
6216
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6217
-
6218
- /**
6219
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6220
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6221
- * provided its config will be read, if config is provided, only the content key
6222
- * will be used
6223
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6224
- * place the window in another screen.
6225
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6226
- * when popIn is clicked
6227
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6228
- */
6229
- createPopout(
6230
- configOrContentItem: ItemConfigType | ContentItem,
6231
- dimensions: {
6232
- width: number;
6233
- height: number;
6234
- left: number;
6235
- top: number;
6236
- },
6237
- parentId?: string,
6238
- indexInParent?: number
6239
- ): void;
6240
-
6241
- /**
6242
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6243
- * where it turns into a contentItem.
6244
- * @param element The DOM element that will be turned into a dragSource
6245
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6246
- * @return the dragSource that was created. This can be used to remove the
6247
- * dragSource from the layout later.
6248
- */
6249
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6250
-
6251
- /**
6252
- * Removes a dragSource from the layout.
6253
- *
6254
- * @param dragSource The dragSource to remove
6255
- */
6256
- removeDragSource(dragSource: DragSource): void;
6257
-
6258
- /**
6259
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6260
- * @param contentItem A ContentItem instance
6261
- */
6262
- selectItem(contentItem: ContentItem): void;
6263
-
6264
- /**
6265
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6266
- * and replace frequent keys and values with single letter substitutes.
6267
- * @param config A GoldenLayout configuration object
6268
- */
6269
- static minifyConfig(config: any): any;
6270
-
6271
- /**
6272
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6273
- * @param minifiedConfig A minified GoldenLayout configuration object
6274
- */
6275
- static unminifyConfig(minifiedConfig: any): any;
6276
-
6277
- /**
6278
- * Subscribe to an event
6279
- * @param eventName The name of the event to describe to
6280
- * @param callback The function that should be invoked when the event occurs
6281
- * @param context The value of the this pointer in the callback function
6282
- */
6283
- on(eventName: string, callback: Function, context?: any): void;
6284
-
6285
- /**
6286
- * Notify listeners of an event and pass arguments along
6287
- * @param eventName The name of the event to emit
6288
- */
6289
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6290
-
6291
- /**
6292
- * Alias for emit
6293
- */
6294
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6295
-
6296
- /**
6297
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6298
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6299
- * arguments.
6300
- * @param eventName The name of the event to unsubscribe from
6301
- * @param callback The function that should be invoked when the event occurs
6302
- * @param context The value of the this pointer in the callback function
6303
- */
6304
- unbind(eventName: string, callback?: Function, context?: any): void;
6305
-
6306
- /**
6307
- * Alias for unbind
6308
- */
6309
- off(eventName: string, callback?: Function, context?: any): void;
6310
-
6311
- /**
6312
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6313
- */
6314
- _$createRootItemAreas(): void;
6315
- }
6316
-
6317
5618
  /**
6318
5619
  * @interface
6319
5620
  */
@@ -6321,62 +5622,6 @@ declare type GpuInfo = {
6321
5622
  name: string;
6322
5623
  };
6323
5624
 
6324
- declare interface Header {
6325
- /**
6326
- * A reference to the LayoutManager instance
6327
- */
6328
- layoutManager: GoldenLayout_2;
6329
-
6330
- /**
6331
- * A reference to the Stack this Header belongs to
6332
- */
6333
- parent: ContentItem;
6334
-
6335
- /**
6336
- * An array of the Tabs within this header
6337
- */
6338
- tabs: Tab[];
6339
-
6340
- /**
6341
- * The currently selected activeContentItem
6342
- */
6343
- activeContentItem: ContentItem;
6344
-
6345
- /**
6346
- * The outer (jQuery) DOM element of this Header
6347
- */
6348
- element: JQuery;
6349
-
6350
- /**
6351
- * The (jQuery) DOM element containing the tabs
6352
- */
6353
- tabsContainer: JQuery;
6354
-
6355
- /**
6356
- * The (jQuery) DOM element containing the close, maximise and popout button
6357
- */
6358
- controlsContainer: JQuery;
6359
-
6360
- /**
6361
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6362
- * @param contentItem The content item that will be selected
6363
- */
6364
- setActiveContentItem(contentItem: ContentItem): void;
6365
-
6366
- /**
6367
- * Creates a new tab and associates it with a content item
6368
- * @param contentItem The content item the tab will be associated with
6369
- * @param index A zero based index, specifying the position of the new tab
6370
- */
6371
- createTab(contentItem: ContentItem, index?: number): void;
6372
-
6373
- /**
6374
- * Finds a tab by its contentItem and removes it
6375
- * @param contentItem The content item the tab is associated with
6376
- */
6377
- removeTab(contentItem: ContentItem): void;
6378
- }
6379
-
6380
5625
  /**
6381
5626
  * Generated when a View is hidden.
6382
5627
  * @interface
@@ -7963,50 +7208,6 @@ declare class InteropModule extends Base {
7963
7208
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7964
7209
  }
7965
7210
 
7966
- declare interface ItemConfig {
7967
- /**
7968
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
7969
- */
7970
- type: ItemType;
7971
-
7972
- /**
7973
- * An array of configurations for items that will be created as children of this item.
7974
- */
7975
- content?: ItemConfigType[];
7976
-
7977
- /**
7978
- * The width of this item, relative to the other children of its parent in percent
7979
- */
7980
- width?: number;
7981
-
7982
- /**
7983
- * The height of this item, relative to the other children of its parent in percent
7984
- */
7985
- height?: number;
7986
-
7987
- /**
7988
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
7989
- */
7990
- id?: string | string[];
7991
-
7992
- /**
7993
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
7994
- * will return false
7995
- * Default: true
7996
- */
7997
- isClosable?: boolean;
7998
-
7999
- /**
8000
- * The title of the item as displayed on its tab and on popout windows
8001
- * Default: componentName or ''
8002
- */
8003
- title?: string;
8004
- }
8005
-
8006
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8007
-
8008
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8009
-
8010
7211
  /**
8011
7212
  * @interface
8012
7213
  */
@@ -8064,32 +7265,6 @@ declare type JumpListTask = {
8064
7265
  iconIndex?: number;
8065
7266
  };
8066
7267
 
8067
- declare interface Labels {
8068
- /**
8069
- * The tooltip text that appears when hovering over the close icon.
8070
- * Default: 'close'
8071
- */
8072
- close?: string;
8073
-
8074
- /**
8075
- * The tooltip text that appears when hovering over the maximise icon.
8076
- * Default: 'maximise'
8077
- */
8078
- maximise?: string;
8079
-
8080
- /**
8081
- * The tooltip text that appears when hovering over the minimise icon.
8082
- * Default: 'minimise'
8083
- */
8084
- minimise?: string;
8085
-
8086
- /**
8087
- * The tooltip text that appears when hovering over the popout icon.
8088
- * Default: 'open in new window'
8089
- */
8090
- popout?: string;
8091
- }
8092
-
8093
7268
  export declare function launch(config: ConnectConfig): Promise<number>;
8094
7269
 
8095
7270
  /**
@@ -8543,7 +7718,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8543
7718
  entityId: string;
8544
7719
  };
8545
7720
 
8546
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7721
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8547
7722
 
8548
7723
  /**
8549
7724
  * @interface
@@ -12480,18 +11655,6 @@ declare type QueryPermissionResult = {
12480
11655
  rawValue?: unknown;
12481
11656
  };
12482
11657
 
12483
- declare interface ReactComponentConfig extends ItemConfig {
12484
- /**
12485
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12486
- */
12487
- component: string;
12488
-
12489
- /**
12490
- * Properties that will be passed to the component and accessible using this.props.
12491
- */
12492
- props?: any;
12493
- }
12494
-
12495
11658
  /**
12496
11659
  * @interface
12497
11660
  */
@@ -12968,97 +12131,6 @@ declare type SessionContextGroup = {
12968
12131
  }>;
12969
12132
  };
12970
12133
 
12971
- declare interface Settings {
12972
- preventSplitterResize?: boolean;
12973
-
12974
- newTabButton?: {
12975
- url?: string;
12976
- };
12977
-
12978
- /**
12979
- * If true, tabs can't be dragged into the window.
12980
- * Default: false
12981
- */
12982
- preventDragIn?: boolean;
12983
-
12984
- /**
12985
- * If true, tabs can't be dragged out of the window.
12986
- * Default: false
12987
- */
12988
- preventDragOut?: boolean;
12989
-
12990
- /**
12991
- * If true, stack headers are the only areas where tabs can be dropped.
12992
- * Default: false
12993
- */
12994
- constrainDragToHeaders?: boolean;
12995
- /**
12996
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
12997
- * Default: true
12998
- */
12999
- hasHeaders?: boolean;
13000
-
13001
- /**
13002
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13003
- * automatically when layout.createDragSource() is called.
13004
- * Default: true
13005
- */
13006
- constrainDragToContainer?: boolean;
13007
-
13008
- /**
13009
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13010
- * Default: true
13011
- */
13012
- reorderEnabled?: boolean;
13013
-
13014
- /**
13015
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13016
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13017
- * Default: false
13018
- */
13019
- selectionEnabled?: boolean;
13020
-
13021
- /**
13022
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13023
- * be transferred to the new window, if false only the active component will be opened.
13024
- * Default: false
13025
- */
13026
- popoutWholeStack?: boolean;
13027
-
13028
- /**
13029
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13030
- * If false, the popout call will fail silently.
13031
- * Default: true
13032
- */
13033
- blockedPopoutsThrowError?: boolean;
13034
-
13035
- /**
13036
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13037
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13038
- * addition, any changes made to popouts won't be stored after the parent is closed.
13039
- * Default: true
13040
- */
13041
- closePopoutsOnUnload?: boolean;
13042
-
13043
- /**
13044
- * Specifies if the popout icon should be displayed in the header-bar.
13045
- * Default: true
13046
- */
13047
- showPopoutIcon?: boolean;
13048
-
13049
- /**
13050
- * Specifies if the maximise icon should be displayed in the header-bar.
13051
- * Default: true
13052
- */
13053
- showMaximiseIcon?: boolean;
13054
-
13055
- /**
13056
- * Specifies if the close icon should be displayed in the header-bar.
13057
- * Default: true
13058
- */
13059
- showCloseIcon?: boolean;
13060
- }
13061
-
13062
12134
  /**
13063
12135
  * @interface
13064
12136
  */
@@ -14954,52 +14026,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14954
14026
  proceed: () => void;
14955
14027
  }) => void;
14956
14028
 
14957
- declare interface Tab {
14958
- _dragListener: TabDragListener;
14959
-
14960
- /**
14961
- * True if this tab is the selected tab
14962
- */
14963
- isActive: boolean;
14964
-
14965
- /**
14966
- * A reference to the header this tab is a child of
14967
- */
14968
- header: Header;
14969
-
14970
- /**
14971
- * A reference to the content item this tab relates to
14972
- */
14973
- contentItem: ContentItem;
14974
-
14975
- /**
14976
- * The tabs outer (jQuery) DOM element
14977
- */
14978
- element: JQuery;
14979
-
14980
- /**
14981
- * The (jQuery) DOM element containing the title
14982
- */
14983
- titleElement: JQuery;
14984
-
14985
- /**
14986
- * The (jQuery) DOM element that closes the tab
14987
- */
14988
- closeElement: JQuery;
14989
-
14990
- /**
14991
- * Sets the tab's title. Does not affect the contentItem's title!
14992
- * @param title The new title
14993
- */
14994
- setTitle(title: string): void;
14995
-
14996
- /**
14997
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
14998
- * @param isActive Whether the tab is active
14999
- */
15000
- setActive(isActive: boolean): void;
15001
- }
15002
-
15003
14029
  /**
15004
14030
  * Generated when a Layout Tab Component was closed.
15005
14031
  * @interface
@@ -15017,13 +14043,6 @@ declare type TabCreatedEvent = LayoutDOMEvent & {
15017
14043
  type: 'tab-created';
15018
14044
  };
15019
14045
 
15020
- declare interface TabDragListener extends EventEmitter_2 {
15021
- /**
15022
- * A reference to the content item this tab relates to
15023
- */
15024
- contentItem: ContentItem;
15025
- }
15026
-
15027
14046
  /**
15028
14047
  * Generated when a Layout Tab Component was dropped.
15029
14048
  * @interface