@openfin/core 37.81.20 → 37.81.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,9 @@
1
1
  /// <reference types="node" />
2
2
 
3
3
  import { EventEmitter } from 'events';
4
+ import { v1_2 } from '@openfin/fdc3';
5
+ import { v2_0 } from '@openfin/fdc3';
6
+ import { Version } from '@openfin/fdc3';
4
7
 
5
8
  /**
6
9
  * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
@@ -1161,9 +1164,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1161
1164
  */
1162
1165
  mainWindowOptions: WindowCreationOptions;
1163
1166
  /**
1164
- * The name of the application (and the application's main window).
1167
+ * The name of the application.
1165
1168
  *
1166
- * If provided, _must_ match `uuid`.
1169
+ * @remarks
1170
+ * This property is only used for naming the application logging folder, which will be sanitized to remove
1171
+ * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1172
+ * during startup with the UUID of the application.
1173
+ *
1174
+ * This property will be deprecated in the future.
1167
1175
  */
1168
1176
  name: string;
1169
1177
  /**
@@ -1193,9 +1201,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1193
1201
  url: string;
1194
1202
  /**
1195
1203
  * The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
1196
- * running in the OpenFin Runtime.
1197
- *
1198
- * Note that `name` and `uuid` must match.
1204
+ * running in the OpenFin Runtime.
1199
1205
  */
1200
1206
  uuid: string;
1201
1207
  /**
@@ -1904,48 +1910,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
1904
1910
  behavior: 'browser';
1905
1911
  };
1906
1912
 
1907
- declare interface BrowserWindow {
1908
- /**
1909
- * True if the window has been opened and its GoldenLayout instance initialised.
1910
- */
1911
- isInitialised: boolean;
1912
-
1913
- /**
1914
- * Creates a window configuration object from the Popout.
1915
- */
1916
- toConfig(): {
1917
- dimensions: {
1918
- width: number;
1919
- height: number;
1920
- left: number;
1921
- top: number;
1922
- };
1923
- content: Config;
1924
- parentId: string;
1925
- indexInParent: number;
1926
- };
1927
-
1928
- /**
1929
- * Returns the GoldenLayout instance from the child window
1930
- */
1931
- getGlInstance(): GoldenLayout_2;
1932
-
1933
- /**
1934
- * Returns the native Window object
1935
- */
1936
- getWindow(): Window;
1937
-
1938
- /**
1939
- * Closes the popout
1940
- */
1941
- close(): void;
1942
-
1943
- /**
1944
- * Returns the popout to its original position as specified in parentId and indexInParent
1945
- */
1946
- popIn(): void;
1947
- }
1948
-
1949
1913
  /**
1950
1914
  * Extracts a single event type matching the given key from the View {@link Event} union.
1951
1915
  *
@@ -3317,31 +3281,6 @@ declare class ColumnOrRow extends LayoutNode {
3317
3281
  getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
3318
3282
  }
3319
3283
 
3320
- declare interface ComponentConfig extends ItemConfig {
3321
- /**
3322
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
3323
- */
3324
- componentName: string;
3325
-
3326
- /**
3327
- * A serialisable object. Will be passed to the component constructor function and will be the value returned by
3328
- * container.getState().
3329
- */
3330
- componentState?: any;
3331
- }
3332
-
3333
- declare interface Config {
3334
- settings?: Settings;
3335
- dimensions?: Dimensions;
3336
- labels?: Labels;
3337
- content?: ItemConfigType[];
3338
- /**
3339
- * (Only on layout config object)
3340
- * Id of the currently maximised content item
3341
- */
3342
- maximisedItemId?: string;
3343
- }
3344
-
3345
3284
  declare type ConfigWithRuntime = BaseConfig & {
3346
3285
  runtime: RuntimeConfig;
3347
3286
  };
@@ -3719,103 +3658,6 @@ declare type ConstWindowOptions = {
3719
3658
  inheritance?: Partial<InheritableOptions>;
3720
3659
  };
3721
3660
 
3722
- declare interface Container extends EventEmitter_2 {
3723
- /**
3724
- * The current width of the container in pixel
3725
- */
3726
- width: number;
3727
-
3728
- /**
3729
- * The current height of the container in pixel
3730
- */
3731
- height: number;
3732
-
3733
- /**
3734
- * A reference to the component-item that controls this container
3735
- */
3736
- parent: ContentItem;
3737
-
3738
- /**
3739
- * A reference to the tab that controls this container. Will initially be null
3740
- * (and populated once a tab event has been fired).
3741
- */
3742
- tab: Tab;
3743
-
3744
- /**
3745
- * The current title of the container
3746
- */
3747
- title: string;
3748
-
3749
- /*
3750
- * A reference to the GoldenLayout instance this container belongs to
3751
- */
3752
- layoutManager: GoldenLayout_2;
3753
-
3754
- /**
3755
- * True if the item is currently hidden
3756
- */
3757
- isHidden: boolean;
3758
-
3759
- /**
3760
- * Overwrites the components state with the provided value. To only change parts of the componentState see
3761
- * extendState below. This is the main mechanism for saving the state of a component. This state will be the
3762
- * value of componentState when layout.toConfig() is called and will be passed back to the component's
3763
- * constructor function. It will also be used when the component is opened in a new window.
3764
- * @param state A serialisable object
3765
- */
3766
- setState(state: any): void;
3767
-
3768
- /**
3769
- * The same as setState but does not emit 'stateChanged' event
3770
- * @param {serialisable} state
3771
- */
3772
- setStateSkipEvent(state: any): void;
3773
-
3774
- /**
3775
- * This is similar to setState, but merges the provided state into the current one, rather than overwriting it.
3776
- * @param state A serialisable object
3777
- */
3778
- extendState(state: any): void;
3779
-
3780
- /**
3781
- * Returns the current state.
3782
- */
3783
- getState(): any;
3784
-
3785
- /**
3786
- * Returns the container's inner element as a jQuery element
3787
- */
3788
- getElement(): JQuery;
3789
-
3790
- /**
3791
- * hides the container or returns false if hiding it is not possible
3792
- */
3793
- hide(): boolean;
3794
-
3795
- /**
3796
- * shows the container or returns false if showing it is not possible
3797
- */
3798
- show(): boolean;
3799
-
3800
- /**
3801
- * Sets the container to the specified size or returns false if that's not possible
3802
- * @param width the new width in pixel
3803
- * @param height the new height in pixel
3804
- */
3805
- setSize(width: number, height: number): boolean;
3806
-
3807
- /**
3808
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
3809
- * @param title the new title
3810
- */
3811
- setTitle(title: string): void;
3812
-
3813
- /**
3814
- * Closes the container or returns false if that is not possible
3815
- */
3816
- close(): boolean;
3817
- }
3818
-
3819
3661
  /**
3820
3662
  * Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
3821
3663
  */
@@ -3889,218 +3731,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
3889
3731
  disposition: string;
3890
3732
  };
3891
3733
 
3892
- declare interface ContentItem extends EventEmitter_2 {
3893
- instance: any;
3894
- header: any;
3895
- _splitter: any;
3896
- /**
3897
- * This items configuration in its current state
3898
- */
3899
- config: ItemConfigType;
3900
-
3901
- /**
3902
- * The type of the item. Can be row, column, stack, component or root
3903
- */
3904
- type: ItemType;
3905
-
3906
- /**
3907
- * An array of items that are children of this item
3908
- */
3909
- contentItems: ContentItem[];
3910
-
3911
- container: Container;
3912
- /**
3913
- * The item that is this item's parent (or null if the item is root)
3914
- */
3915
- parent: ContentItem;
3916
-
3917
- /**
3918
- * A String or array of identifiers if provided in the configuration
3919
- */
3920
- id: string;
3921
-
3922
- /**
3923
- * True if the item had been initialised
3924
- */
3925
- isInitialised: boolean;
3926
-
3927
- /**
3928
- * True if the item is maximised
3929
- */
3930
- isMaximised: boolean;
3931
-
3932
- /**
3933
- * True if the item is the layout's root item
3934
- */
3935
- isRoot: boolean;
3936
-
3937
- /**
3938
- * True if the item is a row
3939
- */
3940
- isRow: boolean;
3941
-
3942
- /**
3943
- * True if the item is a column
3944
- */
3945
- isColumn: boolean;
3946
-
3947
- /**
3948
- * True if the item is a stack
3949
- */
3950
- isStack: boolean;
3951
-
3952
- /**
3953
- * True if the item is a component
3954
- */
3955
- isComponent: boolean;
3956
-
3957
- /**
3958
- * A reference to the layoutManager that controls this item
3959
- */
3960
- layoutManager: any;
3961
-
3962
- /**
3963
- * The item's outer element
3964
- */
3965
- element: JQuery;
3966
-
3967
- /**
3968
- * The item's inner element. Can be the same as the outer element.
3969
- */
3970
- childElementContainer: Container;
3971
-
3972
- /**
3973
- * Adds an item as a child to this item. If the item is already a part of a layout it will be removed
3974
- * from its original position before adding it to this item.
3975
- * @param itemOrItemConfig A content item (or tree of content items) or an ItemConfiguration to create the item from
3976
- * @param index last index An optional index that determines at which position the new item should be added. Default: last index.
3977
- */
3978
- addChild(itemOrItemConfig: ContentItem | ItemConfigType, index?: number): void;
3979
-
3980
- /**
3981
- * Destroys the item and all it's children
3982
- * @param contentItem The contentItem that should be removed
3983
- * @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.
3984
- */
3985
- removeChild(contentItem: ContentItem, keepChild?: boolean): void;
3986
-
3987
- /**
3988
- * The contentItem that should be removed
3989
- * @param oldChild ContentItem The contentItem that should be removed
3990
- * @param newChild A content item (or tree of content items) or an ItemConfiguration to create the item from
3991
- */
3992
- replaceChild(oldChild: ContentItem, newChild: ContentItem | ItemConfigType): void;
3993
-
3994
- /**
3995
- * Updates the items size. To actually assign a new size from within a component, use container.setSize( width, height )
3996
- */
3997
- setSize(): void;
3998
-
3999
- /**
4000
- * Sets the item's title to the provided value. Triggers titleChanged and stateChanged events
4001
- * @param title the new title
4002
- */
4003
- setTitle(title: string): void;
4004
-
4005
- /**
4006
- * A powerful, yet admittedly confusing method to recursively call methods on items in a tree. Usually you wouldn't need
4007
- * to use it directly, but it's used internally to setSizes, destroy parts of the item tree etc.
4008
- * @param functionName The name of the method to invoke
4009
- * @param functionArguments An array of arguments to pass to every function
4010
- * @param bottomUp If true, the method is invoked on the lowest parts of the tree first and then bubbles upwards. Default: false
4011
- * @param skipSelf If true, the method will only be invoked on the item's children, but not on the item itself. Default: false
4012
- */
4013
- callDownwards(functionName: string, functionArguments?: any[], bottomUp?: boolean, skipSelf?: boolean): void;
4014
-
4015
- /**
4016
- * 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.
4017
- */
4018
- emitBubblingEvent(name: string): void;
4019
-
4020
- /**
4021
- * Convenience method for item.parent.removeChild( item )
4022
- */
4023
- remove(): void;
4024
-
4025
- /**
4026
- * Removes the item from its current position in the layout and opens it in a window
4027
- */
4028
- popout(): BrowserWindow;
4029
-
4030
- /**
4031
- * Maximises the item or minimises it if it's already maximised
4032
- */
4033
- toggleMaximise(): void;
4034
-
4035
- /**
4036
- * Selects the item. Only relevant if settings.selectionEnabled is set to true
4037
- */
4038
- select(): void;
4039
-
4040
- /**
4041
- * Unselects the item. Only relevant if settings.selectionEnabled is set to true
4042
- */
4043
- deselect(): void;
4044
-
4045
- /**
4046
- * Returns true if the item has the specified id or false if not
4047
- * @param id An id to check for
4048
- */
4049
- hasId(id: string): boolean;
4050
-
4051
- /**
4052
- * Only Stacks have this method! It's the programmatical equivalent of clicking a tab.
4053
- * @param contentItem The new active content item
4054
- * @param preventFocus [OpenFin Custom] Indicates to openfin that the view should not be focused when activated.
4055
- */
4056
- // (CORE-198)[../docs/golden-layout-changelog.md#CORE-198 stack.setActiveView]
4057
- setActiveContentItem(contentItem: ContentItem, preventFocus?: boolean): void;
4058
-
4059
- /**
4060
- * Only Stacks have this method! Returns the currently selected contentItem.
4061
- */
4062
- getActiveContentItem(): ContentItem;
4063
-
4064
- /**
4065
- * Adds an id to an item or does nothing if the id is already present
4066
- * @param id The id to be added
4067
- */
4068
- addId(id: string): void;
4069
-
4070
- /**
4071
- * Removes an id from an item or throws an error if the id couldn't be found
4072
- * @param id The id to be removed
4073
- */
4074
- removeId(id: string): void;
4075
-
4076
- /**
4077
- * Calls filterFunction recursively for every item in the tree. If the function returns true the item is added to the resulting array
4078
- * @param filterFunction A function that determines whether an item matches certain criteria
4079
- */
4080
- getItemsByFilter(filterFunction: (contentItem: ContentItem) => boolean): ContentItem[];
4081
-
4082
- /**
4083
- * Returns all items with the specified id.
4084
- * @param id An id specified in the itemConfig
4085
- */
4086
- getItemsById(id: string | string[]): ContentItem[];
4087
-
4088
- /**
4089
- * Returns all items with the specified type
4090
- * @param type 'row', 'column', 'stack', 'component' or 'root'
4091
- */
4092
- getItemsByType(type: string): ContentItem[];
4093
-
4094
- /**
4095
- * Returns all instances of the component with the specified componentName
4096
- * @param componentName a componentName as specified in the itemConfig
4097
- */
4098
- getComponentsByName(componentName: string): any;
4099
-
4100
- _contentAreaDimensions: any;
4101
- _$getArea: () => any;
4102
- }
4103
-
4104
3734
  /**
4105
3735
  * Restrict navigation to URLs that match an allowed pattern.
4106
3736
  * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
@@ -4528,46 +4158,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
4528
4158
  type: 'did-finish-load';
4529
4159
  };
4530
4160
 
4531
- declare interface Dimensions {
4532
- /**
4533
- * The width of the borders between the layout items in pixel. Please note: The actual draggable area is wider
4534
- * than the visible one, making it safe to set this to small values without affecting usability.
4535
- * Default: 5
4536
- */
4537
- borderWidth?: number;
4538
-
4539
- /**
4540
- * The minimum height an item can be resized to (in pixel).
4541
- * Default: 10
4542
- */
4543
- minItemHeight?: number;
4544
-
4545
- /**
4546
- * The minimum width an item can be resized to (in pixel).
4547
- * Default: 10
4548
- */
4549
- minItemWidth?: number;
4550
-
4551
- /**
4552
- * The height of the header elements in pixel. This can be changed, but your theme's header css needs to be
4553
- * adjusted accordingly.
4554
- * Default: 20
4555
- */
4556
- headerHeight?: number;
4557
-
4558
- /**
4559
- * The width of the element that appears when an item is dragged (in pixel).
4560
- * Default: 300
4561
- */
4562
- dragProxyWidth?: number;
4563
-
4564
- /**
4565
- * The height of the element that appears when an item is dragged (in pixel).
4566
- * Default: 200
4567
- */
4568
- dragProxyHeight?: number;
4569
- }
4570
-
4571
4161
  /**
4572
4162
  * @interface
4573
4163
  */
@@ -4817,8 +4407,6 @@ declare type Dpi = {
4817
4407
  vertical?: number;
4818
4408
  };
4819
4409
 
4820
- declare interface DragSource {}
4821
-
4822
4410
  /**
4823
4411
  * Generated when a window has been embedded.
4824
4412
  * @interface
@@ -5124,43 +4712,6 @@ declare class EventAggregator extends EmitterMap {
5124
4712
  dispatchEvent: (message: Message<any>) => boolean;
5125
4713
  }
5126
4714
 
5127
- declare interface EventEmitter_2 {
5128
- [x: string]: any;
5129
- /**
5130
- * Subscribe to an event
5131
- * @param eventName The name of the event to describe to
5132
- * @param callback The function that should be invoked when the event occurs
5133
- * @param context The value of the this pointer in the callback function
5134
- */
5135
- on(eventName: string, callback: Function, context?: any): void;
5136
-
5137
- /**
5138
- * Notify listeners of an event and pass arguments along
5139
- * @param eventName The name of the event to emit
5140
- */
5141
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5142
-
5143
- /**
5144
- * Alias for emit
5145
- */
5146
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5147
-
5148
- /**
5149
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
5150
- * eventName and callback or just a specific callback with a specific context if invoked with all three
5151
- * arguments.
5152
- * @param eventName The name of the event to unsubscribe from
5153
- * @param callback The function that should be invoked when the event occurs
5154
- * @param context The value of the this pointer in the callback function
5155
- */
5156
- unbind(eventName: string, callback?: Function, context?: any): void;
5157
-
5158
- /**
5159
- * Alias for unbind
5160
- */
5161
- off(eventName: string, callback?: Function, context?: any): void;
5162
- }
5163
-
5164
4715
  /**
5165
4716
  * Handler for an event on an EventEmitter.
5166
4717
  * @remarks Selects the correct type for the event
@@ -5903,344 +5454,97 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
5903
5454
  * })
5904
5455
  * .then(() => {
5905
5456
  * console.log('Success');
5906
- * })
5907
- * .catch(err => {
5908
- * console.log('Error registering the hotkey', err);
5909
- * });
5910
- * ```
5911
- */
5912
- register(hotkey: string, listener: (...args: any[]) => void): Promise<void>;
5913
- /**
5914
- * Unregisters a global hotkey with the operating system.
5915
- * @param hotkey a hotkey string
5916
- *
5917
- * @remarks This method will unregister all existing registrations of the hotkey within the application.
5918
- * Raises the `unregistered` event.
5919
- *
5920
- * @example
5921
- * ```js
5922
- * const hotkey = 'CommandOrControl+X';
5923
- *
5924
- * fin.GlobalHotkey.unregister(hotkey)
5925
- * .then(() => {
5926
- * console.log('Success');
5927
- * })
5928
- * .catch(err => {
5929
- * console.log('Error unregistering the hotkey', err);
5930
- * });
5931
- * ```
5932
- */
5933
- unregister(hotkey: string): Promise<void>;
5934
- /**
5935
- * Unregisters all global hotkeys for the current application.
5936
- *
5937
- * @remarks Raises the `unregistered` event for each hotkey unregistered.
5938
- *
5939
- * @example
5940
- * ```js
5941
- * fin.GlobalHotkey.unregisterAll()
5942
- * .then(() => {
5943
- * console.log('Success');
5944
- * })
5945
- * .catch(err => {
5946
- * console.log('Error unregistering all hotkeys for this application', err);
5947
- * });
5948
- * ```
5949
- */
5950
- unregisterAll(): Promise<void>;
5951
- /**
5952
- * Checks if a given hotkey has been registered by an application within the current runtime.
5953
- * @param hotkey a hotkey string
5954
- *
5955
- * @example
5956
- * ```js
5957
- * const hotkey = 'CommandOrControl+X';
5958
- *
5959
- * fin.GlobalHotkey.isRegistered(hotkey)
5960
- * .then((registered) => {
5961
- * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
5962
- * })
5963
- * .catch(err => {
5964
- * console.log('Error unregistering the hotkey', err);
5965
- * });
5966
- * ```
5967
- */
5968
- isRegistered(hotkey: string): Promise<boolean>;
5969
- }
5970
-
5971
- /**
5972
- * @deprecated Renamed to {@link Event}.
5973
- */
5974
- declare type GlobalHotkeyEvent = Event_9;
5975
-
5976
- declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
5977
-
5978
- declare namespace GlobalHotkeyEvents {
5979
- export {
5980
- BaseEvent_8 as BaseEvent,
5981
- RegisteredEvent,
5982
- UnregisteredEvent,
5983
- Event_9 as Event,
5984
- GlobalHotkeyEvent,
5985
- EventType_6 as EventType,
5986
- GlobalHotkeyEventType,
5987
- Payload_7 as Payload,
5988
- ByType_6 as ByType
5989
- }
5990
- }
5991
-
5992
- /**
5993
- * @deprecated Renamed to {@link EventType}.
5994
- */
5995
- declare type GlobalHotkeyEventType = EventType_6;
5996
-
5997
- declare namespace GoldenLayout {
5998
- export {
5999
- GoldenLayout_2 as GoldenLayout,
6000
- ItemConfigType,
6001
- Settings,
6002
- Dimensions,
6003
- Labels,
6004
- ItemType,
6005
- ItemConfig,
6006
- ComponentConfig,
6007
- ReactComponentConfig,
6008
- Config,
6009
- ContentItem,
6010
- Container,
6011
- DragSource,
6012
- BrowserWindow,
6013
- Header,
6014
- TabDragListener,
6015
- Tab,
6016
- EventEmitter_2 as EventEmitter
6017
- }
6018
- }
6019
-
6020
- declare class GoldenLayout_2 implements EventEmitter_2 {
6021
- /**
6022
- * The topmost item in the layout item tree. In browser terms: Think of the GoldenLayout instance as window
6023
- * object and of goldenLayout.root as the document.
6024
- */
6025
- root: ContentItem;
6026
-
6027
- /**
6028
- * A reference to the (jQuery) DOM element containing the layout
6029
- */
6030
- container: JQuery;
6031
-
6032
- /**
6033
- * True once the layout item tree has been created and the initialised event has been fired
6034
- */
6035
- isInitialised: boolean;
6036
-
6037
- /**
6038
- * A reference to the current, extended top level config.
6039
- *
6040
- * Don't rely on this object for state saving / serialisation. Use layout.toConfig() instead.
6041
- */
6042
- config: Config;
6043
-
6044
- /**
6045
- * The currently selected item or null if no item is selected. Only relevant if settings.selectionEnabled is set
6046
- * to true.
6047
- */
6048
- selectedItem: ContentItem;
6049
-
6050
- /**
6051
- * The current outer width of the layout in pixels.
6052
- */
6053
- width: number;
6054
-
6055
- /**
6056
- * The current outer height of the layout in pixels.
6057
- */
6058
- height: number;
6059
-
6060
- /**
6061
- * An array of BrowserWindow instances
6062
- */
6063
- openPopouts: BrowserWindow[];
6064
-
6065
- /**
6066
- * True if the layout has been opened as a popout by another layout.
6067
- */
6068
- isSubWindow: boolean;
6069
-
6070
- /**
6071
- * A singleton instance of EventEmitter that works across windows
6072
- */
6073
- eventHub: EventEmitter_2;
6074
-
6075
- _dragProxy: any;
6076
-
6077
- dropTargetIndicator: any;
6078
-
6079
- _isFullPage: boolean;
6080
-
6081
- _onUnload: any;
6082
-
6083
- tabDropPlaceholder: any;
6084
-
6085
- transitionIndicator: any;
6086
-
6087
- _dragSources: any;
6088
-
6089
- _resizeFunction: any;
6090
-
6091
- _unloadFunction: any;
6092
-
6093
- /**
6094
- * @param config A GoldenLayout configuration object
6095
- * @param container The DOM element the layout will be initialised in. Default: document.body
6096
- */
6097
- constructor(configuration: Config, container?: Element | HTMLElement | JQuery);
6098
-
6099
- /*
6100
- * @param name The name of the component, as referred to by componentName in the component configuration.
6101
- * @param component A constructor or factory function. Will be invoked with new and two arguments, a
6102
- * containerobject and a component state
6103
- */
6104
- registerComponent(name: String, component: any): void;
6105
-
6106
- /**
6107
- * Renders the layout into the container. If init() is called before the document is ready it attaches itself as
6108
- * a listener to the document and executes once it becomes ready.
6109
- */
6110
- init(): void;
6111
-
6112
- /**
6113
- * Returns the current state of the layout and its components as a serialisable object.
6114
- */
6115
- toConfig(): Config;
6116
-
6117
- /**
6118
- * Returns a component that was previously registered with layout.registerComponent().
6119
- * @param name The name of a previously registered component
6120
- */
6121
- getComponent(name: string): any;
6122
-
6123
- /**
6124
- * Resizes the layout. If no arguments are provided GoldenLayout measures its container and resizes accordingly.
6125
- * @param width The outer width the layout should be resized to. Default: The container elements width
6126
- * @param height The outer height the layout should be resized to. Default: The container elements height
6127
- */
6128
- updateSize(width?: number, height?: number): void;
6129
-
6130
- /**
6131
- * Destroys the layout. Recursively calls destroy on all components and content items, removes all event
6132
- * listeners and finally removes itself from the DOM.
6133
- */
6134
- destroy(): void;
6135
-
6136
- /**
6137
- * Creates a new content item or tree of content items from configuration. Usually you wouldn't call this
6138
- * directly, but instead use methods like layout.createDragSource(), item.addChild() or item.replaceChild() that
6139
- * all call this method implicitly.
6140
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6141
- * @param parent A parent item
6142
- */
6143
- createContentItem(itemConfiguration?: ItemConfigType, parent?: ContentItem): ContentItem;
6144
-
6145
- /**
6146
- * Creates a new popout window with configOrContentItem as contents at the position specified in dimensions
6147
- * @param configOrContentItem The content item or config that will be created in the new window. If a item is
6148
- * provided its config will be read, if config is provided, only the content key
6149
- * will be used
6150
- * @param dimensions A map containing the keys left, top, width and height. Left and top can be negative to
6151
- * place the window in another screen.
6152
- * @param parentId The id of the item within the current layout the child window's content will be appended to
6153
- * when popIn is clicked
6154
- * @param indexInParent The index at which the child window's contents will be appended to. Default: null
6155
- */
6156
- createPopout(
6157
- configOrContentItem: ItemConfigType | ContentItem,
6158
- dimensions: {
6159
- width: number;
6160
- height: number;
6161
- left: number;
6162
- top: number;
6163
- },
6164
- parentId?: string,
6165
- indexInParent?: number
6166
- ): void;
6167
-
6168
- /**
6169
- * Turns a DOM element into a dragSource, meaning that the user can drag the element directly onto the layout
6170
- * where it turns into a contentItem.
6171
- * @param element The DOM element that will be turned into a dragSource
6172
- * @param itemConfiguration An item configuration (can be an entire tree of items)
6173
- * @return the dragSource that was created. This can be used to remove the
6174
- * dragSource from the layout later.
6175
- */
6176
- createDragSource(element: HTMLElement | JQuery, itemConfiguration: ItemConfigType): DragSource;
6177
-
6178
- /**
6179
- * Removes a dragSource from the layout.
6180
- *
6181
- * @param dragSource The dragSource to remove
6182
- */
6183
- removeDragSource(dragSource: DragSource): void;
6184
-
6185
- /**
6186
- * If settings.selectionEnabled is set to true, this allows to select items programmatically.
6187
- * @param contentItem A ContentItem instance
6188
- */
6189
- selectItem(contentItem: ContentItem): void;
6190
-
6191
- /**
6192
- * Static method on the GoldenLayout constructor! This method will iterate through a GoldenLayout config object
6193
- * and replace frequent keys and values with single letter substitutes.
6194
- * @param config A GoldenLayout configuration object
6195
- */
6196
- static minifyConfig(config: any): any;
6197
-
6198
- /**
6199
- * Static method on the GoldenLayout constructor! This method will reverse the minifications of minifyConfig.
6200
- * @param minifiedConfig A minified GoldenLayout configuration object
5457
+ * })
5458
+ * .catch(err => {
5459
+ * console.log('Error registering the hotkey', err);
5460
+ * });
5461
+ * ```
6201
5462
  */
6202
- static unminifyConfig(minifiedConfig: any): any;
6203
-
5463
+ register(hotkey: string, listener: (...args: any[]) => void): Promise<void>;
6204
5464
  /**
6205
- * Subscribe to an event
6206
- * @param eventName The name of the event to describe to
6207
- * @param callback The function that should be invoked when the event occurs
6208
- * @param context The value of the this pointer in the callback function
5465
+ * Unregisters a global hotkey with the operating system.
5466
+ * @param hotkey a hotkey string
5467
+ *
5468
+ * @remarks This method will unregister all existing registrations of the hotkey within the application.
5469
+ * Raises the `unregistered` event.
5470
+ *
5471
+ * @example
5472
+ * ```js
5473
+ * const hotkey = 'CommandOrControl+X';
5474
+ *
5475
+ * fin.GlobalHotkey.unregister(hotkey)
5476
+ * .then(() => {
5477
+ * console.log('Success');
5478
+ * })
5479
+ * .catch(err => {
5480
+ * console.log('Error unregistering the hotkey', err);
5481
+ * });
5482
+ * ```
6209
5483
  */
6210
- on(eventName: string, callback: Function, context?: any): void;
6211
-
5484
+ unregister(hotkey: string): Promise<void>;
6212
5485
  /**
6213
- * Notify listeners of an event and pass arguments along
6214
- * @param eventName The name of the event to emit
5486
+ * Unregisters all global hotkeys for the current application.
5487
+ *
5488
+ * @remarks Raises the `unregistered` event for each hotkey unregistered.
5489
+ *
5490
+ * @example
5491
+ * ```js
5492
+ * fin.GlobalHotkey.unregisterAll()
5493
+ * .then(() => {
5494
+ * console.log('Success');
5495
+ * })
5496
+ * .catch(err => {
5497
+ * console.log('Error unregistering all hotkeys for this application', err);
5498
+ * });
5499
+ * ```
6215
5500
  */
6216
- emit(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
6217
-
5501
+ unregisterAll(): Promise<void>;
6218
5502
  /**
6219
- * Alias for emit
5503
+ * Checks if a given hotkey has been registered by an application within the current runtime.
5504
+ * @param hotkey a hotkey string
5505
+ *
5506
+ * @example
5507
+ * ```js
5508
+ * const hotkey = 'CommandOrControl+X';
5509
+ *
5510
+ * fin.GlobalHotkey.isRegistered(hotkey)
5511
+ * .then((registered) => {
5512
+ * console.log(`hotkey ${hotkey} is registered ? ${registered}`);
5513
+ * })
5514
+ * .catch(err => {
5515
+ * console.log('Error unregistering the hotkey', err);
5516
+ * });
5517
+ * ```
6220
5518
  */
6221
- trigger(eventName: string, arg1?: any, arg2?: any, ...argN: any[]): void;
5519
+ isRegistered(hotkey: string): Promise<boolean>;
5520
+ }
6222
5521
 
6223
- /**
6224
- * Unsubscribes either all listeners if just an eventName is provided, just a specific callback if invoked with
6225
- * eventName and callback or just a specific callback with a specific context if invoked with all three
6226
- * arguments.
6227
- * @param eventName The name of the event to unsubscribe from
6228
- * @param callback The function that should be invoked when the event occurs
6229
- * @param context The value of the this pointer in the callback function
6230
- */
6231
- unbind(eventName: string, callback?: Function, context?: any): void;
5522
+ /**
5523
+ * @deprecated Renamed to {@link Event}.
5524
+ */
5525
+ declare type GlobalHotkeyEvent = Event_9;
6232
5526
 
6233
- /**
6234
- * Alias for unbind
6235
- */
6236
- off(eventName: string, callback?: Function, context?: any): void;
5527
+ declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
6237
5528
 
6238
- /**
6239
- * Internal method that create drop areas on the far edges of window, e.g. far-right of window
6240
- */
6241
- _$createRootItemAreas(): void;
5529
+ declare namespace GlobalHotkeyEvents {
5530
+ export {
5531
+ BaseEvent_8 as BaseEvent,
5532
+ RegisteredEvent,
5533
+ UnregisteredEvent,
5534
+ Event_9 as Event,
5535
+ GlobalHotkeyEvent,
5536
+ EventType_6 as EventType,
5537
+ GlobalHotkeyEventType,
5538
+ Payload_7 as Payload,
5539
+ ByType_6 as ByType
5540
+ }
6242
5541
  }
6243
5542
 
5543
+ /**
5544
+ * @deprecated Renamed to {@link EventType}.
5545
+ */
5546
+ declare type GlobalHotkeyEventType = EventType_6;
5547
+
6244
5548
  /**
6245
5549
  * @interface
6246
5550
  */
@@ -6248,62 +5552,6 @@ declare type GpuInfo = {
6248
5552
  name: string;
6249
5553
  };
6250
5554
 
6251
- declare interface Header {
6252
- /**
6253
- * A reference to the LayoutManager instance
6254
- */
6255
- layoutManager: GoldenLayout_2;
6256
-
6257
- /**
6258
- * A reference to the Stack this Header belongs to
6259
- */
6260
- parent: ContentItem;
6261
-
6262
- /**
6263
- * An array of the Tabs within this header
6264
- */
6265
- tabs: Tab[];
6266
-
6267
- /**
6268
- * The currently selected activeContentItem
6269
- */
6270
- activeContentItem: ContentItem;
6271
-
6272
- /**
6273
- * The outer (jQuery) DOM element of this Header
6274
- */
6275
- element: JQuery;
6276
-
6277
- /**
6278
- * The (jQuery) DOM element containing the tabs
6279
- */
6280
- tabsContainer: JQuery;
6281
-
6282
- /**
6283
- * The (jQuery) DOM element containing the close, maximise and popout button
6284
- */
6285
- controlsContainer: JQuery;
6286
-
6287
- /**
6288
- * Hides the currently selected contentItem, shows the specified one and highlights its tab.
6289
- * @param contentItem The content item that will be selected
6290
- */
6291
- setActiveContentItem(contentItem: ContentItem): void;
6292
-
6293
- /**
6294
- * Creates a new tab and associates it with a content item
6295
- * @param contentItem The content item the tab will be associated with
6296
- * @param index A zero based index, specifying the position of the new tab
6297
- */
6298
- createTab(contentItem: ContentItem, index?: number): void;
6299
-
6300
- /**
6301
- * Finds a tab by its contentItem and removes it
6302
- * @param contentItem The content item the tab is associated with
6303
- */
6304
- removeTab(contentItem: ContentItem): void;
6305
- }
6306
-
6307
5555
  /**
6308
5556
  * Generated when a View is hidden.
6309
5557
  * @interface
@@ -7890,50 +7138,6 @@ declare class InteropModule extends Base {
7890
7138
  connectSync(name: string, interopConfig?: OpenFin_2.InteropConfig): InteropClient;
7891
7139
  }
7892
7140
 
7893
- declare interface ItemConfig {
7894
- /**
7895
- * The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
7896
- */
7897
- type: ItemType;
7898
-
7899
- /**
7900
- * An array of configurations for items that will be created as children of this item.
7901
- */
7902
- content?: ItemConfigType[];
7903
-
7904
- /**
7905
- * The width of this item, relative to the other children of its parent in percent
7906
- */
7907
- width?: number;
7908
-
7909
- /**
7910
- * The height of this item, relative to the other children of its parent in percent
7911
- */
7912
- height?: number;
7913
-
7914
- /**
7915
- * A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
7916
- */
7917
- id?: string | string[];
7918
-
7919
- /**
7920
- * Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
7921
- * will return false
7922
- * Default: true
7923
- */
7924
- isClosable?: boolean;
7925
-
7926
- /**
7927
- * The title of the item as displayed on its tab and on popout windows
7928
- * Default: componentName or ''
7929
- */
7930
- title?: string;
7931
- }
7932
-
7933
- declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
7934
-
7935
- declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
7936
-
7937
7141
  /**
7938
7142
  * @interface
7939
7143
  */
@@ -7991,32 +7195,6 @@ declare type JumpListTask = {
7991
7195
  iconIndex?: number;
7992
7196
  };
7993
7197
 
7994
- declare interface Labels {
7995
- /**
7996
- * The tooltip text that appears when hovering over the close icon.
7997
- * Default: 'close'
7998
- */
7999
- close?: string;
8000
-
8001
- /**
8002
- * The tooltip text that appears when hovering over the maximise icon.
8003
- * Default: 'maximise'
8004
- */
8005
- maximise?: string;
8006
-
8007
- /**
8008
- * The tooltip text that appears when hovering over the minimise icon.
8009
- * Default: 'minimise'
8010
- */
8011
- minimise?: string;
8012
-
8013
- /**
8014
- * The tooltip text that appears when hovering over the popout icon.
8015
- * Default: 'open in new window'
8016
- */
8017
- popout?: string;
8018
- }
8019
-
8020
7198
  /**
8021
7199
  * The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
8022
7200
  *
@@ -8442,7 +7620,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
8442
7620
  entityId: string;
8443
7621
  };
8444
7622
 
8445
- declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'root'>;
7623
+ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
8446
7624
 
8447
7625
  /**
8448
7626
  * @interface
@@ -12350,18 +11528,6 @@ declare type QueryPermissionResult = {
12350
11528
  rawValue?: unknown;
12351
11529
  };
12352
11530
 
12353
- declare interface ReactComponentConfig extends ItemConfig {
12354
- /**
12355
- * The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
12356
- */
12357
- component: string;
12358
-
12359
- /**
12360
- * Properties that will be passed to the component and accessible using this.props.
12361
- */
12362
- props?: any;
12363
- }
12364
-
12365
11531
  /**
12366
11532
  * @interface
12367
11533
  */
@@ -12838,97 +12004,6 @@ declare type SessionContextGroup = {
12838
12004
  }>;
12839
12005
  };
12840
12006
 
12841
- declare interface Settings {
12842
- preventSplitterResize?: boolean;
12843
-
12844
- newTabButton?: {
12845
- url?: string;
12846
- };
12847
-
12848
- /**
12849
- * If true, tabs can't be dragged into the window.
12850
- * Default: false
12851
- */
12852
- preventDragIn?: boolean;
12853
-
12854
- /**
12855
- * If true, tabs can't be dragged out of the window.
12856
- * Default: false
12857
- */
12858
- preventDragOut?: boolean;
12859
-
12860
- /**
12861
- * If true, stack headers are the only areas where tabs can be dropped.
12862
- * Default: false
12863
- */
12864
- constrainDragToHeaders?: boolean;
12865
- /**
12866
- * Turns headers on or off. If false, the layout will be displayed with splitters only.
12867
- * Default: true
12868
- */
12869
- hasHeaders?: boolean;
12870
-
12871
- /**
12872
- * (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
12873
- * automatically when layout.createDragSource() is called.
12874
- * Default: true
12875
- */
12876
- constrainDragToContainer?: boolean;
12877
-
12878
- /**
12879
- * If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
12880
- * Default: true
12881
- */
12882
- reorderEnabled?: boolean;
12883
-
12884
- /**
12885
- * If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
12886
- * the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
12887
- * Default: false
12888
- */
12889
- selectionEnabled?: boolean;
12890
-
12891
- /**
12892
- * Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
12893
- * be transferred to the new window, if false only the active component will be opened.
12894
- * Default: false
12895
- */
12896
- popoutWholeStack?: boolean;
12897
-
12898
- /**
12899
- * Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
12900
- * If false, the popout call will fail silently.
12901
- * Default: true
12902
- */
12903
- blockedPopoutsThrowError?: boolean;
12904
-
12905
- /**
12906
- * Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
12907
- * strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
12908
- * addition, any changes made to popouts won't be stored after the parent is closed.
12909
- * Default: true
12910
- */
12911
- closePopoutsOnUnload?: boolean;
12912
-
12913
- /**
12914
- * Specifies if the popout icon should be displayed in the header-bar.
12915
- * Default: true
12916
- */
12917
- showPopoutIcon?: boolean;
12918
-
12919
- /**
12920
- * Specifies if the maximise icon should be displayed in the header-bar.
12921
- * Default: true
12922
- */
12923
- showMaximiseIcon?: boolean;
12924
-
12925
- /**
12926
- * Specifies if the close icon should be displayed in the header-bar.
12927
- * Default: true
12928
- */
12929
- showCloseIcon?: boolean;
12930
- }
12931
-
12932
12007
  /**
12933
12008
  * @interface
12934
12009
  */
@@ -14819,59 +13894,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
14819
13894
  proceed: () => void;
14820
13895
  }) => void;
14821
13896
 
14822
- declare interface Tab {
14823
- _dragListener: TabDragListener;
14824
-
14825
- /**
14826
- * True if this tab is the selected tab
14827
- */
14828
- isActive: boolean;
14829
-
14830
- /**
14831
- * A reference to the header this tab is a child of
14832
- */
14833
- header: Header;
14834
-
14835
- /**
14836
- * A reference to the content item this tab relates to
14837
- */
14838
- contentItem: ContentItem;
14839
-
14840
- /**
14841
- * The tabs outer (jQuery) DOM element
14842
- */
14843
- element: JQuery;
14844
-
14845
- /**
14846
- * The (jQuery) DOM element containing the title
14847
- */
14848
- titleElement: JQuery;
14849
-
14850
- /**
14851
- * The (jQuery) DOM element that closes the tab
14852
- */
14853
- closeElement: JQuery;
14854
-
14855
- /**
14856
- * Sets the tab's title. Does not affect the contentItem's title!
14857
- * @param title The new title
14858
- */
14859
- setTitle(title: string): void;
14860
-
14861
- /**
14862
- * Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
14863
- * @param isActive Whether the tab is active
14864
- */
14865
- setActive(isActive: boolean): void;
14866
- }
14867
-
14868
- declare interface TabDragListener extends EventEmitter_2 {
14869
- /**
14870
- * A reference to the content item this tab relates to
14871
- */
14872
- contentItem: ContentItem;
14873
- }
14874
-
14875
13897
  /**
14876
13898
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
14877
13899
  */
@@ -15270,117 +14292,11 @@ declare type UserMovementEnabledEvent = BaseEvent_5 & {
15270
14292
  type: 'user-movement-enabled';
15271
14293
  };
15272
14294
 
15273
- declare namespace v1_2 {
15274
- {
15275
- AppIntent,
15276
- AppMetadata,
15277
- DisplayMetadata,
15278
- OpenError,
15279
- ResolveError,
15280
- ChannelError,
15281
- ImplementationMetadata,
15282
- IntentMetadata,
15283
- Listener,
15284
- ContextTypes,
15285
- ContextType,
15286
- Context,
15287
- ContactList,
15288
- Contact,
15289
- ContactID,
15290
- InstrumentList,
15291
- Instrument,
15292
- InstrumentID,
15293
- Country,
15294
- CountryID,
15295
- Organization,
15296
- OrganizationID,
15297
- Portfolio,
15298
- Position,
15299
- Convert,
15300
- Intents,
15301
- Channel,
15302
- DesktopAgent,
15303
- IntentResolution,
15304
- TargetApp,
15305
- ContextHandler
15306
- }
15307
- }
15308
-
15309
- declare namespace v2_0 {
15310
- {
15311
- AppIdentifier,
15312
- AppIntent_2 as AppIntent,
15313
- AppMetadata_2 as AppMetadata,
15314
- ContextMetadata,
15315
- DisplayMetadata_2 as DisplayMetadata,
15316
- OpenError_2 as OpenError,
15317
- ResolveError_2 as ResolveError,
15318
- ResultError,
15319
- ChannelError_2 as ChannelError,
15320
- Icon,
15321
- Image_2 as Image,
15322
- ImplementationMetadata_2 as ImplementationMetadata,
15323
- IntentMetadata_2 as IntentMetadata,
15324
- Listener_2 as Listener,
15325
- ContextTypes_2 as ContextTypes,
15326
- ContextType_2 as ContextType,
15327
- Chart,
15328
- InstrumentElement,
15329
- PurpleID,
15330
- PurpleMarket,
15331
- TimeRangeObject,
15332
- Style,
15333
- ChatInitSettings,
15334
- ContactListObject,
15335
- ContactElement,
15336
- FluffyID,
15337
- Contact_2 as Contact,
15338
- TentacledID,
15339
- ContactList_2 as ContactList,
15340
- Context_2 as Context,
15341
- Country_2 as Country,
15342
- CountryID_2 as CountryID,
15343
- Currency,
15344
- CurrencyID,
15345
- Email,
15346
- RecipientsObject,
15347
- RecipientsID,
15348
- Instrument_2 as Instrument,
15349
- StickyID,
15350
- FluffyMarket,
15351
- InstrumentList_2 as InstrumentList,
15352
- Nothing,
15353
- Organization_2 as Organization,
15354
- OrganizationID_2 as OrganizationID,
15355
- Portfolio_2 as Portfolio,
15356
- PositionElement,
15357
- Position_2 as Position,
15358
- TimeRange,
15359
- Valuation,
15360
- Convert_2 as Convert,
15361
- Intents_2 as Intents,
15362
- Channel_2 as Channel,
15363
- DesktopAgent_2 as DesktopAgent,
15364
- IntentResolution_2 as IntentResolution,
15365
- PrivateChannel,
15366
- ContextHandler_2 as ContextHandler,
15367
- IntentResult,
15368
- IntentHandler
15369
- }
15370
- }
15371
-
15372
14295
  declare type VerboseWebPermission = {
15373
14296
  api: string;
15374
14297
  enabled: boolean;
15375
14298
  };
15376
14299
 
15377
- declare type Version = (typeof versions)[keyof typeof versions];
15378
-
15379
- declare const versions: {
15380
- readonly v1_2: "1.2";
15381
- readonly v2_0: "2.0";
15382
- };
15383
-
15384
14300
  declare type View = OpenFin_2.View;
15385
14301
 
15386
14302
  /**