@openfin/node-adapter 37.81.20 → 37.81.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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
  };
@@ -3723,103 +3659,6 @@ declare type ConstWindowOptions = {
3723
3659
  inheritance?: Partial<InheritableOptions>;
3724
3660
  };
3725
3661
 
3726
- declare interface Container extends EventEmitter_2 {
3727
- /**
3728
- * The current width of the container in pixel
3729
- */
3730
- width: number;
3731
-
3732
- /**
3733
- * The current height of the container in pixel
3734
- */
3735
- height: number;
3736
-
3737
- /**
3738
- * A reference to the component-item that controls this container
3739
- */
3740
- parent: ContentItem;
3741
-
3742
- /**
3743
- * A reference to the tab that controls this container. Will initially be null
3744
- * (and populated once a tab event has been fired).
3745
- */
3746
- tab: Tab;
3747
-
3748
- /**
3749
- * The current title of the container
3750
- */
3751
- title: string;
3752
-
3753
- /*
3754
- * A reference to the GoldenLayout instance this container belongs to
3755
- */
3756
- layoutManager: GoldenLayout_2;
3757
-
3758
- /**
3759
- * True if the item is currently hidden
3760
- */
3761
- isHidden: boolean;
3762
-
3763
- /**
3764
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3765
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3766
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3767
- * constructor function. It will also be used when the component is opened in a new window.
3768
- * @param state A serialisable object
3769
- */
3770
- setState(state: any): void;
3771
-
3772
- /**
3773
- * The same as setState but does not emit 'stateChanged' event
3774
- * @param {serialisable} state
3775
- */
3776
- setStateSkipEvent(state: any): void;
3777
-
3778
- /**
3779
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3780
- * @param state A serialisable object
3781
- */
3782
- extendState(state: any): void;
3783
-
3784
- /**
3785
- * Returns the current state.
3786
- */
3787
- getState(): any;
3788
-
3789
- /**
3790
- * Returns the container's inner element as a jQuery element
3791
- */
3792
- getElement(): JQuery;
3793
-
3794
- /**
3795
- * hides the container or returns false if hiding it is not possible
3796
- */
3797
- hide(): boolean;
3798
-
3799
- /**
3800
- * shows the container or returns false if showing it is not possible
3801
- */
3802
- show(): boolean;
3803
-
3804
- /**
3805
- * Sets the container to the specified size or returns false if that's not possible
3806
- * @param width the new width in pixel
3807
- * @param height the new height in pixel
3808
- */
3809
- setSize(width: number, height: number): boolean;
3810
-
3811
- /**
3812
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3813
- * @param title the new title
3814
- */
3815
- setTitle(title: string): void;
3816
-
3817
- /**
3818
- * Closes the container or returns false if that is not possible
3819
- */
3820
- close(): boolean;
3821
- }
3822
-
3823
3662
  /**
3824
3663
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3825
3664
  */
@@ -3893,218 +3732,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3893
3732
  disposition: string;
3894
3733
  };
3895
3734
 
3896
- declare interface ContentItem extends EventEmitter_2 {
3897
- instance: any;
3898
- header: any;
3899
- _splitter: any;
3900
- /**
3901
- * This items configuration in its current state
3902
- */
3903
- config: ItemConfigType;
3904
-
3905
- /**
3906
- * The type of the item. Can be row, column, stack, component or root
3907
- */
3908
- type: ItemType;
3909
-
3910
- /**
3911
- * An array of items that are children of this item
3912
- */
3913
- contentItems: ContentItem[];
3914
-
3915
- container: Container;
3916
- /**
3917
- * The item that is this item's parent (or null if the item is root)
3918
- */
3919
- parent: ContentItem;
3920
-
3921
- /**
3922
- * A String or array of identifiers if provided in the configuration
3923
- */
3924
- id: string;
3925
-
3926
- /**
3927
- * True if the item had been initialised
3928
- */
3929
- isInitialised: boolean;
3930
-
3931
- /**
3932
- * True if the item is maximised
3933
- */
3934
- isMaximised: boolean;
3935
-
3936
- /**
3937
- * True if the item is the layout's root item
3938
- */
3939
- isRoot: boolean;
3940
-
3941
- /**
3942
- * True if the item is a row
3943
- */
3944
- isRow: boolean;
3945
-
3946
- /**
3947
- * True if the item is a column
3948
- */
3949
- isColumn: boolean;
3950
-
3951
- /**
3952
- * True if the item is a stack
3953
- */
3954
- isStack: boolean;
3955
-
3956
- /**
3957
- * True if the item is a component
3958
- */
3959
- isComponent: boolean;
3960
-
3961
- /**
3962
- * A reference to the layoutManager that controls this item
3963
- */
3964
- layoutManager: any;
3965
-
3966
- /**
3967
- * The item's outer element
3968
- */
3969
- element: JQuery;
3970
-
3971
- /**
3972
- * The item's inner element. Can be the same as the outer element.
3973
- */
3974
- childElementContainer: Container;
3975
-
3976
- /**
3977
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
3978
- * from its original position before adding it to this item.
3979
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
3980
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
3981
- */
3982
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
3983
-
3984
- /**
3985
- * Destroys the item and all it's children
3986
- * @param contentItem The contentItem that should be removed
3987
- * @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.
3988
- */
3989
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
3990
-
3991
- /**
3992
- * The contentItem that should be removed
3993
- * @param oldChild ContentItem The contentItem that should be removed
3994
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
3995
- */
3996
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
3997
-
3998
- /**
3999
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4000
- */
4001
- setSize(): void;
4002
-
4003
- /**
4004
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4005
- * @param title the new title
4006
- */
4007
- setTitle(title: string): void;
4008
-
4009
- /**
4010
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4011
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4012
- * @param functionName The name of the method to invoke
4013
- * @param functionArguments An array of arguments to pass to every function
4014
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4015
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4016
- */
4017
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4018
-
4019
- /**
4020
- * 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.
4021
- */
4022
- emitBubblingEvent(name: string): void;
4023
-
4024
- /**
4025
- * Convenience method for item.parent.removeChild( item )
4026
- */
4027
- remove(): void;
4028
-
4029
- /**
4030
- * Removes the item from its current position in the layout and opens it in a window
4031
- */
4032
- popout(): BrowserWindow;
4033
-
4034
- /**
4035
- * Maximises the item or minimises it if it's already maximised
4036
- */
4037
- toggleMaximise(): void;
4038
-
4039
- /**
4040
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4041
- */
4042
- select(): void;
4043
-
4044
- /**
4045
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4046
- */
4047
- deselect(): void;
4048
-
4049
- /**
4050
- * Returns true if the item has the specified id or false if not
4051
- * @param id An id to check for
4052
- */
4053
- hasId(id: string): boolean;
4054
-
4055
- /**
4056
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4057
- * @param contentItem The new active content item
4058
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4059
- */
4060
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4061
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4062
-
4063
- /**
4064
- * Only Stacks have this method! Returns the currently selected contentItem.
4065
- */
4066
- getActiveContentItem(): ContentItem;
4067
-
4068
- /**
4069
- * Adds an id to an item or does nothing if the id is already present
4070
- * @param id The id to be added
4071
- */
4072
- addId(id: string): void;
4073
-
4074
- /**
4075
- * Removes an id from an item or throws an error if the id couldn't be found
4076
- * @param id The id to be removed
4077
- */
4078
- removeId(id: string): void;
4079
-
4080
- /**
4081
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4082
- * @param filterFunction A function that determines whether an item matches certain criteria
4083
- */
4084
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4085
-
4086
- /**
4087
- * Returns all items with the specified id.
4088
- * @param id An id specified in the itemConfig
4089
- */
4090
- getItemsById(id: string | string[]): ContentItem[];
4091
-
4092
- /**
4093
- * Returns all items with the specified type
4094
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4095
- */
4096
- getItemsByType(type: string): ContentItem[];
4097
-
4098
- /**
4099
- * Returns all instances of the component with the specified componentName
4100
- * @param componentName a componentName as specified in the itemConfig
4101
- */
4102
- getComponentsByName(componentName: string): any;
4103
-
4104
- _contentAreaDimensions: any;
4105
- _$getArea: () => any;
4106
- }
4107
-
4108
3735
  /**
4109
3736
  * Restrict navigation to URLs that match an allowed pattern.
4110
3737
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4532,46 +4159,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4532
4159
  type: 'did-finish-load';
4533
4160
  };
4534
4161
 
4535
- declare interface Dimensions {
4536
- /**
4537
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4538
- * than the visible one, making it safe to set this to small values without affecting usability.
4539
- * Default: 5
4540
- */
4541
- borderWidth?: number;
4542
-
4543
- /**
4544
- * The minimum height an item can be resized to (in pixel).
4545
- * Default: 10
4546
- */
4547
- minItemHeight?: number;
4548
-
4549
- /**
4550
- * The minimum width an item can be resized to (in pixel).
4551
- * Default: 10
4552
- */
4553
- minItemWidth?: number;
4554
-
4555
- /**
4556
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4557
- * adjusted accordingly.
4558
- * Default: 20
4559
- */
4560
- headerHeight?: number;
4561
-
4562
- /**
4563
- * The width of the element that appears when an item is dragged (in pixel).
4564
- * Default: 300
4565
- */
4566
- dragProxyWidth?: number;
4567
-
4568
- /**
4569
- * The height of the element that appears when an item is dragged (in pixel).
4570
- * Default: 200
4571
- */
4572
- dragProxyHeight?: number;
4573
- }
4574
-
4575
4162
  /**
4576
4163
  * @interface
4577
4164
  */
@@ -4821,8 +4408,6 @@ declare type Dpi = {
4821
4408
  vertical?: number;
4822
4409
  };
4823
4410
 
4824
- declare interface DragSource {}
4825
-
4826
4411
  /**
4827
4412
  * Generated when a window has been embedded.
4828
4413
  * @interface
@@ -5128,43 +4713,6 @@ declare class EventAggregator extends EmitterMap {
5128
4713
  dispatchEvent: (message: Message<any>) => boolean;
5129
4714
  }
5130
4715
 
5131
- declare interface EventEmitter_2 {
5132
- [x: string]: any;
5133
- /**
5134
- * Subscribe to an event
5135
- * @param eventName The name of the event to describe to
5136
- * @param callback The function that should be invoked when the event occurs
5137
- * @param context The value of the this pointer in the callback function
5138
- */
5139
- on(eventName: string, callback: Function, context?: any): void;
5140
-
5141
- /**
5142
- * Notify listeners of an event and pass arguments along
5143
- * @param eventName The name of the event to emit
5144
- */
5145
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5146
-
5147
- /**
5148
- * Alias for emit
5149
- */
5150
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5151
-
5152
- /**
5153
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5154
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5155
- * arguments.
5156
- * @param eventName The name of the event to unsubscribe from
5157
- * @param callback The function that should be invoked when the event occurs
5158
- * @param context The value of the this pointer in the callback function
5159
- */
5160
- unbind(eventName: string, callback?: Function, context?: any): void;
5161
-
5162
- /**
5163
- * Alias for unbind
5164
- */
5165
- off(eventName: string, callback?: Function, context?: any): void;
5166
- }
5167
-
5168
4716
  /**
5169
4717
  * Handler for an event on an EventEmitter.
5170
4718
  * @remarks Selects the correct type for the event
@@ -6002,253 +5550,6 @@ declare namespace GlobalHotkeyEvents {
6002
5550
  */
6003
5551
  declare type GlobalHotkeyEventType = EventType_6;
6004
5552
 
6005
- declare namespace GoldenLayout {
6006
- export {
6007
- GoldenLayout_2 as GoldenLayout,
6008
- ItemConfigType,
6009
- Settings,
6010
- Dimensions,
6011
- Labels,
6012
- ItemType,
6013
- ItemConfig,
6014
- ComponentConfig,
6015
- ReactComponentConfig,
6016
- Config,
6017
- ContentItem,
6018
- Container,
6019
- DragSource,
6020
- BrowserWindow,
6021
- Header,
6022
- TabDragListener,
6023
- Tab,
6024
- EventEmitter_2 as EventEmitter
6025
- }
6026
- }
6027
-
6028
- declare class GoldenLayout_2 implements EventEmitter_2 {
6029
- /**
6030
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6031
- * object and of goldenLayout.root as the document.
6032
- */
6033
- root: ContentItem;
6034
-
6035
- /**
6036
- * A reference to the (jQuery) DOM element containing the layout
6037
- */
6038
- container: JQuery;
6039
-
6040
- /**
6041
- * True once the layout item tree has been created and the initialised event has been fired
6042
- */
6043
- isInitialised: boolean;
6044
-
6045
- /**
6046
- * A reference to the current, extended top level config.
6047
- *
6048
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6049
- */
6050
- config: Config;
6051
-
6052
- /**
6053
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6054
- * to true.
6055
- */
6056
- selectedItem: ContentItem;
6057
-
6058
- /**
6059
- * The current outer width of the layout in pixels.
6060
- */
6061
- width: number;
6062
-
6063
- /**
6064
- * The current outer height of the layout in pixels.
6065
- */
6066
- height: number;
6067
-
6068
- /**
6069
- * An array of BrowserWindow instances
6070
- */
6071
- openPopouts: BrowserWindow[];
6072
-
6073
- /**
6074
- * True if the layout has been opened as a popout by another layout.
6075
- */
6076
- isSubWindow: boolean;
6077
-
6078
- /**
6079
- * A singleton instance of EventEmitter that works across windows
6080
- */
6081
- eventHub: EventEmitter_2;
6082
-
6083
- _dragProxy: any;
6084
-
6085
- dropTargetIndicator: any;
6086
-
6087
- _isFullPage: boolean;
6088
-
6089
- _onUnload: any;
6090
-
6091
- tabDropPlaceholder: any;
6092
-
6093
- transitionIndicator: any;
6094
-
6095
- _dragSources: any;
6096
-
6097
- _resizeFunction: any;
6098
-
6099
- _unloadFunction: any;
6100
-
6101
- /**
6102
- * @param config A GoldenLayout configuration object
6103
- * @param container The DOM element the layout will be initialised in. Default: document.body
6104
- */
6105
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6106
-
6107
- /*
6108
- * @param name The name of the component, as referred to by componentName in the component configuration.
6109
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6110
- * containerobject and a component state
6111
- */
6112
- registerComponent(name: String, component: any): void;
6113
-
6114
- /**
6115
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6116
- * a listener to the document and executes once it becomes ready.
6117
- */
6118
- init(): void;
6119
-
6120
- /**
6121
- * Returns the current state of the layout and its components as a serialisable object.
6122
- */
6123
- toConfig(): Config;
6124
-
6125
- /**
6126
- * Returns a component that was previously registered with layout.registerComponent().
6127
- * @param name The name of a previously registered component
6128
- */
6129
- getComponent(name: string): any;
6130
-
6131
- /**
6132
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6133
- * @param width The outer width the layout should be resized to. Default: The container elements width
6134
- * @param height The outer height the layout should be resized to. Default: The container elements height
6135
- */
6136
- updateSize(width?: number, height?: number): void;
6137
-
6138
- /**
6139
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6140
- * listeners and finally removes itself from the DOM.
6141
- */
6142
- destroy(): void;
6143
-
6144
- /**
6145
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6146
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6147
- * all call this method implicitly.
6148
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6149
- * @param parent A parent item
6150
- */
6151
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6152
-
6153
- /**
6154
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6155
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6156
- * provided its config will be read, if config is provided, only the content key
6157
- * will be used
6158
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6159
- * place the window in another screen.
6160
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6161
- * when popIn is clicked
6162
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6163
- */
6164
- createPopout(
6165
- configOrContentItem: ItemConfigType | ContentItem,
6166
- dimensions: {
6167
- width: number;
6168
- height: number;
6169
- left: number;
6170
- top: number;
6171
- },
6172
- parentId?: string,
6173
- indexInParent?: number
6174
- ): void;
6175
-
6176
- /**
6177
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6178
- * where it turns into a contentItem.
6179
- * @param element The DOM element that will be turned into a dragSource
6180
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6181
- * @return the dragSource that was created. This can be used to remove the
6182
- * dragSource from the layout later.
6183
- */
6184
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6185
-
6186
- /**
6187
- * Removes a dragSource from the layout.
6188
- *
6189
- * @param dragSource The dragSource to remove
6190
- */
6191
- removeDragSource(dragSource: DragSource): void;
6192
-
6193
- /**
6194
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6195
- * @param contentItem A ContentItem instance
6196
- */
6197
- selectItem(contentItem: ContentItem): void;
6198
-
6199
- /**
6200
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6201
- * and replace frequent keys and values with single letter substitutes.
6202
- * @param config A GoldenLayout configuration object
6203
- */
6204
- static minifyConfig(config: any): any;
6205
-
6206
- /**
6207
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6208
- * @param minifiedConfig A minified GoldenLayout configuration object
6209
- */
6210
- static unminifyConfig(minifiedConfig: any): any;
6211
-
6212
- /**
6213
- * Subscribe to an event
6214
- * @param eventName The name of the event to describe to
6215
- * @param callback The function that should be invoked when the event occurs
6216
- * @param context The value of the this pointer in the callback function
6217
- */
6218
- on(eventName: string, callback: Function, context?: any): void;
6219
-
6220
- /**
6221
- * Notify listeners of an event and pass arguments along
6222
- * @param eventName The name of the event to emit
6223
- */
6224
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6225
-
6226
- /**
6227
- * Alias for emit
6228
- */
6229
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6230
-
6231
- /**
6232
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6233
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6234
- * arguments.
6235
- * @param eventName The name of the event to unsubscribe from
6236
- * @param callback The function that should be invoked when the event occurs
6237
- * @param context The value of the this pointer in the callback function
6238
- */
6239
- unbind(eventName: string, callback?: Function, context?: any): void;
6240
-
6241
- /**
6242
- * Alias for unbind
6243
- */
6244
- off(eventName: string, callback?: Function, context?: any): void;
6245
-
6246
- /**
6247
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6248
- */
6249
- _$createRootItemAreas(): void;
6250
- }
6251
-
6252
5553
  /**
6253
5554
  * @interface
6254
5555
  */
@@ -6256,62 +5557,6 @@ declare type GpuInfo = {
6256
5557
  name: string;
6257
5558
  };
6258
5559
 
6259
- declare interface Header {
6260
- /**
6261
- * A reference to the LayoutManager instance
6262
- */
6263
- layoutManager: GoldenLayout_2;
6264
-
6265
- /**
6266
- * A reference to the Stack this Header belongs to
6267
- */
6268
- parent: ContentItem;
6269
-
6270
- /**
6271
- * An array of the Tabs within this header
6272
- */
6273
- tabs: Tab[];
6274
-
6275
- /**
6276
- * The currently selected activeContentItem
6277
- */
6278
- activeContentItem: ContentItem;
6279
-
6280
- /**
6281
- * The outer (jQuery) DOM element of this Header
6282
- */
6283
- element: JQuery;
6284
-
6285
- /**
6286
- * The (jQuery) DOM element containing the tabs
6287
- */
6288
- tabsContainer: JQuery;
6289
-
6290
- /**
6291
- * The (jQuery) DOM element containing the close, maximise and popout button
6292
- */
6293
- controlsContainer: JQuery;
6294
-
6295
- /**
6296
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6297
- * @param contentItem The content item that will be selected
6298
- */
6299
- setActiveContentItem(contentItem: ContentItem): void;
6300
-
6301
- /**
6302
- * Creates a new tab and associates it with a content item
6303
- * @param contentItem The content item the tab will be associated with
6304
- * @param index A zero based index, specifying the position of the new tab
6305
- */
6306
- createTab(contentItem: ContentItem, index?: number): void;
6307
-
6308
- /**
6309
- * Finds a tab by its contentItem and removes it
6310
- * @param contentItem The content item the tab is associated with
6311
- */
6312
- removeTab(contentItem: ContentItem): void;
6313
- }
6314
-
6315
5560
  /**
6316
5561
  * Generated when a View is hidden.
6317
5562
  * @interface
@@ -7898,50 +7143,6 @@ declare class InteropModule extends Base {
7898
7143
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7899
7144
  }
7900
7145
 
7901
- declare interface ItemConfig {
7902
- /**
7903
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
7904
- */
7905
- type: ItemType;
7906
-
7907
- /**
7908
- * An array of configurations for items that will be created as children of this item.
7909
- */
7910
- content?: ItemConfigType[];
7911
-
7912
- /**
7913
- * The width of this item, relative to the other children of its parent in percent
7914
- */
7915
- width?: number;
7916
-
7917
- /**
7918
- * The height of this item, relative to the other children of its parent in percent
7919
- */
7920
- height?: number;
7921
-
7922
- /**
7923
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
7924
- */
7925
- id?: string | string[];
7926
-
7927
- /**
7928
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
7929
- * will return false
7930
- * Default: true
7931
- */
7932
- isClosable?: boolean;
7933
-
7934
- /**
7935
- * The title of the item as displayed on its tab and on popout windows
7936
- * Default: componentName or ''
7937
- */
7938
- title?: string;
7939
- }
7940
-
7941
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
7942
-
7943
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
7944
-
7945
7146
  /**
7946
7147
  * @interface
7947
7148
  */
@@ -7999,32 +7200,6 @@ declare type JumpListTask = {
7999
7200
  iconIndex?: number;
8000
7201
  };
8001
7202
 
8002
- declare interface Labels {
8003
- /**
8004
- * The tooltip text that appears when hovering over the close icon.
8005
- * Default: 'close'
8006
- */
8007
- close?: string;
8008
-
8009
- /**
8010
- * The tooltip text that appears when hovering over the maximise icon.
8011
- * Default: 'maximise'
8012
- */
8013
- maximise?: string;
8014
-
8015
- /**
8016
- * The tooltip text that appears when hovering over the minimise icon.
8017
- * Default: 'minimise'
8018
- */
8019
- minimise?: string;
8020
-
8021
- /**
8022
- * The tooltip text that appears when hovering over the popout icon.
8023
- * Default: 'open in new window'
8024
- */
8025
- popout?: string;
8026
- }
8027
-
8028
7203
  export declare function launch(config: ConnectConfig): Promise<number>;
8029
7204
 
8030
7205
  /**
@@ -8452,7 +7627,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8452
7627
  entityId: string;
8453
7628
  };
8454
7629
 
8455
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7630
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8456
7631
 
8457
7632
  /**
8458
7633
  * @interface
@@ -12360,18 +11535,6 @@ declare type QueryPermissionResult = {
12360
11535
  rawValue?: unknown;
12361
11536
  };
12362
11537
 
12363
- declare interface ReactComponentConfig extends ItemConfig {
12364
- /**
12365
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12366
- */
12367
- component: string;
12368
-
12369
- /**
12370
- * Properties that will be passed to the component and accessible using this.props.
12371
- */
12372
- props?: any;
12373
- }
12374
-
12375
11538
  /**
12376
11539
  * @interface
12377
11540
  */
@@ -12848,97 +12011,6 @@ declare type SessionContextGroup = {
12848
12011
  }>;
12849
12012
  };
12850
12013
 
12851
- declare interface Settings {
12852
- preventSplitterResize?: boolean;
12853
-
12854
- newTabButton?: {
12855
- url?: string;
12856
- };
12857
-
12858
- /**
12859
- * If true, tabs can't be dragged into the window.
12860
- * Default: false
12861
- */
12862
- preventDragIn?: boolean;
12863
-
12864
- /**
12865
- * If true, tabs can't be dragged out of the window.
12866
- * Default: false
12867
- */
12868
- preventDragOut?: boolean;
12869
-
12870
- /**
12871
- * If true, stack headers are the only areas where tabs can be dropped.
12872
- * Default: false
12873
- */
12874
- constrainDragToHeaders?: boolean;
12875
- /**
12876
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
12877
- * Default: true
12878
- */
12879
- hasHeaders?: boolean;
12880
-
12881
- /**
12882
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
12883
- * automatically when layout.createDragSource() is called.
12884
- * Default: true
12885
- */
12886
- constrainDragToContainer?: boolean;
12887
-
12888
- /**
12889
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
12890
- * Default: true
12891
- */
12892
- reorderEnabled?: boolean;
12893
-
12894
- /**
12895
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
12896
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
12897
- * Default: false
12898
- */
12899
- selectionEnabled?: boolean;
12900
-
12901
- /**
12902
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
12903
- * be transferred to the new window, if false only the active component will be opened.
12904
- * Default: false
12905
- */
12906
- popoutWholeStack?: boolean;
12907
-
12908
- /**
12909
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
12910
- * If false, the popout call will fail silently.
12911
- * Default: true
12912
- */
12913
- blockedPopoutsThrowError?: boolean;
12914
-
12915
- /**
12916
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
12917
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
12918
- * addition, any changes made to popouts won't be stored after the parent is closed.
12919
- * Default: true
12920
- */
12921
- closePopoutsOnUnload?: boolean;
12922
-
12923
- /**
12924
- * Specifies if the popout icon should be displayed in the header-bar.
12925
- * Default: true
12926
- */
12927
- showPopoutIcon?: boolean;
12928
-
12929
- /**
12930
- * Specifies if the maximise icon should be displayed in the header-bar.
12931
- * Default: true
12932
- */
12933
- showMaximiseIcon?: boolean;
12934
-
12935
- /**
12936
- * Specifies if the close icon should be displayed in the header-bar.
12937
- * Default: true
12938
- */
12939
- showCloseIcon?: boolean;
12940
- }
12941
-
12942
12014
  /**
12943
12015
  * @interface
12944
12016
  */
@@ -14829,59 +13901,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14829
13901
  proceed: () => void;
14830
13902
  }) => void;
14831
13903
 
14832
- declare interface Tab {
14833
- _dragListener: TabDragListener;
14834
-
14835
- /**
14836
- * True if this tab is the selected tab
14837
- */
14838
- isActive: boolean;
14839
-
14840
- /**
14841
- * A reference to the header this tab is a child of
14842
- */
14843
- header: Header;
14844
-
14845
- /**
14846
- * A reference to the content item this tab relates to
14847
- */
14848
- contentItem: ContentItem;
14849
-
14850
- /**
14851
- * The tabs outer (jQuery) DOM element
14852
- */
14853
- element: JQuery;
14854
-
14855
- /**
14856
- * The (jQuery) DOM element containing the title
14857
- */
14858
- titleElement: JQuery;
14859
-
14860
- /**
14861
- * The (jQuery) DOM element that closes the tab
14862
- */
14863
- closeElement: JQuery;
14864
-
14865
- /**
14866
- * Sets the tab's title. Does not affect the contentItem's title!
14867
- * @param title The new title
14868
- */
14869
- setTitle(title: string): void;
14870
-
14871
- /**
14872
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
14873
- * @param isActive Whether the tab is active
14874
- */
14875
- setActive(isActive: boolean): void;
14876
- }
14877
-
14878
- declare interface TabDragListener extends EventEmitter_2 {
14879
- /**
14880
- * A reference to the content item this tab relates to
14881
- */
14882
- contentItem: ContentItem;
14883
- }
14884
-
14885
13904
  /**
14886
13905
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
14887
13906
  */