@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.
@@ -1161,9 +1161,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1161
1161
  */
1162
1162
  mainWindowOptions: WindowCreationOptions;
1163
1163
  /**
1164
- * The name of the application (and the application's main window).
1164
+ * The name of the application.
1165
1165
  *
1166
- * If provided, _must_ match `uuid`.
1166
+ * @remarks
1167
+ * This property is only used for naming the application logging folder, which will be sanitized to remove
1168
+ * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1169
+ * during startup with the UUID of the application.
1170
+ *
1171
+ * This property will be deprecated in the future.
1167
1172
  */
1168
1173
  name: string;
1169
1174
  /**
@@ -1193,9 +1198,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1193
1198
  url: string;
1194
1199
  /**
1195
1200
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1196
- * running in the OpenFin Runtime.
1197
- *
1198
- * Note that `name` and `uuid` must match.
1201
+ * running in the OpenFin Runtime.
1199
1202
  */
1200
1203
  uuid: string;
1201
1204
  /**
@@ -1904,48 +1907,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1904
1907
  behavior: 'browser';
1905
1908
  };
1906
1909
 
1907
- declare interface BrowserWindow {
1908
- /**
1909
- * True if the window has been opened and its GoldenLayout instance initialised.
1910
- */
1911
- isInitialised: boolean;
1912
-
1913
- /**
1914
- * Creates a window configuration object from the Popout.
1915
- */
1916
- toConfig(): {
1917
- dimensions: {
1918
- width: number;
1919
- height: number;
1920
- left: number;
1921
- top: number;
1922
- };
1923
- content: Config;
1924
- parentId: string;
1925
- indexInParent: number;
1926
- };
1927
-
1928
- /**
1929
- * Returns the GoldenLayout instance from the child window
1930
- */
1931
- getGlInstance(): GoldenLayout_2;
1932
-
1933
- /**
1934
- * Returns the native Window object
1935
- */
1936
- getWindow(): Window;
1937
-
1938
- /**
1939
- * Closes the popout
1940
- */
1941
- close(): void;
1942
-
1943
- /**
1944
- * Returns the popout to its original position as specified in parentId and indexInParent
1945
- */
1946
- popIn(): void;
1947
- }
1948
-
1949
1910
  /**
1950
1911
  * Extracts a single event type matching the given key from the View {@link Event} union.
1951
1912
  *
@@ -3326,31 +3287,6 @@ declare class ColumnOrRow extends LayoutNode {
3326
3287
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3327
3288
  }
3328
3289
 
3329
- declare interface ComponentConfig extends ItemConfig {
3330
- /**
3331
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3332
- */
3333
- componentName: string;
3334
-
3335
- /**
3336
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3337
- * container.getState().
3338
- */
3339
- componentState?: any;
3340
- }
3341
-
3342
- declare interface Config {
3343
- settings?: Settings;
3344
- dimensions?: Dimensions;
3345
- labels?: Labels;
3346
- content?: ItemConfigType[];
3347
- /**
3348
- * (Only on layout config object)
3349
- * Id of the currently maximised content item
3350
- */
3351
- maximisedItemId?: string;
3352
- }
3353
-
3354
3290
  declare type ConfigWithRuntime = BaseConfig & {
3355
3291
  runtime: RuntimeConfig;
3356
3292
  };
@@ -3742,103 +3678,6 @@ declare type ConstWindowOptions = {
3742
3678
  inheritance?: Partial<InheritableOptions>;
3743
3679
  };
3744
3680
 
3745
- declare interface Container extends EventEmitter_2 {
3746
- /**
3747
- * The current width of the container in pixel
3748
- */
3749
- width: number;
3750
-
3751
- /**
3752
- * The current height of the container in pixel
3753
- */
3754
- height: number;
3755
-
3756
- /**
3757
- * A reference to the component-item that controls this container
3758
- */
3759
- parent: ContentItem;
3760
-
3761
- /**
3762
- * A reference to the tab that controls this container. Will initially be null
3763
- * (and populated once a tab event has been fired).
3764
- */
3765
- tab: Tab;
3766
-
3767
- /**
3768
- * The current title of the container
3769
- */
3770
- title: string;
3771
-
3772
- /*
3773
- * A reference to the GoldenLayout instance this container belongs to
3774
- */
3775
- layoutManager: GoldenLayout_2;
3776
-
3777
- /**
3778
- * True if the item is currently hidden
3779
- */
3780
- isHidden: boolean;
3781
-
3782
- /**
3783
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3784
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3785
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3786
- * constructor function. It will also be used when the component is opened in a new window.
3787
- * @param state A serialisable object
3788
- */
3789
- setState(state: any): void;
3790
-
3791
- /**
3792
- * The same as setState but does not emit 'stateChanged' event
3793
- * @param {serialisable} state
3794
- */
3795
- setStateSkipEvent(state: any): void;
3796
-
3797
- /**
3798
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3799
- * @param state A serialisable object
3800
- */
3801
- extendState(state: any): void;
3802
-
3803
- /**
3804
- * Returns the current state.
3805
- */
3806
- getState(): any;
3807
-
3808
- /**
3809
- * Returns the container's inner element as a jQuery element
3810
- */
3811
- getElement(): JQuery;
3812
-
3813
- /**
3814
- * hides the container or returns false if hiding it is not possible
3815
- */
3816
- hide(): boolean;
3817
-
3818
- /**
3819
- * shows the container or returns false if showing it is not possible
3820
- */
3821
- show(): boolean;
3822
-
3823
- /**
3824
- * Sets the container to the specified size or returns false if that's not possible
3825
- * @param width the new width in pixel
3826
- * @param height the new height in pixel
3827
- */
3828
- setSize(width: number, height: number): boolean;
3829
-
3830
- /**
3831
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3832
- * @param title the new title
3833
- */
3834
- setTitle(title: string): void;
3835
-
3836
- /**
3837
- * Closes the container or returns false if that is not possible
3838
- */
3839
- close(): boolean;
3840
- }
3841
-
3842
3681
  /**
3843
3682
  * Generated when a Layout Container Component was created.
3844
3683
  * @interface
@@ -3920,218 +3759,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3920
3759
  disposition: string;
3921
3760
  };
3922
3761
 
3923
- declare interface ContentItem extends EventEmitter_2 {
3924
- instance: any;
3925
- header: any;
3926
- _splitter: any;
3927
- /**
3928
- * This items configuration in its current state
3929
- */
3930
- config: ItemConfigType;
3931
-
3932
- /**
3933
- * The type of the item. Can be row, column, stack, component or root
3934
- */
3935
- type: ItemType;
3936
-
3937
- /**
3938
- * An array of items that are children of this item
3939
- */
3940
- contentItems: ContentItem[];
3941
-
3942
- container: Container;
3943
- /**
3944
- * The item that is this item's parent (or null if the item is root)
3945
- */
3946
- parent: ContentItem;
3947
-
3948
- /**
3949
- * A String or array of identifiers if provided in the configuration
3950
- */
3951
- id: string;
3952
-
3953
- /**
3954
- * True if the item had been initialised
3955
- */
3956
- isInitialised: boolean;
3957
-
3958
- /**
3959
- * True if the item is maximised
3960
- */
3961
- isMaximised: boolean;
3962
-
3963
- /**
3964
- * True if the item is the layout's root item
3965
- */
3966
- isRoot: boolean;
3967
-
3968
- /**
3969
- * True if the item is a row
3970
- */
3971
- isRow: boolean;
3972
-
3973
- /**
3974
- * True if the item is a column
3975
- */
3976
- isColumn: boolean;
3977
-
3978
- /**
3979
- * True if the item is a stack
3980
- */
3981
- isStack: boolean;
3982
-
3983
- /**
3984
- * True if the item is a component
3985
- */
3986
- isComponent: boolean;
3987
-
3988
- /**
3989
- * A reference to the layoutManager that controls this item
3990
- */
3991
- layoutManager: any;
3992
-
3993
- /**
3994
- * The item's outer element
3995
- */
3996
- element: JQuery;
3997
-
3998
- /**
3999
- * The item's inner element. Can be the same as the outer element.
4000
- */
4001
- childElementContainer: Container;
4002
-
4003
- /**
4004
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4005
- * from its original position before adding it to this item.
4006
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4007
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4008
- */
4009
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4010
-
4011
- /**
4012
- * Destroys the item and all it's children
4013
- * @param contentItem The contentItem that should be removed
4014
- * @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.
4015
- */
4016
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4017
-
4018
- /**
4019
- * The contentItem that should be removed
4020
- * @param oldChild ContentItem The contentItem that should be removed
4021
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4022
- */
4023
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4024
-
4025
- /**
4026
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4027
- */
4028
- setSize(): void;
4029
-
4030
- /**
4031
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4032
- * @param title the new title
4033
- */
4034
- setTitle(title: string): void;
4035
-
4036
- /**
4037
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4038
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4039
- * @param functionName The name of the method to invoke
4040
- * @param functionArguments An array of arguments to pass to every function
4041
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4042
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4043
- */
4044
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4045
-
4046
- /**
4047
- * 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.
4048
- */
4049
- emitBubblingEvent(name: string): void;
4050
-
4051
- /**
4052
- * Convenience method for item.parent.removeChild( item )
4053
- */
4054
- remove(): void;
4055
-
4056
- /**
4057
- * Removes the item from its current position in the layout and opens it in a window
4058
- */
4059
- popout(): BrowserWindow;
4060
-
4061
- /**
4062
- * Maximises the item or minimises it if it's already maximised
4063
- */
4064
- toggleMaximise(): void;
4065
-
4066
- /**
4067
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4068
- */
4069
- select(): void;
4070
-
4071
- /**
4072
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4073
- */
4074
- deselect(): void;
4075
-
4076
- /**
4077
- * Returns true if the item has the specified id or false if not
4078
- * @param id An id to check for
4079
- */
4080
- hasId(id: string): boolean;
4081
-
4082
- /**
4083
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4084
- * @param contentItem The new active content item
4085
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4086
- */
4087
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4088
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4089
-
4090
- /**
4091
- * Only Stacks have this method! Returns the currently selected contentItem.
4092
- */
4093
- getActiveContentItem(): ContentItem;
4094
-
4095
- /**
4096
- * Adds an id to an item or does nothing if the id is already present
4097
- * @param id The id to be added
4098
- */
4099
- addId(id: string): void;
4100
-
4101
- /**
4102
- * Removes an id from an item or throws an error if the id couldn't be found
4103
- * @param id The id to be removed
4104
- */
4105
- removeId(id: string): void;
4106
-
4107
- /**
4108
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4109
- * @param filterFunction A function that determines whether an item matches certain criteria
4110
- */
4111
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4112
-
4113
- /**
4114
- * Returns all items with the specified id.
4115
- * @param id An id specified in the itemConfig
4116
- */
4117
- getItemsById(id: string | string[]): ContentItem[];
4118
-
4119
- /**
4120
- * Returns all items with the specified type
4121
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4122
- */
4123
- getItemsByType(type: string): ContentItem[];
4124
-
4125
- /**
4126
- * Returns all instances of the component with the specified componentName
4127
- * @param componentName a componentName as specified in the itemConfig
4128
- */
4129
- getComponentsByName(componentName: string): any;
4130
-
4131
- _contentAreaDimensions: any;
4132
- _$getArea: () => any;
4133
- }
4134
-
4135
3762
  /**
4136
3763
  * Restrict navigation to URLs that match an allowed pattern.
4137
3764
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4570,46 +4197,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4570
4197
  type: 'did-finish-load';
4571
4198
  };
4572
4199
 
4573
- declare interface Dimensions {
4574
- /**
4575
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4576
- * than the visible one, making it safe to set this to small values without affecting usability.
4577
- * Default: 5
4578
- */
4579
- borderWidth?: number;
4580
-
4581
- /**
4582
- * The minimum height an item can be resized to (in pixel).
4583
- * Default: 10
4584
- */
4585
- minItemHeight?: number;
4586
-
4587
- /**
4588
- * The minimum width an item can be resized to (in pixel).
4589
- * Default: 10
4590
- */
4591
- minItemWidth?: number;
4592
-
4593
- /**
4594
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4595
- * adjusted accordingly.
4596
- * Default: 20
4597
- */
4598
- headerHeight?: number;
4599
-
4600
- /**
4601
- * The width of the element that appears when an item is dragged (in pixel).
4602
- * Default: 300
4603
- */
4604
- dragProxyWidth?: number;
4605
-
4606
- /**
4607
- * The height of the element that appears when an item is dragged (in pixel).
4608
- * Default: 200
4609
- */
4610
- dragProxyHeight?: number;
4611
- }
4612
-
4613
4200
  /**
4614
4201
  * @interface
4615
4202
  */
@@ -4870,8 +4457,6 @@ declare type Dpi = {
4870
4457
  vertical?: number;
4871
4458
  };
4872
4459
 
4873
- declare interface DragSource {}
4874
-
4875
4460
  /**
4876
4461
  * Generated when a window has been embedded.
4877
4462
  * @interface
@@ -5184,43 +4769,6 @@ declare class EventAggregator extends EmitterMap {
5184
4769
  dispatchEvent: (message: Message<any>) => boolean;
5185
4770
  }
5186
4771
 
5187
- declare interface EventEmitter_2 {
5188
- [x: string]: any;
5189
- /**
5190
- * Subscribe to an event
5191
- * @param eventName The name of the event to describe to
5192
- * @param callback The function that should be invoked when the event occurs
5193
- * @param context The value of the this pointer in the callback function
5194
- */
5195
- on(eventName: string, callback: Function, context?: any): void;
5196
-
5197
- /**
5198
- * Notify listeners of an event and pass arguments along
5199
- * @param eventName The name of the event to emit
5200
- */
5201
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5202
-
5203
- /**
5204
- * Alias for emit
5205
- */
5206
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5207
-
5208
- /**
5209
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5210
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5211
- * arguments.
5212
- * @param eventName The name of the event to unsubscribe from
5213
- * @param callback The function that should be invoked when the event occurs
5214
- * @param context The value of the this pointer in the callback function
5215
- */
5216
- unbind(eventName: string, callback?: Function, context?: any): void;
5217
-
5218
- /**
5219
- * Alias for unbind
5220
- */
5221
- off(eventName: string, callback?: Function, context?: any): void;
5222
- }
5223
-
5224
4772
  /**
5225
4773
  * Handler for an event on an EventEmitter.
5226
4774
  * @remarks Selects the correct type for the event
@@ -6059,253 +5607,6 @@ declare namespace GlobalHotkeyEvents {
6059
5607
  */
6060
5608
  declare type GlobalHotkeyEventType = EventType_6;
6061
5609
 
6062
- declare namespace GoldenLayout {
6063
- export {
6064
- GoldenLayout_2 as GoldenLayout,
6065
- ItemConfigType,
6066
- Settings,
6067
- Dimensions,
6068
- Labels,
6069
- ItemType,
6070
- ItemConfig,
6071
- ComponentConfig,
6072
- ReactComponentConfig,
6073
- Config,
6074
- ContentItem,
6075
- Container,
6076
- DragSource,
6077
- BrowserWindow,
6078
- Header,
6079
- TabDragListener,
6080
- Tab,
6081
- EventEmitter_2 as EventEmitter
6082
- }
6083
- }
6084
-
6085
- declare class GoldenLayout_2 implements EventEmitter_2 {
6086
- /**
6087
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6088
- * object and of goldenLayout.root as the document.
6089
- */
6090
- root: ContentItem;
6091
-
6092
- /**
6093
- * A reference to the (jQuery) DOM element containing the layout
6094
- */
6095
- container: JQuery;
6096
-
6097
- /**
6098
- * True once the layout item tree has been created and the initialised event has been fired
6099
- */
6100
- isInitialised: boolean;
6101
-
6102
- /**
6103
- * A reference to the current, extended top level config.
6104
- *
6105
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6106
- */
6107
- config: Config;
6108
-
6109
- /**
6110
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6111
- * to true.
6112
- */
6113
- selectedItem: ContentItem;
6114
-
6115
- /**
6116
- * The current outer width of the layout in pixels.
6117
- */
6118
- width: number;
6119
-
6120
- /**
6121
- * The current outer height of the layout in pixels.
6122
- */
6123
- height: number;
6124
-
6125
- /**
6126
- * An array of BrowserWindow instances
6127
- */
6128
- openPopouts: BrowserWindow[];
6129
-
6130
- /**
6131
- * True if the layout has been opened as a popout by another layout.
6132
- */
6133
- isSubWindow: boolean;
6134
-
6135
- /**
6136
- * A singleton instance of EventEmitter that works across windows
6137
- */
6138
- eventHub: EventEmitter_2;
6139
-
6140
- _dragProxy: any;
6141
-
6142
- dropTargetIndicator: any;
6143
-
6144
- _isFullPage: boolean;
6145
-
6146
- _onUnload: any;
6147
-
6148
- tabDropPlaceholder: any;
6149
-
6150
- transitionIndicator: any;
6151
-
6152
- _dragSources: any;
6153
-
6154
- _resizeFunction: any;
6155
-
6156
- _unloadFunction: any;
6157
-
6158
- /**
6159
- * @param config A GoldenLayout configuration object
6160
- * @param container The DOM element the layout will be initialised in. Default: document.body
6161
- */
6162
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6163
-
6164
- /*
6165
- * @param name The name of the component, as referred to by componentName in the component configuration.
6166
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6167
- * containerobject and a component state
6168
- */
6169
- registerComponent(name: String, component: any): void;
6170
-
6171
- /**
6172
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6173
- * a listener to the document and executes once it becomes ready.
6174
- */
6175
- init(): void;
6176
-
6177
- /**
6178
- * Returns the current state of the layout and its components as a serialisable object.
6179
- */
6180
- toConfig(): Config;
6181
-
6182
- /**
6183
- * Returns a component that was previously registered with layout.registerComponent().
6184
- * @param name The name of a previously registered component
6185
- */
6186
- getComponent(name: string): any;
6187
-
6188
- /**
6189
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6190
- * @param width The outer width the layout should be resized to. Default: The container elements width
6191
- * @param height The outer height the layout should be resized to. Default: The container elements height
6192
- */
6193
- updateSize(width?: number, height?: number): void;
6194
-
6195
- /**
6196
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6197
- * listeners and finally removes itself from the DOM.
6198
- */
6199
- destroy(): void;
6200
-
6201
- /**
6202
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6203
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6204
- * all call this method implicitly.
6205
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6206
- * @param parent A parent item
6207
- */
6208
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6209
-
6210
- /**
6211
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6212
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6213
- * provided its config will be read, if config is provided, only the content key
6214
- * will be used
6215
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6216
- * place the window in another screen.
6217
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6218
- * when popIn is clicked
6219
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6220
- */
6221
- createPopout(
6222
- configOrContentItem: ItemConfigType | ContentItem,
6223
- dimensions: {
6224
- width: number;
6225
- height: number;
6226
- left: number;
6227
- top: number;
6228
- },
6229
- parentId?: string,
6230
- indexInParent?: number
6231
- ): void;
6232
-
6233
- /**
6234
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6235
- * where it turns into a contentItem.
6236
- * @param element The DOM element that will be turned into a dragSource
6237
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6238
- * @return the dragSource that was created. This can be used to remove the
6239
- * dragSource from the layout later.
6240
- */
6241
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6242
-
6243
- /**
6244
- * Removes a dragSource from the layout.
6245
- *
6246
- * @param dragSource The dragSource to remove
6247
- */
6248
- removeDragSource(dragSource: DragSource): void;
6249
-
6250
- /**
6251
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6252
- * @param contentItem A ContentItem instance
6253
- */
6254
- selectItem(contentItem: ContentItem): void;
6255
-
6256
- /**
6257
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6258
- * and replace frequent keys and values with single letter substitutes.
6259
- * @param config A GoldenLayout configuration object
6260
- */
6261
- static minifyConfig(config: any): any;
6262
-
6263
- /**
6264
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6265
- * @param minifiedConfig A minified GoldenLayout configuration object
6266
- */
6267
- static unminifyConfig(minifiedConfig: any): any;
6268
-
6269
- /**
6270
- * Subscribe to an event
6271
- * @param eventName The name of the event to describe to
6272
- * @param callback The function that should be invoked when the event occurs
6273
- * @param context The value of the this pointer in the callback function
6274
- */
6275
- on(eventName: string, callback: Function, context?: any): void;
6276
-
6277
- /**
6278
- * Notify listeners of an event and pass arguments along
6279
- * @param eventName The name of the event to emit
6280
- */
6281
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6282
-
6283
- /**
6284
- * Alias for emit
6285
- */
6286
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6287
-
6288
- /**
6289
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6290
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6291
- * arguments.
6292
- * @param eventName The name of the event to unsubscribe from
6293
- * @param callback The function that should be invoked when the event occurs
6294
- * @param context The value of the this pointer in the callback function
6295
- */
6296
- unbind(eventName: string, callback?: Function, context?: any): void;
6297
-
6298
- /**
6299
- * Alias for unbind
6300
- */
6301
- off(eventName: string, callback?: Function, context?: any): void;
6302
-
6303
- /**
6304
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6305
- */
6306
- _$createRootItemAreas(): void;
6307
- }
6308
-
6309
5610
  /**
6310
5611
  * @interface
6311
5612
  */
@@ -6313,62 +5614,6 @@ declare type GpuInfo = {
6313
5614
  name: string;
6314
5615
  };
6315
5616
 
6316
- declare interface Header {
6317
- /**
6318
- * A reference to the LayoutManager instance
6319
- */
6320
- layoutManager: GoldenLayout_2;
6321
-
6322
- /**
6323
- * A reference to the Stack this Header belongs to
6324
- */
6325
- parent: ContentItem;
6326
-
6327
- /**
6328
- * An array of the Tabs within this header
6329
- */
6330
- tabs: Tab[];
6331
-
6332
- /**
6333
- * The currently selected activeContentItem
6334
- */
6335
- activeContentItem: ContentItem;
6336
-
6337
- /**
6338
- * The outer (jQuery) DOM element of this Header
6339
- */
6340
- element: JQuery;
6341
-
6342
- /**
6343
- * The (jQuery) DOM element containing the tabs
6344
- */
6345
- tabsContainer: JQuery;
6346
-
6347
- /**
6348
- * The (jQuery) DOM element containing the close, maximise and popout button
6349
- */
6350
- controlsContainer: JQuery;
6351
-
6352
- /**
6353
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6354
- * @param contentItem The content item that will be selected
6355
- */
6356
- setActiveContentItem(contentItem: ContentItem): void;
6357
-
6358
- /**
6359
- * Creates a new tab and associates it with a content item
6360
- * @param contentItem The content item the tab will be associated with
6361
- * @param index A zero based index, specifying the position of the new tab
6362
- */
6363
- createTab(contentItem: ContentItem, index?: number): void;
6364
-
6365
- /**
6366
- * Finds a tab by its contentItem and removes it
6367
- * @param contentItem The content item the tab is associated with
6368
- */
6369
- removeTab(contentItem: ContentItem): void;
6370
- }
6371
-
6372
5617
  /**
6373
5618
  * Generated when a View is hidden.
6374
5619
  * @interface
@@ -7955,50 +7200,6 @@ declare class InteropModule extends Base {
7955
7200
  connectSync(name: string, interopConfig?: OpenFin_2.InteropConfig): InteropClient;
7956
7201
  }
7957
7202
 
7958
- declare interface ItemConfig {
7959
- /**
7960
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
7961
- */
7962
- type: ItemType;
7963
-
7964
- /**
7965
- * An array of configurations for items that will be created as children of this item.
7966
- */
7967
- content?: ItemConfigType[];
7968
-
7969
- /**
7970
- * The width of this item, relative to the other children of its parent in percent
7971
- */
7972
- width?: number;
7973
-
7974
- /**
7975
- * The height of this item, relative to the other children of its parent in percent
7976
- */
7977
- height?: number;
7978
-
7979
- /**
7980
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
7981
- */
7982
- id?: string | string[];
7983
-
7984
- /**
7985
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
7986
- * will return false
7987
- * Default: true
7988
- */
7989
- isClosable?: boolean;
7990
-
7991
- /**
7992
- * The title of the item as displayed on its tab and on popout windows
7993
- * Default: componentName or ''
7994
- */
7995
- title?: string;
7996
- }
7997
-
7998
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
7999
-
8000
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8001
-
8002
7203
  /**
8003
7204
  * @interface
8004
7205
  */
@@ -8056,32 +7257,6 @@ declare type JumpListTask = {
8056
7257
  iconIndex?: number;
8057
7258
  };
8058
7259
 
8059
- declare interface Labels {
8060
- /**
8061
- * The tooltip text that appears when hovering over the close icon.
8062
- * Default: 'close'
8063
- */
8064
- close?: string;
8065
-
8066
- /**
8067
- * The tooltip text that appears when hovering over the maximise icon.
8068
- * Default: 'maximise'
8069
- */
8070
- maximise?: string;
8071
-
8072
- /**
8073
- * The tooltip text that appears when hovering over the minimise icon.
8074
- * Default: 'minimise'
8075
- */
8076
- minimise?: string;
8077
-
8078
- /**
8079
- * The tooltip text that appears when hovering over the popout icon.
8080
- * Default: 'open in new window'
8081
- */
8082
- popout?: string;
8083
- }
8084
-
8085
7260
  /**
8086
7261
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8087
7262
  *
@@ -8533,7 +7708,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8533
7708
  entityId: string;
8534
7709
  };
8535
7710
 
8536
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7711
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8537
7712
 
8538
7713
  /**
8539
7714
  * @interface
@@ -12470,18 +11645,6 @@ declare type QueryPermissionResult = {
12470
11645
  rawValue?: unknown;
12471
11646
  };
12472
11647
 
12473
- declare interface ReactComponentConfig extends ItemConfig {
12474
- /**
12475
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12476
- */
12477
- component: string;
12478
-
12479
- /**
12480
- * Properties that will be passed to the component and accessible using this.props.
12481
- */
12482
- props?: any;
12483
- }
12484
-
12485
11648
  /**
12486
11649
  * @interface
12487
11650
  */
@@ -12958,97 +12121,6 @@ declare type SessionContextGroup = {
12958
12121
  }>;
12959
12122
  };
12960
12123
 
12961
- declare interface Settings {
12962
- preventSplitterResize?: boolean;
12963
-
12964
- newTabButton?: {
12965
- url?: string;
12966
- };
12967
-
12968
- /**
12969
- * If true, tabs can't be dragged into the window.
12970
- * Default: false
12971
- */
12972
- preventDragIn?: boolean;
12973
-
12974
- /**
12975
- * If true, tabs can't be dragged out of the window.
12976
- * Default: false
12977
- */
12978
- preventDragOut?: boolean;
12979
-
12980
- /**
12981
- * If true, stack headers are the only areas where tabs can be dropped.
12982
- * Default: false
12983
- */
12984
- constrainDragToHeaders?: boolean;
12985
- /**
12986
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
12987
- * Default: true
12988
- */
12989
- hasHeaders?: boolean;
12990
-
12991
- /**
12992
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
12993
- * automatically when layout.createDragSource() is called.
12994
- * Default: true
12995
- */
12996
- constrainDragToContainer?: boolean;
12997
-
12998
- /**
12999
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13000
- * Default: true
13001
- */
13002
- reorderEnabled?: boolean;
13003
-
13004
- /**
13005
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13006
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13007
- * Default: false
13008
- */
13009
- selectionEnabled?: boolean;
13010
-
13011
- /**
13012
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13013
- * be transferred to the new window, if false only the active component will be opened.
13014
- * Default: false
13015
- */
13016
- popoutWholeStack?: boolean;
13017
-
13018
- /**
13019
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13020
- * If false, the popout call will fail silently.
13021
- * Default: true
13022
- */
13023
- blockedPopoutsThrowError?: boolean;
13024
-
13025
- /**
13026
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13027
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13028
- * addition, any changes made to popouts won't be stored after the parent is closed.
13029
- * Default: true
13030
- */
13031
- closePopoutsOnUnload?: boolean;
13032
-
13033
- /**
13034
- * Specifies if the popout icon should be displayed in the header-bar.
13035
- * Default: true
13036
- */
13037
- showPopoutIcon?: boolean;
13038
-
13039
- /**
13040
- * Specifies if the maximise icon should be displayed in the header-bar.
13041
- * Default: true
13042
- */
13043
- showMaximiseIcon?: boolean;
13044
-
13045
- /**
13046
- * Specifies if the close icon should be displayed in the header-bar.
13047
- * Default: true
13048
- */
13049
- showCloseIcon?: boolean;
13050
- }
13051
-
13052
12124
  /**
13053
12125
  * @interface
13054
12126
  */
@@ -14944,52 +14016,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14944
14016
  proceed: () => void;
14945
14017
  }) => void;
14946
14018
 
14947
- declare interface Tab {
14948
- _dragListener: TabDragListener;
14949
-
14950
- /**
14951
- * True if this tab is the selected tab
14952
- */
14953
- isActive: boolean;
14954
-
14955
- /**
14956
- * A reference to the header this tab is a child of
14957
- */
14958
- header: Header;
14959
-
14960
- /**
14961
- * A reference to the content item this tab relates to
14962
- */
14963
- contentItem: ContentItem;
14964
-
14965
- /**
14966
- * The tabs outer (jQuery) DOM element
14967
- */
14968
- element: JQuery;
14969
-
14970
- /**
14971
- * The (jQuery) DOM element containing the title
14972
- */
14973
- titleElement: JQuery;
14974
-
14975
- /**
14976
- * The (jQuery) DOM element that closes the tab
14977
- */
14978
- closeElement: JQuery;
14979
-
14980
- /**
14981
- * Sets the tab's title. Does not affect the contentItem's title!
14982
- * @param title The new title
14983
- */
14984
- setTitle(title: string): void;
14985
-
14986
- /**
14987
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
14988
- * @param isActive Whether the tab is active
14989
- */
14990
- setActive(isActive: boolean): void;
14991
- }
14992
-
14993
14019
  /**
14994
14020
  * Generated when a Layout Tab Component was closed.
14995
14021
  * @interface
@@ -15007,13 +14033,6 @@ declare type TabCreatedEvent = LayoutDOMEvent & {
15007
14033
  type: 'tab-created';
15008
14034
  };
15009
14035
 
15010
- declare interface TabDragListener extends EventEmitter_2 {
15011
- /**
15012
- * A reference to the content item this tab relates to
15013
- */
15014
- contentItem: ContentItem;
15015
- }
15016
-
15017
14036
  /**
15018
14037
  * Generated when a Layout Tab Component was dropped.
15019
14038
  * @interface