@openfin/core 38.81.31 → 38.81.34

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/out/mock.d.ts CHANGED
@@ -1167,9 +1167,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1167
1167
  */
1168
1168
  mainWindowOptions: WindowCreationOptions;
1169
1169
  /**
1170
- * The name of the application (and the application's main window).
1170
+ * The name of the application.
1171
1171
  *
1172
- * If provided, _must_ match `uuid`.
1172
+ * @remarks
1173
+ * This property is only used for naming the application logging folder, which will be sanitized to remove
1174
+ * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1175
+ * during startup with the UUID of the application.
1176
+ *
1177
+ * This property will be deprecated in the future.
1173
1178
  */
1174
1179
  name: string;
1175
1180
  /**
@@ -1199,9 +1204,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1199
1204
  url: string;
1200
1205
  /**
1201
1206
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1202
- * running in the OpenFin Runtime.
1203
- *
1204
- * Note that `name` and `uuid` must match.
1207
+ * running in the OpenFin Runtime.
1205
1208
  */
1206
1209
  uuid: string;
1207
1210
  /**
@@ -1936,48 +1939,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1936
1939
  behavior: 'browser';
1937
1940
  };
1938
1941
 
1939
- declare interface BrowserWindow {
1940
- /**
1941
- * True if the window has been opened and its GoldenLayout instance initialised.
1942
- */
1943
- isInitialised: boolean;
1944
-
1945
- /**
1946
- * Creates a window configuration object from the Popout.
1947
- */
1948
- toConfig(): {
1949
- dimensions: {
1950
- width: number;
1951
- height: number;
1952
- left: number;
1953
- top: number;
1954
- };
1955
- content: Config;
1956
- parentId: string;
1957
- indexInParent: number;
1958
- };
1959
-
1960
- /**
1961
- * Returns the GoldenLayout instance from the child window
1962
- */
1963
- getGlInstance(): GoldenLayout_2;
1964
-
1965
- /**
1966
- * Returns the native Window object
1967
- */
1968
- getWindow(): Window;
1969
-
1970
- /**
1971
- * Closes the popout
1972
- */
1973
- close(): void;
1974
-
1975
- /**
1976
- * Returns the popout to its original position as specified in parentId and indexInParent
1977
- */
1978
- popIn(): void;
1979
- }
1980
-
1981
1942
  /**
1982
1943
  * Extracts a single event type matching the given key from the View {@link Event} union.
1983
1944
  *
@@ -3385,31 +3346,6 @@ declare class ColumnOrRow extends LayoutNode {
3385
3346
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3386
3347
  }
3387
3348
 
3388
- declare interface ComponentConfig extends ItemConfig {
3389
- /**
3390
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3391
- */
3392
- componentName: string;
3393
-
3394
- /**
3395
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3396
- * container.getState().
3397
- */
3398
- componentState?: any;
3399
- }
3400
-
3401
- declare interface Config {
3402
- settings?: Settings;
3403
- dimensions?: Dimensions;
3404
- labels?: Labels;
3405
- content?: ItemConfigType[];
3406
- /**
3407
- * (Only on layout config object)
3408
- * Id of the currently maximised content item
3409
- */
3410
- maximisedItemId?: string;
3411
- }
3412
-
3413
3349
  declare type ConfigWithRuntime = BaseConfig & {
3414
3350
  runtime: RuntimeConfig;
3415
3351
  };
@@ -3801,103 +3737,6 @@ declare type ConstWindowOptions = {
3801
3737
  inheritance?: Partial<InheritableOptions>;
3802
3738
  };
3803
3739
 
3804
- declare interface Container extends EventEmitter_2 {
3805
- /**
3806
- * The current width of the container in pixel
3807
- */
3808
- width: number;
3809
-
3810
- /**
3811
- * The current height of the container in pixel
3812
- */
3813
- height: number;
3814
-
3815
- /**
3816
- * A reference to the component-item that controls this container
3817
- */
3818
- parent: ContentItem;
3819
-
3820
- /**
3821
- * A reference to the tab that controls this container. Will initially be null
3822
- * (and populated once a tab event has been fired).
3823
- */
3824
- tab: Tab;
3825
-
3826
- /**
3827
- * The current title of the container
3828
- */
3829
- title: string;
3830
-
3831
- /*
3832
- * A reference to the GoldenLayout instance this container belongs to
3833
- */
3834
- layoutManager: GoldenLayout_2;
3835
-
3836
- /**
3837
- * True if the item is currently hidden
3838
- */
3839
- isHidden: boolean;
3840
-
3841
- /**
3842
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3843
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3844
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3845
- * constructor function. It will also be used when the component is opened in a new window.
3846
- * @param state A serialisable object
3847
- */
3848
- setState(state: any): void;
3849
-
3850
- /**
3851
- * The same as setState but does not emit 'stateChanged' event
3852
- * @param {serialisable} state
3853
- */
3854
- setStateSkipEvent(state: any): void;
3855
-
3856
- /**
3857
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3858
- * @param state A serialisable object
3859
- */
3860
- extendState(state: any): void;
3861
-
3862
- /**
3863
- * Returns the current state.
3864
- */
3865
- getState(): any;
3866
-
3867
- /**
3868
- * Returns the container's inner element as a jQuery element
3869
- */
3870
- getElement(): JQuery;
3871
-
3872
- /**
3873
- * hides the container or returns false if hiding it is not possible
3874
- */
3875
- hide(): boolean;
3876
-
3877
- /**
3878
- * shows the container or returns false if showing it is not possible
3879
- */
3880
- show(): boolean;
3881
-
3882
- /**
3883
- * Sets the container to the specified size or returns false if that's not possible
3884
- * @param width the new width in pixel
3885
- * @param height the new height in pixel
3886
- */
3887
- setSize(width: number, height: number): boolean;
3888
-
3889
- /**
3890
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3891
- * @param title the new title
3892
- */
3893
- setTitle(title: string): void;
3894
-
3895
- /**
3896
- * Closes the container or returns false if that is not possible
3897
- */
3898
- close(): boolean;
3899
- }
3900
-
3901
3740
  /**
3902
3741
  * Generated when a Layout Container Component was created.
3903
3742
  * @interface
@@ -3979,218 +3818,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3979
3818
  disposition: string;
3980
3819
  };
3981
3820
 
3982
- declare interface ContentItem extends EventEmitter_2 {
3983
- instance: any;
3984
- header: any;
3985
- _splitter: any;
3986
- /**
3987
- * This items configuration in its current state
3988
- */
3989
- config: ItemConfigType;
3990
-
3991
- /**
3992
- * The type of the item. Can be row, column, stack, component or root
3993
- */
3994
- type: ItemType;
3995
-
3996
- /**
3997
- * An array of items that are children of this item
3998
- */
3999
- contentItems: ContentItem[];
4000
-
4001
- container: Container;
4002
- /**
4003
- * The item that is this item's parent (or null if the item is root)
4004
- */
4005
- parent: ContentItem;
4006
-
4007
- /**
4008
- * A String or array of identifiers if provided in the configuration
4009
- */
4010
- id: string;
4011
-
4012
- /**
4013
- * True if the item had been initialised
4014
- */
4015
- isInitialised: boolean;
4016
-
4017
- /**
4018
- * True if the item is maximised
4019
- */
4020
- isMaximised: boolean;
4021
-
4022
- /**
4023
- * True if the item is the layout's root item
4024
- */
4025
- isRoot: boolean;
4026
-
4027
- /**
4028
- * True if the item is a row
4029
- */
4030
- isRow: boolean;
4031
-
4032
- /**
4033
- * True if the item is a column
4034
- */
4035
- isColumn: boolean;
4036
-
4037
- /**
4038
- * True if the item is a stack
4039
- */
4040
- isStack: boolean;
4041
-
4042
- /**
4043
- * True if the item is a component
4044
- */
4045
- isComponent: boolean;
4046
-
4047
- /**
4048
- * A reference to the layoutManager that controls this item
4049
- */
4050
- layoutManager: any;
4051
-
4052
- /**
4053
- * The item's outer element
4054
- */
4055
- element: JQuery;
4056
-
4057
- /**
4058
- * The item's inner element. Can be the same as the outer element.
4059
- */
4060
- childElementContainer: Container;
4061
-
4062
- /**
4063
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4064
- * from its original position before adding it to this item.
4065
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4066
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4067
- */
4068
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4069
-
4070
- /**
4071
- * Destroys the item and all it's children
4072
- * @param contentItem The contentItem that should be removed
4073
- * @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.
4074
- */
4075
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4076
-
4077
- /**
4078
- * The contentItem that should be removed
4079
- * @param oldChild ContentItem The contentItem that should be removed
4080
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4081
- */
4082
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4083
-
4084
- /**
4085
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4086
- */
4087
- setSize(): void;
4088
-
4089
- /**
4090
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4091
- * @param title the new title
4092
- */
4093
- setTitle(title: string): void;
4094
-
4095
- /**
4096
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4097
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4098
- * @param functionName The name of the method to invoke
4099
- * @param functionArguments An array of arguments to pass to every function
4100
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4101
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4102
- */
4103
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4104
-
4105
- /**
4106
- * 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.
4107
- */
4108
- emitBubblingEvent(name: string): void;
4109
-
4110
- /**
4111
- * Convenience method for item.parent.removeChild( item )
4112
- */
4113
- remove(): void;
4114
-
4115
- /**
4116
- * Removes the item from its current position in the layout and opens it in a window
4117
- */
4118
- popout(): BrowserWindow;
4119
-
4120
- /**
4121
- * Maximises the item or minimises it if it's already maximised
4122
- */
4123
- toggleMaximise(): void;
4124
-
4125
- /**
4126
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4127
- */
4128
- select(): void;
4129
-
4130
- /**
4131
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4132
- */
4133
- deselect(): void;
4134
-
4135
- /**
4136
- * Returns true if the item has the specified id or false if not
4137
- * @param id An id to check for
4138
- */
4139
- hasId(id: string): boolean;
4140
-
4141
- /**
4142
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4143
- * @param contentItem The new active content item
4144
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4145
- */
4146
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4147
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4148
-
4149
- /**
4150
- * Only Stacks have this method! Returns the currently selected contentItem.
4151
- */
4152
- getActiveContentItem(): ContentItem;
4153
-
4154
- /**
4155
- * Adds an id to an item or does nothing if the id is already present
4156
- * @param id The id to be added
4157
- */
4158
- addId(id: string): void;
4159
-
4160
- /**
4161
- * Removes an id from an item or throws an error if the id couldn't be found
4162
- * @param id The id to be removed
4163
- */
4164
- removeId(id: string): void;
4165
-
4166
- /**
4167
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4168
- * @param filterFunction A function that determines whether an item matches certain criteria
4169
- */
4170
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4171
-
4172
- /**
4173
- * Returns all items with the specified id.
4174
- * @param id An id specified in the itemConfig
4175
- */
4176
- getItemsById(id: string | string[]): ContentItem[];
4177
-
4178
- /**
4179
- * Returns all items with the specified type
4180
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4181
- */
4182
- getItemsByType(type: string): ContentItem[];
4183
-
4184
- /**
4185
- * Returns all instances of the component with the specified componentName
4186
- * @param componentName a componentName as specified in the itemConfig
4187
- */
4188
- getComponentsByName(componentName: string): any;
4189
-
4190
- _contentAreaDimensions: any;
4191
- _$getArea: () => any;
4192
- }
4193
-
4194
3821
  /**
4195
3822
  * Restrict navigation to URLs that match an allowed pattern.
4196
3823
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4629,46 +4256,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4629
4256
  type: 'did-finish-load';
4630
4257
  };
4631
4258
 
4632
- declare interface Dimensions {
4633
- /**
4634
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4635
- * than the visible one, making it safe to set this to small values without affecting usability.
4636
- * Default: 5
4637
- */
4638
- borderWidth?: number;
4639
-
4640
- /**
4641
- * The minimum height an item can be resized to (in pixel).
4642
- * Default: 10
4643
- */
4644
- minItemHeight?: number;
4645
-
4646
- /**
4647
- * The minimum width an item can be resized to (in pixel).
4648
- * Default: 10
4649
- */
4650
- minItemWidth?: number;
4651
-
4652
- /**
4653
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4654
- * adjusted accordingly.
4655
- * Default: 20
4656
- */
4657
- headerHeight?: number;
4658
-
4659
- /**
4660
- * The width of the element that appears when an item is dragged (in pixel).
4661
- * Default: 300
4662
- */
4663
- dragProxyWidth?: number;
4664
-
4665
- /**
4666
- * The height of the element that appears when an item is dragged (in pixel).
4667
- * Default: 200
4668
- */
4669
- dragProxyHeight?: number;
4670
- }
4671
-
4672
4259
  /**
4673
4260
  * @interface
4674
4261
  */
@@ -4929,8 +4516,6 @@ declare type Dpi = {
4929
4516
  vertical?: number;
4930
4517
  };
4931
4518
 
4932
- declare interface DragSource {}
4933
-
4934
4519
  /**
4935
4520
  * Generated when a window has been embedded.
4936
4521
  * @interface
@@ -5248,43 +4833,6 @@ declare class EventAggregator extends EmitterMap {
5248
4833
  dispatchEvent: (message: Message<any>) => boolean;
5249
4834
  }
5250
4835
 
5251
- declare interface EventEmitter_2 {
5252
- [x: string]: any;
5253
- /**
5254
- * Subscribe to an event
5255
- * @param eventName The name of the event to describe to
5256
- * @param callback The function that should be invoked when the event occurs
5257
- * @param context The value of the this pointer in the callback function
5258
- */
5259
- on(eventName: string, callback: Function, context?: any): void;
5260
-
5261
- /**
5262
- * Notify listeners of an event and pass arguments along
5263
- * @param eventName The name of the event to emit
5264
- */
5265
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5266
-
5267
- /**
5268
- * Alias for emit
5269
- */
5270
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5271
-
5272
- /**
5273
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5274
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5275
- * arguments.
5276
- * @param eventName The name of the event to unsubscribe from
5277
- * @param callback The function that should be invoked when the event occurs
5278
- * @param context The value of the this pointer in the callback function
5279
- */
5280
- unbind(eventName: string, callback?: Function, context?: any): void;
5281
-
5282
- /**
5283
- * Alias for unbind
5284
- */
5285
- off(eventName: string, callback?: Function, context?: any): void;
5286
- }
5287
-
5288
4836
  /**
5289
4837
  * Handler for an event on an EventEmitter.
5290
4838
  * @remarks Selects the correct type for the event
@@ -6150,253 +5698,6 @@ declare namespace GlobalHotkeyEvents {
6150
5698
  */
6151
5699
  declare type GlobalHotkeyEventType = EventType_6;
6152
5700
 
6153
- declare namespace GoldenLayout {
6154
- export {
6155
- GoldenLayout_2 as GoldenLayout,
6156
- ItemConfigType,
6157
- Settings,
6158
- Dimensions,
6159
- Labels,
6160
- ItemType,
6161
- ItemConfig,
6162
- ComponentConfig,
6163
- ReactComponentConfig,
6164
- Config,
6165
- ContentItem,
6166
- Container,
6167
- DragSource,
6168
- BrowserWindow,
6169
- Header,
6170
- TabDragListener,
6171
- Tab,
6172
- EventEmitter_2 as EventEmitter
6173
- }
6174
- }
6175
-
6176
- declare class GoldenLayout_2 implements EventEmitter_2 {
6177
- /**
6178
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6179
- * object and of goldenLayout.root as the document.
6180
- */
6181
- root: ContentItem;
6182
-
6183
- /**
6184
- * A reference to the (jQuery) DOM element containing the layout
6185
- */
6186
- container: JQuery;
6187
-
6188
- /**
6189
- * True once the layout item tree has been created and the initialised event has been fired
6190
- */
6191
- isInitialised: boolean;
6192
-
6193
- /**
6194
- * A reference to the current, extended top level config.
6195
- *
6196
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6197
- */
6198
- config: Config;
6199
-
6200
- /**
6201
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6202
- * to true.
6203
- */
6204
- selectedItem: ContentItem;
6205
-
6206
- /**
6207
- * The current outer width of the layout in pixels.
6208
- */
6209
- width: number;
6210
-
6211
- /**
6212
- * The current outer height of the layout in pixels.
6213
- */
6214
- height: number;
6215
-
6216
- /**
6217
- * An array of BrowserWindow instances
6218
- */
6219
- openPopouts: BrowserWindow[];
6220
-
6221
- /**
6222
- * True if the layout has been opened as a popout by another layout.
6223
- */
6224
- isSubWindow: boolean;
6225
-
6226
- /**
6227
- * A singleton instance of EventEmitter that works across windows
6228
- */
6229
- eventHub: EventEmitter_2;
6230
-
6231
- _dragProxy: any;
6232
-
6233
- dropTargetIndicator: any;
6234
-
6235
- _isFullPage: boolean;
6236
-
6237
- _onUnload: any;
6238
-
6239
- tabDropPlaceholder: any;
6240
-
6241
- transitionIndicator: any;
6242
-
6243
- _dragSources: any;
6244
-
6245
- _resizeFunction: any;
6246
-
6247
- _unloadFunction: any;
6248
-
6249
- /**
6250
- * @param config A GoldenLayout configuration object
6251
- * @param container The DOM element the layout will be initialised in. Default: document.body
6252
- */
6253
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6254
-
6255
- /*
6256
- * @param name The name of the component, as referred to by componentName in the component configuration.
6257
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6258
- * containerobject and a component state
6259
- */
6260
- registerComponent(name: String, component: any): void;
6261
-
6262
- /**
6263
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6264
- * a listener to the document and executes once it becomes ready.
6265
- */
6266
- init(): void;
6267
-
6268
- /**
6269
- * Returns the current state of the layout and its components as a serialisable object.
6270
- */
6271
- toConfig(): Config;
6272
-
6273
- /**
6274
- * Returns a component that was previously registered with layout.registerComponent().
6275
- * @param name The name of a previously registered component
6276
- */
6277
- getComponent(name: string): any;
6278
-
6279
- /**
6280
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6281
- * @param width The outer width the layout should be resized to. Default: The container elements width
6282
- * @param height The outer height the layout should be resized to. Default: The container elements height
6283
- */
6284
- updateSize(width?: number, height?: number): void;
6285
-
6286
- /**
6287
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6288
- * listeners and finally removes itself from the DOM.
6289
- */
6290
- destroy(): void;
6291
-
6292
- /**
6293
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6294
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6295
- * all call this method implicitly.
6296
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6297
- * @param parent A parent item
6298
- */
6299
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6300
-
6301
- /**
6302
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6303
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6304
- * provided its config will be read, if config is provided, only the content key
6305
- * will be used
6306
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6307
- * place the window in another screen.
6308
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6309
- * when popIn is clicked
6310
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6311
- */
6312
- createPopout(
6313
- configOrContentItem: ItemConfigType | ContentItem,
6314
- dimensions: {
6315
- width: number;
6316
- height: number;
6317
- left: number;
6318
- top: number;
6319
- },
6320
- parentId?: string,
6321
- indexInParent?: number
6322
- ): void;
6323
-
6324
- /**
6325
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6326
- * where it turns into a contentItem.
6327
- * @param element The DOM element that will be turned into a dragSource
6328
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6329
- * @return the dragSource that was created. This can be used to remove the
6330
- * dragSource from the layout later.
6331
- */
6332
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6333
-
6334
- /**
6335
- * Removes a dragSource from the layout.
6336
- *
6337
- * @param dragSource The dragSource to remove
6338
- */
6339
- removeDragSource(dragSource: DragSource): void;
6340
-
6341
- /**
6342
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6343
- * @param contentItem A ContentItem instance
6344
- */
6345
- selectItem(contentItem: ContentItem): void;
6346
-
6347
- /**
6348
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6349
- * and replace frequent keys and values with single letter substitutes.
6350
- * @param config A GoldenLayout configuration object
6351
- */
6352
- static minifyConfig(config: any): any;
6353
-
6354
- /**
6355
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6356
- * @param minifiedConfig A minified GoldenLayout configuration object
6357
- */
6358
- static unminifyConfig(minifiedConfig: any): any;
6359
-
6360
- /**
6361
- * Subscribe to an event
6362
- * @param eventName The name of the event to describe to
6363
- * @param callback The function that should be invoked when the event occurs
6364
- * @param context The value of the this pointer in the callback function
6365
- */
6366
- on(eventName: string, callback: Function, context?: any): void;
6367
-
6368
- /**
6369
- * Notify listeners of an event and pass arguments along
6370
- * @param eventName The name of the event to emit
6371
- */
6372
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6373
-
6374
- /**
6375
- * Alias for emit
6376
- */
6377
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6378
-
6379
- /**
6380
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6381
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6382
- * arguments.
6383
- * @param eventName The name of the event to unsubscribe from
6384
- * @param callback The function that should be invoked when the event occurs
6385
- * @param context The value of the this pointer in the callback function
6386
- */
6387
- unbind(eventName: string, callback?: Function, context?: any): void;
6388
-
6389
- /**
6390
- * Alias for unbind
6391
- */
6392
- off(eventName: string, callback?: Function, context?: any): void;
6393
-
6394
- /**
6395
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6396
- */
6397
- _$createRootItemAreas(): void;
6398
- }
6399
-
6400
5701
  /**
6401
5702
  * @interface
6402
5703
  */
@@ -6404,62 +5705,6 @@ declare type GpuInfo = {
6404
5705
  name: string;
6405
5706
  };
6406
5707
 
6407
- declare interface Header {
6408
- /**
6409
- * A reference to the LayoutManager instance
6410
- */
6411
- layoutManager: GoldenLayout_2;
6412
-
6413
- /**
6414
- * A reference to the Stack this Header belongs to
6415
- */
6416
- parent: ContentItem;
6417
-
6418
- /**
6419
- * An array of the Tabs within this header
6420
- */
6421
- tabs: Tab[];
6422
-
6423
- /**
6424
- * The currently selected activeContentItem
6425
- */
6426
- activeContentItem: ContentItem;
6427
-
6428
- /**
6429
- * The outer (jQuery) DOM element of this Header
6430
- */
6431
- element: JQuery;
6432
-
6433
- /**
6434
- * The (jQuery) DOM element containing the tabs
6435
- */
6436
- tabsContainer: JQuery;
6437
-
6438
- /**
6439
- * The (jQuery) DOM element containing the close, maximise and popout button
6440
- */
6441
- controlsContainer: JQuery;
6442
-
6443
- /**
6444
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6445
- * @param contentItem The content item that will be selected
6446
- */
6447
- setActiveContentItem(contentItem: ContentItem): void;
6448
-
6449
- /**
6450
- * Creates a new tab and associates it with a content item
6451
- * @param contentItem The content item the tab will be associated with
6452
- * @param index A zero based index, specifying the position of the new tab
6453
- */
6454
- createTab(contentItem: ContentItem, index?: number): void;
6455
-
6456
- /**
6457
- * Finds a tab by its contentItem and removes it
6458
- * @param contentItem The content item the tab is associated with
6459
- */
6460
- removeTab(contentItem: ContentItem): void;
6461
- }
6462
-
6463
5708
  /**
6464
5709
  * Generated when a View is hidden.
6465
5710
  * @interface
@@ -8072,50 +7317,6 @@ declare class InteropModule extends Base {
8072
7317
  connectSync(name: string, interopConfig?: OpenFin_2.InteropConfig): InteropClient;
8073
7318
  }
8074
7319
 
8075
- declare interface ItemConfig {
8076
- /**
8077
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8078
- */
8079
- type: ItemType;
8080
-
8081
- /**
8082
- * An array of configurations for items that will be created as children of this item.
8083
- */
8084
- content?: ItemConfigType[];
8085
-
8086
- /**
8087
- * The width of this item, relative to the other children of its parent in percent
8088
- */
8089
- width?: number;
8090
-
8091
- /**
8092
- * The height of this item, relative to the other children of its parent in percent
8093
- */
8094
- height?: number;
8095
-
8096
- /**
8097
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8098
- */
8099
- id?: string | string[];
8100
-
8101
- /**
8102
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8103
- * will return false
8104
- * Default: true
8105
- */
8106
- isClosable?: boolean;
8107
-
8108
- /**
8109
- * The title of the item as displayed on its tab and on popout windows
8110
- * Default: componentName or ''
8111
- */
8112
- title?: string;
8113
- }
8114
-
8115
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8116
-
8117
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8118
-
8119
7320
  /**
8120
7321
  * @interface
8121
7322
  */
@@ -8173,32 +7374,6 @@ declare type JumpListTask = {
8173
7374
  iconIndex?: number;
8174
7375
  };
8175
7376
 
8176
- declare interface Labels {
8177
- /**
8178
- * The tooltip text that appears when hovering over the close icon.
8179
- * Default: 'close'
8180
- */
8181
- close?: string;
8182
-
8183
- /**
8184
- * The tooltip text that appears when hovering over the maximise icon.
8185
- * Default: 'maximise'
8186
- */
8187
- maximise?: string;
8188
-
8189
- /**
8190
- * The tooltip text that appears when hovering over the minimise icon.
8191
- * Default: 'minimise'
8192
- */
8193
- minimise?: string;
8194
-
8195
- /**
8196
- * The tooltip text that appears when hovering over the popout icon.
8197
- * Default: 'open in new window'
8198
- */
8199
- popout?: string;
8200
- }
8201
-
8202
7377
  /**
8203
7378
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8204
7379
  *
@@ -8656,7 +7831,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8656
7831
  entityId: string;
8657
7832
  };
8658
7833
 
8659
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7834
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8660
7835
 
8661
7836
  /**
8662
7837
  * @interface
@@ -12863,18 +12038,6 @@ declare type QueryPermissionResult = {
12863
12038
  rawValue?: unknown;
12864
12039
  };
12865
12040
 
12866
- declare interface ReactComponentConfig extends ItemConfig {
12867
- /**
12868
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12869
- */
12870
- component: string;
12871
-
12872
- /**
12873
- * Properties that will be passed to the component and accessible using this.props.
12874
- */
12875
- props?: any;
12876
- }
12877
-
12878
12041
  /**
12879
12042
  * @interface
12880
12043
  */
@@ -13351,97 +12514,6 @@ declare type SessionContextGroup = {
13351
12514
  }>;
13352
12515
  };
13353
12516
 
13354
- declare interface Settings {
13355
- preventSplitterResize?: boolean;
13356
-
13357
- newTabButton?: {
13358
- url?: string;
13359
- };
13360
-
13361
- /**
13362
- * If true, tabs can't be dragged into the window.
13363
- * Default: false
13364
- */
13365
- preventDragIn?: boolean;
13366
-
13367
- /**
13368
- * If true, tabs can't be dragged out of the window.
13369
- * Default: false
13370
- */
13371
- preventDragOut?: boolean;
13372
-
13373
- /**
13374
- * If true, stack headers are the only areas where tabs can be dropped.
13375
- * Default: false
13376
- */
13377
- constrainDragToHeaders?: boolean;
13378
- /**
13379
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13380
- * Default: true
13381
- */
13382
- hasHeaders?: boolean;
13383
-
13384
- /**
13385
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13386
- * automatically when layout.createDragSource() is called.
13387
- * Default: true
13388
- */
13389
- constrainDragToContainer?: boolean;
13390
-
13391
- /**
13392
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13393
- * Default: true
13394
- */
13395
- reorderEnabled?: boolean;
13396
-
13397
- /**
13398
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13399
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13400
- * Default: false
13401
- */
13402
- selectionEnabled?: boolean;
13403
-
13404
- /**
13405
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13406
- * be transferred to the new window, if false only the active component will be opened.
13407
- * Default: false
13408
- */
13409
- popoutWholeStack?: boolean;
13410
-
13411
- /**
13412
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13413
- * If false, the popout call will fail silently.
13414
- * Default: true
13415
- */
13416
- blockedPopoutsThrowError?: boolean;
13417
-
13418
- /**
13419
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13420
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13421
- * addition, any changes made to popouts won't be stored after the parent is closed.
13422
- * Default: true
13423
- */
13424
- closePopoutsOnUnload?: boolean;
13425
-
13426
- /**
13427
- * Specifies if the popout icon should be displayed in the header-bar.
13428
- * Default: true
13429
- */
13430
- showPopoutIcon?: boolean;
13431
-
13432
- /**
13433
- * Specifies if the maximise icon should be displayed in the header-bar.
13434
- * Default: true
13435
- */
13436
- showMaximiseIcon?: boolean;
13437
-
13438
- /**
13439
- * Specifies if the close icon should be displayed in the header-bar.
13440
- * Default: true
13441
- */
13442
- showCloseIcon?: boolean;
13443
- }
13444
-
13445
12517
  /**
13446
12518
  * @interface
13447
12519
  */
@@ -15349,52 +14421,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15349
14421
  proceed: () => void;
15350
14422
  }) => void;
15351
14423
 
15352
- declare interface Tab {
15353
- _dragListener: TabDragListener;
15354
-
15355
- /**
15356
- * True if this tab is the selected tab
15357
- */
15358
- isActive: boolean;
15359
-
15360
- /**
15361
- * A reference to the header this tab is a child of
15362
- */
15363
- header: Header;
15364
-
15365
- /**
15366
- * A reference to the content item this tab relates to
15367
- */
15368
- contentItem: ContentItem;
15369
-
15370
- /**
15371
- * The tabs outer (jQuery) DOM element
15372
- */
15373
- element: JQuery;
15374
-
15375
- /**
15376
- * The (jQuery) DOM element containing the title
15377
- */
15378
- titleElement: JQuery;
15379
-
15380
- /**
15381
- * The (jQuery) DOM element that closes the tab
15382
- */
15383
- closeElement: JQuery;
15384
-
15385
- /**
15386
- * Sets the tab's title. Does not affect the contentItem's title!
15387
- * @param title The new title
15388
- */
15389
- setTitle(title: string): void;
15390
-
15391
- /**
15392
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15393
- * @param isActive Whether the tab is active
15394
- */
15395
- setActive(isActive: boolean): void;
15396
- }
15397
-
15398
14424
  /**
15399
14425
  * Generated when a Layout Tab Component was closed.
15400
14426
  * @interface
@@ -15412,13 +14438,6 @@ declare type TabCreatedEvent = LayoutDOMEvent & {
15412
14438
  type: 'tab-created';
15413
14439
  };
15414
14440
 
15415
- declare interface TabDragListener extends EventEmitter_2 {
15416
- /**
15417
- * A reference to the content item this tab relates to
15418
- */
15419
- contentItem: ContentItem;
15420
- }
15421
-
15422
14441
  /**
15423
14442
  * Generated when a Layout Tab Component was dropped.
15424
14443
  * @interface