@openfin/node-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
  };
@@ -3749,103 +3682,6 @@ declare type ConstWindowOptions = {
3749
3682
  inheritance?: Partial<InheritableOptions>;
3750
3683
  };
3751
3684
 
3752
- declare interface Container extends EventEmitter_2 {
3753
- /**
3754
- * The current width of the container in pixel
3755
- */
3756
- width: number;
3757
-
3758
- /**
3759
- * The current height of the container in pixel
3760
- */
3761
- height: number;
3762
-
3763
- /**
3764
- * A reference to the component-item that controls this container
3765
- */
3766
- parent: ContentItem;
3767
-
3768
- /**
3769
- * A reference to the tab that controls this container. Will initially be null
3770
- * (and populated once a tab event has been fired).
3771
- */
3772
- tab: Tab;
3773
-
3774
- /**
3775
- * The current title of the container
3776
- */
3777
- title: string;
3778
-
3779
- /*
3780
- * A reference to the GoldenLayout instance this container belongs to
3781
- */
3782
- layoutManager: GoldenLayout_2;
3783
-
3784
- /**
3785
- * True if the item is currently hidden
3786
- */
3787
- isHidden: boolean;
3788
-
3789
- /**
3790
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3791
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3792
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3793
- * constructor function. It will also be used when the component is opened in a new window.
3794
- * @param state A serialisable object
3795
- */
3796
- setState(state: any): void;
3797
-
3798
- /**
3799
- * The same as setState but does not emit 'stateChanged' event
3800
- * @param {serialisable} state
3801
- */
3802
- setStateSkipEvent(state: any): void;
3803
-
3804
- /**
3805
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3806
- * @param state A serialisable object
3807
- */
3808
- extendState(state: any): void;
3809
-
3810
- /**
3811
- * Returns the current state.
3812
- */
3813
- getState(): any;
3814
-
3815
- /**
3816
- * Returns the container's inner element as a jQuery element
3817
- */
3818
- getElement(): JQuery;
3819
-
3820
- /**
3821
- * hides the container or returns false if hiding it is not possible
3822
- */
3823
- hide(): boolean;
3824
-
3825
- /**
3826
- * shows the container or returns false if showing it is not possible
3827
- */
3828
- show(): boolean;
3829
-
3830
- /**
3831
- * Sets the container to the specified size or returns false if that's not possible
3832
- * @param width the new width in pixel
3833
- * @param height the new height in pixel
3834
- */
3835
- setSize(width: number, height: number): boolean;
3836
-
3837
- /**
3838
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3839
- * @param title the new title
3840
- */
3841
- setTitle(title: string): void;
3842
-
3843
- /**
3844
- * Closes the container or returns false if that is not possible
3845
- */
3846
- close(): boolean;
3847
- }
3848
-
3849
3685
  /**
3850
3686
  * Generated when a Layout Container Component was created.
3851
3687
  * @interface
@@ -3927,218 +3763,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3927
3763
  disposition: string;
3928
3764
  };
3929
3765
 
3930
- declare interface ContentItem extends EventEmitter_2 {
3931
- instance: any;
3932
- header: any;
3933
- _splitter: any;
3934
- /**
3935
- * This items configuration in its current state
3936
- */
3937
- config: ItemConfigType;
3938
-
3939
- /**
3940
- * The type of the item. Can be row, column, stack, component or root
3941
- */
3942
- type: ItemType;
3943
-
3944
- /**
3945
- * An array of items that are children of this item
3946
- */
3947
- contentItems: ContentItem[];
3948
-
3949
- container: Container;
3950
- /**
3951
- * The item that is this item's parent (or null if the item is root)
3952
- */
3953
- parent: ContentItem;
3954
-
3955
- /**
3956
- * A String or array of identifiers if provided in the configuration
3957
- */
3958
- id: string;
3959
-
3960
- /**
3961
- * True if the item had been initialised
3962
- */
3963
- isInitialised: boolean;
3964
-
3965
- /**
3966
- * True if the item is maximised
3967
- */
3968
- isMaximised: boolean;
3969
-
3970
- /**
3971
- * True if the item is the layout's root item
3972
- */
3973
- isRoot: boolean;
3974
-
3975
- /**
3976
- * True if the item is a row
3977
- */
3978
- isRow: boolean;
3979
-
3980
- /**
3981
- * True if the item is a column
3982
- */
3983
- isColumn: boolean;
3984
-
3985
- /**
3986
- * True if the item is a stack
3987
- */
3988
- isStack: boolean;
3989
-
3990
- /**
3991
- * True if the item is a component
3992
- */
3993
- isComponent: boolean;
3994
-
3995
- /**
3996
- * A reference to the layoutManager that controls this item
3997
- */
3998
- layoutManager: any;
3999
-
4000
- /**
4001
- * The item's outer element
4002
- */
4003
- element: JQuery;
4004
-
4005
- /**
4006
- * The item's inner element. Can be the same as the outer element.
4007
- */
4008
- childElementContainer: Container;
4009
-
4010
- /**
4011
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4012
- * from its original position before adding it to this item.
4013
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4014
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4015
- */
4016
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4017
-
4018
- /**
4019
- * Destroys the item and all it's children
4020
- * @param contentItem The contentItem that should be removed
4021
- * @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.
4022
- */
4023
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4024
-
4025
- /**
4026
- * The contentItem that should be removed
4027
- * @param oldChild ContentItem The contentItem that should be removed
4028
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4029
- */
4030
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4031
-
4032
- /**
4033
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4034
- */
4035
- setSize(): void;
4036
-
4037
- /**
4038
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4039
- * @param title the new title
4040
- */
4041
- setTitle(title: string): void;
4042
-
4043
- /**
4044
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4045
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4046
- * @param functionName The name of the method to invoke
4047
- * @param functionArguments An array of arguments to pass to every function
4048
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4049
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4050
- */
4051
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4052
-
4053
- /**
4054
- * 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.
4055
- */
4056
- emitBubblingEvent(name: string): void;
4057
-
4058
- /**
4059
- * Convenience method for item.parent.removeChild( item )
4060
- */
4061
- remove(): void;
4062
-
4063
- /**
4064
- * Removes the item from its current position in the layout and opens it in a window
4065
- */
4066
- popout(): BrowserWindow;
4067
-
4068
- /**
4069
- * Maximises the item or minimises it if it's already maximised
4070
- */
4071
- toggleMaximise(): void;
4072
-
4073
- /**
4074
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4075
- */
4076
- select(): void;
4077
-
4078
- /**
4079
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4080
- */
4081
- deselect(): void;
4082
-
4083
- /**
4084
- * Returns true if the item has the specified id or false if not
4085
- * @param id An id to check for
4086
- */
4087
- hasId(id: string): boolean;
4088
-
4089
- /**
4090
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4091
- * @param contentItem The new active content item
4092
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4093
- */
4094
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4095
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4096
-
4097
- /**
4098
- * Only Stacks have this method! Returns the currently selected contentItem.
4099
- */
4100
- getActiveContentItem(): ContentItem;
4101
-
4102
- /**
4103
- * Adds an id to an item or does nothing if the id is already present
4104
- * @param id The id to be added
4105
- */
4106
- addId(id: string): void;
4107
-
4108
- /**
4109
- * Removes an id from an item or throws an error if the id couldn't be found
4110
- * @param id The id to be removed
4111
- */
4112
- removeId(id: string): void;
4113
-
4114
- /**
4115
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4116
- * @param filterFunction A function that determines whether an item matches certain criteria
4117
- */
4118
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4119
-
4120
- /**
4121
- * Returns all items with the specified id.
4122
- * @param id An id specified in the itemConfig
4123
- */
4124
- getItemsById(id: string | string[]): ContentItem[];
4125
-
4126
- /**
4127
- * Returns all items with the specified type
4128
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4129
- */
4130
- getItemsByType(type: string): ContentItem[];
4131
-
4132
- /**
4133
- * Returns all instances of the component with the specified componentName
4134
- * @param componentName a componentName as specified in the itemConfig
4135
- */
4136
- getComponentsByName(componentName: string): any;
4137
-
4138
- _contentAreaDimensions: any;
4139
- _$getArea: () => any;
4140
- }
4141
-
4142
3766
  /**
4143
3767
  * Restrict navigation to URLs that match an allowed pattern.
4144
3768
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4577,46 +4201,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4577
4201
  type: 'did-finish-load';
4578
4202
  };
4579
4203
 
4580
- declare interface Dimensions {
4581
- /**
4582
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4583
- * than the visible one, making it safe to set this to small values without affecting usability.
4584
- * Default: 5
4585
- */
4586
- borderWidth?: number;
4587
-
4588
- /**
4589
- * The minimum height an item can be resized to (in pixel).
4590
- * Default: 10
4591
- */
4592
- minItemHeight?: number;
4593
-
4594
- /**
4595
- * The minimum width an item can be resized to (in pixel).
4596
- * Default: 10
4597
- */
4598
- minItemWidth?: number;
4599
-
4600
- /**
4601
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4602
- * adjusted accordingly.
4603
- * Default: 20
4604
- */
4605
- headerHeight?: number;
4606
-
4607
- /**
4608
- * The width of the element that appears when an item is dragged (in pixel).
4609
- * Default: 300
4610
- */
4611
- dragProxyWidth?: number;
4612
-
4613
- /**
4614
- * The height of the element that appears when an item is dragged (in pixel).
4615
- * Default: 200
4616
- */
4617
- dragProxyHeight?: number;
4618
- }
4619
-
4620
4204
  /**
4621
4205
  * @interface
4622
4206
  */
@@ -4877,8 +4461,6 @@ declare type Dpi = {
4877
4461
  vertical?: number;
4878
4462
  };
4879
4463
 
4880
- declare interface DragSource {}
4881
-
4882
4464
  /**
4883
4465
  * Generated when a window has been embedded.
4884
4466
  * @interface
@@ -5191,43 +4773,6 @@ declare class EventAggregator extends EmitterMap {
5191
4773
  dispatchEvent: (message: Message<any>) => boolean;
5192
4774
  }
5193
4775
 
5194
- declare interface EventEmitter_2 {
5195
- [x: string]: any;
5196
- /**
5197
- * Subscribe to an event
5198
- * @param eventName The name of the event to describe to
5199
- * @param callback The function that should be invoked when the event occurs
5200
- * @param context The value of the this pointer in the callback function
5201
- */
5202
- on(eventName: string, callback: Function, context?: any): void;
5203
-
5204
- /**
5205
- * Notify listeners of an event and pass arguments along
5206
- * @param eventName The name of the event to emit
5207
- */
5208
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5209
-
5210
- /**
5211
- * Alias for emit
5212
- */
5213
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5214
-
5215
- /**
5216
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5217
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5218
- * arguments.
5219
- * @param eventName The name of the event to unsubscribe from
5220
- * @param callback The function that should be invoked when the event occurs
5221
- * @param context The value of the this pointer in the callback function
5222
- */
5223
- unbind(eventName: string, callback?: Function, context?: any): void;
5224
-
5225
- /**
5226
- * Alias for unbind
5227
- */
5228
- off(eventName: string, callback?: Function, context?: any): void;
5229
- }
5230
-
5231
4776
  /**
5232
4777
  * Handler for an event on an EventEmitter.
5233
4778
  * @remarks Selects the correct type for the event
@@ -6070,253 +5615,6 @@ declare namespace GlobalHotkeyEvents {
6070
5615
  */
6071
5616
  declare type GlobalHotkeyEventType = EventType_6;
6072
5617
 
6073
- declare namespace GoldenLayout {
6074
- export {
6075
- GoldenLayout_2 as GoldenLayout,
6076
- ItemConfigType,
6077
- Settings,
6078
- Dimensions,
6079
- Labels,
6080
- ItemType,
6081
- ItemConfig,
6082
- ComponentConfig,
6083
- ReactComponentConfig,
6084
- Config,
6085
- ContentItem,
6086
- Container,
6087
- DragSource,
6088
- BrowserWindow,
6089
- Header,
6090
- TabDragListener,
6091
- Tab,
6092
- EventEmitter_2 as EventEmitter
6093
- }
6094
- }
6095
-
6096
- declare class GoldenLayout_2 implements EventEmitter_2 {
6097
- /**
6098
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6099
- * object and of goldenLayout.root as the document.
6100
- */
6101
- root: ContentItem;
6102
-
6103
- /**
6104
- * A reference to the (jQuery) DOM element containing the layout
6105
- */
6106
- container: JQuery;
6107
-
6108
- /**
6109
- * True once the layout item tree has been created and the initialised event has been fired
6110
- */
6111
- isInitialised: boolean;
6112
-
6113
- /**
6114
- * A reference to the current, extended top level config.
6115
- *
6116
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6117
- */
6118
- config: Config;
6119
-
6120
- /**
6121
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6122
- * to true.
6123
- */
6124
- selectedItem: ContentItem;
6125
-
6126
- /**
6127
- * The current outer width of the layout in pixels.
6128
- */
6129
- width: number;
6130
-
6131
- /**
6132
- * The current outer height of the layout in pixels.
6133
- */
6134
- height: number;
6135
-
6136
- /**
6137
- * An array of BrowserWindow instances
6138
- */
6139
- openPopouts: BrowserWindow[];
6140
-
6141
- /**
6142
- * True if the layout has been opened as a popout by another layout.
6143
- */
6144
- isSubWindow: boolean;
6145
-
6146
- /**
6147
- * A singleton instance of EventEmitter that works across windows
6148
- */
6149
- eventHub: EventEmitter_2;
6150
-
6151
- _dragProxy: any;
6152
-
6153
- dropTargetIndicator: any;
6154
-
6155
- _isFullPage: boolean;
6156
-
6157
- _onUnload: any;
6158
-
6159
- tabDropPlaceholder: any;
6160
-
6161
- transitionIndicator: any;
6162
-
6163
- _dragSources: any;
6164
-
6165
- _resizeFunction: any;
6166
-
6167
- _unloadFunction: any;
6168
-
6169
- /**
6170
- * @param config A GoldenLayout configuration object
6171
- * @param container The DOM element the layout will be initialised in. Default: document.body
6172
- */
6173
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6174
-
6175
- /*
6176
- * @param name The name of the component, as referred to by componentName in the component configuration.
6177
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6178
- * containerobject and a component state
6179
- */
6180
- registerComponent(name: String, component: any): void;
6181
-
6182
- /**
6183
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6184
- * a listener to the document and executes once it becomes ready.
6185
- */
6186
- init(): void;
6187
-
6188
- /**
6189
- * Returns the current state of the layout and its components as a serialisable object.
6190
- */
6191
- toConfig(): Config;
6192
-
6193
- /**
6194
- * Returns a component that was previously registered with layout.registerComponent().
6195
- * @param name The name of a previously registered component
6196
- */
6197
- getComponent(name: string): any;
6198
-
6199
- /**
6200
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6201
- * @param width The outer width the layout should be resized to. Default: The container elements width
6202
- * @param height The outer height the layout should be resized to. Default: The container elements height
6203
- */
6204
- updateSize(width?: number, height?: number): void;
6205
-
6206
- /**
6207
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6208
- * listeners and finally removes itself from the DOM.
6209
- */
6210
- destroy(): void;
6211
-
6212
- /**
6213
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6214
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6215
- * all call this method implicitly.
6216
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6217
- * @param parent A parent item
6218
- */
6219
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6220
-
6221
- /**
6222
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6223
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6224
- * provided its config will be read, if config is provided, only the content key
6225
- * will be used
6226
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6227
- * place the window in another screen.
6228
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6229
- * when popIn is clicked
6230
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6231
- */
6232
- createPopout(
6233
- configOrContentItem: ItemConfigType | ContentItem,
6234
- dimensions: {
6235
- width: number;
6236
- height: number;
6237
- left: number;
6238
- top: number;
6239
- },
6240
- parentId?: string,
6241
- indexInParent?: number
6242
- ): void;
6243
-
6244
- /**
6245
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6246
- * where it turns into a contentItem.
6247
- * @param element The DOM element that will be turned into a dragSource
6248
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6249
- * @return the dragSource that was created. This can be used to remove the
6250
- * dragSource from the layout later.
6251
- */
6252
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6253
-
6254
- /**
6255
- * Removes a dragSource from the layout.
6256
- *
6257
- * @param dragSource The dragSource to remove
6258
- */
6259
- removeDragSource(dragSource: DragSource): void;
6260
-
6261
- /**
6262
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6263
- * @param contentItem A ContentItem instance
6264
- */
6265
- selectItem(contentItem: ContentItem): void;
6266
-
6267
- /**
6268
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6269
- * and replace frequent keys and values with single letter substitutes.
6270
- * @param config A GoldenLayout configuration object
6271
- */
6272
- static minifyConfig(config: any): any;
6273
-
6274
- /**
6275
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6276
- * @param minifiedConfig A minified GoldenLayout configuration object
6277
- */
6278
- static unminifyConfig(minifiedConfig: any): any;
6279
-
6280
- /**
6281
- * Subscribe to an event
6282
- * @param eventName The name of the event to describe to
6283
- * @param callback The function that should be invoked when the event occurs
6284
- * @param context The value of the this pointer in the callback function
6285
- */
6286
- on(eventName: string, callback: Function, context?: any): void;
6287
-
6288
- /**
6289
- * Notify listeners of an event and pass arguments along
6290
- * @param eventName The name of the event to emit
6291
- */
6292
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6293
-
6294
- /**
6295
- * Alias for emit
6296
- */
6297
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6298
-
6299
- /**
6300
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6301
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6302
- * arguments.
6303
- * @param eventName The name of the event to unsubscribe from
6304
- * @param callback The function that should be invoked when the event occurs
6305
- * @param context The value of the this pointer in the callback function
6306
- */
6307
- unbind(eventName: string, callback?: Function, context?: any): void;
6308
-
6309
- /**
6310
- * Alias for unbind
6311
- */
6312
- off(eventName: string, callback?: Function, context?: any): void;
6313
-
6314
- /**
6315
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6316
- */
6317
- _$createRootItemAreas(): void;
6318
- }
6319
-
6320
5618
  /**
6321
5619
  * @interface
6322
5620
  */
@@ -6324,64 +5622,15 @@ declare type GpuInfo = {
6324
5622
  name: string;
6325
5623
  };
6326
5624
 
6327
- declare interface Header {
6328
- /**
6329
- * A reference to the LayoutManager instance
6330
- */
6331
- layoutManager: GoldenLayout_2;
6332
-
6333
- /**
6334
- * A reference to the Stack this Header belongs to
6335
- */
6336
- parent: ContentItem;
6337
-
6338
- /**
6339
- * An array of the Tabs within this header
6340
- */
6341
- tabs: Tab[];
6342
-
6343
- /**
6344
- * The currently selected activeContentItem
6345
- */
6346
- activeContentItem: ContentItem;
6347
-
6348
- /**
6349
- * The outer (jQuery) DOM element of this Header
6350
- */
6351
- element: JQuery;
6352
-
6353
- /**
6354
- * The (jQuery) DOM element containing the tabs
6355
- */
6356
- tabsContainer: JQuery;
6357
-
6358
- /**
6359
- * The (jQuery) DOM element containing the close, maximise and popout button
6360
- */
6361
- controlsContainer: JQuery;
6362
-
6363
- /**
6364
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6365
- * @param contentItem The content item that will be selected
6366
- */
6367
- setActiveContentItem(contentItem: ContentItem): void;
6368
-
6369
- /**
6370
- * Creates a new tab and associates it with a content item
6371
- * @param contentItem The content item the tab will be associated with
6372
- * @param index A zero based index, specifying the position of the new tab
6373
- */
6374
- createTab(contentItem: ContentItem, index?: number): void;
6375
-
6376
- /**
6377
- * Finds a tab by its contentItem and removes it
6378
- * @param contentItem The content item the tab is associated with
6379
- */
6380
- removeTab(contentItem: ContentItem): void;
6381
- }
6382
-
6383
5625
  /**
6384
5626
  * Generated when a View is hidden.
5627
+ *
5628
+ * @remarks
5629
+ * An OpenFin View's `hidden` event is only emitted when a specific View API is called.
5630
+ * This event can fire when calling:
5631
+ *
5632
+ * * `view.hide()` - If a View is previously shown, a `hidden` event will be fired.
5633
+ *
6385
5634
  * @interface
6386
5635
  */
6387
5636
  declare type HiddenEvent = BaseEvent_4 & {
@@ -7966,50 +7215,6 @@ declare class InteropModule extends Base {
7966
7215
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
7967
7216
  }
7968
7217
 
7969
- declare interface ItemConfig {
7970
- /**
7971
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
7972
- */
7973
- type: ItemType;
7974
-
7975
- /**
7976
- * An array of configurations for items that will be created as children of this item.
7977
- */
7978
- content?: ItemConfigType[];
7979
-
7980
- /**
7981
- * The width of this item, relative to the other children of its parent in percent
7982
- */
7983
- width?: number;
7984
-
7985
- /**
7986
- * The height of this item, relative to the other children of its parent in percent
7987
- */
7988
- height?: number;
7989
-
7990
- /**
7991
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
7992
- */
7993
- id?: string | string[];
7994
-
7995
- /**
7996
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
7997
- * will return false
7998
- * Default: true
7999
- */
8000
- isClosable?: boolean;
8001
-
8002
- /**
8003
- * The title of the item as displayed on its tab and on popout windows
8004
- * Default: componentName or ''
8005
- */
8006
- title?: string;
8007
- }
8008
-
8009
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8010
-
8011
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8012
-
8013
7218
  /**
8014
7219
  * @interface
8015
7220
  */
@@ -8067,32 +7272,6 @@ declare type JumpListTask = {
8067
7272
  iconIndex?: number;
8068
7273
  };
8069
7274
 
8070
- declare interface Labels {
8071
- /**
8072
- * The tooltip text that appears when hovering over the close icon.
8073
- * Default: 'close'
8074
- */
8075
- close?: string;
8076
-
8077
- /**
8078
- * The tooltip text that appears when hovering over the maximise icon.
8079
- * Default: 'maximise'
8080
- */
8081
- maximise?: string;
8082
-
8083
- /**
8084
- * The tooltip text that appears when hovering over the minimise icon.
8085
- * Default: 'minimise'
8086
- */
8087
- minimise?: string;
8088
-
8089
- /**
8090
- * The tooltip text that appears when hovering over the popout icon.
8091
- * Default: 'open in new window'
8092
- */
8093
- popout?: string;
8094
- }
8095
-
8096
7275
  export declare function launch(config: ConnectConfig): Promise<number>;
8097
7276
 
8098
7277
  /**
@@ -8546,7 +7725,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8546
7725
  entityId: string;
8547
7726
  };
8548
7727
 
8549
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7728
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8550
7729
 
8551
7730
  /**
8552
7731
  * @interface
@@ -12483,18 +11662,6 @@ declare type QueryPermissionResult = {
12483
11662
  rawValue?: unknown;
12484
11663
  };
12485
11664
 
12486
- declare interface ReactComponentConfig extends ItemConfig {
12487
- /**
12488
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12489
- */
12490
- component: string;
12491
-
12492
- /**
12493
- * Properties that will be passed to the component and accessible using this.props.
12494
- */
12495
- props?: any;
12496
- }
12497
-
12498
11665
  /**
12499
11666
  * @interface
12500
11667
  */
@@ -12971,97 +12138,6 @@ declare type SessionContextGroup = {
12971
12138
  }>;
12972
12139
  };
12973
12140
 
12974
- declare interface Settings {
12975
- preventSplitterResize?: boolean;
12976
-
12977
- newTabButton?: {
12978
- url?: string;
12979
- };
12980
-
12981
- /**
12982
- * If true, tabs can't be dragged into the window.
12983
- * Default: false
12984
- */
12985
- preventDragIn?: boolean;
12986
-
12987
- /**
12988
- * If true, tabs can't be dragged out of the window.
12989
- * Default: false
12990
- */
12991
- preventDragOut?: boolean;
12992
-
12993
- /**
12994
- * If true, stack headers are the only areas where tabs can be dropped.
12995
- * Default: false
12996
- */
12997
- constrainDragToHeaders?: boolean;
12998
- /**
12999
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13000
- * Default: true
13001
- */
13002
- hasHeaders?: boolean;
13003
-
13004
- /**
13005
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13006
- * automatically when layout.createDragSource() is called.
13007
- * Default: true
13008
- */
13009
- constrainDragToContainer?: boolean;
13010
-
13011
- /**
13012
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13013
- * Default: true
13014
- */
13015
- reorderEnabled?: boolean;
13016
-
13017
- /**
13018
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13019
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13020
- * Default: false
13021
- */
13022
- selectionEnabled?: boolean;
13023
-
13024
- /**
13025
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13026
- * be transferred to the new window, if false only the active component will be opened.
13027
- * Default: false
13028
- */
13029
- popoutWholeStack?: boolean;
13030
-
13031
- /**
13032
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13033
- * If false, the popout call will fail silently.
13034
- * Default: true
13035
- */
13036
- blockedPopoutsThrowError?: boolean;
13037
-
13038
- /**
13039
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13040
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13041
- * addition, any changes made to popouts won't be stored after the parent is closed.
13042
- * Default: true
13043
- */
13044
- closePopoutsOnUnload?: boolean;
13045
-
13046
- /**
13047
- * Specifies if the popout icon should be displayed in the header-bar.
13048
- * Default: true
13049
- */
13050
- showPopoutIcon?: boolean;
13051
-
13052
- /**
13053
- * Specifies if the maximise icon should be displayed in the header-bar.
13054
- * Default: true
13055
- */
13056
- showMaximiseIcon?: boolean;
13057
-
13058
- /**
13059
- * Specifies if the close icon should be displayed in the header-bar.
13060
- * Default: true
13061
- */
13062
- showCloseIcon?: boolean;
13063
- }
13064
-
13065
12141
  /**
13066
12142
  * @interface
13067
12143
  */
@@ -13163,7 +12239,18 @@ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
13163
12239
  };
13164
12240
 
13165
12241
  /**
13166
- * Generated when a View is shown. This event will fire during creation of a View.
12242
+ * Generated when a View is shown.
12243
+ *
12244
+ * @remarks
12245
+ * An OpenFin View's `shown` event is only emitted when specific View APIs are called.
12246
+ * This event can fire when calling:
12247
+ *
12248
+ * * `view.show()` or `view.showAt()` - If a View is previously hidden, a `shown` event will be fired.
12249
+ *
12250
+ * * `view.attach()` - If a View is hidden and attached to a new Window, it will be shown and the `shown` event will be fired.
12251
+ *
12252
+ * * `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.)
12253
+ *
13167
12254
  * @interface
13168
12255
  */
13169
12256
  declare type ShownEvent = BaseEvent_4 & {
@@ -14957,52 +14044,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14957
14044
  proceed: () => void;
14958
14045
  }) => void;
14959
14046
 
14960
- declare interface Tab {
14961
- _dragListener: TabDragListener;
14962
-
14963
- /**
14964
- * True if this tab is the selected tab
14965
- */
14966
- isActive: boolean;
14967
-
14968
- /**
14969
- * A reference to the header this tab is a child of
14970
- */
14971
- header: Header;
14972
-
14973
- /**
14974
- * A reference to the content item this tab relates to
14975
- */
14976
- contentItem: ContentItem;
14977
-
14978
- /**
14979
- * The tabs outer (jQuery) DOM element
14980
- */
14981
- element: JQuery;
14982
-
14983
- /**
14984
- * The (jQuery) DOM element containing the title
14985
- */
14986
- titleElement: JQuery;
14987
-
14988
- /**
14989
- * The (jQuery) DOM element that closes the tab
14990
- */
14991
- closeElement: JQuery;
14992
-
14993
- /**
14994
- * Sets the tab's title. Does not affect the contentItem's title!
14995
- * @param title The new title
14996
- */
14997
- setTitle(title: string): void;
14998
-
14999
- /**
15000
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15001
- * @param isActive Whether the tab is active
15002
- */
15003
- setActive(isActive: boolean): void;
15004
- }
15005
-
15006
14047
  /**
15007
14048
  * Generated when a Layout Tab Component was closed.
15008
14049
  * @interface
@@ -15020,13 +14061,6 @@ declare type TabCreatedEvent = LayoutDOMEvent & {
15020
14061
  type: 'tab-created';
15021
14062
  };
15022
14063
 
15023
- declare interface TabDragListener extends EventEmitter_2 {
15024
- /**
15025
- * A reference to the content item this tab relates to
15026
- */
15027
- contentItem: ContentItem;
15028
- }
15029
-
15030
14064
  /**
15031
14065
  * Generated when a Layout Tab Component was dropped.
15032
14066
  * @interface