@openfin/remote-adapter 37.81.20 → 37.81.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1167,9 +1167,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1167
1167
  */
1168
1168
  mainWindowOptions: WindowCreationOptions;
1169
1169
  /**
1170
- * The name of the application (and the application's main window).
1170
+ * The name of the application.
1171
1171
  *
1172
- * If provided, _must_ match `uuid`.
1172
+ * @remarks
1173
+ * This property is only used for naming the application logging folder, which will be sanitized to remove
1174
+ * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1175
+ * during startup with the UUID of the application.
1176
+ *
1177
+ * This property will be deprecated in the future.
1173
1178
  */
1174
1179
  name: string;
1175
1180
  /**
@@ -1199,9 +1204,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1199
1204
  url: string;
1200
1205
  /**
1201
1206
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1202
- * running in the OpenFin Runtime.
1203
- *
1204
- * Note that `name` and `uuid` must match.
1207
+ * running in the OpenFin Runtime.
1205
1208
  */
1206
1209
  uuid: string;
1207
1210
  /**
@@ -1936,48 +1939,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1936
1939
  behavior: 'browser';
1937
1940
  };
1938
1941
 
1939
- declare interface BrowserWindow {
1940
- /**
1941
- * True if the window has been opened and its GoldenLayout instance initialised.
1942
- */
1943
- isInitialised: boolean;
1944
-
1945
- /**
1946
- * Creates a window configuration object from the Popout.
1947
- */
1948
- toConfig(): {
1949
- dimensions: {
1950
- width: number;
1951
- height: number;
1952
- left: number;
1953
- top: number;
1954
- };
1955
- content: Config;
1956
- parentId: string;
1957
- indexInParent: number;
1958
- };
1959
-
1960
- /**
1961
- * Returns the GoldenLayout instance from the child window
1962
- */
1963
- getGlInstance(): GoldenLayout_2;
1964
-
1965
- /**
1966
- * Returns the native Window object
1967
- */
1968
- getWindow(): Window;
1969
-
1970
- /**
1971
- * Closes the popout
1972
- */
1973
- close(): void;
1974
-
1975
- /**
1976
- * Returns the popout to its original position as specified in parentId and indexInParent
1977
- */
1978
- popIn(): void;
1979
- }
1980
-
1981
1942
  /**
1982
1943
  * Extracts a single event type matching the given key from the View {@link Event} union.
1983
1944
  *
@@ -3376,31 +3337,6 @@ declare class ColumnOrRow extends LayoutNode {
3376
3337
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3377
3338
  }
3378
3339
 
3379
- declare interface ComponentConfig extends ItemConfig {
3380
- /**
3381
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3382
- */
3383
- componentName: string;
3384
-
3385
- /**
3386
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3387
- * container.getState().
3388
- */
3389
- componentState?: any;
3390
- }
3391
-
3392
- declare interface Config {
3393
- settings?: Settings;
3394
- dimensions?: Dimensions;
3395
- labels?: Labels;
3396
- content?: ItemConfigType[];
3397
- /**
3398
- * (Only on layout config object)
3399
- * Id of the currently maximised content item
3400
- */
3401
- maximisedItemId?: string;
3402
- }
3403
-
3404
3340
  declare type ConfigWithRuntime = BaseConfig & {
3405
3341
  runtime: RuntimeConfig;
3406
3342
  };
@@ -3802,103 +3738,6 @@ declare type ConstWindowOptions = {
3802
3738
  inheritance?: Partial<InheritableOptions>;
3803
3739
  };
3804
3740
 
3805
- declare interface Container extends EventEmitter_2 {
3806
- /**
3807
- * The current width of the container in pixel
3808
- */
3809
- width: number;
3810
-
3811
- /**
3812
- * The current height of the container in pixel
3813
- */
3814
- height: number;
3815
-
3816
- /**
3817
- * A reference to the component-item that controls this container
3818
- */
3819
- parent: ContentItem;
3820
-
3821
- /**
3822
- * A reference to the tab that controls this container. Will initially be null
3823
- * (and populated once a tab event has been fired).
3824
- */
3825
- tab: Tab;
3826
-
3827
- /**
3828
- * The current title of the container
3829
- */
3830
- title: string;
3831
-
3832
- /*
3833
- * A reference to the GoldenLayout instance this container belongs to
3834
- */
3835
- layoutManager: GoldenLayout_2;
3836
-
3837
- /**
3838
- * True if the item is currently hidden
3839
- */
3840
- isHidden: boolean;
3841
-
3842
- /**
3843
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3844
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3845
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3846
- * constructor function. It will also be used when the component is opened in a new window.
3847
- * @param state A serialisable object
3848
- */
3849
- setState(state: any): void;
3850
-
3851
- /**
3852
- * The same as setState but does not emit 'stateChanged' event
3853
- * @param {serialisable} state
3854
- */
3855
- setStateSkipEvent(state: any): void;
3856
-
3857
- /**
3858
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3859
- * @param state A serialisable object
3860
- */
3861
- extendState(state: any): void;
3862
-
3863
- /**
3864
- * Returns the current state.
3865
- */
3866
- getState(): any;
3867
-
3868
- /**
3869
- * Returns the container's inner element as a jQuery element
3870
- */
3871
- getElement(): JQuery;
3872
-
3873
- /**
3874
- * hides the container or returns false if hiding it is not possible
3875
- */
3876
- hide(): boolean;
3877
-
3878
- /**
3879
- * shows the container or returns false if showing it is not possible
3880
- */
3881
- show(): boolean;
3882
-
3883
- /**
3884
- * Sets the container to the specified size or returns false if that's not possible
3885
- * @param width the new width in pixel
3886
- * @param height the new height in pixel
3887
- */
3888
- setSize(width: number, height: number): boolean;
3889
-
3890
- /**
3891
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3892
- * @param title the new title
3893
- */
3894
- setTitle(title: string): void;
3895
-
3896
- /**
3897
- * Closes the container or returns false if that is not possible
3898
- */
3899
- close(): boolean;
3900
- }
3901
-
3902
3741
  /**
3903
3742
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3904
3743
  */
@@ -3972,218 +3811,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3972
3811
  disposition: string;
3973
3812
  };
3974
3813
 
3975
- declare interface ContentItem extends EventEmitter_2 {
3976
- instance: any;
3977
- header: any;
3978
- _splitter: any;
3979
- /**
3980
- * This items configuration in its current state
3981
- */
3982
- config: ItemConfigType;
3983
-
3984
- /**
3985
- * The type of the item. Can be row, column, stack, component or root
3986
- */
3987
- type: ItemType;
3988
-
3989
- /**
3990
- * An array of items that are children of this item
3991
- */
3992
- contentItems: ContentItem[];
3993
-
3994
- container: Container;
3995
- /**
3996
- * The item that is this item's parent (or null if the item is root)
3997
- */
3998
- parent: ContentItem;
3999
-
4000
- /**
4001
- * A String or array of identifiers if provided in the configuration
4002
- */
4003
- id: string;
4004
-
4005
- /**
4006
- * True if the item had been initialised
4007
- */
4008
- isInitialised: boolean;
4009
-
4010
- /**
4011
- * True if the item is maximised
4012
- */
4013
- isMaximised: boolean;
4014
-
4015
- /**
4016
- * True if the item is the layout's root item
4017
- */
4018
- isRoot: boolean;
4019
-
4020
- /**
4021
- * True if the item is a row
4022
- */
4023
- isRow: boolean;
4024
-
4025
- /**
4026
- * True if the item is a column
4027
- */
4028
- isColumn: boolean;
4029
-
4030
- /**
4031
- * True if the item is a stack
4032
- */
4033
- isStack: boolean;
4034
-
4035
- /**
4036
- * True if the item is a component
4037
- */
4038
- isComponent: boolean;
4039
-
4040
- /**
4041
- * A reference to the layoutManager that controls this item
4042
- */
4043
- layoutManager: any;
4044
-
4045
- /**
4046
- * The item's outer element
4047
- */
4048
- element: JQuery;
4049
-
4050
- /**
4051
- * The item's inner element. Can be the same as the outer element.
4052
- */
4053
- childElementContainer: Container;
4054
-
4055
- /**
4056
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4057
- * from its original position before adding it to this item.
4058
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4059
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4060
- */
4061
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4062
-
4063
- /**
4064
- * Destroys the item and all it's children
4065
- * @param contentItem The contentItem that should be removed
4066
- * @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.
4067
- */
4068
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4069
-
4070
- /**
4071
- * The contentItem that should be removed
4072
- * @param oldChild ContentItem The contentItem that should be removed
4073
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4074
- */
4075
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4076
-
4077
- /**
4078
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4079
- */
4080
- setSize(): void;
4081
-
4082
- /**
4083
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4084
- * @param title the new title
4085
- */
4086
- setTitle(title: string): void;
4087
-
4088
- /**
4089
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4090
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4091
- * @param functionName The name of the method to invoke
4092
- * @param functionArguments An array of arguments to pass to every function
4093
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4094
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4095
- */
4096
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4097
-
4098
- /**
4099
- * 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.
4100
- */
4101
- emitBubblingEvent(name: string): void;
4102
-
4103
- /**
4104
- * Convenience method for item.parent.removeChild( item )
4105
- */
4106
- remove(): void;
4107
-
4108
- /**
4109
- * Removes the item from its current position in the layout and opens it in a window
4110
- */
4111
- popout(): BrowserWindow;
4112
-
4113
- /**
4114
- * Maximises the item or minimises it if it's already maximised
4115
- */
4116
- toggleMaximise(): void;
4117
-
4118
- /**
4119
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4120
- */
4121
- select(): void;
4122
-
4123
- /**
4124
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4125
- */
4126
- deselect(): void;
4127
-
4128
- /**
4129
- * Returns true if the item has the specified id or false if not
4130
- * @param id An id to check for
4131
- */
4132
- hasId(id: string): boolean;
4133
-
4134
- /**
4135
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4136
- * @param contentItem The new active content item
4137
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4138
- */
4139
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4140
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4141
-
4142
- /**
4143
- * Only Stacks have this method! Returns the currently selected contentItem.
4144
- */
4145
- getActiveContentItem(): ContentItem;
4146
-
4147
- /**
4148
- * Adds an id to an item or does nothing if the id is already present
4149
- * @param id The id to be added
4150
- */
4151
- addId(id: string): void;
4152
-
4153
- /**
4154
- * Removes an id from an item or throws an error if the id couldn't be found
4155
- * @param id The id to be removed
4156
- */
4157
- removeId(id: string): void;
4158
-
4159
- /**
4160
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4161
- * @param filterFunction A function that determines whether an item matches certain criteria
4162
- */
4163
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4164
-
4165
- /**
4166
- * Returns all items with the specified id.
4167
- * @param id An id specified in the itemConfig
4168
- */
4169
- getItemsById(id: string | string[]): ContentItem[];
4170
-
4171
- /**
4172
- * Returns all items with the specified type
4173
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4174
- */
4175
- getItemsByType(type: string): ContentItem[];
4176
-
4177
- /**
4178
- * Returns all instances of the component with the specified componentName
4179
- * @param componentName a componentName as specified in the itemConfig
4180
- */
4181
- getComponentsByName(componentName: string): any;
4182
-
4183
- _contentAreaDimensions: any;
4184
- _$getArea: () => any;
4185
- }
4186
-
4187
3814
  /**
4188
3815
  * Restrict navigation to URLs that match an allowed pattern.
4189
3816
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4611,46 +4238,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4611
4238
  type: 'did-finish-load';
4612
4239
  };
4613
4240
 
4614
- declare interface Dimensions {
4615
- /**
4616
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4617
- * than the visible one, making it safe to set this to small values without affecting usability.
4618
- * Default: 5
4619
- */
4620
- borderWidth?: number;
4621
-
4622
- /**
4623
- * The minimum height an item can be resized to (in pixel).
4624
- * Default: 10
4625
- */
4626
- minItemHeight?: number;
4627
-
4628
- /**
4629
- * The minimum width an item can be resized to (in pixel).
4630
- * Default: 10
4631
- */
4632
- minItemWidth?: number;
4633
-
4634
- /**
4635
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4636
- * adjusted accordingly.
4637
- * Default: 20
4638
- */
4639
- headerHeight?: number;
4640
-
4641
- /**
4642
- * The width of the element that appears when an item is dragged (in pixel).
4643
- * Default: 300
4644
- */
4645
- dragProxyWidth?: number;
4646
-
4647
- /**
4648
- * The height of the element that appears when an item is dragged (in pixel).
4649
- * Default: 200
4650
- */
4651
- dragProxyHeight?: number;
4652
- }
4653
-
4654
4241
  /**
4655
4242
  * @interface
4656
4243
  */
@@ -4900,8 +4487,6 @@ declare type Dpi = {
4900
4487
  vertical?: number;
4901
4488
  };
4902
4489
 
4903
- declare interface DragSource {}
4904
-
4905
4490
  /**
4906
4491
  * Generated when a window has been embedded.
4907
4492
  * @interface
@@ -5212,43 +4797,6 @@ declare class EventAggregator extends EmitterMap {
5212
4797
  dispatchEvent: (message: Message<any>) => boolean;
5213
4798
  }
5214
4799
 
5215
- declare interface EventEmitter_2 {
5216
- [x: string]: any;
5217
- /**
5218
- * Subscribe to an event
5219
- * @param eventName The name of the event to describe to
5220
- * @param callback The function that should be invoked when the event occurs
5221
- * @param context The value of the this pointer in the callback function
5222
- */
5223
- on(eventName: string, callback: Function, context?: any): void;
5224
-
5225
- /**
5226
- * Notify listeners of an event and pass arguments along
5227
- * @param eventName The name of the event to emit
5228
- */
5229
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5230
-
5231
- /**
5232
- * Alias for emit
5233
- */
5234
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5235
-
5236
- /**
5237
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5238
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5239
- * arguments.
5240
- * @param eventName The name of the event to unsubscribe from
5241
- * @param callback The function that should be invoked when the event occurs
5242
- * @param context The value of the this pointer in the callback function
5243
- */
5244
- unbind(eventName: string, callback?: Function, context?: any): void;
5245
-
5246
- /**
5247
- * Alias for unbind
5248
- */
5249
- off(eventName: string, callback?: Function, context?: any): void;
5250
- }
5251
-
5252
4800
  /**
5253
4801
  * Handler for an event on an EventEmitter.
5254
4802
  * @remarks Selects the correct type for the event
@@ -6107,253 +5655,6 @@ declare namespace GlobalHotkeyEvents {
6107
5655
  */
6108
5656
  declare type GlobalHotkeyEventType = EventType_6;
6109
5657
 
6110
- declare namespace GoldenLayout {
6111
- export {
6112
- GoldenLayout_2 as GoldenLayout,
6113
- ItemConfigType,
6114
- Settings,
6115
- Dimensions,
6116
- Labels,
6117
- ItemType,
6118
- ItemConfig,
6119
- ComponentConfig,
6120
- ReactComponentConfig,
6121
- Config,
6122
- ContentItem,
6123
- Container,
6124
- DragSource,
6125
- BrowserWindow,
6126
- Header,
6127
- TabDragListener,
6128
- Tab,
6129
- EventEmitter_2 as EventEmitter
6130
- }
6131
- }
6132
-
6133
- declare class GoldenLayout_2 implements EventEmitter_2 {
6134
- /**
6135
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6136
- * object and of goldenLayout.root as the document.
6137
- */
6138
- root: ContentItem;
6139
-
6140
- /**
6141
- * A reference to the (jQuery) DOM element containing the layout
6142
- */
6143
- container: JQuery;
6144
-
6145
- /**
6146
- * True once the layout item tree has been created and the initialised event has been fired
6147
- */
6148
- isInitialised: boolean;
6149
-
6150
- /**
6151
- * A reference to the current, extended top level config.
6152
- *
6153
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6154
- */
6155
- config: Config;
6156
-
6157
- /**
6158
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6159
- * to true.
6160
- */
6161
- selectedItem: ContentItem;
6162
-
6163
- /**
6164
- * The current outer width of the layout in pixels.
6165
- */
6166
- width: number;
6167
-
6168
- /**
6169
- * The current outer height of the layout in pixels.
6170
- */
6171
- height: number;
6172
-
6173
- /**
6174
- * An array of BrowserWindow instances
6175
- */
6176
- openPopouts: BrowserWindow[];
6177
-
6178
- /**
6179
- * True if the layout has been opened as a popout by another layout.
6180
- */
6181
- isSubWindow: boolean;
6182
-
6183
- /**
6184
- * A singleton instance of EventEmitter that works across windows
6185
- */
6186
- eventHub: EventEmitter_2;
6187
-
6188
- _dragProxy: any;
6189
-
6190
- dropTargetIndicator: any;
6191
-
6192
- _isFullPage: boolean;
6193
-
6194
- _onUnload: any;
6195
-
6196
- tabDropPlaceholder: any;
6197
-
6198
- transitionIndicator: any;
6199
-
6200
- _dragSources: any;
6201
-
6202
- _resizeFunction: any;
6203
-
6204
- _unloadFunction: any;
6205
-
6206
- /**
6207
- * @param config A GoldenLayout configuration object
6208
- * @param container The DOM element the layout will be initialised in. Default: document.body
6209
- */
6210
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6211
-
6212
- /*
6213
- * @param name The name of the component, as referred to by componentName in the component configuration.
6214
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6215
- * containerobject and a component state
6216
- */
6217
- registerComponent(name: String, component: any): void;
6218
-
6219
- /**
6220
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6221
- * a listener to the document and executes once it becomes ready.
6222
- */
6223
- init(): void;
6224
-
6225
- /**
6226
- * Returns the current state of the layout and its components as a serialisable object.
6227
- */
6228
- toConfig(): Config;
6229
-
6230
- /**
6231
- * Returns a component that was previously registered with layout.registerComponent().
6232
- * @param name The name of a previously registered component
6233
- */
6234
- getComponent(name: string): any;
6235
-
6236
- /**
6237
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6238
- * @param width The outer width the layout should be resized to. Default: The container elements width
6239
- * @param height The outer height the layout should be resized to. Default: The container elements height
6240
- */
6241
- updateSize(width?: number, height?: number): void;
6242
-
6243
- /**
6244
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6245
- * listeners and finally removes itself from the DOM.
6246
- */
6247
- destroy(): void;
6248
-
6249
- /**
6250
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6251
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6252
- * all call this method implicitly.
6253
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6254
- * @param parent A parent item
6255
- */
6256
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6257
-
6258
- /**
6259
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6260
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6261
- * provided its config will be read, if config is provided, only the content key
6262
- * will be used
6263
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6264
- * place the window in another screen.
6265
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6266
- * when popIn is clicked
6267
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6268
- */
6269
- createPopout(
6270
- configOrContentItem: ItemConfigType | ContentItem,
6271
- dimensions: {
6272
- width: number;
6273
- height: number;
6274
- left: number;
6275
- top: number;
6276
- },
6277
- parentId?: string,
6278
- indexInParent?: number
6279
- ): void;
6280
-
6281
- /**
6282
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6283
- * where it turns into a contentItem.
6284
- * @param element The DOM element that will be turned into a dragSource
6285
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6286
- * @return the dragSource that was created. This can be used to remove the
6287
- * dragSource from the layout later.
6288
- */
6289
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6290
-
6291
- /**
6292
- * Removes a dragSource from the layout.
6293
- *
6294
- * @param dragSource The dragSource to remove
6295
- */
6296
- removeDragSource(dragSource: DragSource): void;
6297
-
6298
- /**
6299
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6300
- * @param contentItem A ContentItem instance
6301
- */
6302
- selectItem(contentItem: ContentItem): void;
6303
-
6304
- /**
6305
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6306
- * and replace frequent keys and values with single letter substitutes.
6307
- * @param config A GoldenLayout configuration object
6308
- */
6309
- static minifyConfig(config: any): any;
6310
-
6311
- /**
6312
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6313
- * @param minifiedConfig A minified GoldenLayout configuration object
6314
- */
6315
- static unminifyConfig(minifiedConfig: any): any;
6316
-
6317
- /**
6318
- * Subscribe to an event
6319
- * @param eventName The name of the event to describe to
6320
- * @param callback The function that should be invoked when the event occurs
6321
- * @param context The value of the this pointer in the callback function
6322
- */
6323
- on(eventName: string, callback: Function, context?: any): void;
6324
-
6325
- /**
6326
- * Notify listeners of an event and pass arguments along
6327
- * @param eventName The name of the event to emit
6328
- */
6329
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6330
-
6331
- /**
6332
- * Alias for emit
6333
- */
6334
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6335
-
6336
- /**
6337
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6338
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6339
- * arguments.
6340
- * @param eventName The name of the event to unsubscribe from
6341
- * @param callback The function that should be invoked when the event occurs
6342
- * @param context The value of the this pointer in the callback function
6343
- */
6344
- unbind(eventName: string, callback?: Function, context?: any): void;
6345
-
6346
- /**
6347
- * Alias for unbind
6348
- */
6349
- off(eventName: string, callback?: Function, context?: any): void;
6350
-
6351
- /**
6352
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6353
- */
6354
- _$createRootItemAreas(): void;
6355
- }
6356
-
6357
5658
  /**
6358
5659
  * @interface
6359
5660
  */
@@ -6361,62 +5662,6 @@ declare type GpuInfo = {
6361
5662
  name: string;
6362
5663
  };
6363
5664
 
6364
- declare interface Header {
6365
- /**
6366
- * A reference to the LayoutManager instance
6367
- */
6368
- layoutManager: GoldenLayout_2;
6369
-
6370
- /**
6371
- * A reference to the Stack this Header belongs to
6372
- */
6373
- parent: ContentItem;
6374
-
6375
- /**
6376
- * An array of the Tabs within this header
6377
- */
6378
- tabs: Tab[];
6379
-
6380
- /**
6381
- * The currently selected activeContentItem
6382
- */
6383
- activeContentItem: ContentItem;
6384
-
6385
- /**
6386
- * The outer (jQuery) DOM element of this Header
6387
- */
6388
- element: JQuery;
6389
-
6390
- /**
6391
- * The (jQuery) DOM element containing the tabs
6392
- */
6393
- tabsContainer: JQuery;
6394
-
6395
- /**
6396
- * The (jQuery) DOM element containing the close, maximise and popout button
6397
- */
6398
- controlsContainer: JQuery;
6399
-
6400
- /**
6401
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6402
- * @param contentItem The content item that will be selected
6403
- */
6404
- setActiveContentItem(contentItem: ContentItem): void;
6405
-
6406
- /**
6407
- * Creates a new tab and associates it with a content item
6408
- * @param contentItem The content item the tab will be associated with
6409
- * @param index A zero based index, specifying the position of the new tab
6410
- */
6411
- createTab(contentItem: ContentItem, index?: number): void;
6412
-
6413
- /**
6414
- * Finds a tab by its contentItem and removes it
6415
- * @param contentItem The content item the tab is associated with
6416
- */
6417
- removeTab(contentItem: ContentItem): void;
6418
- }
6419
-
6420
5665
  /**
6421
5666
  * Generated when a View is hidden.
6422
5667
  * @interface
@@ -8050,50 +7295,6 @@ declare class InteropModule extends Base {
8050
7295
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8051
7296
  }
8052
7297
 
8053
- declare interface ItemConfig {
8054
- /**
8055
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8056
- */
8057
- type: ItemType;
8058
-
8059
- /**
8060
- * An array of configurations for items that will be created as children of this item.
8061
- */
8062
- content?: ItemConfigType[];
8063
-
8064
- /**
8065
- * The width of this item, relative to the other children of its parent in percent
8066
- */
8067
- width?: number;
8068
-
8069
- /**
8070
- * The height of this item, relative to the other children of its parent in percent
8071
- */
8072
- height?: number;
8073
-
8074
- /**
8075
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8076
- */
8077
- id?: string | string[];
8078
-
8079
- /**
8080
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8081
- * will return false
8082
- * Default: true
8083
- */
8084
- isClosable?: boolean;
8085
-
8086
- /**
8087
- * The title of the item as displayed on its tab and on popout windows
8088
- * Default: componentName or ''
8089
- */
8090
- title?: string;
8091
- }
8092
-
8093
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8094
-
8095
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8096
-
8097
7298
  /**
8098
7299
  * @interface
8099
7300
  */
@@ -8151,32 +7352,6 @@ declare type JumpListTask = {
8151
7352
  iconIndex?: number;
8152
7353
  };
8153
7354
 
8154
- declare interface Labels {
8155
- /**
8156
- * The tooltip text that appears when hovering over the close icon.
8157
- * Default: 'close'
8158
- */
8159
- close?: string;
8160
-
8161
- /**
8162
- * The tooltip text that appears when hovering over the maximise icon.
8163
- * Default: 'maximise'
8164
- */
8165
- maximise?: string;
8166
-
8167
- /**
8168
- * The tooltip text that appears when hovering over the minimise icon.
8169
- * Default: 'minimise'
8170
- */
8171
- minimise?: string;
8172
-
8173
- /**
8174
- * The tooltip text that appears when hovering over the popout icon.
8175
- * Default: 'open in new window'
8176
- */
8177
- popout?: string;
8178
- }
8179
-
8180
7355
  /**
8181
7356
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8182
7357
  *
@@ -8608,7 +7783,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8608
7783
  entityId: string;
8609
7784
  };
8610
7785
 
8611
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7786
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8612
7787
 
8613
7788
  /**
8614
7789
  * @interface
@@ -12785,18 +11960,6 @@ declare type QueryPermissionResult = {
12785
11960
  rawValue?: unknown;
12786
11961
  };
12787
11962
 
12788
- declare interface ReactComponentConfig extends ItemConfig {
12789
- /**
12790
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12791
- */
12792
- component: string;
12793
-
12794
- /**
12795
- * Properties that will be passed to the component and accessible using this.props.
12796
- */
12797
- props?: any;
12798
- }
12799
-
12800
11963
  /**
12801
11964
  * @interface
12802
11965
  */
@@ -13273,97 +12436,6 @@ declare type SessionContextGroup = {
13273
12436
  }>;
13274
12437
  };
13275
12438
 
13276
- declare interface Settings {
13277
- preventSplitterResize?: boolean;
13278
-
13279
- newTabButton?: {
13280
- url?: string;
13281
- };
13282
-
13283
- /**
13284
- * If true, tabs can't be dragged into the window.
13285
- * Default: false
13286
- */
13287
- preventDragIn?: boolean;
13288
-
13289
- /**
13290
- * If true, tabs can't be dragged out of the window.
13291
- * Default: false
13292
- */
13293
- preventDragOut?: boolean;
13294
-
13295
- /**
13296
- * If true, stack headers are the only areas where tabs can be dropped.
13297
- * Default: false
13298
- */
13299
- constrainDragToHeaders?: boolean;
13300
- /**
13301
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13302
- * Default: true
13303
- */
13304
- hasHeaders?: boolean;
13305
-
13306
- /**
13307
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13308
- * automatically when layout.createDragSource() is called.
13309
- * Default: true
13310
- */
13311
- constrainDragToContainer?: boolean;
13312
-
13313
- /**
13314
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13315
- * Default: true
13316
- */
13317
- reorderEnabled?: boolean;
13318
-
13319
- /**
13320
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13321
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13322
- * Default: false
13323
- */
13324
- selectionEnabled?: boolean;
13325
-
13326
- /**
13327
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13328
- * be transferred to the new window, if false only the active component will be opened.
13329
- * Default: false
13330
- */
13331
- popoutWholeStack?: boolean;
13332
-
13333
- /**
13334
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13335
- * If false, the popout call will fail silently.
13336
- * Default: true
13337
- */
13338
- blockedPopoutsThrowError?: boolean;
13339
-
13340
- /**
13341
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13342
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13343
- * addition, any changes made to popouts won't be stored after the parent is closed.
13344
- * Default: true
13345
- */
13346
- closePopoutsOnUnload?: boolean;
13347
-
13348
- /**
13349
- * Specifies if the popout icon should be displayed in the header-bar.
13350
- * Default: true
13351
- */
13352
- showPopoutIcon?: boolean;
13353
-
13354
- /**
13355
- * Specifies if the maximise icon should be displayed in the header-bar.
13356
- * Default: true
13357
- */
13358
- showMaximiseIcon?: boolean;
13359
-
13360
- /**
13361
- * Specifies if the close icon should be displayed in the header-bar.
13362
- * Default: true
13363
- */
13364
- showCloseIcon?: boolean;
13365
- }
13366
-
13367
12439
  /**
13368
12440
  * @interface
13369
12441
  */
@@ -15266,59 +14338,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15266
14338
  proceed: () => void;
15267
14339
  }) => void;
15268
14340
 
15269
- declare interface Tab {
15270
- _dragListener: TabDragListener;
15271
-
15272
- /**
15273
- * True if this tab is the selected tab
15274
- */
15275
- isActive: boolean;
15276
-
15277
- /**
15278
- * A reference to the header this tab is a child of
15279
- */
15280
- header: Header;
15281
-
15282
- /**
15283
- * A reference to the content item this tab relates to
15284
- */
15285
- contentItem: ContentItem;
15286
-
15287
- /**
15288
- * The tabs outer (jQuery) DOM element
15289
- */
15290
- element: JQuery;
15291
-
15292
- /**
15293
- * The (jQuery) DOM element containing the title
15294
- */
15295
- titleElement: JQuery;
15296
-
15297
- /**
15298
- * The (jQuery) DOM element that closes the tab
15299
- */
15300
- closeElement: JQuery;
15301
-
15302
- /**
15303
- * Sets the tab's title. Does not affect the contentItem's title!
15304
- * @param title The new title
15305
- */
15306
- setTitle(title: string): void;
15307
-
15308
- /**
15309
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15310
- * @param isActive Whether the tab is active
15311
- */
15312
- setActive(isActive: boolean): void;
15313
- }
15314
-
15315
- declare interface TabDragListener extends EventEmitter_2 {
15316
- /**
15317
- * A reference to the content item this tab relates to
15318
- */
15319
- contentItem: ContentItem;
15320
- }
15321
-
15322
14341
  /**
15323
14342
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15324
14343
  */