@openfin/remote-adapter 36.80.10 → 36.80.23

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.
@@ -1184,9 +1184,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1184
1184
  */
1185
1185
  mainWindowOptions: WindowCreationOptions;
1186
1186
  /**
1187
- * The name of the application (and the application's main window).
1187
+ * The name of the application.
1188
1188
  *
1189
- * If provided, _must_ match `uuid`.
1189
+ * @remarks
1190
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1191
+ * any special characters, spaces or international characters. It's also used in error messages, API
1192
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1193
+ *
1194
+ * This property will be deprecated in the future.
1190
1195
  */
1191
1196
  name: string;
1192
1197
  /**
@@ -1216,9 +1221,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1216
1221
  url: string;
1217
1222
  /**
1218
1223
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1219
- * running in the OpenFin Runtime.
1220
- *
1221
- * Note that `name` and `uuid` must match.
1224
+ * running in the OpenFin Runtime.
1222
1225
  */
1223
1226
  uuid: string;
1224
1227
  /**
@@ -2007,48 +2010,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
2007
2010
  behavior: 'browser';
2008
2011
  };
2009
2012
 
2010
- declare interface BrowserWindow {
2011
- /**
2012
- * True if the window has been opened and its GoldenLayout instance initialised.
2013
- */
2014
- isInitialised: boolean;
2015
-
2016
- /**
2017
- * Creates a window configuration object from the Popout.
2018
- */
2019
- toConfig(): {
2020
- dimensions: {
2021
- width: number;
2022
- height: number;
2023
- left: number;
2024
- top: number;
2025
- };
2026
- content: Config;
2027
- parentId: string;
2028
- indexInParent: number;
2029
- };
2030
-
2031
- /**
2032
- * Returns the GoldenLayout instance from the child window
2033
- */
2034
- getGlInstance(): GoldenLayout_2;
2035
-
2036
- /**
2037
- * Returns the native Window object
2038
- */
2039
- getWindow(): Window;
2040
-
2041
- /**
2042
- * Closes the popout
2043
- */
2044
- close(): void;
2045
-
2046
- /**
2047
- * Returns the popout to its original position as specified in parentId and indexInParent
2048
- */
2049
- popIn(): void;
2050
- }
2051
-
2052
2013
  /**
2053
2014
  * Extracts a single event type matching the given key from the View {@link Event} union.
2054
2015
  *
@@ -3491,31 +3452,6 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3491
3452
  close(): Promise<void>;
3492
3453
  }
3493
3454
 
3494
- declare interface ComponentConfig extends ItemConfig {
3495
- /**
3496
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3497
- */
3498
- componentName: string;
3499
-
3500
- /**
3501
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3502
- * container.getState().
3503
- */
3504
- componentState?: any;
3505
- }
3506
-
3507
- declare interface Config {
3508
- settings?: Settings;
3509
- dimensions?: Dimensions;
3510
- labels?: Labels;
3511
- content?: ItemConfigType[];
3512
- /**
3513
- * (Only on layout config object)
3514
- * Id of the currently maximised content item
3515
- */
3516
- maximisedItemId?: string;
3517
- }
3518
-
3519
3455
  declare type ConfigWithRuntime = BaseConfig & {
3520
3456
  runtime: RuntimeConfig;
3521
3457
  };
@@ -3917,103 +3853,6 @@ declare type ConstWindowOptions = {
3917
3853
  inheritance?: Partial<InheritableOptions>;
3918
3854
  };
3919
3855
 
3920
- declare interface Container extends EventEmitter_2 {
3921
- /**
3922
- * The current width of the container in pixel
3923
- */
3924
- width: number;
3925
-
3926
- /**
3927
- * The current height of the container in pixel
3928
- */
3929
- height: number;
3930
-
3931
- /**
3932
- * A reference to the component-item that controls this container
3933
- */
3934
- parent: ContentItem;
3935
-
3936
- /**
3937
- * A reference to the tab that controls this container. Will initially be null
3938
- * (and populated once a tab event has been fired).
3939
- */
3940
- tab: Tab;
3941
-
3942
- /**
3943
- * The current title of the container
3944
- */
3945
- title: string;
3946
-
3947
- /*
3948
- * A reference to the GoldenLayout instance this container belongs to
3949
- */
3950
- layoutManager: GoldenLayout_2;
3951
-
3952
- /**
3953
- * True if the item is currently hidden
3954
- */
3955
- isHidden: boolean;
3956
-
3957
- /**
3958
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3959
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3960
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3961
- * constructor function. It will also be used when the component is opened in a new window.
3962
- * @param state A serialisable object
3963
- */
3964
- setState(state: any): void;
3965
-
3966
- /**
3967
- * The same as setState but does not emit 'stateChanged' event
3968
- * @param {serialisable} state
3969
- */
3970
- setStateSkipEvent(state: any): void;
3971
-
3972
- /**
3973
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3974
- * @param state A serialisable object
3975
- */
3976
- extendState(state: any): void;
3977
-
3978
- /**
3979
- * Returns the current state.
3980
- */
3981
- getState(): any;
3982
-
3983
- /**
3984
- * Returns the container's inner element as a jQuery element
3985
- */
3986
- getElement(): JQuery;
3987
-
3988
- /**
3989
- * hides the container or returns false if hiding it is not possible
3990
- */
3991
- hide(): boolean;
3992
-
3993
- /**
3994
- * shows the container or returns false if showing it is not possible
3995
- */
3996
- show(): boolean;
3997
-
3998
- /**
3999
- * Sets the container to the specified size or returns false if that's not possible
4000
- * @param width the new width in pixel
4001
- * @param height the new height in pixel
4002
- */
4003
- setSize(width: number, height: number): boolean;
4004
-
4005
- /**
4006
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4007
- * @param title the new title
4008
- */
4009
- setTitle(title: string): void;
4010
-
4011
- /**
4012
- * Closes the container or returns false if that is not possible
4013
- */
4014
- close(): boolean;
4015
- }
4016
-
4017
3856
  declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
4018
3857
 
4019
3858
  /**
@@ -4076,218 +3915,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
4076
3915
  disposition: string;
4077
3916
  };
4078
3917
 
4079
- declare interface ContentItem extends EventEmitter_2 {
4080
- instance: any;
4081
- header: any;
4082
- _splitter: any;
4083
- /**
4084
- * This items configuration in its current state
4085
- */
4086
- config: ItemConfigType;
4087
-
4088
- /**
4089
- * The type of the item. Can be row, column, stack, component or root
4090
- */
4091
- type: ItemType;
4092
-
4093
- /**
4094
- * An array of items that are children of this item
4095
- */
4096
- contentItems: ContentItem[];
4097
-
4098
- container: Container;
4099
- /**
4100
- * The item that is this item's parent (or null if the item is root)
4101
- */
4102
- parent: ContentItem;
4103
-
4104
- /**
4105
- * A String or array of identifiers if provided in the configuration
4106
- */
4107
- id: string;
4108
-
4109
- /**
4110
- * True if the item had been initialised
4111
- */
4112
- isInitialised: boolean;
4113
-
4114
- /**
4115
- * True if the item is maximised
4116
- */
4117
- isMaximised: boolean;
4118
-
4119
- /**
4120
- * True if the item is the layout's root item
4121
- */
4122
- isRoot: boolean;
4123
-
4124
- /**
4125
- * True if the item is a row
4126
- */
4127
- isRow: boolean;
4128
-
4129
- /**
4130
- * True if the item is a column
4131
- */
4132
- isColumn: boolean;
4133
-
4134
- /**
4135
- * True if the item is a stack
4136
- */
4137
- isStack: boolean;
4138
-
4139
- /**
4140
- * True if the item is a component
4141
- */
4142
- isComponent: boolean;
4143
-
4144
- /**
4145
- * A reference to the layoutManager that controls this item
4146
- */
4147
- layoutManager: any;
4148
-
4149
- /**
4150
- * The item's outer element
4151
- */
4152
- element: JQuery;
4153
-
4154
- /**
4155
- * The item's inner element. Can be the same as the outer element.
4156
- */
4157
- childElementContainer: Container;
4158
-
4159
- /**
4160
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4161
- * from its original position before adding it to this item.
4162
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4163
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4164
- */
4165
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4166
-
4167
- /**
4168
- * Destroys the item and all it's children
4169
- * @param contentItem The contentItem that should be removed
4170
- * @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.
4171
- */
4172
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4173
-
4174
- /**
4175
- * The contentItem that should be removed
4176
- * @param oldChild ContentItem The contentItem that should be removed
4177
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4178
- */
4179
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4180
-
4181
- /**
4182
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4183
- */
4184
- setSize(): void;
4185
-
4186
- /**
4187
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4188
- * @param title the new title
4189
- */
4190
- setTitle(title: string): void;
4191
-
4192
- /**
4193
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4194
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4195
- * @param functionName The name of the method to invoke
4196
- * @param functionArguments An array of arguments to pass to every function
4197
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4198
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4199
- */
4200
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4201
-
4202
- /**
4203
- * 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.
4204
- */
4205
- emitBubblingEvent(name: string): void;
4206
-
4207
- /**
4208
- * Convenience method for item.parent.removeChild( item )
4209
- */
4210
- remove(): void;
4211
-
4212
- /**
4213
- * Removes the item from its current position in the layout and opens it in a window
4214
- */
4215
- popout(): BrowserWindow;
4216
-
4217
- /**
4218
- * Maximises the item or minimises it if it's already maximised
4219
- */
4220
- toggleMaximise(): void;
4221
-
4222
- /**
4223
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4224
- */
4225
- select(): void;
4226
-
4227
- /**
4228
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4229
- */
4230
- deselect(): void;
4231
-
4232
- /**
4233
- * Returns true if the item has the specified id or false if not
4234
- * @param id An id to check for
4235
- */
4236
- hasId(id: string): boolean;
4237
-
4238
- /**
4239
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4240
- * @param contentItem The new active content item
4241
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4242
- */
4243
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4244
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4245
-
4246
- /**
4247
- * Only Stacks have this method! Returns the currently selected contentItem.
4248
- */
4249
- getActiveContentItem(): ContentItem;
4250
-
4251
- /**
4252
- * Adds an id to an item or does nothing if the id is already present
4253
- * @param id The id to be added
4254
- */
4255
- addId(id: string): void;
4256
-
4257
- /**
4258
- * Removes an id from an item or throws an error if the id couldn't be found
4259
- * @param id The id to be removed
4260
- */
4261
- removeId(id: string): void;
4262
-
4263
- /**
4264
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4265
- * @param filterFunction A function that determines whether an item matches certain criteria
4266
- */
4267
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4268
-
4269
- /**
4270
- * Returns all items with the specified id.
4271
- * @param id An id specified in the itemConfig
4272
- */
4273
- getItemsById(id: string | string[]): ContentItem[];
4274
-
4275
- /**
4276
- * Returns all items with the specified type
4277
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4278
- */
4279
- getItemsByType(type: string): ContentItem[];
4280
-
4281
- /**
4282
- * Returns all instances of the component with the specified componentName
4283
- * @param componentName a componentName as specified in the itemConfig
4284
- */
4285
- getComponentsByName(componentName: string): any;
4286
-
4287
- _contentAreaDimensions: any;
4288
- _$getArea: () => any;
4289
- }
4290
-
4291
3918
  /**
4292
3919
  * Restrict navigation to URLs that match an allowed pattern.
4293
3920
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4772,46 +4399,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4772
4399
  type: 'did-finish-load';
4773
4400
  };
4774
4401
 
4775
- declare interface Dimensions {
4776
- /**
4777
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4778
- * than the visible one, making it safe to set this to small values without affecting usability.
4779
- * Default: 5
4780
- */
4781
- borderWidth?: number;
4782
-
4783
- /**
4784
- * The minimum height an item can be resized to (in pixel).
4785
- * Default: 10
4786
- */
4787
- minItemHeight?: number;
4788
-
4789
- /**
4790
- * The minimum width an item can be resized to (in pixel).
4791
- * Default: 10
4792
- */
4793
- minItemWidth?: number;
4794
-
4795
- /**
4796
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4797
- * adjusted accordingly.
4798
- * Default: 20
4799
- */
4800
- headerHeight?: number;
4801
-
4802
- /**
4803
- * The width of the element that appears when an item is dragged (in pixel).
4804
- * Default: 300
4805
- */
4806
- dragProxyWidth?: number;
4807
-
4808
- /**
4809
- * The height of the element that appears when an item is dragged (in pixel).
4810
- * Default: 200
4811
- */
4812
- dragProxyHeight?: number;
4813
- }
4814
-
4815
4402
  /**
4816
4403
  * @interface
4817
4404
  */
@@ -5108,8 +4695,6 @@ declare type Dpi = {
5108
4695
  vertical?: number;
5109
4696
  };
5110
4697
 
5111
- declare interface DragSource {}
5112
-
5113
4698
  /**
5114
4699
  * Generated when a window has been embedded.
5115
4700
  * @interface
@@ -5426,43 +5011,6 @@ declare class EventAggregator extends EmitterMap {
5426
5011
  dispatchEvent: (message: Message<any>) => boolean;
5427
5012
  }
5428
5013
 
5429
- declare interface EventEmitter_2 {
5430
- [x: string]: any;
5431
- /**
5432
- * Subscribe to an event
5433
- * @param eventName The name of the event to describe to
5434
- * @param callback The function that should be invoked when the event occurs
5435
- * @param context The value of the this pointer in the callback function
5436
- */
5437
- on(eventName: string, callback: Function, context?: any): void;
5438
-
5439
- /**
5440
- * Notify listeners of an event and pass arguments along
5441
- * @param eventName The name of the event to emit
5442
- */
5443
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5444
-
5445
- /**
5446
- * Alias for emit
5447
- */
5448
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5449
-
5450
- /**
5451
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5452
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5453
- * arguments.
5454
- * @param eventName The name of the event to unsubscribe from
5455
- * @param callback The function that should be invoked when the event occurs
5456
- * @param context The value of the this pointer in the callback function
5457
- */
5458
- unbind(eventName: string, callback?: Function, context?: any): void;
5459
-
5460
- /**
5461
- * Alias for unbind
5462
- */
5463
- off(eventName: string, callback?: Function, context?: any): void;
5464
- }
5465
-
5466
5014
  /**
5467
5015
  * Handler for an event on an EventEmitter.
5468
5016
  * @remarks Selects the correct type for the event
@@ -6324,239 +5872,6 @@ declare namespace GlobalHotkeyEvents {
6324
5872
  */
6325
5873
  declare type GlobalHotkeyEventType = EventType_6;
6326
5874
 
6327
- declare namespace GoldenLayout {
6328
- export {
6329
- GoldenLayout_2 as GoldenLayout,
6330
- ItemConfigType,
6331
- Settings,
6332
- Dimensions,
6333
- Labels,
6334
- ItemType,
6335
- ItemConfig,
6336
- ComponentConfig,
6337
- ReactComponentConfig,
6338
- Config,
6339
- ContentItem,
6340
- Container,
6341
- DragSource,
6342
- BrowserWindow,
6343
- Header,
6344
- TabDragListener,
6345
- Tab,
6346
- EventEmitter_2 as EventEmitter
6347
- }
6348
- }
6349
-
6350
- declare class GoldenLayout_2 implements EventEmitter_2 {
6351
- /**
6352
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6353
- * object and of goldenLayout.root as the document.
6354
- */
6355
- root: ContentItem;
6356
-
6357
- /**
6358
- * A reference to the (jQuery) DOM element containing the layout
6359
- */
6360
- container: JQuery;
6361
-
6362
- /**
6363
- * True once the layout item tree has been created and the initialised event has been fired
6364
- */
6365
- isInitialised: boolean;
6366
-
6367
- /**
6368
- * A reference to the current, extended top level config.
6369
- *
6370
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6371
- */
6372
- config: Config;
6373
-
6374
- /**
6375
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6376
- * to true.
6377
- */
6378
- selectedItem: ContentItem;
6379
-
6380
- /**
6381
- * The current outer width of the layout in pixels.
6382
- */
6383
- width: number;
6384
-
6385
- /**
6386
- * The current outer height of the layout in pixels.
6387
- */
6388
- height: number;
6389
-
6390
- /**
6391
- * An array of BrowserWindow instances
6392
- */
6393
- openPopouts: BrowserWindow[];
6394
-
6395
- /**
6396
- * True if the layout has been opened as a popout by another layout.
6397
- */
6398
- isSubWindow: boolean;
6399
-
6400
- /**
6401
- * A singleton instance of EventEmitter that works across windows
6402
- */
6403
- eventHub: EventEmitter_2;
6404
-
6405
- _dragProxy: any;
6406
-
6407
- dropTargetIndicator: any;
6408
-
6409
- /**
6410
- * @param config A GoldenLayout configuration object
6411
- * @param container The DOM element the layout will be initialised in. Default: document.body
6412
- */
6413
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6414
-
6415
- /*
6416
- * @param name The name of the component, as referred to by componentName in the component configuration.
6417
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6418
- * containerobject and a component state
6419
- */
6420
- registerComponent(name: String, component: any): void;
6421
-
6422
- /**
6423
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6424
- * a listener to the document and executes once it becomes ready.
6425
- */
6426
- init(): void;
6427
-
6428
- /**
6429
- * Returns the current state of the layout and its components as a serialisable object.
6430
- */
6431
- toConfig(): Config;
6432
-
6433
- /**
6434
- * Returns a component that was previously registered with layout.registerComponent().
6435
- * @param name The name of a previously registered component
6436
- */
6437
- getComponent(name: string): any;
6438
-
6439
- /**
6440
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6441
- * @param width The outer width the layout should be resized to. Default: The container elements width
6442
- * @param height The outer height the layout should be resized to. Default: The container elements height
6443
- */
6444
- updateSize(width?: number, height?: number): void;
6445
-
6446
- /**
6447
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6448
- * listeners and finally removes itself from the DOM.
6449
- */
6450
- destroy(): void;
6451
-
6452
- /**
6453
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6454
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6455
- * all call this method implicitly.
6456
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6457
- * @param parent A parent item
6458
- */
6459
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6460
-
6461
- /**
6462
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6463
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6464
- * provided its config will be read, if config is provided, only the content key
6465
- * will be used
6466
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6467
- * place the window in another screen.
6468
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6469
- * when popIn is clicked
6470
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6471
- */
6472
- createPopout(
6473
- configOrContentItem: ItemConfigType | ContentItem,
6474
- dimensions: {
6475
- width: number;
6476
- height: number;
6477
- left: number;
6478
- top: number;
6479
- },
6480
- parentId?: string,
6481
- indexInParent?: number
6482
- ): void;
6483
-
6484
- /**
6485
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6486
- * where it turns into a contentItem.
6487
- * @param element The DOM element that will be turned into a dragSource
6488
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6489
- * @return the dragSource that was created. This can be used to remove the
6490
- * dragSource from the layout later.
6491
- */
6492
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6493
-
6494
- /**
6495
- * Removes a dragSource from the layout.
6496
- *
6497
- * @param dragSource The dragSource to remove
6498
- */
6499
- removeDragSource(dragSource: DragSource): void;
6500
-
6501
- /**
6502
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6503
- * @param contentItem A ContentItem instance
6504
- */
6505
- selectItem(contentItem: ContentItem): void;
6506
-
6507
- /**
6508
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6509
- * and replace frequent keys and values with single letter substitutes.
6510
- * @param config A GoldenLayout configuration object
6511
- */
6512
- static minifyConfig(config: any): any;
6513
-
6514
- /**
6515
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6516
- * @param minifiedConfig A minified GoldenLayout configuration object
6517
- */
6518
- static unminifyConfig(minifiedConfig: any): any;
6519
-
6520
- /**
6521
- * Subscribe to an event
6522
- * @param eventName The name of the event to describe to
6523
- * @param callback The function that should be invoked when the event occurs
6524
- * @param context The value of the this pointer in the callback function
6525
- */
6526
- on(eventName: string, callback: Function, context?: any): void;
6527
-
6528
- /**
6529
- * Notify listeners of an event and pass arguments along
6530
- * @param eventName The name of the event to emit
6531
- */
6532
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6533
-
6534
- /**
6535
- * Alias for emit
6536
- */
6537
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6538
-
6539
- /**
6540
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6541
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6542
- * arguments.
6543
- * @param eventName The name of the event to unsubscribe from
6544
- * @param callback The function that should be invoked when the event occurs
6545
- * @param context The value of the this pointer in the callback function
6546
- */
6547
- unbind(eventName: string, callback?: Function, context?: any): void;
6548
-
6549
- /**
6550
- * Alias for unbind
6551
- */
6552
- off(eventName: string, callback?: Function, context?: any): void;
6553
-
6554
- /**
6555
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6556
- */
6557
- _$createRootItemAreas(): void;
6558
- }
6559
-
6560
5875
  /**
6561
5876
  * @interface
6562
5877
  */
@@ -6564,62 +5879,6 @@ declare type GpuInfo = {
6564
5879
  name: string;
6565
5880
  };
6566
5881
 
6567
- declare interface Header {
6568
- /**
6569
- * A reference to the LayoutManager instance
6570
- */
6571
- layoutManager: GoldenLayout_2;
6572
-
6573
- /**
6574
- * A reference to the Stack this Header belongs to
6575
- */
6576
- parent: ContentItem;
6577
-
6578
- /**
6579
- * An array of the Tabs within this header
6580
- */
6581
- tabs: Tab[];
6582
-
6583
- /**
6584
- * The currently selected activeContentItem
6585
- */
6586
- activeContentItem: ContentItem;
6587
-
6588
- /**
6589
- * The outer (jQuery) DOM element of this Header
6590
- */
6591
- element: JQuery;
6592
-
6593
- /**
6594
- * The (jQuery) DOM element containing the tabs
6595
- */
6596
- tabsContainer: JQuery;
6597
-
6598
- /**
6599
- * The (jQuery) DOM element containing the close, maximise and popout button
6600
- */
6601
- controlsContainer: JQuery;
6602
-
6603
- /**
6604
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6605
- * @param contentItem The content item that will be selected
6606
- */
6607
- setActiveContentItem(contentItem: ContentItem): void;
6608
-
6609
- /**
6610
- * Creates a new tab and associates it with a content item
6611
- * @param contentItem The content item the tab will be associated with
6612
- * @param index A zero based index, specifying the position of the new tab
6613
- */
6614
- createTab(contentItem: ContentItem, index?: number): void;
6615
-
6616
- /**
6617
- * Finds a tab by its contentItem and removes it
6618
- * @param contentItem The content item the tab is associated with
6619
- */
6620
- removeTab(contentItem: ContentItem): void;
6621
- }
6622
-
6623
5882
  /**
6624
5883
  * Generated when a View is hidden.
6625
5884
  * @interface
@@ -8335,50 +7594,6 @@ declare class InteropModule extends Base {
8335
7594
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8336
7595
  }
8337
7596
 
8338
- declare interface ItemConfig {
8339
- /**
8340
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8341
- */
8342
- type: ItemType;
8343
-
8344
- /**
8345
- * An array of configurations for items that will be created as children of this item.
8346
- */
8347
- content?: ItemConfigType[];
8348
-
8349
- /**
8350
- * The width of this item, relative to the other children of its parent in percent
8351
- */
8352
- width?: number;
8353
-
8354
- /**
8355
- * The height of this item, relative to the other children of its parent in percent
8356
- */
8357
- height?: number;
8358
-
8359
- /**
8360
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8361
- */
8362
- id?: string | string[];
8363
-
8364
- /**
8365
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8366
- * will return false
8367
- * Default: true
8368
- */
8369
- isClosable?: boolean;
8370
-
8371
- /**
8372
- * The title of the item as displayed on its tab and on popout windows
8373
- * Default: componentName or ''
8374
- */
8375
- title?: string;
8376
- }
8377
-
8378
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8379
-
8380
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8381
-
8382
7597
  /**
8383
7598
  * @interface
8384
7599
  */
@@ -8436,32 +7651,6 @@ declare type JumpListTask = {
8436
7651
  iconIndex?: number;
8437
7652
  };
8438
7653
 
8439
- declare interface Labels {
8440
- /**
8441
- * The tooltip text that appears when hovering over the close icon.
8442
- * Default: 'close'
8443
- */
8444
- close?: string;
8445
-
8446
- /**
8447
- * The tooltip text that appears when hovering over the maximise icon.
8448
- * Default: 'maximise'
8449
- */
8450
- maximise?: string;
8451
-
8452
- /**
8453
- * The tooltip text that appears when hovering over the minimise icon.
8454
- * Default: 'minimise'
8455
- */
8456
- minimise?: string;
8457
-
8458
- /**
8459
- * The tooltip text that appears when hovering over the popout icon.
8460
- * Default: 'open in new window'
8461
- */
8462
- popout?: string;
8463
- }
8464
-
8465
7654
  /**
8466
7655
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8467
7656
  *
@@ -8893,7 +8082,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8893
8082
  entityId: string;
8894
8083
  };
8895
8084
 
8896
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
8085
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8897
8086
 
8898
8087
  /**
8899
8088
  * @interface
@@ -13088,18 +12277,6 @@ declare type QueryPermissionResult = {
13088
12277
  rawValue?: unknown;
13089
12278
  };
13090
12279
 
13091
- declare interface ReactComponentConfig extends ItemConfig {
13092
- /**
13093
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
13094
- */
13095
- component: string;
13096
-
13097
- /**
13098
- * Properties that will be passed to the component and accessible using this.props.
13099
- */
13100
- props?: any;
13101
- }
13102
-
13103
12280
  /**
13104
12281
  * @interface
13105
12282
  */
@@ -13606,97 +12783,6 @@ declare type SessionContextGroup = {
13606
12783
  }>;
13607
12784
  };
13608
12785
 
13609
- declare interface Settings {
13610
- preventSplitterResize?: boolean;
13611
-
13612
- newTabButton?: {
13613
- url?: string;
13614
- };
13615
-
13616
- /**
13617
- * If true, tabs can't be dragged into the window.
13618
- * Default: false
13619
- */
13620
- preventDragIn?: boolean;
13621
-
13622
- /**
13623
- * If true, tabs can't be dragged out of the window.
13624
- * Default: false
13625
- */
13626
- preventDragOut?: boolean;
13627
-
13628
- /**
13629
- * If true, stack headers are the only areas where tabs can be dropped.
13630
- * Default: false
13631
- */
13632
- constrainDragToHeaders?: boolean;
13633
- /**
13634
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13635
- * Default: true
13636
- */
13637
- hasHeaders?: boolean;
13638
-
13639
- /**
13640
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13641
- * automatically when layout.createDragSource() is called.
13642
- * Default: true
13643
- */
13644
- constrainDragToContainer?: boolean;
13645
-
13646
- /**
13647
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13648
- * Default: true
13649
- */
13650
- reorderEnabled?: boolean;
13651
-
13652
- /**
13653
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13654
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13655
- * Default: false
13656
- */
13657
- selectionEnabled?: boolean;
13658
-
13659
- /**
13660
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13661
- * be transferred to the new window, if false only the active component will be opened.
13662
- * Default: false
13663
- */
13664
- popoutWholeStack?: boolean;
13665
-
13666
- /**
13667
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13668
- * If false, the popout call will fail silently.
13669
- * Default: true
13670
- */
13671
- blockedPopoutsThrowError?: boolean;
13672
-
13673
- /**
13674
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13675
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13676
- * addition, any changes made to popouts won't be stored after the parent is closed.
13677
- * Default: true
13678
- */
13679
- closePopoutsOnUnload?: boolean;
13680
-
13681
- /**
13682
- * Specifies if the popout icon should be displayed in the header-bar.
13683
- * Default: true
13684
- */
13685
- showPopoutIcon?: boolean;
13686
-
13687
- /**
13688
- * Specifies if the maximise icon should be displayed in the header-bar.
13689
- * Default: true
13690
- */
13691
- showMaximiseIcon?: boolean;
13692
-
13693
- /**
13694
- * Specifies if the close icon should be displayed in the header-bar.
13695
- * Default: true
13696
- */
13697
- showCloseIcon?: boolean;
13698
- }
13699
-
13700
12786
  /**
13701
12787
  * @interface
13702
12788
  */
@@ -15605,59 +14691,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15605
14691
  proceed: () => void;
15606
14692
  }) => void;
15607
14693
 
15608
- declare interface Tab {
15609
- _dragListener: TabDragListener;
15610
-
15611
- /**
15612
- * True if this tab is the selected tab
15613
- */
15614
- isActive: boolean;
15615
-
15616
- /**
15617
- * A reference to the header this tab is a child of
15618
- */
15619
- header: Header;
15620
-
15621
- /**
15622
- * A reference to the content item this tab relates to
15623
- */
15624
- contentItem: ContentItem;
15625
-
15626
- /**
15627
- * The tabs outer (jQuery) DOM element
15628
- */
15629
- element: JQuery;
15630
-
15631
- /**
15632
- * The (jQuery) DOM element containing the title
15633
- */
15634
- titleElement: JQuery;
15635
-
15636
- /**
15637
- * The (jQuery) DOM element that closes the tab
15638
- */
15639
- closeElement: JQuery;
15640
-
15641
- /**
15642
- * Sets the tab's title. Does not affect the contentItem's title!
15643
- * @param title The new title
15644
- */
15645
- setTitle(title: string): void;
15646
-
15647
- /**
15648
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15649
- * @param isActive Whether the tab is active
15650
- */
15651
- setActive(isActive: boolean): void;
15652
- }
15653
-
15654
- declare interface TabDragListener extends EventEmitter_2 {
15655
- /**
15656
- * A reference to the content item this tab relates to
15657
- */
15658
- contentItem: ContentItem;
15659
- }
15660
-
15661
14694
  /**
15662
14695
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15663
14696
  */