@openfin/remote-adapter 38.81.32 → 38.81.37

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.
@@ -1907,48 +1907,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1907
1907
  behavior: 'browser';
1908
1908
  };
1909
1909
 
1910
- declare interface BrowserWindow {
1911
- /**
1912
- * True if the window has been opened and its GoldenLayout instance initialised.
1913
- */
1914
- isInitialised: boolean;
1915
-
1916
- /**
1917
- * Creates a window configuration object from the Popout.
1918
- */
1919
- toConfig(): {
1920
- dimensions: {
1921
- width: number;
1922
- height: number;
1923
- left: number;
1924
- top: number;
1925
- };
1926
- content: Config;
1927
- parentId: string;
1928
- indexInParent: number;
1929
- };
1930
-
1931
- /**
1932
- * Returns the GoldenLayout instance from the child window
1933
- */
1934
- getGlInstance(): GoldenLayout_2;
1935
-
1936
- /**
1937
- * Returns the native Window object
1938
- */
1939
- getWindow(): Window;
1940
-
1941
- /**
1942
- * Closes the popout
1943
- */
1944
- close(): void;
1945
-
1946
- /**
1947
- * Returns the popout to its original position as specified in parentId and indexInParent
1948
- */
1949
- popIn(): void;
1950
- }
1951
-
1952
1910
  /**
1953
1911
  * Extracts a single event type matching the given key from the View {@link Event} union.
1954
1912
  *
@@ -3329,31 +3287,6 @@ declare class ColumnOrRow extends LayoutNode {
3329
3287
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3330
3288
  }
3331
3289
 
3332
- declare interface ComponentConfig extends ItemConfig {
3333
- /**
3334
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3335
- */
3336
- componentName: string;
3337
-
3338
- /**
3339
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3340
- * container.getState().
3341
- */
3342
- componentState?: any;
3343
- }
3344
-
3345
- declare interface Config {
3346
- settings?: Settings;
3347
- dimensions?: Dimensions;
3348
- labels?: Labels;
3349
- content?: ItemConfigType[];
3350
- /**
3351
- * (Only on layout config object)
3352
- * Id of the currently maximised content item
3353
- */
3354
- maximisedItemId?: string;
3355
- }
3356
-
3357
3290
  declare type ConfigWithRuntime = BaseConfig & {
3358
3291
  runtime: RuntimeConfig;
3359
3292
  };
@@ -3769,103 +3702,6 @@ declare type ConstWindowOptions = {
3769
3702
  inheritance?: Partial<InheritableOptions>;
3770
3703
  };
3771
3704
 
3772
- declare interface Container extends EventEmitter_2 {
3773
- /**
3774
- * The current width of the container in pixel
3775
- */
3776
- width: number;
3777
-
3778
- /**
3779
- * The current height of the container in pixel
3780
- */
3781
- height: number;
3782
-
3783
- /**
3784
- * A reference to the component-item that controls this container
3785
- */
3786
- parent: ContentItem;
3787
-
3788
- /**
3789
- * A reference to the tab that controls this container. Will initially be null
3790
- * (and populated once a tab event has been fired).
3791
- */
3792
- tab: Tab;
3793
-
3794
- /**
3795
- * The current title of the container
3796
- */
3797
- title: string;
3798
-
3799
- /*
3800
- * A reference to the GoldenLayout instance this container belongs to
3801
- */
3802
- layoutManager: GoldenLayout_2;
3803
-
3804
- /**
3805
- * True if the item is currently hidden
3806
- */
3807
- isHidden: boolean;
3808
-
3809
- /**
3810
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3811
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3812
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3813
- * constructor function. It will also be used when the component is opened in a new window.
3814
- * @param state A serialisable object
3815
- */
3816
- setState(state: any): void;
3817
-
3818
- /**
3819
- * The same as setState but does not emit 'stateChanged' event
3820
- * @param {serialisable} state
3821
- */
3822
- setStateSkipEvent(state: any): void;
3823
-
3824
- /**
3825
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3826
- * @param state A serialisable object
3827
- */
3828
- extendState(state: any): void;
3829
-
3830
- /**
3831
- * Returns the current state.
3832
- */
3833
- getState(): any;
3834
-
3835
- /**
3836
- * Returns the container's inner element as a jQuery element
3837
- */
3838
- getElement(): JQuery;
3839
-
3840
- /**
3841
- * hides the container or returns false if hiding it is not possible
3842
- */
3843
- hide(): boolean;
3844
-
3845
- /**
3846
- * shows the container or returns false if showing it is not possible
3847
- */
3848
- show(): boolean;
3849
-
3850
- /**
3851
- * Sets the container to the specified size or returns false if that's not possible
3852
- * @param width the new width in pixel
3853
- * @param height the new height in pixel
3854
- */
3855
- setSize(width: number, height: number): boolean;
3856
-
3857
- /**
3858
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3859
- * @param title the new title
3860
- */
3861
- setTitle(title: string): void;
3862
-
3863
- /**
3864
- * Closes the container or returns false if that is not possible
3865
- */
3866
- close(): boolean;
3867
- }
3868
-
3869
3705
  /**
3870
3706
  * Generated when a Layout Container Component was created.
3871
3707
  * @interface
@@ -3947,218 +3783,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3947
3783
  disposition: string;
3948
3784
  };
3949
3785
 
3950
- declare interface ContentItem extends EventEmitter_2 {
3951
- instance: any;
3952
- header: any;
3953
- _splitter: any;
3954
- /**
3955
- * This items configuration in its current state
3956
- */
3957
- config: ItemConfigType;
3958
-
3959
- /**
3960
- * The type of the item. Can be row, column, stack, component or root
3961
- */
3962
- type: ItemType;
3963
-
3964
- /**
3965
- * An array of items that are children of this item
3966
- */
3967
- contentItems: ContentItem[];
3968
-
3969
- container: Container;
3970
- /**
3971
- * The item that is this item's parent (or null if the item is root)
3972
- */
3973
- parent: ContentItem;
3974
-
3975
- /**
3976
- * A String or array of identifiers if provided in the configuration
3977
- */
3978
- id: string;
3979
-
3980
- /**
3981
- * True if the item had been initialised
3982
- */
3983
- isInitialised: boolean;
3984
-
3985
- /**
3986
- * True if the item is maximised
3987
- */
3988
- isMaximised: boolean;
3989
-
3990
- /**
3991
- * True if the item is the layout's root item
3992
- */
3993
- isRoot: boolean;
3994
-
3995
- /**
3996
- * True if the item is a row
3997
- */
3998
- isRow: boolean;
3999
-
4000
- /**
4001
- * True if the item is a column
4002
- */
4003
- isColumn: boolean;
4004
-
4005
- /**
4006
- * True if the item is a stack
4007
- */
4008
- isStack: boolean;
4009
-
4010
- /**
4011
- * True if the item is a component
4012
- */
4013
- isComponent: boolean;
4014
-
4015
- /**
4016
- * A reference to the layoutManager that controls this item
4017
- */
4018
- layoutManager: any;
4019
-
4020
- /**
4021
- * The item's outer element
4022
- */
4023
- element: JQuery;
4024
-
4025
- /**
4026
- * The item's inner element. Can be the same as the outer element.
4027
- */
4028
- childElementContainer: Container;
4029
-
4030
- /**
4031
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4032
- * from its original position before adding it to this item.
4033
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4034
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4035
- */
4036
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4037
-
4038
- /**
4039
- * Destroys the item and all it's children
4040
- * @param contentItem The contentItem that should be removed
4041
- * @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.
4042
- */
4043
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4044
-
4045
- /**
4046
- * The contentItem that should be removed
4047
- * @param oldChild ContentItem The contentItem that should be removed
4048
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4049
- */
4050
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4051
-
4052
- /**
4053
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4054
- */
4055
- setSize(): void;
4056
-
4057
- /**
4058
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4059
- * @param title the new title
4060
- */
4061
- setTitle(title: string): void;
4062
-
4063
- /**
4064
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4065
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4066
- * @param functionName The name of the method to invoke
4067
- * @param functionArguments An array of arguments to pass to every function
4068
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4069
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4070
- */
4071
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4072
-
4073
- /**
4074
- * 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.
4075
- */
4076
- emitBubblingEvent(name: string): void;
4077
-
4078
- /**
4079
- * Convenience method for item.parent.removeChild( item )
4080
- */
4081
- remove(): void;
4082
-
4083
- /**
4084
- * Removes the item from its current position in the layout and opens it in a window
4085
- */
4086
- popout(): BrowserWindow;
4087
-
4088
- /**
4089
- * Maximises the item or minimises it if it's already maximised
4090
- */
4091
- toggleMaximise(): void;
4092
-
4093
- /**
4094
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4095
- */
4096
- select(): void;
4097
-
4098
- /**
4099
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4100
- */
4101
- deselect(): void;
4102
-
4103
- /**
4104
- * Returns true if the item has the specified id or false if not
4105
- * @param id An id to check for
4106
- */
4107
- hasId(id: string): boolean;
4108
-
4109
- /**
4110
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4111
- * @param contentItem The new active content item
4112
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4113
- */
4114
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4115
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4116
-
4117
- /**
4118
- * Only Stacks have this method! Returns the currently selected contentItem.
4119
- */
4120
- getActiveContentItem(): ContentItem;
4121
-
4122
- /**
4123
- * Adds an id to an item or does nothing if the id is already present
4124
- * @param id The id to be added
4125
- */
4126
- addId(id: string): void;
4127
-
4128
- /**
4129
- * Removes an id from an item or throws an error if the id couldn't be found
4130
- * @param id The id to be removed
4131
- */
4132
- removeId(id: string): void;
4133
-
4134
- /**
4135
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4136
- * @param filterFunction A function that determines whether an item matches certain criteria
4137
- */
4138
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4139
-
4140
- /**
4141
- * Returns all items with the specified id.
4142
- * @param id An id specified in the itemConfig
4143
- */
4144
- getItemsById(id: string | string[]): ContentItem[];
4145
-
4146
- /**
4147
- * Returns all items with the specified type
4148
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4149
- */
4150
- getItemsByType(type: string): ContentItem[];
4151
-
4152
- /**
4153
- * Returns all instances of the component with the specified componentName
4154
- * @param componentName a componentName as specified in the itemConfig
4155
- */
4156
- getComponentsByName(componentName: string): any;
4157
-
4158
- _contentAreaDimensions: any;
4159
- _$getArea: () => any;
4160
- }
4161
-
4162
3786
  /**
4163
3787
  * Restrict navigation to URLs that match an allowed pattern.
4164
3788
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4597,46 +4221,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4597
4221
  type: 'did-finish-load';
4598
4222
  };
4599
4223
 
4600
- declare interface Dimensions {
4601
- /**
4602
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4603
- * than the visible one, making it safe to set this to small values without affecting usability.
4604
- * Default: 5
4605
- */
4606
- borderWidth?: number;
4607
-
4608
- /**
4609
- * The minimum height an item can be resized to (in pixel).
4610
- * Default: 10
4611
- */
4612
- minItemHeight?: number;
4613
-
4614
- /**
4615
- * The minimum width an item can be resized to (in pixel).
4616
- * Default: 10
4617
- */
4618
- minItemWidth?: number;
4619
-
4620
- /**
4621
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4622
- * adjusted accordingly.
4623
- * Default: 20
4624
- */
4625
- headerHeight?: number;
4626
-
4627
- /**
4628
- * The width of the element that appears when an item is dragged (in pixel).
4629
- * Default: 300
4630
- */
4631
- dragProxyWidth?: number;
4632
-
4633
- /**
4634
- * The height of the element that appears when an item is dragged (in pixel).
4635
- * Default: 200
4636
- */
4637
- dragProxyHeight?: number;
4638
- }
4639
-
4640
4224
  /**
4641
4225
  * @interface
4642
4226
  */
@@ -4897,8 +4481,6 @@ declare type Dpi = {
4897
4481
  vertical?: number;
4898
4482
  };
4899
4483
 
4900
- declare interface DragSource {}
4901
-
4902
4484
  /**
4903
4485
  * Generated when a window has been embedded.
4904
4486
  * @interface
@@ -5211,43 +4793,6 @@ declare class EventAggregator extends EmitterMap {
5211
4793
  dispatchEvent: (message: Message<any>) => boolean;
5212
4794
  }
5213
4795
 
5214
- declare interface EventEmitter_2 {
5215
- [x: string]: any;
5216
- /**
5217
- * Subscribe to an event
5218
- * @param eventName The name of the event to describe to
5219
- * @param callback The function that should be invoked when the event occurs
5220
- * @param context The value of the this pointer in the callback function
5221
- */
5222
- on(eventName: string, callback: Function, context?: any): void;
5223
-
5224
- /**
5225
- * Notify listeners of an event and pass arguments along
5226
- * @param eventName The name of the event to emit
5227
- */
5228
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5229
-
5230
- /**
5231
- * Alias for emit
5232
- */
5233
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5234
-
5235
- /**
5236
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5237
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5238
- * arguments.
5239
- * @param eventName The name of the event to unsubscribe from
5240
- * @param callback The function that should be invoked when the event occurs
5241
- * @param context The value of the this pointer in the callback function
5242
- */
5243
- unbind(eventName: string, callback?: Function, context?: any): void;
5244
-
5245
- /**
5246
- * Alias for unbind
5247
- */
5248
- off(eventName: string, callback?: Function, context?: any): void;
5249
- }
5250
-
5251
4796
  /**
5252
4797
  * Handler for an event on an EventEmitter.
5253
4798
  * @remarks Selects the correct type for the event
@@ -6084,253 +5629,6 @@ declare namespace GlobalHotkeyEvents {
6084
5629
  */
6085
5630
  declare type GlobalHotkeyEventType = EventType_6;
6086
5631
 
6087
- declare namespace GoldenLayout {
6088
- export {
6089
- GoldenLayout_2 as GoldenLayout,
6090
- ItemConfigType,
6091
- Settings,
6092
- Dimensions,
6093
- Labels,
6094
- ItemType,
6095
- ItemConfig,
6096
- ComponentConfig,
6097
- ReactComponentConfig,
6098
- Config,
6099
- ContentItem,
6100
- Container,
6101
- DragSource,
6102
- BrowserWindow,
6103
- Header,
6104
- TabDragListener,
6105
- Tab,
6106
- EventEmitter_2 as EventEmitter
6107
- }
6108
- }
6109
-
6110
- declare class GoldenLayout_2 implements EventEmitter_2 {
6111
- /**
6112
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6113
- * object and of goldenLayout.root as the document.
6114
- */
6115
- root: ContentItem;
6116
-
6117
- /**
6118
- * A reference to the (jQuery) DOM element containing the layout
6119
- */
6120
- container: JQuery;
6121
-
6122
- /**
6123
- * True once the layout item tree has been created and the initialised event has been fired
6124
- */
6125
- isInitialised: boolean;
6126
-
6127
- /**
6128
- * A reference to the current, extended top level config.
6129
- *
6130
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6131
- */
6132
- config: Config;
6133
-
6134
- /**
6135
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6136
- * to true.
6137
- */
6138
- selectedItem: ContentItem;
6139
-
6140
- /**
6141
- * The current outer width of the layout in pixels.
6142
- */
6143
- width: number;
6144
-
6145
- /**
6146
- * The current outer height of the layout in pixels.
6147
- */
6148
- height: number;
6149
-
6150
- /**
6151
- * An array of BrowserWindow instances
6152
- */
6153
- openPopouts: BrowserWindow[];
6154
-
6155
- /**
6156
- * True if the layout has been opened as a popout by another layout.
6157
- */
6158
- isSubWindow: boolean;
6159
-
6160
- /**
6161
- * A singleton instance of EventEmitter that works across windows
6162
- */
6163
- eventHub: EventEmitter_2;
6164
-
6165
- _dragProxy: any;
6166
-
6167
- dropTargetIndicator: any;
6168
-
6169
- _isFullPage: boolean;
6170
-
6171
- _onUnload: any;
6172
-
6173
- tabDropPlaceholder: any;
6174
-
6175
- transitionIndicator: any;
6176
-
6177
- _dragSources: any;
6178
-
6179
- _resizeFunction: any;
6180
-
6181
- _unloadFunction: any;
6182
-
6183
- /**
6184
- * @param config A GoldenLayout configuration object
6185
- * @param container The DOM element the layout will be initialised in. Default: document.body
6186
- */
6187
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6188
-
6189
- /*
6190
- * @param name The name of the component, as referred to by componentName in the component configuration.
6191
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6192
- * containerobject and a component state
6193
- */
6194
- registerComponent(name: String, component: any): void;
6195
-
6196
- /**
6197
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6198
- * a listener to the document and executes once it becomes ready.
6199
- */
6200
- init(): void;
6201
-
6202
- /**
6203
- * Returns the current state of the layout and its components as a serialisable object.
6204
- */
6205
- toConfig(): Config;
6206
-
6207
- /**
6208
- * Returns a component that was previously registered with layout.registerComponent().
6209
- * @param name The name of a previously registered component
6210
- */
6211
- getComponent(name: string): any;
6212
-
6213
- /**
6214
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6215
- * @param width The outer width the layout should be resized to. Default: The container elements width
6216
- * @param height The outer height the layout should be resized to. Default: The container elements height
6217
- */
6218
- updateSize(width?: number, height?: number): void;
6219
-
6220
- /**
6221
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6222
- * listeners and finally removes itself from the DOM.
6223
- */
6224
- destroy(): void;
6225
-
6226
- /**
6227
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6228
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6229
- * all call this method implicitly.
6230
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6231
- * @param parent A parent item
6232
- */
6233
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6234
-
6235
- /**
6236
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6237
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6238
- * provided its config will be read, if config is provided, only the content key
6239
- * will be used
6240
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6241
- * place the window in another screen.
6242
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6243
- * when popIn is clicked
6244
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6245
- */
6246
- createPopout(
6247
- configOrContentItem: ItemConfigType | ContentItem,
6248
- dimensions: {
6249
- width: number;
6250
- height: number;
6251
- left: number;
6252
- top: number;
6253
- },
6254
- parentId?: string,
6255
- indexInParent?: number
6256
- ): void;
6257
-
6258
- /**
6259
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6260
- * where it turns into a contentItem.
6261
- * @param element The DOM element that will be turned into a dragSource
6262
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6263
- * @return the dragSource that was created. This can be used to remove the
6264
- * dragSource from the layout later.
6265
- */
6266
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6267
-
6268
- /**
6269
- * Removes a dragSource from the layout.
6270
- *
6271
- * @param dragSource The dragSource to remove
6272
- */
6273
- removeDragSource(dragSource: DragSource): void;
6274
-
6275
- /**
6276
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6277
- * @param contentItem A ContentItem instance
6278
- */
6279
- selectItem(contentItem: ContentItem): void;
6280
-
6281
- /**
6282
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6283
- * and replace frequent keys and values with single letter substitutes.
6284
- * @param config A GoldenLayout configuration object
6285
- */
6286
- static minifyConfig(config: any): any;
6287
-
6288
- /**
6289
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6290
- * @param minifiedConfig A minified GoldenLayout configuration object
6291
- */
6292
- static unminifyConfig(minifiedConfig: any): any;
6293
-
6294
- /**
6295
- * Subscribe to an event
6296
- * @param eventName The name of the event to describe to
6297
- * @param callback The function that should be invoked when the event occurs
6298
- * @param context The value of the this pointer in the callback function
6299
- */
6300
- on(eventName: string, callback: Function, context?: any): void;
6301
-
6302
- /**
6303
- * Notify listeners of an event and pass arguments along
6304
- * @param eventName The name of the event to emit
6305
- */
6306
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6307
-
6308
- /**
6309
- * Alias for emit
6310
- */
6311
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6312
-
6313
- /**
6314
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6315
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6316
- * arguments.
6317
- * @param eventName The name of the event to unsubscribe from
6318
- * @param callback The function that should be invoked when the event occurs
6319
- * @param context The value of the this pointer in the callback function
6320
- */
6321
- unbind(eventName: string, callback?: Function, context?: any): void;
6322
-
6323
- /**
6324
- * Alias for unbind
6325
- */
6326
- off(eventName: string, callback?: Function, context?: any): void;
6327
-
6328
- /**
6329
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6330
- */
6331
- _$createRootItemAreas(): void;
6332
- }
6333
-
6334
5632
  /**
6335
5633
  * @interface
6336
5634
  */
@@ -6338,64 +5636,15 @@ declare type GpuInfo = {
6338
5636
  name: string;
6339
5637
  };
6340
5638
 
6341
- declare interface Header {
6342
- /**
6343
- * A reference to the LayoutManager instance
6344
- */
6345
- layoutManager: GoldenLayout_2;
6346
-
6347
- /**
6348
- * A reference to the Stack this Header belongs to
6349
- */
6350
- parent: ContentItem;
6351
-
6352
- /**
6353
- * An array of the Tabs within this header
6354
- */
6355
- tabs: Tab[];
6356
-
6357
- /**
6358
- * The currently selected activeContentItem
6359
- */
6360
- activeContentItem: ContentItem;
6361
-
6362
- /**
6363
- * The outer (jQuery) DOM element of this Header
6364
- */
6365
- element: JQuery;
6366
-
6367
- /**
6368
- * The (jQuery) DOM element containing the tabs
6369
- */
6370
- tabsContainer: JQuery;
6371
-
6372
- /**
6373
- * The (jQuery) DOM element containing the close, maximise and popout button
6374
- */
6375
- controlsContainer: JQuery;
6376
-
6377
- /**
6378
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6379
- * @param contentItem The content item that will be selected
6380
- */
6381
- setActiveContentItem(contentItem: ContentItem): void;
6382
-
6383
- /**
6384
- * Creates a new tab and associates it with a content item
6385
- * @param contentItem The content item the tab will be associated with
6386
- * @param index A zero based index, specifying the position of the new tab
6387
- */
6388
- createTab(contentItem: ContentItem, index?: number): void;
6389
-
6390
- /**
6391
- * Finds a tab by its contentItem and removes it
6392
- * @param contentItem The content item the tab is associated with
6393
- */
6394
- removeTab(contentItem: ContentItem): void;
6395
- }
6396
-
6397
5639
  /**
6398
5640
  * Generated when a View is hidden.
5641
+ *
5642
+ * @remarks
5643
+ * An OpenFin View's `hidden` event is only emitted when a specific View API is called.
5644
+ * This event can fire when calling:
5645
+ *
5646
+ * * `view.hide()` - If a View is previously shown, a `hidden` event will be fired.
5647
+ *
6399
5648
  * @interface
6400
5649
  */
6401
5650
  declare type HiddenEvent = BaseEvent_4 & {
@@ -8001,50 +7250,6 @@ declare class InteropModule extends Base {
8001
7250
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8002
7251
  }
8003
7252
 
8004
- declare interface ItemConfig {
8005
- /**
8006
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8007
- */
8008
- type: ItemType;
8009
-
8010
- /**
8011
- * An array of configurations for items that will be created as children of this item.
8012
- */
8013
- content?: ItemConfigType[];
8014
-
8015
- /**
8016
- * The width of this item, relative to the other children of its parent in percent
8017
- */
8018
- width?: number;
8019
-
8020
- /**
8021
- * The height of this item, relative to the other children of its parent in percent
8022
- */
8023
- height?: number;
8024
-
8025
- /**
8026
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8027
- */
8028
- id?: string | string[];
8029
-
8030
- /**
8031
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8032
- * will return false
8033
- * Default: true
8034
- */
8035
- isClosable?: boolean;
8036
-
8037
- /**
8038
- * The title of the item as displayed on its tab and on popout windows
8039
- * Default: componentName or ''
8040
- */
8041
- title?: string;
8042
- }
8043
-
8044
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8045
-
8046
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8047
-
8048
7253
  /**
8049
7254
  * @interface
8050
7255
  */
@@ -8102,32 +7307,6 @@ declare type JumpListTask = {
8102
7307
  iconIndex?: number;
8103
7308
  };
8104
7309
 
8105
- declare interface Labels {
8106
- /**
8107
- * The tooltip text that appears when hovering over the close icon.
8108
- * Default: 'close'
8109
- */
8110
- close?: string;
8111
-
8112
- /**
8113
- * The tooltip text that appears when hovering over the maximise icon.
8114
- * Default: 'maximise'
8115
- */
8116
- maximise?: string;
8117
-
8118
- /**
8119
- * The tooltip text that appears when hovering over the minimise icon.
8120
- * Default: 'minimise'
8121
- */
8122
- minimise?: string;
8123
-
8124
- /**
8125
- * The tooltip text that appears when hovering over the popout icon.
8126
- * Default: 'open in new window'
8127
- */
8128
- popout?: string;
8129
- }
8130
-
8131
7310
  /**
8132
7311
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8133
7312
  *
@@ -8579,7 +7758,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8579
7758
  entityId: string;
8580
7759
  };
8581
7760
 
8582
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7761
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8583
7762
 
8584
7763
  /**
8585
7764
  * @interface
@@ -12515,18 +11694,6 @@ declare type QueryPermissionResult = {
12515
11694
  rawValue?: unknown;
12516
11695
  };
12517
11696
 
12518
- declare interface ReactComponentConfig extends ItemConfig {
12519
- /**
12520
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12521
- */
12522
- component: string;
12523
-
12524
- /**
12525
- * Properties that will be passed to the component and accessible using this.props.
12526
- */
12527
- props?: any;
12528
- }
12529
-
12530
11697
  /**
12531
11698
  * @interface
12532
11699
  */
@@ -13003,97 +12170,6 @@ declare type SessionContextGroup = {
13003
12170
  }>;
13004
12171
  };
13005
12172
 
13006
- declare interface Settings {
13007
- preventSplitterResize?: boolean;
13008
-
13009
- newTabButton?: {
13010
- url?: string;
13011
- };
13012
-
13013
- /**
13014
- * If true, tabs can't be dragged into the window.
13015
- * Default: false
13016
- */
13017
- preventDragIn?: boolean;
13018
-
13019
- /**
13020
- * If true, tabs can't be dragged out of the window.
13021
- * Default: false
13022
- */
13023
- preventDragOut?: boolean;
13024
-
13025
- /**
13026
- * If true, stack headers are the only areas where tabs can be dropped.
13027
- * Default: false
13028
- */
13029
- constrainDragToHeaders?: boolean;
13030
- /**
13031
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13032
- * Default: true
13033
- */
13034
- hasHeaders?: boolean;
13035
-
13036
- /**
13037
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13038
- * automatically when layout.createDragSource() is called.
13039
- * Default: true
13040
- */
13041
- constrainDragToContainer?: boolean;
13042
-
13043
- /**
13044
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13045
- * Default: true
13046
- */
13047
- reorderEnabled?: boolean;
13048
-
13049
- /**
13050
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13051
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13052
- * Default: false
13053
- */
13054
- selectionEnabled?: boolean;
13055
-
13056
- /**
13057
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13058
- * be transferred to the new window, if false only the active component will be opened.
13059
- * Default: false
13060
- */
13061
- popoutWholeStack?: boolean;
13062
-
13063
- /**
13064
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13065
- * If false, the popout call will fail silently.
13066
- * Default: true
13067
- */
13068
- blockedPopoutsThrowError?: boolean;
13069
-
13070
- /**
13071
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13072
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13073
- * addition, any changes made to popouts won't be stored after the parent is closed.
13074
- * Default: true
13075
- */
13076
- closePopoutsOnUnload?: boolean;
13077
-
13078
- /**
13079
- * Specifies if the popout icon should be displayed in the header-bar.
13080
- * Default: true
13081
- */
13082
- showPopoutIcon?: boolean;
13083
-
13084
- /**
13085
- * Specifies if the maximise icon should be displayed in the header-bar.
13086
- * Default: true
13087
- */
13088
- showMaximiseIcon?: boolean;
13089
-
13090
- /**
13091
- * Specifies if the close icon should be displayed in the header-bar.
13092
- * Default: true
13093
- */
13094
- showCloseIcon?: boolean;
13095
- }
13096
-
13097
12173
  /**
13098
12174
  * @interface
13099
12175
  */
@@ -13195,7 +12271,18 @@ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13195
12271
  };
13196
12272
 
13197
12273
  /**
13198
- * Generated when a View is shown. This event will fire during creation of a View.
12274
+ * Generated when a View is shown.
12275
+ *
12276
+ * @remarks
12277
+ * An OpenFin View's `shown` event is only emitted when specific View APIs are called.
12278
+ * This event can fire when calling:
12279
+ *
12280
+ * * `view.show()` or `view.showAt()` - If a View is previously hidden, a `shown` event will be fired.
12281
+ *
12282
+ * * `view.attach()` - If a View is hidden and attached to a new Window, it will be shown and the `shown` event will be fired.
12283
+ *
12284
+ * * `view.create()` - A View `shown` event will be fired. (Internally the `attach` method is called when calling the `create` method, which fires the `shown` event.)
12285
+ *
13199
12286
  * @interface
13200
12287
  */
13201
12288
  declare type ShownEvent = BaseEvent_4 & {
@@ -14989,52 +14076,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14989
14076
  proceed: () => void;
14990
14077
  }) => void;
14991
14078
 
14992
- declare interface Tab {
14993
- _dragListener: TabDragListener;
14994
-
14995
- /**
14996
- * True if this tab is the selected tab
14997
- */
14998
- isActive: boolean;
14999
-
15000
- /**
15001
- * A reference to the header this tab is a child of
15002
- */
15003
- header: Header;
15004
-
15005
- /**
15006
- * A reference to the content item this tab relates to
15007
- */
15008
- contentItem: ContentItem;
15009
-
15010
- /**
15011
- * The tabs outer (jQuery) DOM element
15012
- */
15013
- element: JQuery;
15014
-
15015
- /**
15016
- * The (jQuery) DOM element containing the title
15017
- */
15018
- titleElement: JQuery;
15019
-
15020
- /**
15021
- * The (jQuery) DOM element that closes the tab
15022
- */
15023
- closeElement: JQuery;
15024
-
15025
- /**
15026
- * Sets the tab's title. Does not affect the contentItem's title!
15027
- * @param title The new title
15028
- */
15029
- setTitle(title: string): void;
15030
-
15031
- /**
15032
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15033
- * @param isActive Whether the tab is active
15034
- */
15035
- setActive(isActive: boolean): void;
15036
- }
15037
-
15038
14079
  /**
15039
14080
  * Generated when a Layout Tab Component was closed.
15040
14081
  * @interface
@@ -15052,13 +14093,6 @@ declare type TabCreatedEvent = LayoutDOMEvent & {
15052
14093
  type: 'tab-created';
15053
14094
  };
15054
14095
 
15055
- declare interface TabDragListener extends EventEmitter_2 {
15056
- /**
15057
- * A reference to the content item this tab relates to
15058
- */
15059
- contentItem: ContentItem;
15060
- }
15061
-
15062
14096
  /**
15063
14097
  * Generated when a Layout Tab Component was dropped.
15064
14098
  * @interface