@openfin/fdc3-api 36.80.10 → 36.80.23

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.
package/out/fdc3-api.d.ts CHANGED
@@ -1184,9 +1184,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1184
1184
  */
1185
1185
  mainWindowOptions: WindowCreationOptions;
1186
1186
  /**
1187
- * The name of the application (and the application's main window).
1187
+ * The name of the application.
1188
1188
  *
1189
- * If provided, _must_ match `uuid`.
1189
+ * @remarks
1190
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1191
+ * any special characters, spaces or international characters. It's also used in error messages, API
1192
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1193
+ *
1194
+ * This property will be deprecated in the future.
1190
1195
  */
1191
1196
  name: string;
1192
1197
  /**
@@ -1216,9 +1221,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1216
1221
  url: string;
1217
1222
  /**
1218
1223
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1219
- * running in the OpenFin Runtime.
1220
- *
1221
- * Note that `name` and `uuid` must match.
1224
+ * running in the OpenFin Runtime.
1222
1225
  */
1223
1226
  uuid: string;
1224
1227
  /**
@@ -2007,48 +2010,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
2007
2010
  behavior: 'browser';
2008
2011
  };
2009
2012
 
2010
- declare interface BrowserWindow {
2011
- /**
2012
- * True if the window has been opened and its GoldenLayout instance initialised.
2013
- */
2014
- isInitialised: boolean;
2015
-
2016
- /**
2017
- * Creates a window configuration object from the Popout.
2018
- */
2019
- toConfig(): {
2020
- dimensions: {
2021
- width: number;
2022
- height: number;
2023
- left: number;
2024
- top: number;
2025
- };
2026
- content: Config;
2027
- parentId: string;
2028
- indexInParent: number;
2029
- };
2030
-
2031
- /**
2032
- * Returns the GoldenLayout instance from the child window
2033
- */
2034
- getGlInstance(): GoldenLayout_2;
2035
-
2036
- /**
2037
- * Returns the native Window object
2038
- */
2039
- getWindow(): Window;
2040
-
2041
- /**
2042
- * Closes the popout
2043
- */
2044
- close(): void;
2045
-
2046
- /**
2047
- * Returns the popout to its original position as specified in parentId and indexInParent
2048
- */
2049
- popIn(): void;
2050
- }
2051
-
2052
2013
  /**
2053
2014
  * Extracts a single event type matching the given key from the View {@link Event} union.
2054
2015
  *
@@ -3491,31 +3452,6 @@ declare class CombinedStrategy<A, B> implements ChannelStrategy<OnlyIfCompatible
3491
3452
  close(): Promise<void>;
3492
3453
  }
3493
3454
 
3494
- declare interface ComponentConfig extends ItemConfig {
3495
- /**
3496
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3497
- */
3498
- componentName: string;
3499
-
3500
- /**
3501
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3502
- * container.getState().
3503
- */
3504
- componentState?: any;
3505
- }
3506
-
3507
- declare interface Config {
3508
- settings?: Settings;
3509
- dimensions?: Dimensions;
3510
- labels?: Labels;
3511
- content?: ItemConfigType[];
3512
- /**
3513
- * (Only on layout config object)
3514
- * Id of the currently maximised content item
3515
- */
3516
- maximisedItemId?: string;
3517
- }
3518
-
3519
3455
  declare type ConfigWithRuntime = BaseConfig & {
3520
3456
  runtime: RuntimeConfig;
3521
3457
  };
@@ -3893,103 +3829,6 @@ declare type ConstWindowOptions = {
3893
3829
  inheritance?: Partial<InheritableOptions>;
3894
3830
  };
3895
3831
 
3896
- declare interface Container extends EventEmitter_2 {
3897
- /**
3898
- * The current width of the container in pixel
3899
- */
3900
- width: number;
3901
-
3902
- /**
3903
- * The current height of the container in pixel
3904
- */
3905
- height: number;
3906
-
3907
- /**
3908
- * A reference to the component-item that controls this container
3909
- */
3910
- parent: ContentItem;
3911
-
3912
- /**
3913
- * A reference to the tab that controls this container. Will initially be null
3914
- * (and populated once a tab event has been fired).
3915
- */
3916
- tab: Tab;
3917
-
3918
- /**
3919
- * The current title of the container
3920
- */
3921
- title: string;
3922
-
3923
- /*
3924
- * A reference to the GoldenLayout instance this container belongs to
3925
- */
3926
- layoutManager: GoldenLayout_2;
3927
-
3928
- /**
3929
- * True if the item is currently hidden
3930
- */
3931
- isHidden: boolean;
3932
-
3933
- /**
3934
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3935
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3936
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3937
- * constructor function. It will also be used when the component is opened in a new window.
3938
- * @param state A serialisable object
3939
- */
3940
- setState(state: any): void;
3941
-
3942
- /**
3943
- * The same as setState but does not emit 'stateChanged' event
3944
- * @param {serialisable} state
3945
- */
3946
- setStateSkipEvent(state: any): void;
3947
-
3948
- /**
3949
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3950
- * @param state A serialisable object
3951
- */
3952
- extendState(state: any): void;
3953
-
3954
- /**
3955
- * Returns the current state.
3956
- */
3957
- getState(): any;
3958
-
3959
- /**
3960
- * Returns the container's inner element as a jQuery element
3961
- */
3962
- getElement(): JQuery;
3963
-
3964
- /**
3965
- * hides the container or returns false if hiding it is not possible
3966
- */
3967
- hide(): boolean;
3968
-
3969
- /**
3970
- * shows the container or returns false if showing it is not possible
3971
- */
3972
- show(): boolean;
3973
-
3974
- /**
3975
- * Sets the container to the specified size or returns false if that's not possible
3976
- * @param width the new width in pixel
3977
- * @param height the new height in pixel
3978
- */
3979
- setSize(width: number, height: number): boolean;
3980
-
3981
- /**
3982
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3983
- * @param title the new title
3984
- */
3985
- setTitle(title: string): void;
3986
-
3987
- /**
3988
- * Closes the container or returns false if that is not possible
3989
- */
3990
- close(): boolean;
3991
- }
3992
-
3993
3832
  declare type ContentCreationBehavior = 'window' | 'view' | 'block' | 'browser';
3994
3833
 
3995
3834
  /**
@@ -4052,218 +3891,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
4052
3891
  disposition: string;
4053
3892
  };
4054
3893
 
4055
- declare interface ContentItem extends EventEmitter_2 {
4056
- instance: any;
4057
- header: any;
4058
- _splitter: any;
4059
- /**
4060
- * This items configuration in its current state
4061
- */
4062
- config: ItemConfigType;
4063
-
4064
- /**
4065
- * The type of the item. Can be row, column, stack, component or root
4066
- */
4067
- type: ItemType;
4068
-
4069
- /**
4070
- * An array of items that are children of this item
4071
- */
4072
- contentItems: ContentItem[];
4073
-
4074
- container: Container;
4075
- /**
4076
- * The item that is this item's parent (or null if the item is root)
4077
- */
4078
- parent: ContentItem;
4079
-
4080
- /**
4081
- * A String or array of identifiers if provided in the configuration
4082
- */
4083
- id: string;
4084
-
4085
- /**
4086
- * True if the item had been initialised
4087
- */
4088
- isInitialised: boolean;
4089
-
4090
- /**
4091
- * True if the item is maximised
4092
- */
4093
- isMaximised: boolean;
4094
-
4095
- /**
4096
- * True if the item is the layout's root item
4097
- */
4098
- isRoot: boolean;
4099
-
4100
- /**
4101
- * True if the item is a row
4102
- */
4103
- isRow: boolean;
4104
-
4105
- /**
4106
- * True if the item is a column
4107
- */
4108
- isColumn: boolean;
4109
-
4110
- /**
4111
- * True if the item is a stack
4112
- */
4113
- isStack: boolean;
4114
-
4115
- /**
4116
- * True if the item is a component
4117
- */
4118
- isComponent: boolean;
4119
-
4120
- /**
4121
- * A reference to the layoutManager that controls this item
4122
- */
4123
- layoutManager: any;
4124
-
4125
- /**
4126
- * The item's outer element
4127
- */
4128
- element: JQuery;
4129
-
4130
- /**
4131
- * The item's inner element. Can be the same as the outer element.
4132
- */
4133
- childElementContainer: Container;
4134
-
4135
- /**
4136
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
4137
- * from its original position before adding it to this item.
4138
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
4139
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
4140
- */
4141
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
4142
-
4143
- /**
4144
- * Destroys the item and all it's children
4145
- * @param contentItem The contentItem that should be removed
4146
- * @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.
4147
- */
4148
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
4149
-
4150
- /**
4151
- * The contentItem that should be removed
4152
- * @param oldChild ContentItem The contentItem that should be removed
4153
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
4154
- */
4155
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
4156
-
4157
- /**
4158
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
4159
- */
4160
- setSize(): void;
4161
-
4162
- /**
4163
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4164
- * @param title the new title
4165
- */
4166
- setTitle(title: string): void;
4167
-
4168
- /**
4169
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4170
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4171
- * @param functionName The name of the method to invoke
4172
- * @param functionArguments An array of arguments to pass to every function
4173
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4174
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4175
- */
4176
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4177
-
4178
- /**
4179
- * 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.
4180
- */
4181
- emitBubblingEvent(name: string): void;
4182
-
4183
- /**
4184
- * Convenience method for item.parent.removeChild( item )
4185
- */
4186
- remove(): void;
4187
-
4188
- /**
4189
- * Removes the item from its current position in the layout and opens it in a window
4190
- */
4191
- popout(): BrowserWindow;
4192
-
4193
- /**
4194
- * Maximises the item or minimises it if it's already maximised
4195
- */
4196
- toggleMaximise(): void;
4197
-
4198
- /**
4199
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4200
- */
4201
- select(): void;
4202
-
4203
- /**
4204
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4205
- */
4206
- deselect(): void;
4207
-
4208
- /**
4209
- * Returns true if the item has the specified id or false if not
4210
- * @param id An id to check for
4211
- */
4212
- hasId(id: string): boolean;
4213
-
4214
- /**
4215
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4216
- * @param contentItem The new active content item
4217
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4218
- */
4219
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4220
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4221
-
4222
- /**
4223
- * Only Stacks have this method! Returns the currently selected contentItem.
4224
- */
4225
- getActiveContentItem(): ContentItem;
4226
-
4227
- /**
4228
- * Adds an id to an item or does nothing if the id is already present
4229
- * @param id The id to be added
4230
- */
4231
- addId(id: string): void;
4232
-
4233
- /**
4234
- * Removes an id from an item or throws an error if the id couldn't be found
4235
- * @param id The id to be removed
4236
- */
4237
- removeId(id: string): void;
4238
-
4239
- /**
4240
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4241
- * @param filterFunction A function that determines whether an item matches certain criteria
4242
- */
4243
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4244
-
4245
- /**
4246
- * Returns all items with the specified id.
4247
- * @param id An id specified in the itemConfig
4248
- */
4249
- getItemsById(id: string | string[]): ContentItem[];
4250
-
4251
- /**
4252
- * Returns all items with the specified type
4253
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4254
- */
4255
- getItemsByType(type: string): ContentItem[];
4256
-
4257
- /**
4258
- * Returns all instances of the component with the specified componentName
4259
- * @param componentName a componentName as specified in the itemConfig
4260
- */
4261
- getComponentsByName(componentName: string): any;
4262
-
4263
- _contentAreaDimensions: any;
4264
- _$getArea: () => any;
4265
- }
4266
-
4267
3894
  /**
4268
3895
  * Restrict navigation to URLs that match an allowed pattern.
4269
3896
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4748,46 +4375,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4748
4375
  type: 'did-finish-load';
4749
4376
  };
4750
4377
 
4751
- declare interface Dimensions {
4752
- /**
4753
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4754
- * than the visible one, making it safe to set this to small values without affecting usability.
4755
- * Default: 5
4756
- */
4757
- borderWidth?: number;
4758
-
4759
- /**
4760
- * The minimum height an item can be resized to (in pixel).
4761
- * Default: 10
4762
- */
4763
- minItemHeight?: number;
4764
-
4765
- /**
4766
- * The minimum width an item can be resized to (in pixel).
4767
- * Default: 10
4768
- */
4769
- minItemWidth?: number;
4770
-
4771
- /**
4772
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4773
- * adjusted accordingly.
4774
- * Default: 20
4775
- */
4776
- headerHeight?: number;
4777
-
4778
- /**
4779
- * The width of the element that appears when an item is dragged (in pixel).
4780
- * Default: 300
4781
- */
4782
- dragProxyWidth?: number;
4783
-
4784
- /**
4785
- * The height of the element that appears when an item is dragged (in pixel).
4786
- * Default: 200
4787
- */
4788
- dragProxyHeight?: number;
4789
- }
4790
-
4791
4378
  /**
4792
4379
  * @interface
4793
4380
  */
@@ -5084,8 +4671,6 @@ declare type Dpi = {
5084
4671
  vertical?: number;
5085
4672
  };
5086
4673
 
5087
- declare interface DragSource {}
5088
-
5089
4674
  /**
5090
4675
  * Generated when a window has been embedded.
5091
4676
  * @interface
@@ -5402,43 +4987,6 @@ declare class EventAggregator extends EmitterMap {
5402
4987
  dispatchEvent: (message: Message<any>) => boolean;
5403
4988
  }
5404
4989
 
5405
- declare interface EventEmitter_2 {
5406
- [x: string]: any;
5407
- /**
5408
- * Subscribe to an event
5409
- * @param eventName The name of the event to describe to
5410
- * @param callback The function that should be invoked when the event occurs
5411
- * @param context The value of the this pointer in the callback function
5412
- */
5413
- on(eventName: string, callback: Function, context?: any): void;
5414
-
5415
- /**
5416
- * Notify listeners of an event and pass arguments along
5417
- * @param eventName The name of the event to emit
5418
- */
5419
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5420
-
5421
- /**
5422
- * Alias for emit
5423
- */
5424
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5425
-
5426
- /**
5427
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5428
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5429
- * arguments.
5430
- * @param eventName The name of the event to unsubscribe from
5431
- * @param callback The function that should be invoked when the event occurs
5432
- * @param context The value of the this pointer in the callback function
5433
- */
5434
- unbind(eventName: string, callback?: Function, context?: any): void;
5435
-
5436
- /**
5437
- * Alias for unbind
5438
- */
5439
- off(eventName: string, callback?: Function, context?: any): void;
5440
- }
5441
-
5442
4990
  /**
5443
4991
  * Handler for an event on an EventEmitter.
5444
4992
  * @remarks Selects the correct type for the event
@@ -6636,239 +6184,6 @@ declare namespace GlobalHotkeyEvents {
6636
6184
  */
6637
6185
  declare type GlobalHotkeyEventType = EventType_6;
6638
6186
 
6639
- declare namespace GoldenLayout {
6640
- export {
6641
- GoldenLayout_2 as GoldenLayout,
6642
- ItemConfigType,
6643
- Settings,
6644
- Dimensions,
6645
- Labels,
6646
- ItemType,
6647
- ItemConfig,
6648
- ComponentConfig,
6649
- ReactComponentConfig,
6650
- Config,
6651
- ContentItem,
6652
- Container,
6653
- DragSource,
6654
- BrowserWindow,
6655
- Header,
6656
- TabDragListener,
6657
- Tab,
6658
- EventEmitter_2 as EventEmitter
6659
- }
6660
- }
6661
-
6662
- declare class GoldenLayout_2 implements EventEmitter_2 {
6663
- /**
6664
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6665
- * object and of goldenLayout.root as the document.
6666
- */
6667
- root: ContentItem;
6668
-
6669
- /**
6670
- * A reference to the (jQuery) DOM element containing the layout
6671
- */
6672
- container: JQuery;
6673
-
6674
- /**
6675
- * True once the layout item tree has been created and the initialised event has been fired
6676
- */
6677
- isInitialised: boolean;
6678
-
6679
- /**
6680
- * A reference to the current, extended top level config.
6681
- *
6682
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6683
- */
6684
- config: Config;
6685
-
6686
- /**
6687
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6688
- * to true.
6689
- */
6690
- selectedItem: ContentItem;
6691
-
6692
- /**
6693
- * The current outer width of the layout in pixels.
6694
- */
6695
- width: number;
6696
-
6697
- /**
6698
- * The current outer height of the layout in pixels.
6699
- */
6700
- height: number;
6701
-
6702
- /**
6703
- * An array of BrowserWindow instances
6704
- */
6705
- openPopouts: BrowserWindow[];
6706
-
6707
- /**
6708
- * True if the layout has been opened as a popout by another layout.
6709
- */
6710
- isSubWindow: boolean;
6711
-
6712
- /**
6713
- * A singleton instance of EventEmitter that works across windows
6714
- */
6715
- eventHub: EventEmitter_2;
6716
-
6717
- _dragProxy: any;
6718
-
6719
- dropTargetIndicator: any;
6720
-
6721
- /**
6722
- * @param config A GoldenLayout configuration object
6723
- * @param container The DOM element the layout will be initialised in. Default: document.body
6724
- */
6725
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6726
-
6727
- /*
6728
- * @param name The name of the component, as referred to by componentName in the component configuration.
6729
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6730
- * containerobject and a component state
6731
- */
6732
- registerComponent(name: String, component: any): void;
6733
-
6734
- /**
6735
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6736
- * a listener to the document and executes once it becomes ready.
6737
- */
6738
- init(): void;
6739
-
6740
- /**
6741
- * Returns the current state of the layout and its components as a serialisable object.
6742
- */
6743
- toConfig(): Config;
6744
-
6745
- /**
6746
- * Returns a component that was previously registered with layout.registerComponent().
6747
- * @param name The name of a previously registered component
6748
- */
6749
- getComponent(name: string): any;
6750
-
6751
- /**
6752
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6753
- * @param width The outer width the layout should be resized to. Default: The container elements width
6754
- * @param height The outer height the layout should be resized to. Default: The container elements height
6755
- */
6756
- updateSize(width?: number, height?: number): void;
6757
-
6758
- /**
6759
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6760
- * listeners and finally removes itself from the DOM.
6761
- */
6762
- destroy(): void;
6763
-
6764
- /**
6765
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6766
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6767
- * all call this method implicitly.
6768
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6769
- * @param parent A parent item
6770
- */
6771
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6772
-
6773
- /**
6774
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6775
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6776
- * provided its config will be read, if config is provided, only the content key
6777
- * will be used
6778
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6779
- * place the window in another screen.
6780
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6781
- * when popIn is clicked
6782
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6783
- */
6784
- createPopout(
6785
- configOrContentItem: ItemConfigType | ContentItem,
6786
- dimensions: {
6787
- width: number;
6788
- height: number;
6789
- left: number;
6790
- top: number;
6791
- },
6792
- parentId?: string,
6793
- indexInParent?: number
6794
- ): void;
6795
-
6796
- /**
6797
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6798
- * where it turns into a contentItem.
6799
- * @param element The DOM element that will be turned into a dragSource
6800
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6801
- * @return the dragSource that was created. This can be used to remove the
6802
- * dragSource from the layout later.
6803
- */
6804
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6805
-
6806
- /**
6807
- * Removes a dragSource from the layout.
6808
- *
6809
- * @param dragSource The dragSource to remove
6810
- */
6811
- removeDragSource(dragSource: DragSource): void;
6812
-
6813
- /**
6814
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6815
- * @param contentItem A ContentItem instance
6816
- */
6817
- selectItem(contentItem: ContentItem): void;
6818
-
6819
- /**
6820
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6821
- * and replace frequent keys and values with single letter substitutes.
6822
- * @param config A GoldenLayout configuration object
6823
- */
6824
- static minifyConfig(config: any): any;
6825
-
6826
- /**
6827
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6828
- * @param minifiedConfig A minified GoldenLayout configuration object
6829
- */
6830
- static unminifyConfig(minifiedConfig: any): any;
6831
-
6832
- /**
6833
- * Subscribe to an event
6834
- * @param eventName The name of the event to describe to
6835
- * @param callback The function that should be invoked when the event occurs
6836
- * @param context The value of the this pointer in the callback function
6837
- */
6838
- on(eventName: string, callback: Function, context?: any): void;
6839
-
6840
- /**
6841
- * Notify listeners of an event and pass arguments along
6842
- * @param eventName The name of the event to emit
6843
- */
6844
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6845
-
6846
- /**
6847
- * Alias for emit
6848
- */
6849
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6850
-
6851
- /**
6852
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6853
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6854
- * arguments.
6855
- * @param eventName The name of the event to unsubscribe from
6856
- * @param callback The function that should be invoked when the event occurs
6857
- * @param context The value of the this pointer in the callback function
6858
- */
6859
- unbind(eventName: string, callback?: Function, context?: any): void;
6860
-
6861
- /**
6862
- * Alias for unbind
6863
- */
6864
- off(eventName: string, callback?: Function, context?: any): void;
6865
-
6866
- /**
6867
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6868
- */
6869
- _$createRootItemAreas(): void;
6870
- }
6871
-
6872
6187
  /**
6873
6188
  * @interface
6874
6189
  */
@@ -6876,62 +6191,6 @@ declare type GpuInfo = {
6876
6191
  name: string;
6877
6192
  };
6878
6193
 
6879
- declare interface Header {
6880
- /**
6881
- * A reference to the LayoutManager instance
6882
- */
6883
- layoutManager: GoldenLayout_2;
6884
-
6885
- /**
6886
- * A reference to the Stack this Header belongs to
6887
- */
6888
- parent: ContentItem;
6889
-
6890
- /**
6891
- * An array of the Tabs within this header
6892
- */
6893
- tabs: Tab[];
6894
-
6895
- /**
6896
- * The currently selected activeContentItem
6897
- */
6898
- activeContentItem: ContentItem;
6899
-
6900
- /**
6901
- * The outer (jQuery) DOM element of this Header
6902
- */
6903
- element: JQuery;
6904
-
6905
- /**
6906
- * The (jQuery) DOM element containing the tabs
6907
- */
6908
- tabsContainer: JQuery;
6909
-
6910
- /**
6911
- * The (jQuery) DOM element containing the close, maximise and popout button
6912
- */
6913
- controlsContainer: JQuery;
6914
-
6915
- /**
6916
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6917
- * @param contentItem The content item that will be selected
6918
- */
6919
- setActiveContentItem(contentItem: ContentItem): void;
6920
-
6921
- /**
6922
- * Creates a new tab and associates it with a content item
6923
- * @param contentItem The content item the tab will be associated with
6924
- * @param index A zero based index, specifying the position of the new tab
6925
- */
6926
- createTab(contentItem: ContentItem, index?: number): void;
6927
-
6928
- /**
6929
- * Finds a tab by its contentItem and removes it
6930
- * @param contentItem The content item the tab is associated with
6931
- */
6932
- removeTab(contentItem: ContentItem): void;
6933
- }
6934
-
6935
6194
  /**
6936
6195
  * Generated when a View is hidden.
6937
6196
  * @interface
@@ -8626,50 +7885,6 @@ declare class InteropModule extends Base {
8626
7885
  connectSync(name: string, interopConfig?: OpenFin.InteropConfig): InteropClient;
8627
7886
  }
8628
7887
 
8629
- declare interface ItemConfig {
8630
- /**
8631
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
8632
- */
8633
- type: ItemType;
8634
-
8635
- /**
8636
- * An array of configurations for items that will be created as children of this item.
8637
- */
8638
- content?: ItemConfigType[];
8639
-
8640
- /**
8641
- * The width of this item, relative to the other children of its parent in percent
8642
- */
8643
- width?: number;
8644
-
8645
- /**
8646
- * The height of this item, relative to the other children of its parent in percent
8647
- */
8648
- height?: number;
8649
-
8650
- /**
8651
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
8652
- */
8653
- id?: string | string[];
8654
-
8655
- /**
8656
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
8657
- * will return false
8658
- * Default: true
8659
- */
8660
- isClosable?: boolean;
8661
-
8662
- /**
8663
- * The title of the item as displayed on its tab and on popout windows
8664
- * Default: componentName or ''
8665
- */
8666
- title?: string;
8667
- }
8668
-
8669
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
8670
-
8671
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
8672
-
8673
7888
  /**
8674
7889
  * @interface
8675
7890
  */
@@ -8727,32 +7942,6 @@ declare type JumpListTask = {
8727
7942
  iconIndex?: number;
8728
7943
  };
8729
7944
 
8730
- declare interface Labels {
8731
- /**
8732
- * The tooltip text that appears when hovering over the close icon.
8733
- * Default: 'close'
8734
- */
8735
- close?: string;
8736
-
8737
- /**
8738
- * The tooltip text that appears when hovering over the maximise icon.
8739
- * Default: 'maximise'
8740
- */
8741
- maximise?: string;
8742
-
8743
- /**
8744
- * The tooltip text that appears when hovering over the minimise icon.
8745
- * Default: 'minimise'
8746
- */
8747
- minimise?: string;
8748
-
8749
- /**
8750
- * The tooltip text that appears when hovering over the popout icon.
8751
- * Default: 'open in new window'
8752
- */
8753
- popout?: string;
8754
- }
8755
-
8756
7945
  /**
8757
7946
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8758
7947
  *
@@ -9184,7 +8373,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
9184
8373
  entityId: string;
9185
8374
  };
9186
8375
 
9187
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
8376
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
9188
8377
 
9189
8378
  /**
9190
8379
  * @interface
@@ -13379,18 +12568,6 @@ declare type QueryPermissionResult = {
13379
12568
  rawValue?: unknown;
13380
12569
  };
13381
12570
 
13382
- declare interface ReactComponentConfig extends ItemConfig {
13383
- /**
13384
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
13385
- */
13386
- component: string;
13387
-
13388
- /**
13389
- * Properties that will be passed to the component and accessible using this.props.
13390
- */
13391
- props?: any;
13392
- }
13393
-
13394
12571
  /**
13395
12572
  * @interface
13396
12573
  */
@@ -13897,97 +13074,6 @@ declare type SessionContextGroup = {
13897
13074
  }>;
13898
13075
  };
13899
13076
 
13900
- declare interface Settings {
13901
- preventSplitterResize?: boolean;
13902
-
13903
- newTabButton?: {
13904
- url?: string;
13905
- };
13906
-
13907
- /**
13908
- * If true, tabs can't be dragged into the window.
13909
- * Default: false
13910
- */
13911
- preventDragIn?: boolean;
13912
-
13913
- /**
13914
- * If true, tabs can't be dragged out of the window.
13915
- * Default: false
13916
- */
13917
- preventDragOut?: boolean;
13918
-
13919
- /**
13920
- * If true, stack headers are the only areas where tabs can be dropped.
13921
- * Default: false
13922
- */
13923
- constrainDragToHeaders?: boolean;
13924
- /**
13925
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
13926
- * Default: true
13927
- */
13928
- hasHeaders?: boolean;
13929
-
13930
- /**
13931
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
13932
- * automatically when layout.createDragSource() is called.
13933
- * Default: true
13934
- */
13935
- constrainDragToContainer?: boolean;
13936
-
13937
- /**
13938
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
13939
- * Default: true
13940
- */
13941
- reorderEnabled?: boolean;
13942
-
13943
- /**
13944
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
13945
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
13946
- * Default: false
13947
- */
13948
- selectionEnabled?: boolean;
13949
-
13950
- /**
13951
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
13952
- * be transferred to the new window, if false only the active component will be opened.
13953
- * Default: false
13954
- */
13955
- popoutWholeStack?: boolean;
13956
-
13957
- /**
13958
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
13959
- * If false, the popout call will fail silently.
13960
- * Default: true
13961
- */
13962
- blockedPopoutsThrowError?: boolean;
13963
-
13964
- /**
13965
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
13966
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
13967
- * addition, any changes made to popouts won't be stored after the parent is closed.
13968
- * Default: true
13969
- */
13970
- closePopoutsOnUnload?: boolean;
13971
-
13972
- /**
13973
- * Specifies if the popout icon should be displayed in the header-bar.
13974
- * Default: true
13975
- */
13976
- showPopoutIcon?: boolean;
13977
-
13978
- /**
13979
- * Specifies if the maximise icon should be displayed in the header-bar.
13980
- * Default: true
13981
- */
13982
- showMaximiseIcon?: boolean;
13983
-
13984
- /**
13985
- * Specifies if the close icon should be displayed in the header-bar.
13986
- * Default: true
13987
- */
13988
- showCloseIcon?: boolean;
13989
- }
13990
-
13991
13077
  /**
13992
13078
  * @interface
13993
13079
  */
@@ -15896,59 +14982,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
15896
14982
  proceed: () => void;
15897
14983
  }) => void;
15898
14984
 
15899
- declare interface Tab {
15900
- _dragListener: TabDragListener;
15901
-
15902
- /**
15903
- * True if this tab is the selected tab
15904
- */
15905
- isActive: boolean;
15906
-
15907
- /**
15908
- * A reference to the header this tab is a child of
15909
- */
15910
- header: Header;
15911
-
15912
- /**
15913
- * A reference to the content item this tab relates to
15914
- */
15915
- contentItem: ContentItem;
15916
-
15917
- /**
15918
- * The tabs outer (jQuery) DOM element
15919
- */
15920
- element: JQuery;
15921
-
15922
- /**
15923
- * The (jQuery) DOM element containing the title
15924
- */
15925
- titleElement: JQuery;
15926
-
15927
- /**
15928
- * The (jQuery) DOM element that closes the tab
15929
- */
15930
- closeElement: JQuery;
15931
-
15932
- /**
15933
- * Sets the tab's title. Does not affect the contentItem's title!
15934
- * @param title The new title
15935
- */
15936
- setTitle(title: string): void;
15937
-
15938
- /**
15939
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
15940
- * @param isActive Whether the tab is active
15941
- */
15942
- setActive(isActive: boolean): void;
15943
- }
15944
-
15945
- declare interface TabDragListener extends EventEmitter_2 {
15946
- /**
15947
- * A reference to the content item this tab relates to
15948
- */
15949
- contentItem: ContentItem;
15950
- }
15951
-
15952
14985
  /**
15953
14986
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15954
14987
  */