@openfin/remote-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.
@@ -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
  *
@@ -3317,31 +3278,6 @@ declare class ColumnOrRow extends LayoutNode {
3317
3278
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3318
3279
  }
3319
3280
 
3320
- declare interface ComponentConfig extends ItemConfig {
3321
- /**
3322
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3323
- */
3324
- componentName: string;
3325
-
3326
- /**
3327
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3328
- * container.getState().
3329
- */
3330
- componentState?: any;
3331
- }
3332
-
3333
- declare interface Config {
3334
- settings?: Settings;
3335
- dimensions?: Dimensions;
3336
- labels?: Labels;
3337
- content?: ItemConfigType[];
3338
- /**
3339
- * (Only on layout config object)
3340
- * Id of the currently maximised content item
3341
- */
3342
- maximisedItemId?: string;
3343
- }
3344
-
3345
3281
  declare type ConfigWithRuntime = BaseConfig & {
3346
3282
  runtime: RuntimeConfig;
3347
3283
  };
@@ -3743,103 +3679,6 @@ declare type ConstWindowOptions = {
3743
3679
  inheritance?: Partial<InheritableOptions>;
3744
3680
  };
3745
3681
 
3746
- declare interface Container extends EventEmitter_2 {
3747
- /**
3748
- * The current width of the container in pixel
3749
- */
3750
- width: number;
3751
-
3752
- /**
3753
- * The current height of the container in pixel
3754
- */
3755
- height: number;
3756
-
3757
- /**
3758
- * A reference to the component-item that controls this container
3759
- */
3760
- parent: ContentItem;
3761
-
3762
- /**
3763
- * A reference to the tab that controls this container. Will initially be null
3764
- * (and populated once a tab event has been fired).
3765
- */
3766
- tab: Tab;
3767
-
3768
- /**
3769
- * The current title of the container
3770
- */
3771
- title: string;
3772
-
3773
- /*
3774
- * A reference to the GoldenLayout instance this container belongs to
3775
- */
3776
- layoutManager: GoldenLayout_2;
3777
-
3778
- /**
3779
- * True if the item is currently hidden
3780
- */
3781
- isHidden: boolean;
3782
-
3783
- /**
3784
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3785
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3786
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3787
- * constructor function. It will also be used when the component is opened in a new window.
3788
- * @param state A serialisable object
3789
- */
3790
- setState(state: any): void;
3791
-
3792
- /**
3793
- * The same as setState but does not emit 'stateChanged' event
3794
- * @param {serialisable} state
3795
- */
3796
- setStateSkipEvent(state: any): void;
3797
-
3798
- /**
3799
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3800
- * @param state A serialisable object
3801
- */
3802
- extendState(state: any): void;
3803
-
3804
- /**
3805
- * Returns the current state.
3806
- */
3807
- getState(): any;
3808
-
3809
- /**
3810
- * Returns the container's inner element as a jQuery element
3811
- */
3812
- getElement(): JQuery;
3813
-
3814
- /**
3815
- * hides the container or returns false if hiding it is not possible
3816
- */
3817
- hide(): boolean;
3818
-
3819
- /**
3820
- * shows the container or returns false if showing it is not possible
3821
- */
3822
- show(): boolean;
3823
-
3824
- /**
3825
- * Sets the container to the specified size or returns false if that's not possible
3826
- * @param width the new width in pixel
3827
- * @param height the new height in pixel
3828
- */
3829
- setSize(width: number, height: number): boolean;
3830
-
3831
- /**
3832
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3833
- * @param title the new title
3834
- */
3835
- setTitle(title: string): void;
3836
-
3837
- /**
3838
- * Closes the container or returns false if that is not possible
3839
- */
3840
- close(): boolean;
3841
- }
3842
-
3843
3682
  /**
3844
3683
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3845
3684
  */
@@ -3913,218 +3752,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3913
3752
  disposition: string;
3914
3753
  };
3915
3754
 
3916
- declare interface ContentItem extends EventEmitter_2 {
3917
- instance: any;
3918
- header: any;
3919
- _splitter: any;
3920
- /**
3921
- * This items configuration in its current state
3922
- */
3923
- config: ItemConfigType;
3924
-
3925
- /**
3926
- * The type of the item. Can be row, column, stack, component or root
3927
- */
3928
- type: ItemType;
3929
-
3930
- /**
3931
- * An array of items that are children of this item
3932
- */
3933
- contentItems: ContentItem[];
3934
-
3935
- container: Container;
3936
- /**
3937
- * The item that is this item's parent (or null if the item is root)
3938
- */
3939
- parent: ContentItem;
3940
-
3941
- /**
3942
- * A String or array of identifiers if provided in the configuration
3943
- */
3944
- id: string;
3945
-
3946
- /**
3947
- * True if the item had been initialised
3948
- */
3949
- isInitialised: boolean;
3950
-
3951
- /**
3952
- * True if the item is maximised
3953
- */
3954
- isMaximised: boolean;
3955
-
3956
- /**
3957
- * True if the item is the layout's root item
3958
- */
3959
- isRoot: boolean;
3960
-
3961
- /**
3962
- * True if the item is a row
3963
- */
3964
- isRow: boolean;
3965
-
3966
- /**
3967
- * True if the item is a column
3968
- */
3969
- isColumn: boolean;
3970
-
3971
- /**
3972
- * True if the item is a stack
3973
- */
3974
- isStack: boolean;
3975
-
3976
- /**
3977
- * True if the item is a component
3978
- */
3979
- isComponent: boolean;
3980
-
3981
- /**
3982
- * A reference to the layoutManager that controls this item
3983
- */
3984
- layoutManager: any;
3985
-
3986
- /**
3987
- * The item's outer element
3988
- */
3989
- element: JQuery;
3990
-
3991
- /**
3992
- * The item's inner element. Can be the same as the outer element.
3993
- */
3994
- childElementContainer: Container;
3995
-
3996
- /**
3997
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
3998
- * from its original position before adding it to this item.
3999
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4000
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4001
- */
4002
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4003
-
4004
- /**
4005
- * Destroys the item and all it's children
4006
- * @param contentItem The contentItem that should be removed
4007
- * @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.
4008
- */
4009
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4010
-
4011
- /**
4012
- * The contentItem that should be removed
4013
- * @param oldChild ContentItem The contentItem that should be removed
4014
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4015
- */
4016
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4017
-
4018
- /**
4019
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4020
- */
4021
- setSize(): void;
4022
-
4023
- /**
4024
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4025
- * @param title the new title
4026
- */
4027
- setTitle(title: string): void;
4028
-
4029
- /**
4030
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4031
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4032
- * @param functionName The name of the method to invoke
4033
- * @param functionArguments An array of arguments to pass to every function
4034
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4035
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4036
- */
4037
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4038
-
4039
- /**
4040
- * 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.
4041
- */
4042
- emitBubblingEvent(name: string): void;
4043
-
4044
- /**
4045
- * Convenience method for item.parent.removeChild( item )
4046
- */
4047
- remove(): void;
4048
-
4049
- /**
4050
- * Removes the item from its current position in the layout and opens it in a window
4051
- */
4052
- popout(): BrowserWindow;
4053
-
4054
- /**
4055
- * Maximises the item or minimises it if it's already maximised
4056
- */
4057
- toggleMaximise(): void;
4058
-
4059
- /**
4060
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4061
- */
4062
- select(): void;
4063
-
4064
- /**
4065
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4066
- */
4067
- deselect(): void;
4068
-
4069
- /**
4070
- * Returns true if the item has the specified id or false if not
4071
- * @param id An id to check for
4072
- */
4073
- hasId(id: string): boolean;
4074
-
4075
- /**
4076
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4077
- * @param contentItem The new active content item
4078
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4079
- */
4080
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4081
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4082
-
4083
- /**
4084
- * Only Stacks have this method! Returns the currently selected contentItem.
4085
- */
4086
- getActiveContentItem(): ContentItem;
4087
-
4088
- /**
4089
- * Adds an id to an item or does nothing if the id is already present
4090
- * @param id The id to be added
4091
- */
4092
- addId(id: string): void;
4093
-
4094
- /**
4095
- * Removes an id from an item or throws an error if the id couldn't be found
4096
- * @param id The id to be removed
4097
- */
4098
- removeId(id: string): void;
4099
-
4100
- /**
4101
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4102
- * @param filterFunction A function that determines whether an item matches certain criteria
4103
- */
4104
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4105
-
4106
- /**
4107
- * Returns all items with the specified id.
4108
- * @param id An id specified in the itemConfig
4109
- */
4110
- getItemsById(id: string | string[]): ContentItem[];
4111
-
4112
- /**
4113
- * Returns all items with the specified type
4114
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4115
- */
4116
- getItemsByType(type: string): ContentItem[];
4117
-
4118
- /**
4119
- * Returns all instances of the component with the specified componentName
4120
- * @param componentName a componentName as specified in the itemConfig
4121
- */
4122
- getComponentsByName(componentName: string): any;
4123
-
4124
- _contentAreaDimensions: any;
4125
- _$getArea: () => any;
4126
- }
4127
-
4128
3755
  /**
4129
3756
  * Restrict navigation to URLs that match an allowed pattern.
4130
3757
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4552,46 +4179,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4552
4179
  type: 'did-finish-load';
4553
4180
  };
4554
4181
 
4555
- declare interface Dimensions {
4556
- /**
4557
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4558
- * than the visible one, making it safe to set this to small values without affecting usability.
4559
- * Default: 5
4560
- */
4561
- borderWidth?: number;
4562
-
4563
- /**
4564
- * The minimum height an item can be resized to (in pixel).
4565
- * Default: 10
4566
- */
4567
- minItemHeight?: number;
4568
-
4569
- /**
4570
- * The minimum width an item can be resized to (in pixel).
4571
- * Default: 10
4572
- */
4573
- minItemWidth?: number;
4574
-
4575
- /**
4576
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4577
- * adjusted accordingly.
4578
- * Default: 20
4579
- */
4580
- headerHeight?: number;
4581
-
4582
- /**
4583
- * The width of the element that appears when an item is dragged (in pixel).
4584
- * Default: 300
4585
- */
4586
- dragProxyWidth?: number;
4587
-
4588
- /**
4589
- * The height of the element that appears when an item is dragged (in pixel).
4590
- * Default: 200
4591
- */
4592
- dragProxyHeight?: number;
4593
- }
4594
-
4595
4182
  /**
4596
4183
  * @interface
4597
4184
  */
@@ -4841,8 +4428,6 @@ declare type Dpi = {
4841
4428
  vertical?: number;
4842
4429
  };
4843
4430
 
4844
- declare interface DragSource {}
4845
-
4846
4431
  /**
4847
4432
  * Generated when a window has been embedded.
4848
4433
  * @interface
@@ -5148,43 +4733,6 @@ declare class EventAggregator extends EmitterMap {
5148
4733
  dispatchEvent: (message: Message<any>) => boolean;
5149
4734
  }
5150
4735
 
5151
- declare interface EventEmitter_2 {
5152
- [x: string]: any;
5153
- /**
5154
- * Subscribe to an event
5155
- * @param eventName The name of the event to describe to
5156
- * @param callback The function that should be invoked when the event occurs
5157
- * @param context The value of the this pointer in the callback function
5158
- */
5159
- on(eventName: string, callback: Function, context?: any): void;
5160
-
5161
- /**
5162
- * Notify listeners of an event and pass arguments along
5163
- * @param eventName The name of the event to emit
5164
- */
5165
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5166
-
5167
- /**
5168
- * Alias for emit
5169
- */
5170
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5171
-
5172
- /**
5173
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5174
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5175
- * arguments.
5176
- * @param eventName The name of the event to unsubscribe from
5177
- * @param callback The function that should be invoked when the event occurs
5178
- * @param context The value of the this pointer in the callback function
5179
- */
5180
- unbind(eventName: string, callback?: Function, context?: any): void;
5181
-
5182
- /**
5183
- * Alias for unbind
5184
- */
5185
- off(eventName: string, callback?: Function, context?: any): void;
5186
- }
5187
-
5188
4736
  /**
5189
4737
  * Handler for an event on an EventEmitter.
5190
4738
  * @remarks Selects the correct type for the event
@@ -6016,253 +5564,6 @@ declare namespace GlobalHotkeyEvents {
6016
5564
  */
6017
5565
  declare type GlobalHotkeyEventType = EventType_6;
6018
5566
 
6019
- declare namespace GoldenLayout {
6020
- export {
6021
- GoldenLayout_2 as GoldenLayout,
6022
- ItemConfigType,
6023
- Settings,
6024
- Dimensions,
6025
- Labels,
6026
- ItemType,
6027
- ItemConfig,
6028
- ComponentConfig,
6029
- ReactComponentConfig,
6030
- Config,
6031
- ContentItem,
6032
- Container,
6033
- DragSource,
6034
- BrowserWindow,
6035
- Header,
6036
- TabDragListener,
6037
- Tab,
6038
- EventEmitter_2 as EventEmitter
6039
- }
6040
- }
6041
-
6042
- declare class GoldenLayout_2 implements EventEmitter_2 {
6043
- /**
6044
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6045
- * object and of goldenLayout.root as the document.
6046
- */
6047
- root: ContentItem;
6048
-
6049
- /**
6050
- * A reference to the (jQuery) DOM element containing the layout
6051
- */
6052
- container: JQuery;
6053
-
6054
- /**
6055
- * True once the layout item tree has been created and the initialised event has been fired
6056
- */
6057
- isInitialised: boolean;
6058
-
6059
- /**
6060
- * A reference to the current, extended top level config.
6061
- *
6062
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6063
- */
6064
- config: Config;
6065
-
6066
- /**
6067
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6068
- * to true.
6069
- */
6070
- selectedItem: ContentItem;
6071
-
6072
- /**
6073
- * The current outer width of the layout in pixels.
6074
- */
6075
- width: number;
6076
-
6077
- /**
6078
- * The current outer height of the layout in pixels.
6079
- */
6080
- height: number;
6081
-
6082
- /**
6083
- * An array of BrowserWindow instances
6084
- */
6085
- openPopouts: BrowserWindow[];
6086
-
6087
- /**
6088
- * True if the layout has been opened as a popout by another layout.
6089
- */
6090
- isSubWindow: boolean;
6091
-
6092
- /**
6093
- * A singleton instance of EventEmitter that works across windows
6094
- */
6095
- eventHub: EventEmitter_2;
6096
-
6097
- _dragProxy: any;
6098
-
6099
- dropTargetIndicator: any;
6100
-
6101
- _isFullPage: boolean;
6102
-
6103
- _onUnload: any;
6104
-
6105
- tabDropPlaceholder: any;
6106
-
6107
- transitionIndicator: any;
6108
-
6109
- _dragSources: any;
6110
-
6111
- _resizeFunction: any;
6112
-
6113
- _unloadFunction: any;
6114
-
6115
- /**
6116
- * @param config A GoldenLayout configuration object
6117
- * @param container The DOM element the layout will be initialised in. Default: document.body
6118
- */
6119
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6120
-
6121
- /*
6122
- * @param name The name of the component, as referred to by componentName in the component configuration.
6123
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6124
- * containerobject and a component state
6125
- */
6126
- registerComponent(name: String, component: any): void;
6127
-
6128
- /**
6129
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6130
- * a listener to the document and executes once it becomes ready.
6131
- */
6132
- init(): void;
6133
-
6134
- /**
6135
- * Returns the current state of the layout and its components as a serialisable object.
6136
- */
6137
- toConfig(): Config;
6138
-
6139
- /**
6140
- * Returns a component that was previously registered with layout.registerComponent().
6141
- * @param name The name of a previously registered component
6142
- */
6143
- getComponent(name: string): any;
6144
-
6145
- /**
6146
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6147
- * @param width The outer width the layout should be resized to. Default: The container elements width
6148
- * @param height The outer height the layout should be resized to. Default: The container elements height
6149
- */
6150
- updateSize(width?: number, height?: number): void;
6151
-
6152
- /**
6153
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6154
- * listeners and finally removes itself from the DOM.
6155
- */
6156
- destroy(): void;
6157
-
6158
- /**
6159
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6160
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6161
- * all call this method implicitly.
6162
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6163
- * @param parent A parent item
6164
- */
6165
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6166
-
6167
- /**
6168
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6169
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6170
- * provided its config will be read, if config is provided, only the content key
6171
- * will be used
6172
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6173
- * place the window in another screen.
6174
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6175
- * when popIn is clicked
6176
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6177
- */
6178
- createPopout(
6179
- configOrContentItem: ItemConfigType | ContentItem,
6180
- dimensions: {
6181
- width: number;
6182
- height: number;
6183
- left: number;
6184
- top: number;
6185
- },
6186
- parentId?: string,
6187
- indexInParent?: number
6188
- ): void;
6189
-
6190
- /**
6191
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6192
- * where it turns into a contentItem.
6193
- * @param element The DOM element that will be turned into a dragSource
6194
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6195
- * @return the dragSource that was created. This can be used to remove the
6196
- * dragSource from the layout later.
6197
- */
6198
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6199
-
6200
- /**
6201
- * Removes a dragSource from the layout.
6202
- *
6203
- * @param dragSource The dragSource to remove
6204
- */
6205
- removeDragSource(dragSource: DragSource): void;
6206
-
6207
- /**
6208
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6209
- * @param contentItem A ContentItem instance
6210
- */
6211
- selectItem(contentItem: ContentItem): void;
6212
-
6213
- /**
6214
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6215
- * and replace frequent keys and values with single letter substitutes.
6216
- * @param config A GoldenLayout configuration object
6217
- */
6218
- static minifyConfig(config: any): any;
6219
-
6220
- /**
6221
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6222
- * @param minifiedConfig A minified GoldenLayout configuration object
6223
- */
6224
- static unminifyConfig(minifiedConfig: any): any;
6225
-
6226
- /**
6227
- * Subscribe to an event
6228
- * @param eventName The name of the event to describe to
6229
- * @param callback The function that should be invoked when the event occurs
6230
- * @param context The value of the this pointer in the callback function
6231
- */
6232
- on(eventName: string, callback: Function, context?: any): void;
6233
-
6234
- /**
6235
- * Notify listeners of an event and pass arguments along
6236
- * @param eventName The name of the event to emit
6237
- */
6238
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6239
-
6240
- /**
6241
- * Alias for emit
6242
- */
6243
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6244
-
6245
- /**
6246
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6247
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6248
- * arguments.
6249
- * @param eventName The name of the event to unsubscribe from
6250
- * @param callback The function that should be invoked when the event occurs
6251
- * @param context The value of the this pointer in the callback function
6252
- */
6253
- unbind(eventName: string, callback?: Function, context?: any): void;
6254
-
6255
- /**
6256
- * Alias for unbind
6257
- */
6258
- off(eventName: string, callback?: Function, context?: any): void;
6259
-
6260
- /**
6261
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6262
- */
6263
- _$createRootItemAreas(): void;
6264
- }
6265
-
6266
5567
  /**
6267
5568
  * @interface
6268
5569
  */
@@ -6270,62 +5571,6 @@ declare type GpuInfo = {
6270
5571
  name: string;
6271
5572
  };
6272
5573
 
6273
- declare interface Header {
6274
- /**
6275
- * A reference to the LayoutManager instance
6276
- */
6277
- layoutManager: GoldenLayout_2;
6278
-
6279
- /**
6280
- * A reference to the Stack this Header belongs to
6281
- */
6282
- parent: ContentItem;
6283
-
6284
- /**
6285
- * An array of the Tabs within this header
6286
- */
6287
- tabs: Tab[];
6288
-
6289
- /**
6290
- * The currently selected activeContentItem
6291
- */
6292
- activeContentItem: ContentItem;
6293
-
6294
- /**
6295
- * The outer (jQuery) DOM element of this Header
6296
- */
6297
- element: JQuery;
6298
-
6299
- /**
6300
- * The (jQuery) DOM element containing the tabs
6301
- */
6302
- tabsContainer: JQuery;
6303
-
6304
- /**
6305
- * The (jQuery) DOM element containing the close, maximise and popout button
6306
- */
6307
- controlsContainer: JQuery;
6308
-
6309
- /**
6310
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6311
- * @param contentItem The content item that will be selected
6312
- */
6313
- setActiveContentItem(contentItem: ContentItem): void;
6314
-
6315
- /**
6316
- * Creates a new tab and associates it with a content item
6317
- * @param contentItem The content item the tab will be associated with
6318
- * @param index A zero based index, specifying the position of the new tab
6319
- */
6320
- createTab(contentItem: ContentItem, index?: number): void;
6321
-
6322
- /**
6323
- * Finds a tab by its contentItem and removes it
6324
- * @param contentItem The content item the tab is associated with
6325
- */
6326
- removeTab(contentItem: ContentItem): void;
6327
- }
6328
-
6329
5574
  /**
6330
5575
  * Generated when a View is hidden.
6331
5576
  * @interface
@@ -7933,50 +7178,6 @@ declare class InteropModule extends Base {
7933
7178
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7934
7179
  }
7935
7180
 
7936
- declare interface ItemConfig {
7937
- /**
7938
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
7939
- */
7940
- type: ItemType;
7941
-
7942
- /**
7943
- * An array of configurations for items that will be created as children of this item.
7944
- */
7945
- content?: ItemConfigType[];
7946
-
7947
- /**
7948
- * The width of this item, relative to the other children of its parent in percent
7949
- */
7950
- width?: number;
7951
-
7952
- /**
7953
- * The height of this item, relative to the other children of its parent in percent
7954
- */
7955
- height?: number;
7956
-
7957
- /**
7958
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
7959
- */
7960
- id?: string | string[];
7961
-
7962
- /**
7963
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
7964
- * will return false
7965
- * Default: true
7966
- */
7967
- isClosable?: boolean;
7968
-
7969
- /**
7970
- * The title of the item as displayed on its tab and on popout windows
7971
- * Default: componentName or ''
7972
- */
7973
- title?: string;
7974
- }
7975
-
7976
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
7977
-
7978
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
7979
-
7980
7181
  /**
7981
7182
  * @interface
7982
7183
  */
@@ -8034,32 +7235,6 @@ declare type JumpListTask = {
8034
7235
  iconIndex?: number;
8035
7236
  };
8036
7237
 
8037
- declare interface Labels {
8038
- /**
8039
- * The tooltip text that appears when hovering over the close icon.
8040
- * Default: 'close'
8041
- */
8042
- close?: string;
8043
-
8044
- /**
8045
- * The tooltip text that appears when hovering over the maximise icon.
8046
- * Default: 'maximise'
8047
- */
8048
- maximise?: string;
8049
-
8050
- /**
8051
- * The tooltip text that appears when hovering over the minimise icon.
8052
- * Default: 'minimise'
8053
- */
8054
- minimise?: string;
8055
-
8056
- /**
8057
- * The tooltip text that appears when hovering over the popout icon.
8058
- * Default: 'open in new window'
8059
- */
8060
- popout?: string;
8061
- }
8062
-
8063
7238
  /**
8064
7239
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8065
7240
  *
@@ -8485,7 +7660,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8485
7660
  entityId: string;
8486
7661
  };
8487
7662
 
8488
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7663
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8489
7664
 
8490
7665
  /**
8491
7666
  * @interface
@@ -12392,18 +11567,6 @@ declare type QueryPermissionResult = {
12392
11567
  rawValue?: unknown;
12393
11568
  };
12394
11569
 
12395
- declare interface ReactComponentConfig extends ItemConfig {
12396
- /**
12397
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12398
- */
12399
- component: string;
12400
-
12401
- /**
12402
- * Properties that will be passed to the component and accessible using this.props.
12403
- */
12404
- props?: any;
12405
- }
12406
-
12407
11570
  /**
12408
11571
  * @interface
12409
11572
  */
@@ -12880,97 +12043,6 @@ declare type SessionContextGroup = {
12880
12043
  }>;
12881
12044
  };
12882
12045
 
12883
- declare interface Settings {
12884
- preventSplitterResize?: boolean;
12885
-
12886
- newTabButton?: {
12887
- url?: string;
12888
- };
12889
-
12890
- /**
12891
- * If true, tabs can't be dragged into the window.
12892
- * Default: false
12893
- */
12894
- preventDragIn?: boolean;
12895
-
12896
- /**
12897
- * If true, tabs can't be dragged out of the window.
12898
- * Default: false
12899
- */
12900
- preventDragOut?: boolean;
12901
-
12902
- /**
12903
- * If true, stack headers are the only areas where tabs can be dropped.
12904
- * Default: false
12905
- */
12906
- constrainDragToHeaders?: boolean;
12907
- /**
12908
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
12909
- * Default: true
12910
- */
12911
- hasHeaders?: boolean;
12912
-
12913
- /**
12914
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
12915
- * automatically when layout.createDragSource() is called.
12916
- * Default: true
12917
- */
12918
- constrainDragToContainer?: boolean;
12919
-
12920
- /**
12921
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
12922
- * Default: true
12923
- */
12924
- reorderEnabled?: boolean;
12925
-
12926
- /**
12927
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
12928
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
12929
- * Default: false
12930
- */
12931
- selectionEnabled?: boolean;
12932
-
12933
- /**
12934
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
12935
- * be transferred to the new window, if false only the active component will be opened.
12936
- * Default: false
12937
- */
12938
- popoutWholeStack?: boolean;
12939
-
12940
- /**
12941
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
12942
- * If false, the popout call will fail silently.
12943
- * Default: true
12944
- */
12945
- blockedPopoutsThrowError?: boolean;
12946
-
12947
- /**
12948
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
12949
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
12950
- * addition, any changes made to popouts won't be stored after the parent is closed.
12951
- * Default: true
12952
- */
12953
- closePopoutsOnUnload?: boolean;
12954
-
12955
- /**
12956
- * Specifies if the popout icon should be displayed in the header-bar.
12957
- * Default: true
12958
- */
12959
- showPopoutIcon?: boolean;
12960
-
12961
- /**
12962
- * Specifies if the maximise icon should be displayed in the header-bar.
12963
- * Default: true
12964
- */
12965
- showMaximiseIcon?: boolean;
12966
-
12967
- /**
12968
- * Specifies if the close icon should be displayed in the header-bar.
12969
- * Default: true
12970
- */
12971
- showCloseIcon?: boolean;
12972
- }
12973
-
12974
12046
  /**
12975
12047
  * @interface
12976
12048
  */
@@ -14861,59 +13933,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14861
13933
  proceed: () => void;
14862
13934
  }) => void;
14863
13935
 
14864
- declare interface Tab {
14865
- _dragListener: TabDragListener;
14866
-
14867
- /**
14868
- * True if this tab is the selected tab
14869
- */
14870
- isActive: boolean;
14871
-
14872
- /**
14873
- * A reference to the header this tab is a child of
14874
- */
14875
- header: Header;
14876
-
14877
- /**
14878
- * A reference to the content item this tab relates to
14879
- */
14880
- contentItem: ContentItem;
14881
-
14882
- /**
14883
- * The tabs outer (jQuery) DOM element
14884
- */
14885
- element: JQuery;
14886
-
14887
- /**
14888
- * The (jQuery) DOM element containing the title
14889
- */
14890
- titleElement: JQuery;
14891
-
14892
- /**
14893
- * The (jQuery) DOM element that closes the tab
14894
- */
14895
- closeElement: JQuery;
14896
-
14897
- /**
14898
- * Sets the tab's title. Does not affect the contentItem's title!
14899
- * @param title The new title
14900
- */
14901
- setTitle(title: string): void;
14902
-
14903
- /**
14904
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
14905
- * @param isActive Whether the tab is active
14906
- */
14907
- setActive(isActive: boolean): void;
14908
- }
14909
-
14910
- declare interface TabDragListener extends EventEmitter_2 {
14911
- /**
14912
- * A reference to the content item this tab relates to
14913
- */
14914
- contentItem: ContentItem;
14915
- }
14916
-
14917
13936
  /**
14918
13937
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
14919
13938
  */