@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.
@@ -1167,9 +1167,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1167
1167
  */
1168
1168
  mainWindowOptions: WindowCreationOptions;
1169
1169
  /**
1170
- * The name of the application (and the application's main window).
1170
+ * The name of the application.
1171
1171
  *
1172
- * If provided, _must_ match `uuid`.
1172
+ * @remarks
1173
+ * This property is only used for naming the application logging folder, which will be sanitized to remove
1174
+ * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1175
+ * during startup with the UUID of the application.
1176
+ *
1177
+ * This property will be deprecated in the future.
1173
1178
  */
1174
1179
  name: string;
1175
1180
  /**
@@ -1199,9 +1204,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1199
1204
  url: string;
1200
1205
  /**
1201
1206
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1202
- * running in the OpenFin Runtime.
1203
- *
1204
- * Note that `name` and `uuid` must match.
1207
+ * running in the OpenFin Runtime.
1205
1208
  */
1206
1209
  uuid: string;
1207
1210
  /**
@@ -1936,48 +1939,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1936
1939
  behavior: 'browser';
1937
1940
  };
1938
1941
 
1939
- declare interface BrowserWindow {
1940
- /**
1941
- * True if the window has been opened and its GoldenLayout instance initialised.
1942
- */
1943
- isInitialised: boolean;
1944
-
1945
- /**
1946
- * Creates a window configuration object from the Popout.
1947
- */
1948
- toConfig(): {
1949
- dimensions: {
1950
- width: number;
1951
- height: number;
1952
- left: number;
1953
- top: number;
1954
- };
1955
- content: Config;
1956
- parentId: string;
1957
- indexInParent: number;
1958
- };
1959
-
1960
- /**
1961
- * Returns the GoldenLayout instance from the child window
1962
- */
1963
- getGlInstance(): GoldenLayout_2;
1964
-
1965
- /**
1966
- * Returns the native Window object
1967
- */
1968
- getWindow(): Window;
1969
-
1970
- /**
1971
- * Closes the popout
1972
- */
1973
- close(): void;
1974
-
1975
- /**
1976
- * Returns the popout to its original position as specified in parentId and indexInParent
1977
- */
1978
- popIn(): void;
1979
- }
1980
-
1981
1942
  /**
1982
1943
  * Extracts a single event type matching the given key from the View {@link Event} union.
1983
1944
  *
@@ -3385,31 +3346,6 @@ declare class ColumnOrRow extends LayoutNode {
3385
3346
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3386
3347
  }
3387
3348
 
3388
- declare interface ComponentConfig extends ItemConfig {
3389
- /**
3390
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3391
- */
3392
- componentName: string;
3393
-
3394
- /**
3395
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3396
- * container.getState().
3397
- */
3398
- componentState?: any;
3399
- }
3400
-
3401
- declare interface Config {
3402
- settings?: Settings;
3403
- dimensions?: Dimensions;
3404
- labels?: Labels;
3405
- content?: ItemConfigType[];
3406
- /**
3407
- * (Only on layout config object)
3408
- * Id of the currently maximised content item
3409
- */
3410
- maximisedItemId?: string;
3411
- }
3412
-
3413
3349
  declare type ConfigWithRuntime = BaseConfig & {
3414
3350
  runtime: RuntimeConfig;
3415
3351
  };
@@ -3805,103 +3741,6 @@ declare type ConstWindowOptions = {
3805
3741
  inheritance?: Partial<InheritableOptions>;
3806
3742
  };
3807
3743
 
3808
- declare interface Container extends EventEmitter_2 {
3809
- /**
3810
- * The current width of the container in pixel
3811
- */
3812
- width: number;
3813
-
3814
- /**
3815
- * The current height of the container in pixel
3816
- */
3817
- height: number;
3818
-
3819
- /**
3820
- * A reference to the component-item that controls this container
3821
- */
3822
- parent: ContentItem;
3823
-
3824
- /**
3825
- * A reference to the tab that controls this container. Will initially be null
3826
- * (and populated once a tab event has been fired).
3827
- */
3828
- tab: Tab;
3829
-
3830
- /**
3831
- * The current title of the container
3832
- */
3833
- title: string;
3834
-
3835
- /*
3836
- * A reference to the GoldenLayout instance this container belongs to
3837
- */
3838
- layoutManager: GoldenLayout_2;
3839
-
3840
- /**
3841
- * True if the item is currently hidden
3842
- */
3843
- isHidden: boolean;
3844
-
3845
- /**
3846
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3847
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3848
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3849
- * constructor function. It will also be used when the component is opened in a new window.
3850
- * @param state A serialisable object
3851
- */
3852
- setState(state: any): void;
3853
-
3854
- /**
3855
- * The same as setState but does not emit 'stateChanged' event
3856
- * @param {serialisable} state
3857
- */
3858
- setStateSkipEvent(state: any): void;
3859
-
3860
- /**
3861
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3862
- * @param state A serialisable object
3863
- */
3864
- extendState(state: any): void;
3865
-
3866
- /**
3867
- * Returns the current state.
3868
- */
3869
- getState(): any;
3870
-
3871
- /**
3872
- * Returns the container's inner element as a jQuery element
3873
- */
3874
- getElement(): JQuery;
3875
-
3876
- /**
3877
- * hides the container or returns false if hiding it is not possible
3878
- */
3879
- hide(): boolean;
3880
-
3881
- /**
3882
- * shows the container or returns false if showing it is not possible
3883
- */
3884
- show(): boolean;
3885
-
3886
- /**
3887
- * Sets the container to the specified size or returns false if that's not possible
3888
- * @param width the new width in pixel
3889
- * @param height the new height in pixel
3890
- */
3891
- setSize(width: number, height: number): boolean;
3892
-
3893
- /**
3894
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3895
- * @param title the new title
3896
- */
3897
- setTitle(title: string): void;
3898
-
3899
- /**
3900
- * Closes the container or returns false if that is not possible
3901
- */
3902
- close(): boolean;
3903
- }
3904
-
3905
3744
  /**
3906
3745
  * Generated when a Layout Container Component was created.
3907
3746
  * @interface
@@ -3983,218 +3822,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3983
3822
  disposition: string;
3984
3823
  };
3985
3824
 
3986
- declare interface ContentItem extends EventEmitter_2 {
3987
- instance: any;
3988
- header: any;
3989
- _splitter: any;
3990
- /**
3991
- * This items configuration in its current state
3992
- */
3993
- config: ItemConfigType;
3994
-
3995
- /**
3996
- * The type of the item. Can be row, column, stack, component or root
3997
- */
3998
- type: ItemType;
3999
-
4000
- /**
4001
- * An array of items that are children of this item
4002
- */
4003
- contentItems: ContentItem[];
4004
-
4005
- container: Container;
4006
- /**
4007
- * The item that is this item's parent (or null if the item is root)
4008
- */
4009
- parent: ContentItem;
4010
-
4011
- /**
4012
- * A String or array of identifiers if provided in the configuration
4013
- */
4014
- id: string;
4015
-
4016
- /**
4017
- * True if the item had been initialised
4018
- */
4019
- isInitialised: boolean;
4020
-
4021
- /**
4022
- * True if the item is maximised
4023
- */
4024
- isMaximised: boolean;
4025
-
4026
- /**
4027
- * True if the item is the layout's root item
4028
- */
4029
- isRoot: boolean;
4030
-
4031
- /**
4032
- * True if the item is a row
4033
- */
4034
- isRow: boolean;
4035
-
4036
- /**
4037
- * True if the item is a column
4038
- */
4039
- isColumn: boolean;
4040
-
4041
- /**
4042
- * True if the item is a stack
4043
- */
4044
- isStack: boolean;
4045
-
4046
- /**
4047
- * True if the item is a component
4048
- */
4049
- isComponent: boolean;
4050
-
4051
- /**
4052
- * A reference to the layoutManager that controls this item
4053
- */
4054
- layoutManager: any;
4055
-
4056
- /**
4057
- * The item's outer element
4058
- */
4059
- element: JQuery;
4060
-
4061
- /**
4062
- * The item's inner element. Can be the same as the outer element.
4063
- */
4064
- childElementContainer: Container;
4065
-
4066
- /**
4067
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4068
- * from its original position before adding it to this item.
4069
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4070
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4071
- */
4072
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4073
-
4074
- /**
4075
- * Destroys the item and all it's children
4076
- * @param contentItem The contentItem that should be removed
4077
- * @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.
4078
- */
4079
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4080
-
4081
- /**
4082
- * The contentItem that should be removed
4083
- * @param oldChild ContentItem The contentItem that should be removed
4084
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4085
- */
4086
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4087
-
4088
- /**
4089
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4090
- */
4091
- setSize(): void;
4092
-
4093
- /**
4094
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4095
- * @param title the new title
4096
- */
4097
- setTitle(title: string): void;
4098
-
4099
- /**
4100
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4101
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4102
- * @param functionName The name of the method to invoke
4103
- * @param functionArguments An array of arguments to pass to every function
4104
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4105
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4106
- */
4107
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4108
-
4109
- /**
4110
- * 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.
4111
- */
4112
- emitBubblingEvent(name: string): void;
4113
-
4114
- /**
4115
- * Convenience method for item.parent.removeChild( item )
4116
- */
4117
- remove(): void;
4118
-
4119
- /**
4120
- * Removes the item from its current position in the layout and opens it in a window
4121
- */
4122
- popout(): BrowserWindow;
4123
-
4124
- /**
4125
- * Maximises the item or minimises it if it's already maximised
4126
- */
4127
- toggleMaximise(): void;
4128
-
4129
- /**
4130
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4131
- */
4132
- select(): void;
4133
-
4134
- /**
4135
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4136
- */
4137
- deselect(): void;
4138
-
4139
- /**
4140
- * Returns true if the item has the specified id or false if not
4141
- * @param id An id to check for
4142
- */
4143
- hasId(id: string): boolean;
4144
-
4145
- /**
4146
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4147
- * @param contentItem The new active content item
4148
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4149
- */
4150
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4151
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4152
-
4153
- /**
4154
- * Only Stacks have this method! Returns the currently selected contentItem.
4155
- */
4156
- getActiveContentItem(): ContentItem;
4157
-
4158
- /**
4159
- * Adds an id to an item or does nothing if the id is already present
4160
- * @param id The id to be added
4161
- */
4162
- addId(id: string): void;
4163
-
4164
- /**
4165
- * Removes an id from an item or throws an error if the id couldn't be found
4166
- * @param id The id to be removed
4167
- */
4168
- removeId(id: string): void;
4169
-
4170
- /**
4171
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4172
- * @param filterFunction A function that determines whether an item matches certain criteria
4173
- */
4174
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4175
-
4176
- /**
4177
- * Returns all items with the specified id.
4178
- * @param id An id specified in the itemConfig
4179
- */
4180
- getItemsById(id: string | string[]): ContentItem[];
4181
-
4182
- /**
4183
- * Returns all items with the specified type
4184
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4185
- */
4186
- getItemsByType(type: string): ContentItem[];
4187
-
4188
- /**
4189
- * Returns all instances of the component with the specified componentName
4190
- * @param componentName a componentName as specified in the itemConfig
4191
- */
4192
- getComponentsByName(componentName: string): any;
4193
-
4194
- _contentAreaDimensions: any;
4195
- _$getArea: () => any;
4196
- }
4197
-
4198
3825
  /**
4199
3826
  * Restrict navigation to URLs that match an allowed pattern.
4200
3827
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4633,46 +4260,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4633
4260
  type: 'did-finish-load';
4634
4261
  };
4635
4262
 
4636
- declare interface Dimensions {
4637
- /**
4638
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4639
- * than the visible one, making it safe to set this to small values without affecting usability.
4640
- * Default: 5
4641
- */
4642
- borderWidth?: number;
4643
-
4644
- /**
4645
- * The minimum height an item can be resized to (in pixel).
4646
- * Default: 10
4647
- */
4648
- minItemHeight?: number;
4649
-
4650
- /**
4651
- * The minimum width an item can be resized to (in pixel).
4652
- * Default: 10
4653
- */
4654
- minItemWidth?: number;
4655
-
4656
- /**
4657
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4658
- * adjusted accordingly.
4659
- * Default: 20
4660
- */
4661
- headerHeight?: number;
4662
-
4663
- /**
4664
- * The width of the element that appears when an item is dragged (in pixel).
4665
- * Default: 300
4666
- */
4667
- dragProxyWidth?: number;
4668
-
4669
- /**
4670
- * The height of the element that appears when an item is dragged (in pixel).
4671
- * Default: 200
4672
- */
4673
- dragProxyHeight?: number;
4674
- }
4675
-
4676
4263
  /**
4677
4264
  * @interface
4678
4265
  */
@@ -4933,8 +4520,6 @@ declare type Dpi = {
4933
4520
  vertical?: number;
4934
4521
  };
4935
4522
 
4936
- declare interface DragSource {}
4937
-
4938
4523
  /**
4939
4524
  * Generated when a window has been embedded.
4940
4525
  * @interface
@@ -5252,43 +4837,6 @@ declare class EventAggregator extends EmitterMap {
5252
4837
  dispatchEvent: (message: Message<any>) => boolean;
5253
4838
  }
5254
4839
 
5255
- declare interface EventEmitter_2 {
5256
- [x: string]: any;
5257
- /**
5258
- * Subscribe to an event
5259
- * @param eventName The name of the event to describe to
5260
- * @param callback The function that should be invoked when the event occurs
5261
- * @param context The value of the this pointer in the callback function
5262
- */
5263
- on(eventName: string, callback: Function, context?: any): void;
5264
-
5265
- /**
5266
- * Notify listeners of an event and pass arguments along
5267
- * @param eventName The name of the event to emit
5268
- */
5269
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5270
-
5271
- /**
5272
- * Alias for emit
5273
- */
5274
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5275
-
5276
- /**
5277
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5278
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5279
- * arguments.
5280
- * @param eventName The name of the event to unsubscribe from
5281
- * @param callback The function that should be invoked when the event occurs
5282
- * @param context The value of the this pointer in the callback function
5283
- */
5284
- unbind(eventName: string, callback?: Function, context?: any): void;
5285
-
5286
- /**
5287
- * Alias for unbind
5288
- */
5289
- off(eventName: string, callback?: Function, context?: any): void;
5290
- }
5291
-
5292
4840
  /**
5293
4841
  * Handler for an event on an EventEmitter.
5294
4842
  * @remarks Selects the correct type for the event
@@ -6180,253 +5728,6 @@ declare namespace GlobalHotkeyEvents {
6180
5728
  */
6181
5729
  declare type GlobalHotkeyEventType = EventType_6;
6182
5730
 
6183
- declare namespace GoldenLayout {
6184
- export {
6185
- GoldenLayout_2 as GoldenLayout,
6186
- ItemConfigType,
6187
- Settings,
6188
- Dimensions,
6189
- Labels,
6190
- ItemType,
6191
- ItemConfig,
6192
- ComponentConfig,
6193
- ReactComponentConfig,
6194
- Config,
6195
- ContentItem,
6196
- Container,
6197
- DragSource,
6198
- BrowserWindow,
6199
- Header,
6200
- TabDragListener,
6201
- Tab,
6202
- EventEmitter_2 as EventEmitter
6203
- }
6204
- }
6205
-
6206
- declare class GoldenLayout_2 implements EventEmitter_2 {
6207
- /**
6208
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6209
- * object and of goldenLayout.root as the document.
6210
- */
6211
- root: ContentItem;
6212
-
6213
- /**
6214
- * A reference to the (jQuery) DOM element containing the layout
6215
- */
6216
- container: JQuery;
6217
-
6218
- /**
6219
- * True once the layout item tree has been created and the initialised event has been fired
6220
- */
6221
- isInitialised: boolean;
6222
-
6223
- /**
6224
- * A reference to the current, extended top level config.
6225
- *
6226
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6227
- */
6228
- config: Config;
6229
-
6230
- /**
6231
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6232
- * to true.
6233
- */
6234
- selectedItem: ContentItem;
6235
-
6236
- /**
6237
- * The current outer width of the layout in pixels.
6238
- */
6239
- width: number;
6240
-
6241
- /**
6242
- * The current outer height of the layout in pixels.
6243
- */
6244
- height: number;
6245
-
6246
- /**
6247
- * An array of BrowserWindow instances
6248
- */
6249
- openPopouts: BrowserWindow[];
6250
-
6251
- /**
6252
- * True if the layout has been opened as a popout by another layout.
6253
- */
6254
- isSubWindow: boolean;
6255
-
6256
- /**
6257
- * A singleton instance of EventEmitter that works across windows
6258
- */
6259
- eventHub: EventEmitter_2;
6260
-
6261
- _dragProxy: any;
6262
-
6263
- dropTargetIndicator: any;
6264
-
6265
- _isFullPage: boolean;
6266
-
6267
- _onUnload: any;
6268
-
6269
- tabDropPlaceholder: any;
6270
-
6271
- transitionIndicator: any;
6272
-
6273
- _dragSources: any;
6274
-
6275
- _resizeFunction: any;
6276
-
6277
- _unloadFunction: any;
6278
-
6279
- /**
6280
- * @param config A GoldenLayout configuration object
6281
- * @param container The DOM element the layout will be initialised in. Default: document.body
6282
- */
6283
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6284
-
6285
- /*
6286
- * @param name The name of the component, as referred to by componentName in the component configuration.
6287
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6288
- * containerobject and a component state
6289
- */
6290
- registerComponent(name: String, component: any): void;
6291
-
6292
- /**
6293
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6294
- * a listener to the document and executes once it becomes ready.
6295
- */
6296
- init(): void;
6297
-
6298
- /**
6299
- * Returns the current state of the layout and its components as a serialisable object.
6300
- */
6301
- toConfig(): Config;
6302
-
6303
- /**
6304
- * Returns a component that was previously registered with layout.registerComponent().
6305
- * @param name The name of a previously registered component
6306
- */
6307
- getComponent(name: string): any;
6308
-
6309
- /**
6310
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6311
- * @param width The outer width the layout should be resized to. Default: The container elements width
6312
- * @param height The outer height the layout should be resized to. Default: The container elements height
6313
- */
6314
- updateSize(width?: number, height?: number): void;
6315
-
6316
- /**
6317
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6318
- * listeners and finally removes itself from the DOM.
6319
- */
6320
- destroy(): void;
6321
-
6322
- /**
6323
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6324
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6325
- * all call this method implicitly.
6326
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6327
- * @param parent A parent item
6328
- */
6329
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6330
-
6331
- /**
6332
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6333
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6334
- * provided its config will be read, if config is provided, only the content key
6335
- * will be used
6336
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6337
- * place the window in another screen.
6338
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6339
- * when popIn is clicked
6340
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6341
- */
6342
- createPopout(
6343
- configOrContentItem: ItemConfigType | ContentItem,
6344
- dimensions: {
6345
- width: number;
6346
- height: number;
6347
- left: number;
6348
- top: number;
6349
- },
6350
- parentId?: string,
6351
- indexInParent?: number
6352
- ): void;
6353
-
6354
- /**
6355
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6356
- * where it turns into a contentItem.
6357
- * @param element The DOM element that will be turned into a dragSource
6358
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6359
- * @return the dragSource that was created. This can be used to remove the
6360
- * dragSource from the layout later.
6361
- */
6362
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6363
-
6364
- /**
6365
- * Removes a dragSource from the layout.
6366
- *
6367
- * @param dragSource The dragSource to remove
6368
- */
6369
- removeDragSource(dragSource: DragSource): void;
6370
-
6371
- /**
6372
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6373
- * @param contentItem A ContentItem instance
6374
- */
6375
- selectItem(contentItem: ContentItem): void;
6376
-
6377
- /**
6378
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6379
- * and replace frequent keys and values with single letter substitutes.
6380
- * @param config A GoldenLayout configuration object
6381
- */
6382
- static minifyConfig(config: any): any;
6383
-
6384
- /**
6385
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6386
- * @param minifiedConfig A minified GoldenLayout configuration object
6387
- */
6388
- static unminifyConfig(minifiedConfig: any): any;
6389
-
6390
- /**
6391
- * Subscribe to an event
6392
- * @param eventName The name of the event to describe to
6393
- * @param callback The function that should be invoked when the event occurs
6394
- * @param context The value of the this pointer in the callback function
6395
- */
6396
- on(eventName: string, callback: Function, context?: any): void;
6397
-
6398
- /**
6399
- * Notify listeners of an event and pass arguments along
6400
- * @param eventName The name of the event to emit
6401
- */
6402
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6403
-
6404
- /**
6405
- * Alias for emit
6406
- */
6407
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6408
-
6409
- /**
6410
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6411
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6412
- * arguments.
6413
- * @param eventName The name of the event to unsubscribe from
6414
- * @param callback The function that should be invoked when the event occurs
6415
- * @param context The value of the this pointer in the callback function
6416
- */
6417
- unbind(eventName: string, callback?: Function, context?: any): void;
6418
-
6419
- /**
6420
- * Alias for unbind
6421
- */
6422
- off(eventName: string, callback?: Function, context?: any): void;
6423
-
6424
- /**
6425
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6426
- */
6427
- _$createRootItemAreas(): void;
6428
- }
6429
-
6430
5731
  /**
6431
5732
  * @interface
6432
5733
  */
@@ -6434,62 +5735,6 @@ declare type GpuInfo = {
6434
5735
  name: string;
6435
5736
  };
6436
5737
 
6437
- declare interface Header {
6438
- /**
6439
- * A reference to the LayoutManager instance
6440
- */
6441
- layoutManager: GoldenLayout_2;
6442
-
6443
- /**
6444
- * A reference to the Stack this Header belongs to
6445
- */
6446
- parent: ContentItem;
6447
-
6448
- /**
6449
- * An array of the Tabs within this header
6450
- */
6451
- tabs: Tab[];
6452
-
6453
- /**
6454
- * The currently selected activeContentItem
6455
- */
6456
- activeContentItem: ContentItem;
6457
-
6458
- /**
6459
- * The outer (jQuery) DOM element of this Header
6460
- */
6461
- element: JQuery;
6462
-
6463
- /**
6464
- * The (jQuery) DOM element containing the tabs
6465
- */
6466
- tabsContainer: JQuery;
6467
-
6468
- /**
6469
- * The (jQuery) DOM element containing the close, maximise and popout button
6470
- */
6471
- controlsContainer: JQuery;
6472
-
6473
- /**
6474
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6475
- * @param contentItem The content item that will be selected
6476
- */
6477
- setActiveContentItem(contentItem: ContentItem): void;
6478
-
6479
- /**
6480
- * Creates a new tab and associates it with a content item
6481
- * @param contentItem The content item the tab will be associated with
6482
- * @param index A zero based index, specifying the position of the new tab
6483
- */
6484
- createTab(contentItem: ContentItem, index?: number): void;
6485
-
6486
- /**
6487
- * Finds a tab by its contentItem and removes it
6488
- * @param contentItem The content item the tab is associated with
6489
- */
6490
- removeTab(contentItem: ContentItem): void;
6491
- }
6492
-
6493
5738
  /**
6494
5739
  * Generated when a View is hidden.
6495
5740
  * @interface
@@ -8102,50 +7347,6 @@ declare class InteropModule extends Base {
8102
7347
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8103
7348
  }
8104
7349
 
8105
- declare interface ItemConfig {
8106
- /**
8107
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8108
- */
8109
- type: ItemType;
8110
-
8111
- /**
8112
- * An array of configurations for items that will be created as children of this item.
8113
- */
8114
- content?: ItemConfigType[];
8115
-
8116
- /**
8117
- * The width of this item, relative to the other children of its parent in percent
8118
- */
8119
- width?: number;
8120
-
8121
- /**
8122
- * The height of this item, relative to the other children of its parent in percent
8123
- */
8124
- height?: number;
8125
-
8126
- /**
8127
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8128
- */
8129
- id?: string | string[];
8130
-
8131
- /**
8132
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8133
- * will return false
8134
- * Default: true
8135
- */
8136
- isClosable?: boolean;
8137
-
8138
- /**
8139
- * The title of the item as displayed on its tab and on popout windows
8140
- * Default: componentName or ''
8141
- */
8142
- title?: string;
8143
- }
8144
-
8145
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8146
-
8147
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8148
-
8149
7350
  /**
8150
7351
  * @interface
8151
7352
  */
@@ -8203,32 +7404,6 @@ declare type JumpListTask = {
8203
7404
  iconIndex?: number;
8204
7405
  };
8205
7406
 
8206
- declare interface Labels {
8207
- /**
8208
- * The tooltip text that appears when hovering over the close icon.
8209
- * Default: 'close'
8210
- */
8211
- close?: string;
8212
-
8213
- /**
8214
- * The tooltip text that appears when hovering over the maximise icon.
8215
- * Default: 'maximise'
8216
- */
8217
- maximise?: string;
8218
-
8219
- /**
8220
- * The tooltip text that appears when hovering over the minimise icon.
8221
- * Default: 'minimise'
8222
- */
8223
- minimise?: string;
8224
-
8225
- /**
8226
- * The tooltip text that appears when hovering over the popout icon.
8227
- * Default: 'open in new window'
8228
- */
8229
- popout?: string;
8230
- }
8231
-
8232
7407
  export declare function launch(config: ConnectConfig): Promise<number>;
8233
7408
 
8234
7409
  /**
@@ -8688,7 +7863,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8688
7863
  entityId: string;
8689
7864
  };
8690
7865
 
8691
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7866
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8692
7867
 
8693
7868
  /**
8694
7869
  * @interface
@@ -12895,18 +12070,6 @@ declare type QueryPermissionResult = {
12895
12070
  rawValue?: unknown;
12896
12071
  };
12897
12072
 
12898
- declare interface ReactComponentConfig extends ItemConfig {
12899
- /**
12900
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12901
- */
12902
- component: string;
12903
-
12904
- /**
12905
- * Properties that will be passed to the component and accessible using this.props.
12906
- */
12907
- props?: any;
12908
- }
12909
-
12910
12073
  /**
12911
12074
  * @interface
12912
12075
  */
@@ -13383,97 +12546,6 @@ declare type SessionContextGroup = {
13383
12546
  }>;
13384
12547
  };
13385
12548
 
13386
- declare interface Settings {
13387
- preventSplitterResize?: boolean;
13388
-
13389
- newTabButton?: {
13390
- url?: string;
13391
- };
13392
-
13393
- /**
13394
- * If true, tabs can't be dragged into the window.
13395
- * Default: false
13396
- */
13397
- preventDragIn?: boolean;
13398
-
13399
- /**
13400
- * If true, tabs can't be dragged out of the window.
13401
- * Default: false
13402
- */
13403
- preventDragOut?: boolean;
13404
-
13405
- /**
13406
- * If true, stack headers are the only areas where tabs can be dropped.
13407
- * Default: false
13408
- */
13409
- constrainDragToHeaders?: boolean;
13410
- /**
13411
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13412
- * Default: true
13413
- */
13414
- hasHeaders?: boolean;
13415
-
13416
- /**
13417
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13418
- * automatically when layout.createDragSource() is called.
13419
- * Default: true
13420
- */
13421
- constrainDragToContainer?: boolean;
13422
-
13423
- /**
13424
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13425
- * Default: true
13426
- */
13427
- reorderEnabled?: boolean;
13428
-
13429
- /**
13430
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13431
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13432
- * Default: false
13433
- */
13434
- selectionEnabled?: boolean;
13435
-
13436
- /**
13437
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13438
- * be transferred to the new window, if false only the active component will be opened.
13439
- * Default: false
13440
- */
13441
- popoutWholeStack?: boolean;
13442
-
13443
- /**
13444
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13445
- * If false, the popout call will fail silently.
13446
- * Default: true
13447
- */
13448
- blockedPopoutsThrowError?: boolean;
13449
-
13450
- /**
13451
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13452
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13453
- * addition, any changes made to popouts won't be stored after the parent is closed.
13454
- * Default: true
13455
- */
13456
- closePopoutsOnUnload?: boolean;
13457
-
13458
- /**
13459
- * Specifies if the popout icon should be displayed in the header-bar.
13460
- * Default: true
13461
- */
13462
- showPopoutIcon?: boolean;
13463
-
13464
- /**
13465
- * Specifies if the maximise icon should be displayed in the header-bar.
13466
- * Default: true
13467
- */
13468
- showMaximiseIcon?: boolean;
13469
-
13470
- /**
13471
- * Specifies if the close icon should be displayed in the header-bar.
13472
- * Default: true
13473
- */
13474
- showCloseIcon?: boolean;
13475
- }
13476
-
13477
12549
  /**
13478
12550
  * @interface
13479
12551
  */
@@ -15381,52 +14453,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15381
14453
  proceed: () => void;
15382
14454
  }) => void;
15383
14455
 
15384
- declare interface Tab {
15385
- _dragListener: TabDragListener;
15386
-
15387
- /**
15388
- * True if this tab is the selected tab
15389
- */
15390
- isActive: boolean;
15391
-
15392
- /**
15393
- * A reference to the header this tab is a child of
15394
- */
15395
- header: Header;
15396
-
15397
- /**
15398
- * A reference to the content item this tab relates to
15399
- */
15400
- contentItem: ContentItem;
15401
-
15402
- /**
15403
- * The tabs outer (jQuery) DOM element
15404
- */
15405
- element: JQuery;
15406
-
15407
- /**
15408
- * The (jQuery) DOM element containing the title
15409
- */
15410
- titleElement: JQuery;
15411
-
15412
- /**
15413
- * The (jQuery) DOM element that closes the tab
15414
- */
15415
- closeElement: JQuery;
15416
-
15417
- /**
15418
- * Sets the tab's title. Does not affect the contentItem's title!
15419
- * @param title The new title
15420
- */
15421
- setTitle(title: string): void;
15422
-
15423
- /**
15424
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15425
- * @param isActive Whether the tab is active
15426
- */
15427
- setActive(isActive: boolean): void;
15428
- }
15429
-
15430
14456
  /**
15431
14457
  * Generated when a Layout Tab Component was closed.
15432
14458
  * @interface
@@ -15444,13 +14470,6 @@ declare type TabCreatedEvent = LayoutDOMEvent & {
15444
14470
  type: 'tab-created';
15445
14471
  };
15446
14472
 
15447
- declare interface TabDragListener extends EventEmitter_2 {
15448
- /**
15449
- * A reference to the content item this tab relates to
15450
- */
15451
- contentItem: ContentItem;
15452
- }
15453
-
15454
14473
  /**
15455
14474
  * Generated when a Layout Tab Component was dropped.
15456
14475
  * @interface