@openfin/remote-adapter 36.80.11 → 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.
@@ -1178,9 +1178,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1178
1178
  */
1179
1179
  mainWindowOptions: WindowCreationOptions;
1180
1180
  /**
1181
- * The name of the application (and the application's main window).
1181
+ * The name of the application.
1182
1182
  *
1183
- * If provided, _must_ match `uuid`.
1183
+ * @remarks
1184
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1185
+ * any special characters, spaces or international characters. It's also used in error messages, API
1186
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1187
+ *
1188
+ * This property will be deprecated in the future.
1184
1189
  */
1185
1190
  name: string;
1186
1191
  /**
@@ -1210,9 +1215,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1210
1215
  url: string;
1211
1216
  /**
1212
1217
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1213
- * running in the OpenFin Runtime.
1214
- *
1215
- * Note that `name` and `uuid` must match.
1218
+ * running in the OpenFin Runtime.
1216
1219
  */
1217
1220
  uuid: string;
1218
1221
  /**
@@ -1975,48 +1978,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1975
1978
  behavior: 'browser';
1976
1979
  };
1977
1980
 
1978
- declare interface BrowserWindow {
1979
- /**
1980
- * True if the window has been opened and its GoldenLayout instance initialised.
1981
- */
1982
- isInitialised: boolean;
1983
-
1984
- /**
1985
- * Creates a window configuration object from the Popout.
1986
- */
1987
- toConfig(): {
1988
- dimensions: {
1989
- width: number;
1990
- height: number;
1991
- left: number;
1992
- top: number;
1993
- };
1994
- content: Config;
1995
- parentId: string;
1996
- indexInParent: number;
1997
- };
1998
-
1999
- /**
2000
- * Returns the GoldenLayout instance from the child window
2001
- */
2002
- getGlInstance(): GoldenLayout_2;
2003
-
2004
- /**
2005
- * Returns the native Window object
2006
- */
2007
- getWindow(): Window;
2008
-
2009
- /**
2010
- * Closes the popout
2011
- */
2012
- close(): void;
2013
-
2014
- /**
2015
- * Returns the popout to its original position as specified in parentId and indexInParent
2016
- */
2017
- popIn(): void;
2018
- }
2019
-
2020
1981
  /**
2021
1982
  * Extracts a single event type matching the given key from the View {@link Event} union.
2022
1983
  *
@@ -3436,31 +3397,6 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3436
3397
  close(): Promise<void>;
3437
3398
  }
3438
3399
 
3439
- declare interface ComponentConfig extends ItemConfig {
3440
- /**
3441
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3442
- */
3443
- componentName: string;
3444
-
3445
- /**
3446
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3447
- * container.getState().
3448
- */
3449
- componentState?: any;
3450
- }
3451
-
3452
- declare interface Config {
3453
- settings?: Settings;
3454
- dimensions?: Dimensions;
3455
- labels?: Labels;
3456
- content?: ItemConfigType[];
3457
- /**
3458
- * (Only on layout config object)
3459
- * Id of the currently maximised content item
3460
- */
3461
- maximisedItemId?: string;
3462
- }
3463
-
3464
3400
  declare type ConfigWithRuntime = BaseConfig & {
3465
3401
  runtime: RuntimeConfig;
3466
3402
  };
@@ -3862,103 +3798,6 @@ declare type ConstWindowOptions = {
3862
3798
  inheritance?: Partial<InheritableOptions>;
3863
3799
  };
3864
3800
 
3865
- declare interface Container extends EventEmitter_2 {
3866
- /**
3867
- * The current width of the container in pixel
3868
- */
3869
- width: number;
3870
-
3871
- /**
3872
- * The current height of the container in pixel
3873
- */
3874
- height: number;
3875
-
3876
- /**
3877
- * A reference to the component-item that controls this container
3878
- */
3879
- parent: ContentItem;
3880
-
3881
- /**
3882
- * A reference to the tab that controls this container. Will initially be null
3883
- * (and populated once a tab event has been fired).
3884
- */
3885
- tab: Tab;
3886
-
3887
- /**
3888
- * The current title of the container
3889
- */
3890
- title: string;
3891
-
3892
- /*
3893
- * A reference to the GoldenLayout instance this container belongs to
3894
- */
3895
- layoutManager: GoldenLayout_2;
3896
-
3897
- /**
3898
- * True if the item is currently hidden
3899
- */
3900
- isHidden: boolean;
3901
-
3902
- /**
3903
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3904
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3905
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3906
- * constructor function. It will also be used when the component is opened in a new window.
3907
- * @param state A serialisable object
3908
- */
3909
- setState(state: any): void;
3910
-
3911
- /**
3912
- * The same as setState but does not emit 'stateChanged' event
3913
- * @param {serialisable} state
3914
- */
3915
- setStateSkipEvent(state: any): void;
3916
-
3917
- /**
3918
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3919
- * @param state A serialisable object
3920
- */
3921
- extendState(state: any): void;
3922
-
3923
- /**
3924
- * Returns the current state.
3925
- */
3926
- getState(): any;
3927
-
3928
- /**
3929
- * Returns the container's inner element as a jQuery element
3930
- */
3931
- getElement(): JQuery;
3932
-
3933
- /**
3934
- * hides the container or returns false if hiding it is not possible
3935
- */
3936
- hide(): boolean;
3937
-
3938
- /**
3939
- * shows the container or returns false if showing it is not possible
3940
- */
3941
- show(): boolean;
3942
-
3943
- /**
3944
- * Sets the container to the specified size or returns false if that's not possible
3945
- * @param width the new width in pixel
3946
- * @param height the new height in pixel
3947
- */
3948
- setSize(width: number, height: number): boolean;
3949
-
3950
- /**
3951
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3952
- * @param title the new title
3953
- */
3954
- setTitle(title: string): void;
3955
-
3956
- /**
3957
- * Closes the container or returns false if that is not possible
3958
- */
3959
- close(): boolean;
3960
- }
3961
-
3962
3801
  declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3963
3802
 
3964
3803
  /**
@@ -4021,218 +3860,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
4021
3860
  disposition: string;
4022
3861
  };
4023
3862
 
4024
- declare interface ContentItem extends EventEmitter_2 {
4025
- instance: any;
4026
- header: any;
4027
- _splitter: any;
4028
- /**
4029
- * This items configuration in its current state
4030
- */
4031
- config: ItemConfigType;
4032
-
4033
- /**
4034
- * The type of the item. Can be row, column, stack, component or root
4035
- */
4036
- type: ItemType;
4037
-
4038
- /**
4039
- * An array of items that are children of this item
4040
- */
4041
- contentItems: ContentItem[];
4042
-
4043
- container: Container;
4044
- /**
4045
- * The item that is this item's parent (or null if the item is root)
4046
- */
4047
- parent: ContentItem;
4048
-
4049
- /**
4050
- * A String or array of identifiers if provided in the configuration
4051
- */
4052
- id: string;
4053
-
4054
- /**
4055
- * True if the item had been initialised
4056
- */
4057
- isInitialised: boolean;
4058
-
4059
- /**
4060
- * True if the item is maximised
4061
- */
4062
- isMaximised: boolean;
4063
-
4064
- /**
4065
- * True if the item is the layout's root item
4066
- */
4067
- isRoot: boolean;
4068
-
4069
- /**
4070
- * True if the item is a row
4071
- */
4072
- isRow: boolean;
4073
-
4074
- /**
4075
- * True if the item is a column
4076
- */
4077
- isColumn: boolean;
4078
-
4079
- /**
4080
- * True if the item is a stack
4081
- */
4082
- isStack: boolean;
4083
-
4084
- /**
4085
- * True if the item is a component
4086
- */
4087
- isComponent: boolean;
4088
-
4089
- /**
4090
- * A reference to the layoutManager that controls this item
4091
- */
4092
- layoutManager: any;
4093
-
4094
- /**
4095
- * The item's outer element
4096
- */
4097
- element: JQuery;
4098
-
4099
- /**
4100
- * The item's inner element. Can be the same as the outer element.
4101
- */
4102
- childElementContainer: Container;
4103
-
4104
- /**
4105
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4106
- * from its original position before adding it to this item.
4107
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4108
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4109
- */
4110
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4111
-
4112
- /**
4113
- * Destroys the item and all it's children
4114
- * @param contentItem The contentItem that should be removed
4115
- * @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.
4116
- */
4117
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4118
-
4119
- /**
4120
- * The contentItem that should be removed
4121
- * @param oldChild ContentItem The contentItem that should be removed
4122
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4123
- */
4124
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4125
-
4126
- /**
4127
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4128
- */
4129
- setSize(): void;
4130
-
4131
- /**
4132
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4133
- * @param title the new title
4134
- */
4135
- setTitle(title: string): void;
4136
-
4137
- /**
4138
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4139
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4140
- * @param functionName The name of the method to invoke
4141
- * @param functionArguments An array of arguments to pass to every function
4142
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4143
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4144
- */
4145
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4146
-
4147
- /**
4148
- * 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.
4149
- */
4150
- emitBubblingEvent(name: string): void;
4151
-
4152
- /**
4153
- * Convenience method for item.parent.removeChild( item )
4154
- */
4155
- remove(): void;
4156
-
4157
- /**
4158
- * Removes the item from its current position in the layout and opens it in a window
4159
- */
4160
- popout(): BrowserWindow;
4161
-
4162
- /**
4163
- * Maximises the item or minimises it if it's already maximised
4164
- */
4165
- toggleMaximise(): void;
4166
-
4167
- /**
4168
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4169
- */
4170
- select(): void;
4171
-
4172
- /**
4173
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4174
- */
4175
- deselect(): void;
4176
-
4177
- /**
4178
- * Returns true if the item has the specified id or false if not
4179
- * @param id An id to check for
4180
- */
4181
- hasId(id: string): boolean;
4182
-
4183
- /**
4184
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4185
- * @param contentItem The new active content item
4186
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4187
- */
4188
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4189
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4190
-
4191
- /**
4192
- * Only Stacks have this method! Returns the currently selected contentItem.
4193
- */
4194
- getActiveContentItem(): ContentItem;
4195
-
4196
- /**
4197
- * Adds an id to an item or does nothing if the id is already present
4198
- * @param id The id to be added
4199
- */
4200
- addId(id: string): void;
4201
-
4202
- /**
4203
- * Removes an id from an item or throws an error if the id couldn't be found
4204
- * @param id The id to be removed
4205
- */
4206
- removeId(id: string): void;
4207
-
4208
- /**
4209
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4210
- * @param filterFunction A function that determines whether an item matches certain criteria
4211
- */
4212
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4213
-
4214
- /**
4215
- * Returns all items with the specified id.
4216
- * @param id An id specified in the itemConfig
4217
- */
4218
- getItemsById(id: string | string[]): ContentItem[];
4219
-
4220
- /**
4221
- * Returns all items with the specified type
4222
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4223
- */
4224
- getItemsByType(type: string): ContentItem[];
4225
-
4226
- /**
4227
- * Returns all instances of the component with the specified componentName
4228
- * @param componentName a componentName as specified in the itemConfig
4229
- */
4230
- getComponentsByName(componentName: string): any;
4231
-
4232
- _contentAreaDimensions: any;
4233
- _$getArea: () => any;
4234
- }
4235
-
4236
3863
  /**
4237
3864
  * Restrict navigation to URLs that match an allowed pattern.
4238
3865
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4717,46 +4344,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4717
4344
  type: 'did-finish-load';
4718
4345
  };
4719
4346
 
4720
- declare interface Dimensions {
4721
- /**
4722
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4723
- * than the visible one, making it safe to set this to small values without affecting usability.
4724
- * Default: 5
4725
- */
4726
- borderWidth?: number;
4727
-
4728
- /**
4729
- * The minimum height an item can be resized to (in pixel).
4730
- * Default: 10
4731
- */
4732
- minItemHeight?: number;
4733
-
4734
- /**
4735
- * The minimum width an item can be resized to (in pixel).
4736
- * Default: 10
4737
- */
4738
- minItemWidth?: number;
4739
-
4740
- /**
4741
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4742
- * adjusted accordingly.
4743
- * Default: 20
4744
- */
4745
- headerHeight?: number;
4746
-
4747
- /**
4748
- * The width of the element that appears when an item is dragged (in pixel).
4749
- * Default: 300
4750
- */
4751
- dragProxyWidth?: number;
4752
-
4753
- /**
4754
- * The height of the element that appears when an item is dragged (in pixel).
4755
- * Default: 200
4756
- */
4757
- dragProxyHeight?: number;
4758
- }
4759
-
4760
4347
  /**
4761
4348
  * @interface
4762
4349
  */
@@ -5053,8 +4640,6 @@ declare type Dpi = {
5053
4640
  vertical?: number;
5054
4641
  };
5055
4642
 
5056
- declare interface DragSource {}
5057
-
5058
4643
  /**
5059
4644
  * Generated when a window has been embedded.
5060
4645
  * @interface
@@ -5366,43 +4951,6 @@ declare class EventAggregator extends EmitterMap {
5366
4951
  dispatchEvent: (message: Message<any>) => boolean;
5367
4952
  }
5368
4953
 
5369
- declare interface EventEmitter_2 {
5370
- [x: string]: any;
5371
- /**
5372
- * Subscribe to an event
5373
- * @param eventName The name of the event to describe to
5374
- * @param callback The function that should be invoked when the event occurs
5375
- * @param context The value of the this pointer in the callback function
5376
- */
5377
- on(eventName: string, callback: Function, context?: any): void;
5378
-
5379
- /**
5380
- * Notify listeners of an event and pass arguments along
5381
- * @param eventName The name of the event to emit
5382
- */
5383
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5384
-
5385
- /**
5386
- * Alias for emit
5387
- */
5388
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5389
-
5390
- /**
5391
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5392
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5393
- * arguments.
5394
- * @param eventName The name of the event to unsubscribe from
5395
- * @param callback The function that should be invoked when the event occurs
5396
- * @param context The value of the this pointer in the callback function
5397
- */
5398
- unbind(eventName: string, callback?: Function, context?: any): void;
5399
-
5400
- /**
5401
- * Alias for unbind
5402
- */
5403
- off(eventName: string, callback?: Function, context?: any): void;
5404
- }
5405
-
5406
4954
  /**
5407
4955
  * Handler for an event on an EventEmitter.
5408
4956
  * @remarks Selects the correct type for the event
@@ -6237,239 +5785,6 @@ declare namespace GlobalHotkeyEvents {
6237
5785
  */
6238
5786
  declare type GlobalHotkeyEventType = EventType_6;
6239
5787
 
6240
- declare namespace GoldenLayout {
6241
- export {
6242
- GoldenLayout_2 as GoldenLayout,
6243
- ItemConfigType,
6244
- Settings,
6245
- Dimensions,
6246
- Labels,
6247
- ItemType,
6248
- ItemConfig,
6249
- ComponentConfig,
6250
- ReactComponentConfig,
6251
- Config,
6252
- ContentItem,
6253
- Container,
6254
- DragSource,
6255
- BrowserWindow,
6256
- Header,
6257
- TabDragListener,
6258
- Tab,
6259
- EventEmitter_2 as EventEmitter
6260
- }
6261
- }
6262
-
6263
- declare class GoldenLayout_2 implements EventEmitter_2 {
6264
- /**
6265
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6266
- * object and of goldenLayout.root as the document.
6267
- */
6268
- root: ContentItem;
6269
-
6270
- /**
6271
- * A reference to the (jQuery) DOM element containing the layout
6272
- */
6273
- container: JQuery;
6274
-
6275
- /**
6276
- * True once the layout item tree has been created and the initialised event has been fired
6277
- */
6278
- isInitialised: boolean;
6279
-
6280
- /**
6281
- * A reference to the current, extended top level config.
6282
- *
6283
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6284
- */
6285
- config: Config;
6286
-
6287
- /**
6288
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6289
- * to true.
6290
- */
6291
- selectedItem: ContentItem;
6292
-
6293
- /**
6294
- * The current outer width of the layout in pixels.
6295
- */
6296
- width: number;
6297
-
6298
- /**
6299
- * The current outer height of the layout in pixels.
6300
- */
6301
- height: number;
6302
-
6303
- /**
6304
- * An array of BrowserWindow instances
6305
- */
6306
- openPopouts: BrowserWindow[];
6307
-
6308
- /**
6309
- * True if the layout has been opened as a popout by another layout.
6310
- */
6311
- isSubWindow: boolean;
6312
-
6313
- /**
6314
- * A singleton instance of EventEmitter that works across windows
6315
- */
6316
- eventHub: EventEmitter_2;
6317
-
6318
- _dragProxy: any;
6319
-
6320
- dropTargetIndicator: any;
6321
-
6322
- /**
6323
- * @param config A GoldenLayout configuration object
6324
- * @param container The DOM element the layout will be initialised in. Default: document.body
6325
- */
6326
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6327
-
6328
- /*
6329
- * @param name The name of the component, as referred to by componentName in the component configuration.
6330
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6331
- * containerobject and a component state
6332
- */
6333
- registerComponent(name: String, component: any): void;
6334
-
6335
- /**
6336
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6337
- * a listener to the document and executes once it becomes ready.
6338
- */
6339
- init(): void;
6340
-
6341
- /**
6342
- * Returns the current state of the layout and its components as a serialisable object.
6343
- */
6344
- toConfig(): Config;
6345
-
6346
- /**
6347
- * Returns a component that was previously registered with layout.registerComponent().
6348
- * @param name The name of a previously registered component
6349
- */
6350
- getComponent(name: string): any;
6351
-
6352
- /**
6353
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6354
- * @param width The outer width the layout should be resized to. Default: The container elements width
6355
- * @param height The outer height the layout should be resized to. Default: The container elements height
6356
- */
6357
- updateSize(width?: number, height?: number): void;
6358
-
6359
- /**
6360
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6361
- * listeners and finally removes itself from the DOM.
6362
- */
6363
- destroy(): void;
6364
-
6365
- /**
6366
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6367
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6368
- * all call this method implicitly.
6369
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6370
- * @param parent A parent item
6371
- */
6372
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6373
-
6374
- /**
6375
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6376
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6377
- * provided its config will be read, if config is provided, only the content key
6378
- * will be used
6379
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6380
- * place the window in another screen.
6381
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6382
- * when popIn is clicked
6383
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6384
- */
6385
- createPopout(
6386
- configOrContentItem: ItemConfigType | ContentItem,
6387
- dimensions: {
6388
- width: number;
6389
- height: number;
6390
- left: number;
6391
- top: number;
6392
- },
6393
- parentId?: string,
6394
- indexInParent?: number
6395
- ): void;
6396
-
6397
- /**
6398
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6399
- * where it turns into a contentItem.
6400
- * @param element The DOM element that will be turned into a dragSource
6401
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6402
- * @return the dragSource that was created. This can be used to remove the
6403
- * dragSource from the layout later.
6404
- */
6405
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6406
-
6407
- /**
6408
- * Removes a dragSource from the layout.
6409
- *
6410
- * @param dragSource The dragSource to remove
6411
- */
6412
- removeDragSource(dragSource: DragSource): void;
6413
-
6414
- /**
6415
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6416
- * @param contentItem A ContentItem instance
6417
- */
6418
- selectItem(contentItem: ContentItem): void;
6419
-
6420
- /**
6421
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6422
- * and replace frequent keys and values with single letter substitutes.
6423
- * @param config A GoldenLayout configuration object
6424
- */
6425
- static minifyConfig(config: any): any;
6426
-
6427
- /**
6428
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6429
- * @param minifiedConfig A minified GoldenLayout configuration object
6430
- */
6431
- static unminifyConfig(minifiedConfig: any): any;
6432
-
6433
- /**
6434
- * Subscribe to an event
6435
- * @param eventName The name of the event to describe to
6436
- * @param callback The function that should be invoked when the event occurs
6437
- * @param context The value of the this pointer in the callback function
6438
- */
6439
- on(eventName: string, callback: Function, context?: any): void;
6440
-
6441
- /**
6442
- * Notify listeners of an event and pass arguments along
6443
- * @param eventName The name of the event to emit
6444
- */
6445
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6446
-
6447
- /**
6448
- * Alias for emit
6449
- */
6450
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6451
-
6452
- /**
6453
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6454
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6455
- * arguments.
6456
- * @param eventName The name of the event to unsubscribe from
6457
- * @param callback The function that should be invoked when the event occurs
6458
- * @param context The value of the this pointer in the callback function
6459
- */
6460
- unbind(eventName: string, callback?: Function, context?: any): void;
6461
-
6462
- /**
6463
- * Alias for unbind
6464
- */
6465
- off(eventName: string, callback?: Function, context?: any): void;
6466
-
6467
- /**
6468
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6469
- */
6470
- _$createRootItemAreas(): void;
6471
- }
6472
-
6473
5788
  /**
6474
5789
  * @interface
6475
5790
  */
@@ -6477,62 +5792,6 @@ declare type GpuInfo = {
6477
5792
  name: string;
6478
5793
  };
6479
5794
 
6480
- declare interface Header {
6481
- /**
6482
- * A reference to the LayoutManager instance
6483
- */
6484
- layoutManager: GoldenLayout_2;
6485
-
6486
- /**
6487
- * A reference to the Stack this Header belongs to
6488
- */
6489
- parent: ContentItem;
6490
-
6491
- /**
6492
- * An array of the Tabs within this header
6493
- */
6494
- tabs: Tab[];
6495
-
6496
- /**
6497
- * The currently selected activeContentItem
6498
- */
6499
- activeContentItem: ContentItem;
6500
-
6501
- /**
6502
- * The outer (jQuery) DOM element of this Header
6503
- */
6504
- element: JQuery;
6505
-
6506
- /**
6507
- * The (jQuery) DOM element containing the tabs
6508
- */
6509
- tabsContainer: JQuery;
6510
-
6511
- /**
6512
- * The (jQuery) DOM element containing the close, maximise and popout button
6513
- */
6514
- controlsContainer: JQuery;
6515
-
6516
- /**
6517
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6518
- * @param contentItem The content item that will be selected
6519
- */
6520
- setActiveContentItem(contentItem: ContentItem): void;
6521
-
6522
- /**
6523
- * Creates a new tab and associates it with a content item
6524
- * @param contentItem The content item the tab will be associated with
6525
- * @param index A zero based index, specifying the position of the new tab
6526
- */
6527
- createTab(contentItem: ContentItem, index?: number): void;
6528
-
6529
- /**
6530
- * Finds a tab by its contentItem and removes it
6531
- * @param contentItem The content item the tab is associated with
6532
- */
6533
- removeTab(contentItem: ContentItem): void;
6534
- }
6535
-
6536
5795
  /**
6537
5796
  * Generated when a View is hidden.
6538
5797
  * @interface
@@ -8222,50 +7481,6 @@ declare class InteropModule extends Base {
8222
7481
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8223
7482
  }
8224
7483
 
8225
- declare interface ItemConfig {
8226
- /**
8227
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8228
- */
8229
- type: ItemType;
8230
-
8231
- /**
8232
- * An array of configurations for items that will be created as children of this item.
8233
- */
8234
- content?: ItemConfigType[];
8235
-
8236
- /**
8237
- * The width of this item, relative to the other children of its parent in percent
8238
- */
8239
- width?: number;
8240
-
8241
- /**
8242
- * The height of this item, relative to the other children of its parent in percent
8243
- */
8244
- height?: number;
8245
-
8246
- /**
8247
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8248
- */
8249
- id?: string | string[];
8250
-
8251
- /**
8252
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8253
- * will return false
8254
- * Default: true
8255
- */
8256
- isClosable?: boolean;
8257
-
8258
- /**
8259
- * The title of the item as displayed on its tab and on popout windows
8260
- * Default: componentName or ''
8261
- */
8262
- title?: string;
8263
- }
8264
-
8265
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8266
-
8267
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8268
-
8269
7484
  /**
8270
7485
  * @interface
8271
7486
  */
@@ -8323,32 +7538,6 @@ declare type JumpListTask = {
8323
7538
  iconIndex?: number;
8324
7539
  };
8325
7540
 
8326
- declare interface Labels {
8327
- /**
8328
- * The tooltip text that appears when hovering over the close icon.
8329
- * Default: 'close'
8330
- */
8331
- close?: string;
8332
-
8333
- /**
8334
- * The tooltip text that appears when hovering over the maximise icon.
8335
- * Default: 'maximise'
8336
- */
8337
- maximise?: string;
8338
-
8339
- /**
8340
- * The tooltip text that appears when hovering over the minimise icon.
8341
- * Default: 'minimise'
8342
- */
8343
- minimise?: string;
8344
-
8345
- /**
8346
- * The tooltip text that appears when hovering over the popout icon.
8347
- * Default: 'open in new window'
8348
- */
8349
- popout?: string;
8350
- }
8351
-
8352
7541
  /**
8353
7542
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8354
7543
  *
@@ -8774,7 +7963,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8774
7963
  entityId: string;
8775
7964
  };
8776
7965
 
8777
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7966
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8778
7967
 
8779
7968
  /**
8780
7969
  * @interface
@@ -12699,18 +11888,6 @@ declare type QueryPermissionResult = {
12699
11888
  rawValue?: unknown;
12700
11889
  };
12701
11890
 
12702
- declare interface ReactComponentConfig extends ItemConfig {
12703
- /**
12704
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12705
- */
12706
- component: string;
12707
-
12708
- /**
12709
- * Properties that will be passed to the component and accessible using this.props.
12710
- */
12711
- props?: any;
12712
- }
12713
-
12714
11891
  /**
12715
11892
  * @interface
12716
11893
  */
@@ -13217,97 +12394,6 @@ declare type SessionContextGroup = {
13217
12394
  }>;
13218
12395
  };
13219
12396
 
13220
- declare interface Settings {
13221
- preventSplitterResize?: boolean;
13222
-
13223
- newTabButton?: {
13224
- url?: string;
13225
- };
13226
-
13227
- /**
13228
- * If true, tabs can't be dragged into the window.
13229
- * Default: false
13230
- */
13231
- preventDragIn?: boolean;
13232
-
13233
- /**
13234
- * If true, tabs can't be dragged out of the window.
13235
- * Default: false
13236
- */
13237
- preventDragOut?: boolean;
13238
-
13239
- /**
13240
- * If true, stack headers are the only areas where tabs can be dropped.
13241
- * Default: false
13242
- */
13243
- constrainDragToHeaders?: boolean;
13244
- /**
13245
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13246
- * Default: true
13247
- */
13248
- hasHeaders?: boolean;
13249
-
13250
- /**
13251
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13252
- * automatically when layout.createDragSource() is called.
13253
- * Default: true
13254
- */
13255
- constrainDragToContainer?: boolean;
13256
-
13257
- /**
13258
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13259
- * Default: true
13260
- */
13261
- reorderEnabled?: boolean;
13262
-
13263
- /**
13264
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13265
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13266
- * Default: false
13267
- */
13268
- selectionEnabled?: boolean;
13269
-
13270
- /**
13271
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13272
- * be transferred to the new window, if false only the active component will be opened.
13273
- * Default: false
13274
- */
13275
- popoutWholeStack?: boolean;
13276
-
13277
- /**
13278
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13279
- * If false, the popout call will fail silently.
13280
- * Default: true
13281
- */
13282
- blockedPopoutsThrowError?: boolean;
13283
-
13284
- /**
13285
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13286
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13287
- * addition, any changes made to popouts won't be stored after the parent is closed.
13288
- * Default: true
13289
- */
13290
- closePopoutsOnUnload?: boolean;
13291
-
13292
- /**
13293
- * Specifies if the popout icon should be displayed in the header-bar.
13294
- * Default: true
13295
- */
13296
- showPopoutIcon?: boolean;
13297
-
13298
- /**
13299
- * Specifies if the maximise icon should be displayed in the header-bar.
13300
- * Default: true
13301
- */
13302
- showMaximiseIcon?: boolean;
13303
-
13304
- /**
13305
- * Specifies if the close icon should be displayed in the header-bar.
13306
- * Default: true
13307
- */
13308
- showCloseIcon?: boolean;
13309
- }
13310
-
13311
12397
  /**
13312
12398
  * @interface
13313
12399
  */
@@ -15204,59 +14290,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15204
14290
  proceed: () => void;
15205
14291
  }) => void;
15206
14292
 
15207
- declare interface Tab {
15208
- _dragListener: TabDragListener;
15209
-
15210
- /**
15211
- * True if this tab is the selected tab
15212
- */
15213
- isActive: boolean;
15214
-
15215
- /**
15216
- * A reference to the header this tab is a child of
15217
- */
15218
- header: Header;
15219
-
15220
- /**
15221
- * A reference to the content item this tab relates to
15222
- */
15223
- contentItem: ContentItem;
15224
-
15225
- /**
15226
- * The tabs outer (jQuery) DOM element
15227
- */
15228
- element: JQuery;
15229
-
15230
- /**
15231
- * The (jQuery) DOM element containing the title
15232
- */
15233
- titleElement: JQuery;
15234
-
15235
- /**
15236
- * The (jQuery) DOM element that closes the tab
15237
- */
15238
- closeElement: JQuery;
15239
-
15240
- /**
15241
- * Sets the tab's title. Does not affect the contentItem's title!
15242
- * @param title The new title
15243
- */
15244
- setTitle(title: string): void;
15245
-
15246
- /**
15247
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15248
- * @param isActive Whether the tab is active
15249
- */
15250
- setActive(isActive: boolean): void;
15251
- }
15252
-
15253
- declare interface TabDragListener extends EventEmitter_2 {
15254
- /**
15255
- * A reference to the content item this tab relates to
15256
- */
15257
- contentItem: ContentItem;
15258
- }
15259
-
15260
14293
  /**
15261
14294
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15262
14295
  */