@openfin/node-adapter 37.81.20 → 37.81.22

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
  };
@@ -3782,103 +3718,6 @@ declare type ConstWindowOptions = {
3782
3718
  inheritance?: Partial<InheritableOptions>;
3783
3719
  };
3784
3720
 
3785
- declare interface Container extends EventEmitter_2 {
3786
- /**
3787
- * The current width of the container in pixel
3788
- */
3789
- width: number;
3790
-
3791
- /**
3792
- * The current height of the container in pixel
3793
- */
3794
- height: number;
3795
-
3796
- /**
3797
- * A reference to the component-item that controls this container
3798
- */
3799
- parent: ContentItem;
3800
-
3801
- /**
3802
- * A reference to the tab that controls this container. Will initially be null
3803
- * (and populated once a tab event has been fired).
3804
- */
3805
- tab: Tab;
3806
-
3807
- /**
3808
- * The current title of the container
3809
- */
3810
- title: string;
3811
-
3812
- /*
3813
- * A reference to the GoldenLayout instance this container belongs to
3814
- */
3815
- layoutManager: GoldenLayout_2;
3816
-
3817
- /**
3818
- * True if the item is currently hidden
3819
- */
3820
- isHidden: boolean;
3821
-
3822
- /**
3823
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3824
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3825
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3826
- * constructor function. It will also be used when the component is opened in a new window.
3827
- * @param state A serialisable object
3828
- */
3829
- setState(state: any): void;
3830
-
3831
- /**
3832
- * The same as setState but does not emit 'stateChanged' event
3833
- * @param {serialisable} state
3834
- */
3835
- setStateSkipEvent(state: any): void;
3836
-
3837
- /**
3838
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3839
- * @param state A serialisable object
3840
- */
3841
- extendState(state: any): void;
3842
-
3843
- /**
3844
- * Returns the current state.
3845
- */
3846
- getState(): any;
3847
-
3848
- /**
3849
- * Returns the container's inner element as a jQuery element
3850
- */
3851
- getElement(): JQuery;
3852
-
3853
- /**
3854
- * hides the container or returns false if hiding it is not possible
3855
- */
3856
- hide(): boolean;
3857
-
3858
- /**
3859
- * shows the container or returns false if showing it is not possible
3860
- */
3861
- show(): boolean;
3862
-
3863
- /**
3864
- * Sets the container to the specified size or returns false if that's not possible
3865
- * @param width the new width in pixel
3866
- * @param height the new height in pixel
3867
- */
3868
- setSize(width: number, height: number): boolean;
3869
-
3870
- /**
3871
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3872
- * @param title the new title
3873
- */
3874
- setTitle(title: string): void;
3875
-
3876
- /**
3877
- * Closes the container or returns false if that is not possible
3878
- */
3879
- close(): boolean;
3880
- }
3881
-
3882
3721
  /**
3883
3722
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3884
3723
  */
@@ -3952,218 +3791,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3952
3791
  disposition: string;
3953
3792
  };
3954
3793
 
3955
- declare interface ContentItem extends EventEmitter_2 {
3956
- instance: any;
3957
- header: any;
3958
- _splitter: any;
3959
- /**
3960
- * This items configuration in its current state
3961
- */
3962
- config: ItemConfigType;
3963
-
3964
- /**
3965
- * The type of the item. Can be row, column, stack, component or root
3966
- */
3967
- type: ItemType;
3968
-
3969
- /**
3970
- * An array of items that are children of this item
3971
- */
3972
- contentItems: ContentItem[];
3973
-
3974
- container: Container;
3975
- /**
3976
- * The item that is this item's parent (or null if the item is root)
3977
- */
3978
- parent: ContentItem;
3979
-
3980
- /**
3981
- * A String or array of identifiers if provided in the configuration
3982
- */
3983
- id: string;
3984
-
3985
- /**
3986
- * True if the item had been initialised
3987
- */
3988
- isInitialised: boolean;
3989
-
3990
- /**
3991
- * True if the item is maximised
3992
- */
3993
- isMaximised: boolean;
3994
-
3995
- /**
3996
- * True if the item is the layout's root item
3997
- */
3998
- isRoot: boolean;
3999
-
4000
- /**
4001
- * True if the item is a row
4002
- */
4003
- isRow: boolean;
4004
-
4005
- /**
4006
- * True if the item is a column
4007
- */
4008
- isColumn: boolean;
4009
-
4010
- /**
4011
- * True if the item is a stack
4012
- */
4013
- isStack: boolean;
4014
-
4015
- /**
4016
- * True if the item is a component
4017
- */
4018
- isComponent: boolean;
4019
-
4020
- /**
4021
- * A reference to the layoutManager that controls this item
4022
- */
4023
- layoutManager: any;
4024
-
4025
- /**
4026
- * The item's outer element
4027
- */
4028
- element: JQuery;
4029
-
4030
- /**
4031
- * The item's inner element. Can be the same as the outer element.
4032
- */
4033
- childElementContainer: Container;
4034
-
4035
- /**
4036
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4037
- * from its original position before adding it to this item.
4038
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4039
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4040
- */
4041
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4042
-
4043
- /**
4044
- * Destroys the item and all it's children
4045
- * @param contentItem The contentItem that should be removed
4046
- * @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.
4047
- */
4048
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4049
-
4050
- /**
4051
- * The contentItem that should be removed
4052
- * @param oldChild ContentItem The contentItem that should be removed
4053
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4054
- */
4055
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4056
-
4057
- /**
4058
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4059
- */
4060
- setSize(): void;
4061
-
4062
- /**
4063
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4064
- * @param title the new title
4065
- */
4066
- setTitle(title: string): void;
4067
-
4068
- /**
4069
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4070
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4071
- * @param functionName The name of the method to invoke
4072
- * @param functionArguments An array of arguments to pass to every function
4073
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4074
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4075
- */
4076
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4077
-
4078
- /**
4079
- * 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.
4080
- */
4081
- emitBubblingEvent(name: string): void;
4082
-
4083
- /**
4084
- * Convenience method for item.parent.removeChild( item )
4085
- */
4086
- remove(): void;
4087
-
4088
- /**
4089
- * Removes the item from its current position in the layout and opens it in a window
4090
- */
4091
- popout(): BrowserWindow;
4092
-
4093
- /**
4094
- * Maximises the item or minimises it if it's already maximised
4095
- */
4096
- toggleMaximise(): void;
4097
-
4098
- /**
4099
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4100
- */
4101
- select(): void;
4102
-
4103
- /**
4104
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4105
- */
4106
- deselect(): void;
4107
-
4108
- /**
4109
- * Returns true if the item has the specified id or false if not
4110
- * @param id An id to check for
4111
- */
4112
- hasId(id: string): boolean;
4113
-
4114
- /**
4115
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4116
- * @param contentItem The new active content item
4117
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4118
- */
4119
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4120
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4121
-
4122
- /**
4123
- * Only Stacks have this method! Returns the currently selected contentItem.
4124
- */
4125
- getActiveContentItem(): ContentItem;
4126
-
4127
- /**
4128
- * Adds an id to an item or does nothing if the id is already present
4129
- * @param id The id to be added
4130
- */
4131
- addId(id: string): void;
4132
-
4133
- /**
4134
- * Removes an id from an item or throws an error if the id couldn't be found
4135
- * @param id The id to be removed
4136
- */
4137
- removeId(id: string): void;
4138
-
4139
- /**
4140
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4141
- * @param filterFunction A function that determines whether an item matches certain criteria
4142
- */
4143
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4144
-
4145
- /**
4146
- * Returns all items with the specified id.
4147
- * @param id An id specified in the itemConfig
4148
- */
4149
- getItemsById(id: string | string[]): ContentItem[];
4150
-
4151
- /**
4152
- * Returns all items with the specified type
4153
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4154
- */
4155
- getItemsByType(type: string): ContentItem[];
4156
-
4157
- /**
4158
- * Returns all instances of the component with the specified componentName
4159
- * @param componentName a componentName as specified in the itemConfig
4160
- */
4161
- getComponentsByName(componentName: string): any;
4162
-
4163
- _contentAreaDimensions: any;
4164
- _$getArea: () => any;
4165
- }
4166
-
4167
3794
  /**
4168
3795
  * Restrict navigation to URLs that match an allowed pattern.
4169
3796
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4591,46 +4218,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4591
4218
  type: 'did-finish-load';
4592
4219
  };
4593
4220
 
4594
- declare interface Dimensions {
4595
- /**
4596
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4597
- * than the visible one, making it safe to set this to small values without affecting usability.
4598
- * Default: 5
4599
- */
4600
- borderWidth?: number;
4601
-
4602
- /**
4603
- * The minimum height an item can be resized to (in pixel).
4604
- * Default: 10
4605
- */
4606
- minItemHeight?: number;
4607
-
4608
- /**
4609
- * The minimum width an item can be resized to (in pixel).
4610
- * Default: 10
4611
- */
4612
- minItemWidth?: number;
4613
-
4614
- /**
4615
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4616
- * adjusted accordingly.
4617
- * Default: 20
4618
- */
4619
- headerHeight?: number;
4620
-
4621
- /**
4622
- * The width of the element that appears when an item is dragged (in pixel).
4623
- * Default: 300
4624
- */
4625
- dragProxyWidth?: number;
4626
-
4627
- /**
4628
- * The height of the element that appears when an item is dragged (in pixel).
4629
- * Default: 200
4630
- */
4631
- dragProxyHeight?: number;
4632
- }
4633
-
4634
4221
  /**
4635
4222
  * @interface
4636
4223
  */
@@ -4880,8 +4467,6 @@ declare type Dpi = {
4880
4467
  vertical?: number;
4881
4468
  };
4882
4469
 
4883
- declare interface DragSource {}
4884
-
4885
4470
  /**
4886
4471
  * Generated when a window has been embedded.
4887
4472
  * @interface
@@ -5192,43 +4777,6 @@ declare class EventAggregator extends EmitterMap {
5192
4777
  dispatchEvent: (message: Message<any>) => boolean;
5193
4778
  }
5194
4779
 
5195
- declare interface EventEmitter_2 {
5196
- [x: string]: any;
5197
- /**
5198
- * Subscribe to an event
5199
- * @param eventName The name of the event to describe to
5200
- * @param callback The function that should be invoked when the event occurs
5201
- * @param context The value of the this pointer in the callback function
5202
- */
5203
- on(eventName: string, callback: Function, context?: any): void;
5204
-
5205
- /**
5206
- * Notify listeners of an event and pass arguments along
5207
- * @param eventName The name of the event to emit
5208
- */
5209
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5210
-
5211
- /**
5212
- * Alias for emit
5213
- */
5214
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5215
-
5216
- /**
5217
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5218
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5219
- * arguments.
5220
- * @param eventName The name of the event to unsubscribe from
5221
- * @param callback The function that should be invoked when the event occurs
5222
- * @param context The value of the this pointer in the callback function
5223
- */
5224
- unbind(eventName: string, callback?: Function, context?: any): void;
5225
-
5226
- /**
5227
- * Alias for unbind
5228
- */
5229
- off(eventName: string, callback?: Function, context?: any): void;
5230
- }
5231
-
5232
4780
  /**
5233
4781
  * Handler for an event on an EventEmitter.
5234
4782
  * @remarks Selects the correct type for the event
@@ -6115,253 +5663,6 @@ declare namespace GlobalHotkeyEvents {
6115
5663
  */
6116
5664
  declare type GlobalHotkeyEventType = EventType_6;
6117
5665
 
6118
- declare namespace GoldenLayout {
6119
- export {
6120
- GoldenLayout_2 as GoldenLayout,
6121
- ItemConfigType,
6122
- Settings,
6123
- Dimensions,
6124
- Labels,
6125
- ItemType,
6126
- ItemConfig,
6127
- ComponentConfig,
6128
- ReactComponentConfig,
6129
- Config,
6130
- ContentItem,
6131
- Container,
6132
- DragSource,
6133
- BrowserWindow,
6134
- Header,
6135
- TabDragListener,
6136
- Tab,
6137
- EventEmitter_2 as EventEmitter
6138
- }
6139
- }
6140
-
6141
- declare class GoldenLayout_2 implements EventEmitter_2 {
6142
- /**
6143
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6144
- * object and of goldenLayout.root as the document.
6145
- */
6146
- root: ContentItem;
6147
-
6148
- /**
6149
- * A reference to the (jQuery) DOM element containing the layout
6150
- */
6151
- container: JQuery;
6152
-
6153
- /**
6154
- * True once the layout item tree has been created and the initialised event has been fired
6155
- */
6156
- isInitialised: boolean;
6157
-
6158
- /**
6159
- * A reference to the current, extended top level config.
6160
- *
6161
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6162
- */
6163
- config: Config;
6164
-
6165
- /**
6166
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6167
- * to true.
6168
- */
6169
- selectedItem: ContentItem;
6170
-
6171
- /**
6172
- * The current outer width of the layout in pixels.
6173
- */
6174
- width: number;
6175
-
6176
- /**
6177
- * The current outer height of the layout in pixels.
6178
- */
6179
- height: number;
6180
-
6181
- /**
6182
- * An array of BrowserWindow instances
6183
- */
6184
- openPopouts: BrowserWindow[];
6185
-
6186
- /**
6187
- * True if the layout has been opened as a popout by another layout.
6188
- */
6189
- isSubWindow: boolean;
6190
-
6191
- /**
6192
- * A singleton instance of EventEmitter that works across windows
6193
- */
6194
- eventHub: EventEmitter_2;
6195
-
6196
- _dragProxy: any;
6197
-
6198
- dropTargetIndicator: any;
6199
-
6200
- _isFullPage: boolean;
6201
-
6202
- _onUnload: any;
6203
-
6204
- tabDropPlaceholder: any;
6205
-
6206
- transitionIndicator: any;
6207
-
6208
- _dragSources: any;
6209
-
6210
- _resizeFunction: any;
6211
-
6212
- _unloadFunction: any;
6213
-
6214
- /**
6215
- * @param config A GoldenLayout configuration object
6216
- * @param container The DOM element the layout will be initialised in. Default: document.body
6217
- */
6218
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6219
-
6220
- /*
6221
- * @param name The name of the component, as referred to by componentName in the component configuration.
6222
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6223
- * containerobject and a component state
6224
- */
6225
- registerComponent(name: String, component: any): void;
6226
-
6227
- /**
6228
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6229
- * a listener to the document and executes once it becomes ready.
6230
- */
6231
- init(): void;
6232
-
6233
- /**
6234
- * Returns the current state of the layout and its components as a serialisable object.
6235
- */
6236
- toConfig(): Config;
6237
-
6238
- /**
6239
- * Returns a component that was previously registered with layout.registerComponent().
6240
- * @param name The name of a previously registered component
6241
- */
6242
- getComponent(name: string): any;
6243
-
6244
- /**
6245
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6246
- * @param width The outer width the layout should be resized to. Default: The container elements width
6247
- * @param height The outer height the layout should be resized to. Default: The container elements height
6248
- */
6249
- updateSize(width?: number, height?: number): void;
6250
-
6251
- /**
6252
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6253
- * listeners and finally removes itself from the DOM.
6254
- */
6255
- destroy(): void;
6256
-
6257
- /**
6258
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6259
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6260
- * all call this method implicitly.
6261
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6262
- * @param parent A parent item
6263
- */
6264
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6265
-
6266
- /**
6267
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6268
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6269
- * provided its config will be read, if config is provided, only the content key
6270
- * will be used
6271
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6272
- * place the window in another screen.
6273
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6274
- * when popIn is clicked
6275
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6276
- */
6277
- createPopout(
6278
- configOrContentItem: ItemConfigType | ContentItem,
6279
- dimensions: {
6280
- width: number;
6281
- height: number;
6282
- left: number;
6283
- top: number;
6284
- },
6285
- parentId?: string,
6286
- indexInParent?: number
6287
- ): void;
6288
-
6289
- /**
6290
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6291
- * where it turns into a contentItem.
6292
- * @param element The DOM element that will be turned into a dragSource
6293
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6294
- * @return the dragSource that was created. This can be used to remove the
6295
- * dragSource from the layout later.
6296
- */
6297
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6298
-
6299
- /**
6300
- * Removes a dragSource from the layout.
6301
- *
6302
- * @param dragSource The dragSource to remove
6303
- */
6304
- removeDragSource(dragSource: DragSource): void;
6305
-
6306
- /**
6307
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6308
- * @param contentItem A ContentItem instance
6309
- */
6310
- selectItem(contentItem: ContentItem): void;
6311
-
6312
- /**
6313
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6314
- * and replace frequent keys and values with single letter substitutes.
6315
- * @param config A GoldenLayout configuration object
6316
- */
6317
- static minifyConfig(config: any): any;
6318
-
6319
- /**
6320
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6321
- * @param minifiedConfig A minified GoldenLayout configuration object
6322
- */
6323
- static unminifyConfig(minifiedConfig: any): any;
6324
-
6325
- /**
6326
- * Subscribe to an event
6327
- * @param eventName The name of the event to describe to
6328
- * @param callback The function that should be invoked when the event occurs
6329
- * @param context The value of the this pointer in the callback function
6330
- */
6331
- on(eventName: string, callback: Function, context?: any): void;
6332
-
6333
- /**
6334
- * Notify listeners of an event and pass arguments along
6335
- * @param eventName The name of the event to emit
6336
- */
6337
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6338
-
6339
- /**
6340
- * Alias for emit
6341
- */
6342
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6343
-
6344
- /**
6345
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6346
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6347
- * arguments.
6348
- * @param eventName The name of the event to unsubscribe from
6349
- * @param callback The function that should be invoked when the event occurs
6350
- * @param context The value of the this pointer in the callback function
6351
- */
6352
- unbind(eventName: string, callback?: Function, context?: any): void;
6353
-
6354
- /**
6355
- * Alias for unbind
6356
- */
6357
- off(eventName: string, callback?: Function, context?: any): void;
6358
-
6359
- /**
6360
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6361
- */
6362
- _$createRootItemAreas(): void;
6363
- }
6364
-
6365
5666
  /**
6366
5667
  * @interface
6367
5668
  */
@@ -6369,62 +5670,6 @@ declare type GpuInfo = {
6369
5670
  name: string;
6370
5671
  };
6371
5672
 
6372
- declare interface Header {
6373
- /**
6374
- * A reference to the LayoutManager instance
6375
- */
6376
- layoutManager: GoldenLayout_2;
6377
-
6378
- /**
6379
- * A reference to the Stack this Header belongs to
6380
- */
6381
- parent: ContentItem;
6382
-
6383
- /**
6384
- * An array of the Tabs within this header
6385
- */
6386
- tabs: Tab[];
6387
-
6388
- /**
6389
- * The currently selected activeContentItem
6390
- */
6391
- activeContentItem: ContentItem;
6392
-
6393
- /**
6394
- * The outer (jQuery) DOM element of this Header
6395
- */
6396
- element: JQuery;
6397
-
6398
- /**
6399
- * The (jQuery) DOM element containing the tabs
6400
- */
6401
- tabsContainer: JQuery;
6402
-
6403
- /**
6404
- * The (jQuery) DOM element containing the close, maximise and popout button
6405
- */
6406
- controlsContainer: JQuery;
6407
-
6408
- /**
6409
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6410
- * @param contentItem The content item that will be selected
6411
- */
6412
- setActiveContentItem(contentItem: ContentItem): void;
6413
-
6414
- /**
6415
- * Creates a new tab and associates it with a content item
6416
- * @param contentItem The content item the tab will be associated with
6417
- * @param index A zero based index, specifying the position of the new tab
6418
- */
6419
- createTab(contentItem: ContentItem, index?: number): void;
6420
-
6421
- /**
6422
- * Finds a tab by its contentItem and removes it
6423
- * @param contentItem The content item the tab is associated with
6424
- */
6425
- removeTab(contentItem: ContentItem): void;
6426
- }
6427
-
6428
5673
  /**
6429
5674
  * Generated when a View is hidden.
6430
5675
  * @interface
@@ -8037,50 +7282,6 @@ declare class InteropModule extends Base {
8037
7282
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8038
7283
  }
8039
7284
 
8040
- declare interface ItemConfig {
8041
- /**
8042
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8043
- */
8044
- type: ItemType;
8045
-
8046
- /**
8047
- * An array of configurations for items that will be created as children of this item.
8048
- */
8049
- content?: ItemConfigType[];
8050
-
8051
- /**
8052
- * The width of this item, relative to the other children of its parent in percent
8053
- */
8054
- width?: number;
8055
-
8056
- /**
8057
- * The height of this item, relative to the other children of its parent in percent
8058
- */
8059
- height?: number;
8060
-
8061
- /**
8062
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8063
- */
8064
- id?: string | string[];
8065
-
8066
- /**
8067
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8068
- * will return false
8069
- * Default: true
8070
- */
8071
- isClosable?: boolean;
8072
-
8073
- /**
8074
- * The title of the item as displayed on its tab and on popout windows
8075
- * Default: componentName or ''
8076
- */
8077
- title?: string;
8078
- }
8079
-
8080
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8081
-
8082
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8083
-
8084
7285
  /**
8085
7286
  * @interface
8086
7287
  */
@@ -8138,32 +7339,6 @@ declare type JumpListTask = {
8138
7339
  iconIndex?: number;
8139
7340
  };
8140
7341
 
8141
- declare interface Labels {
8142
- /**
8143
- * The tooltip text that appears when hovering over the close icon.
8144
- * Default: 'close'
8145
- */
8146
- close?: string;
8147
-
8148
- /**
8149
- * The tooltip text that appears when hovering over the maximise icon.
8150
- * Default: 'maximise'
8151
- */
8152
- maximise?: string;
8153
-
8154
- /**
8155
- * The tooltip text that appears when hovering over the minimise icon.
8156
- * Default: 'minimise'
8157
- */
8158
- minimise?: string;
8159
-
8160
- /**
8161
- * The tooltip text that appears when hovering over the popout icon.
8162
- * Default: 'open in new window'
8163
- */
8164
- popout?: string;
8165
- }
8166
-
8167
7342
  export declare function launch(config: ConnectConfig): Promise<number>;
8168
7343
 
8169
7344
  /**
@@ -8597,7 +7772,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8597
7772
  entityId: string;
8598
7773
  };
8599
7774
 
8600
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7775
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8601
7776
 
8602
7777
  /**
8603
7778
  * @interface
@@ -12775,18 +11950,6 @@ declare type QueryPermissionResult = {
12775
11950
  rawValue?: unknown;
12776
11951
  };
12777
11952
 
12778
- declare interface ReactComponentConfig extends ItemConfig {
12779
- /**
12780
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12781
- */
12782
- component: string;
12783
-
12784
- /**
12785
- * Properties that will be passed to the component and accessible using this.props.
12786
- */
12787
- props?: any;
12788
- }
12789
-
12790
11953
  /**
12791
11954
  * @interface
12792
11955
  */
@@ -13263,97 +12426,6 @@ declare type SessionContextGroup = {
13263
12426
  }>;
13264
12427
  };
13265
12428
 
13266
- declare interface Settings {
13267
- preventSplitterResize?: boolean;
13268
-
13269
- newTabButton?: {
13270
- url?: string;
13271
- };
13272
-
13273
- /**
13274
- * If true, tabs can't be dragged into the window.
13275
- * Default: false
13276
- */
13277
- preventDragIn?: boolean;
13278
-
13279
- /**
13280
- * If true, tabs can't be dragged out of the window.
13281
- * Default: false
13282
- */
13283
- preventDragOut?: boolean;
13284
-
13285
- /**
13286
- * If true, stack headers are the only areas where tabs can be dropped.
13287
- * Default: false
13288
- */
13289
- constrainDragToHeaders?: boolean;
13290
- /**
13291
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13292
- * Default: true
13293
- */
13294
- hasHeaders?: boolean;
13295
-
13296
- /**
13297
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13298
- * automatically when layout.createDragSource() is called.
13299
- * Default: true
13300
- */
13301
- constrainDragToContainer?: boolean;
13302
-
13303
- /**
13304
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13305
- * Default: true
13306
- */
13307
- reorderEnabled?: boolean;
13308
-
13309
- /**
13310
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13311
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13312
- * Default: false
13313
- */
13314
- selectionEnabled?: boolean;
13315
-
13316
- /**
13317
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13318
- * be transferred to the new window, if false only the active component will be opened.
13319
- * Default: false
13320
- */
13321
- popoutWholeStack?: boolean;
13322
-
13323
- /**
13324
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13325
- * If false, the popout call will fail silently.
13326
- * Default: true
13327
- */
13328
- blockedPopoutsThrowError?: boolean;
13329
-
13330
- /**
13331
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13332
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13333
- * addition, any changes made to popouts won't be stored after the parent is closed.
13334
- * Default: true
13335
- */
13336
- closePopoutsOnUnload?: boolean;
13337
-
13338
- /**
13339
- * Specifies if the popout icon should be displayed in the header-bar.
13340
- * Default: true
13341
- */
13342
- showPopoutIcon?: boolean;
13343
-
13344
- /**
13345
- * Specifies if the maximise icon should be displayed in the header-bar.
13346
- * Default: true
13347
- */
13348
- showMaximiseIcon?: boolean;
13349
-
13350
- /**
13351
- * Specifies if the close icon should be displayed in the header-bar.
13352
- * Default: true
13353
- */
13354
- showCloseIcon?: boolean;
13355
- }
13356
-
13357
12429
  /**
13358
12430
  * @interface
13359
12431
  */
@@ -15256,59 +14328,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15256
14328
  proceed: () => void;
15257
14329
  }) => void;
15258
14330
 
15259
- declare interface Tab {
15260
- _dragListener: TabDragListener;
15261
-
15262
- /**
15263
- * True if this tab is the selected tab
15264
- */
15265
- isActive: boolean;
15266
-
15267
- /**
15268
- * A reference to the header this tab is a child of
15269
- */
15270
- header: Header;
15271
-
15272
- /**
15273
- * A reference to the content item this tab relates to
15274
- */
15275
- contentItem: ContentItem;
15276
-
15277
- /**
15278
- * The tabs outer (jQuery) DOM element
15279
- */
15280
- element: JQuery;
15281
-
15282
- /**
15283
- * The (jQuery) DOM element containing the title
15284
- */
15285
- titleElement: JQuery;
15286
-
15287
- /**
15288
- * The (jQuery) DOM element that closes the tab
15289
- */
15290
- closeElement: JQuery;
15291
-
15292
- /**
15293
- * Sets the tab's title. Does not affect the contentItem's title!
15294
- * @param title The new title
15295
- */
15296
- setTitle(title: string): void;
15297
-
15298
- /**
15299
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15300
- * @param isActive Whether the tab is active
15301
- */
15302
- setActive(isActive: boolean): void;
15303
- }
15304
-
15305
- declare interface TabDragListener extends EventEmitter_2 {
15306
- /**
15307
- * A reference to the content item this tab relates to
15308
- */
15309
- contentItem: ContentItem;
15310
- }
15311
-
15312
14331
  /**
15313
14332
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15314
14333
  */