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