@openfin/core 37.81.19 → 37.81.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/out/mock-alpha.d.ts +123 -1074
- package/out/mock-beta.d.ts +123 -1074
- package/out/mock-public.d.ts +123 -1074
- package/out/mock.d.ts +123 -1074
- package/out/mock.js +1 -4
- package/package.json +1 -1
package/out/mock-alpha.d.ts
CHANGED
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
|
|
934
934
|
* @interface
|
935
935
|
*/
|
936
936
|
declare type ApplicationInfo = {
|
937
|
-
initialOptions: ApplicationCreationOptions | PlatformOptions;
|
937
|
+
initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
|
938
938
|
launchMode: string;
|
939
939
|
manifest: Manifest & {
|
940
940
|
[key: string]: any;
|
@@ -1161,9 +1161,14 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1161
1161
|
*/
|
1162
1162
|
mainWindowOptions: WindowCreationOptions;
|
1163
1163
|
/**
|
1164
|
-
* The name of the application
|
1164
|
+
* The name of the application.
|
1165
1165
|
*
|
1166
|
-
*
|
1166
|
+
* @remarks
|
1167
|
+
* This property is only used for naming the application logging folder, which will be sanitized to remove
|
1168
|
+
* any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
|
1169
|
+
* during startup with the UUID of the application.
|
1170
|
+
*
|
1171
|
+
* This property will be deprecated in the future.
|
1167
1172
|
*/
|
1168
1173
|
name: string;
|
1169
1174
|
/**
|
@@ -1193,9 +1198,7 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1193
1198
|
url: string;
|
1194
1199
|
/**
|
1195
1200
|
* The _Unique Universal Identifier_ (UUID) of the application, unique within the set of all other applications
|
1196
|
-
*
|
1197
|
-
*
|
1198
|
-
* Note that `name` and `uuid` must match.
|
1201
|
+
* running in the OpenFin Runtime.
|
1199
1202
|
*/
|
1200
1203
|
uuid: string;
|
1201
1204
|
/**
|
@@ -1904,48 +1907,6 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
1904
1907
|
behavior: 'browser';
|
1905
1908
|
};
|
1906
1909
|
|
1907
|
-
declare interface BrowserWindow {
|
1908
|
-
/**
|
1909
|
-
* True if the window has been opened and its GoldenLayout instance initialised.
|
1910
|
-
*/
|
1911
|
-
isInitialised: boolean;
|
1912
|
-
|
1913
|
-
/**
|
1914
|
-
* Creates a window configuration object from the Popout.
|
1915
|
-
*/
|
1916
|
-
toConfig(): {
|
1917
|
-
dimensions: {
|
1918
|
-
width: number;
|
1919
|
-
height: number;
|
1920
|
-
left: number;
|
1921
|
-
top: number;
|
1922
|
-
};
|
1923
|
-
content: Config;
|
1924
|
-
parentId: string;
|
1925
|
-
indexInParent: number;
|
1926
|
-
};
|
1927
|
-
|
1928
|
-
/**
|
1929
|
-
* Returns the GoldenLayout instance from the child window
|
1930
|
-
*/
|
1931
|
-
getGlInstance(): GoldenLayout_2;
|
1932
|
-
|
1933
|
-
/**
|
1934
|
-
* Returns the native Window object
|
1935
|
-
*/
|
1936
|
-
getWindow(): Window;
|
1937
|
-
|
1938
|
-
/**
|
1939
|
-
* Closes the popout
|
1940
|
-
*/
|
1941
|
-
close(): void;
|
1942
|
-
|
1943
|
-
/**
|
1944
|
-
* Returns the popout to its original position as specified in parentId and indexInParent
|
1945
|
-
*/
|
1946
|
-
popIn(): void;
|
1947
|
-
}
|
1948
|
-
|
1949
1910
|
/**
|
1950
1911
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
1951
1912
|
*
|
@@ -3317,31 +3278,6 @@ declare class ColumnOrRow extends LayoutNode {
|
|
3317
3278
|
getContent: () => Promise<(ColumnOrRow | TabStack)[]>;
|
3318
3279
|
}
|
3319
3280
|
|
3320
|
-
declare interface ComponentConfig extends ItemConfig {
|
3321
|
-
/**
|
3322
|
-
* The name of the component as specified in layout.registerComponent. Mandatory if type is 'component'.
|
3323
|
-
*/
|
3324
|
-
componentName: string;
|
3325
|
-
|
3326
|
-
/**
|
3327
|
-
* A serialisable object. Will be passed to the component constructor function and will be the value returned by
|
3328
|
-
* container.getState().
|
3329
|
-
*/
|
3330
|
-
componentState?: any;
|
3331
|
-
}
|
3332
|
-
|
3333
|
-
declare interface Config {
|
3334
|
-
settings?: Settings;
|
3335
|
-
dimensions?: Dimensions;
|
3336
|
-
labels?: Labels;
|
3337
|
-
content?: ItemConfigType[];
|
3338
|
-
/**
|
3339
|
-
* (Only on layout config object)
|
3340
|
-
* Id of the currently maximised content item
|
3341
|
-
*/
|
3342
|
-
maximisedItemId?: string;
|
3343
|
-
}
|
3344
|
-
|
3345
3281
|
declare type ConfigWithRuntime = BaseConfig & {
|
3346
3282
|
runtime: RuntimeConfig;
|
3347
3283
|
};
|
@@ -3719,103 +3655,6 @@ declare type ConstWindowOptions = {
|
|
3719
3655
|
inheritance?: Partial<InheritableOptions>;
|
3720
3656
|
};
|
3721
3657
|
|
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
3658
|
/**
|
3820
3659
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
3821
3660
|
*/
|
@@ -3889,218 +3728,6 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
3889
3728
|
disposition: string;
|
3890
3729
|
};
|
3891
3730
|
|
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
3731
|
/**
|
4105
3732
|
* Restrict navigation to URLs that match an allowed pattern.
|
4106
3733
|
* In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
|
@@ -4528,46 +4155,6 @@ declare type DidFinishLoadEvent = NamedEvent & {
|
|
4528
4155
|
type: 'did-finish-load';
|
4529
4156
|
};
|
4530
4157
|
|
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
4158
|
/**
|
4572
4159
|
* @interface
|
4573
4160
|
*/
|
@@ -4817,8 +4404,6 @@ declare type Dpi = {
|
|
4817
4404
|
vertical?: number;
|
4818
4405
|
};
|
4819
4406
|
|
4820
|
-
declare interface DragSource {}
|
4821
|
-
|
4822
4407
|
/**
|
4823
4408
|
* Generated when a window has been embedded.
|
4824
4409
|
* @interface
|
@@ -5124,43 +4709,6 @@ declare class EventAggregator extends EmitterMap {
|
|
5124
4709
|
dispatchEvent: (message: Message<any>) => boolean;
|
5125
4710
|
}
|
5126
4711
|
|
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
4712
|
/**
|
5165
4713
|
* Handler for an event on an EventEmitter.
|
5166
4714
|
* @remarks Selects the correct type for the event
|
@@ -5904,343 +5452,96 @@ declare class GlobalHotkey extends EmitterBase<OpenFin_2.GlobalHotkeyEvent> {
|
|
5904
5452
|
* .then(() => {
|
5905
5453
|
* console.log('Success');
|
5906
5454
|
* })
|
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
|
5455
|
+
* .catch(err => {
|
5456
|
+
* console.log('Error registering the hotkey', err);
|
5457
|
+
* });
|
5458
|
+
* ```
|
6201
5459
|
*/
|
6202
|
-
|
6203
|
-
|
5460
|
+
register(hotkey: string, listener: (...args: any[]) => void): Promise<void>;
|
6204
5461
|
/**
|
6205
|
-
*
|
6206
|
-
* @param
|
6207
|
-
*
|
6208
|
-
* @
|
5462
|
+
* Unregisters a global hotkey with the operating system.
|
5463
|
+
* @param hotkey a hotkey string
|
5464
|
+
*
|
5465
|
+
* @remarks This method will unregister all existing registrations of the hotkey within the application.
|
5466
|
+
* Raises the `unregistered` event.
|
5467
|
+
*
|
5468
|
+
* @example
|
5469
|
+
* ```js
|
5470
|
+
* const hotkey = 'CommandOrControl+X';
|
5471
|
+
*
|
5472
|
+
* fin.GlobalHotkey.unregister(hotkey)
|
5473
|
+
* .then(() => {
|
5474
|
+
* console.log('Success');
|
5475
|
+
* })
|
5476
|
+
* .catch(err => {
|
5477
|
+
* console.log('Error unregistering the hotkey', err);
|
5478
|
+
* });
|
5479
|
+
* ```
|
6209
5480
|
*/
|
6210
|
-
|
6211
|
-
|
5481
|
+
unregister(hotkey: string): Promise<void>;
|
6212
5482
|
/**
|
6213
|
-
*
|
6214
|
-
*
|
5483
|
+
* Unregisters all global hotkeys for the current application.
|
5484
|
+
*
|
5485
|
+
* @remarks Raises the `unregistered` event for each hotkey unregistered.
|
5486
|
+
*
|
5487
|
+
* @example
|
5488
|
+
* ```js
|
5489
|
+
* fin.GlobalHotkey.unregisterAll()
|
5490
|
+
* .then(() => {
|
5491
|
+
* console.log('Success');
|
5492
|
+
* })
|
5493
|
+
* .catch(err => {
|
5494
|
+
* console.log('Error unregistering all hotkeys for this application', err);
|
5495
|
+
* });
|
5496
|
+
* ```
|
6215
5497
|
*/
|
6216
|
-
|
6217
|
-
|
5498
|
+
unregisterAll(): Promise<void>;
|
6218
5499
|
/**
|
6219
|
-
*
|
5500
|
+
* Checks if a given hotkey has been registered by an application within the current runtime.
|
5501
|
+
* @param hotkey a hotkey string
|
5502
|
+
*
|
5503
|
+
* @example
|
5504
|
+
* ```js
|
5505
|
+
* const hotkey = 'CommandOrControl+X';
|
5506
|
+
*
|
5507
|
+
* fin.GlobalHotkey.isRegistered(hotkey)
|
5508
|
+
* .then((registered) => {
|
5509
|
+
* console.log(`hotkey ${hotkey} is registered ? ${registered}`);
|
5510
|
+
* })
|
5511
|
+
* .catch(err => {
|
5512
|
+
* console.log('Error unregistering the hotkey', err);
|
5513
|
+
* });
|
5514
|
+
* ```
|
6220
5515
|
*/
|
6221
|
-
|
5516
|
+
isRegistered(hotkey: string): Promise<boolean>;
|
5517
|
+
}
|
6222
5518
|
|
6223
|
-
|
6224
|
-
|
6225
|
-
|
6226
|
-
|
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;
|
5519
|
+
/**
|
5520
|
+
* @deprecated Renamed to {@link Event}.
|
5521
|
+
*/
|
5522
|
+
declare type GlobalHotkeyEvent = Event_9;
|
6232
5523
|
|
6233
|
-
|
6234
|
-
* Alias for unbind
|
6235
|
-
*/
|
6236
|
-
off(eventName: string, callback?: Function, context?: any): void;
|
5524
|
+
declare type GlobalHotkeyEvent_2 = Events.GlobalHotkeyEvents.GlobalHotkeyEvent;
|
6237
5525
|
|
6238
|
-
|
6239
|
-
|
6240
|
-
|
6241
|
-
|
5526
|
+
declare namespace GlobalHotkeyEvents {
|
5527
|
+
export {
|
5528
|
+
BaseEvent_8 as BaseEvent,
|
5529
|
+
RegisteredEvent,
|
5530
|
+
UnregisteredEvent,
|
5531
|
+
Event_9 as Event,
|
5532
|
+
GlobalHotkeyEvent,
|
5533
|
+
EventType_6 as EventType,
|
5534
|
+
GlobalHotkeyEventType,
|
5535
|
+
Payload_7 as Payload,
|
5536
|
+
ByType_6 as ByType
|
5537
|
+
}
|
6242
5538
|
}
|
6243
5539
|
|
5540
|
+
/**
|
5541
|
+
* @deprecated Renamed to {@link EventType}.
|
5542
|
+
*/
|
5543
|
+
declare type GlobalHotkeyEventType = EventType_6;
|
5544
|
+
|
6244
5545
|
/**
|
6245
5546
|
* @interface
|
6246
5547
|
*/
|
@@ -6248,62 +5549,6 @@ declare type GpuInfo = {
|
|
6248
5549
|
name: string;
|
6249
5550
|
};
|
6250
5551
|
|
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
5552
|
/**
|
6308
5553
|
* Generated when a View is hidden.
|
6309
5554
|
* @interface
|
@@ -7508,9 +6753,7 @@ declare class InteropClient extends Base {
|
|
7508
6753
|
* ```
|
7509
6754
|
*
|
7510
6755
|
*
|
7511
|
-
*
|
7512
|
-
* this, please make sure you add your context handlers at the top level of your application, on a page that
|
7513
|
-
* does not navigate/reload/re-render, to avoid memory leaks. This feature is experimental:
|
6756
|
+
* Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
|
7514
6757
|
*
|
7515
6758
|
* ```js
|
7516
6759
|
* function handleInstrumentContext(contextInfo) {
|
@@ -7892,50 +7135,6 @@ declare class InteropModule extends Base {
|
|
7892
7135
|
connectSync(name: string, interopConfig?: OpenFin_2.InteropConfig): InteropClient;
|
7893
7136
|
}
|
7894
7137
|
|
7895
|
-
declare interface ItemConfig {
|
7896
|
-
/**
|
7897
|
-
* The type of the item. Possible values are 'row', 'column', 'stack', 'component' and 'react-component'.
|
7898
|
-
*/
|
7899
|
-
type: ItemType;
|
7900
|
-
|
7901
|
-
/**
|
7902
|
-
* An array of configurations for items that will be created as children of this item.
|
7903
|
-
*/
|
7904
|
-
content?: ItemConfigType[];
|
7905
|
-
|
7906
|
-
/**
|
7907
|
-
* The width of this item, relative to the other children of its parent in percent
|
7908
|
-
*/
|
7909
|
-
width?: number;
|
7910
|
-
|
7911
|
-
/**
|
7912
|
-
* The height of this item, relative to the other children of its parent in percent
|
7913
|
-
*/
|
7914
|
-
height?: number;
|
7915
|
-
|
7916
|
-
/**
|
7917
|
-
* A String or an Array of Strings. Used to retrieve the item using item.getItemsById()
|
7918
|
-
*/
|
7919
|
-
id?: string | string[];
|
7920
|
-
|
7921
|
-
/**
|
7922
|
-
* Determines if the item is closable. If false, the x on the items tab will be hidden and container.close()
|
7923
|
-
* will return false
|
7924
|
-
* Default: true
|
7925
|
-
*/
|
7926
|
-
isClosable?: boolean;
|
7927
|
-
|
7928
|
-
/**
|
7929
|
-
* The title of the item as displayed on its tab and on popout windows
|
7930
|
-
* Default: componentName or ''
|
7931
|
-
*/
|
7932
|
-
title?: string;
|
7933
|
-
}
|
7934
|
-
|
7935
|
-
declare type ItemConfigType = ItemConfig | ComponentConfig | ReactComponentConfig;
|
7936
|
-
|
7937
|
-
declare type ItemType = 'row' | 'column' | 'stack' | 'root' | 'component';
|
7938
|
-
|
7939
7138
|
/**
|
7940
7139
|
* @interface
|
7941
7140
|
*/
|
@@ -7993,32 +7192,6 @@ declare type JumpListTask = {
|
|
7993
7192
|
iconIndex?: number;
|
7994
7193
|
};
|
7995
7194
|
|
7996
|
-
declare interface Labels {
|
7997
|
-
/**
|
7998
|
-
* The tooltip text that appears when hovering over the close icon.
|
7999
|
-
* Default: 'close'
|
8000
|
-
*/
|
8001
|
-
close?: string;
|
8002
|
-
|
8003
|
-
/**
|
8004
|
-
* The tooltip text that appears when hovering over the maximise icon.
|
8005
|
-
* Default: 'maximise'
|
8006
|
-
*/
|
8007
|
-
maximise?: string;
|
8008
|
-
|
8009
|
-
/**
|
8010
|
-
* The tooltip text that appears when hovering over the minimise icon.
|
8011
|
-
* Default: 'minimise'
|
8012
|
-
*/
|
8013
|
-
minimise?: string;
|
8014
|
-
|
8015
|
-
/**
|
8016
|
-
* The tooltip text that appears when hovering over the popout icon.
|
8017
|
-
* Default: 'open in new window'
|
8018
|
-
*/
|
8019
|
-
popout?: string;
|
8020
|
-
}
|
8021
|
-
|
8022
7195
|
/**
|
8023
7196
|
* The LaunchEmitter is an `EventEmitter`. It can listen to app version resolver events.
|
8024
7197
|
*
|
@@ -8444,7 +7617,7 @@ declare type LayoutEntityDefinition<TLayoutEntityType extends LayoutEntityTypes
|
|
8444
7617
|
entityId: string;
|
8445
7618
|
};
|
8446
7619
|
|
8447
|
-
declare type LayoutEntityTypes =
|
7620
|
+
declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
8448
7621
|
|
8449
7622
|
/**
|
8450
7623
|
* @interface
|
@@ -9818,6 +8991,7 @@ declare namespace OpenFin_2 {
|
|
9818
8991
|
AppVersionError,
|
9819
8992
|
AppVersionRuntimeInfo,
|
9820
8993
|
LaunchEmitter,
|
8994
|
+
UserAppConfigArgs,
|
9821
8995
|
RvmLaunchOptions,
|
9822
8996
|
ShortCutConfig,
|
9823
8997
|
TerminateExternalRequestType,
|
@@ -12351,18 +11525,6 @@ declare type QueryPermissionResult = {
|
|
12351
11525
|
rawValue?: unknown;
|
12352
11526
|
};
|
12353
11527
|
|
12354
|
-
declare interface ReactComponentConfig extends ItemConfig {
|
12355
|
-
/**
|
12356
|
-
* The name of the component as specified in layout.registerComponent. Mandatory if type is 'react-component'
|
12357
|
-
*/
|
12358
|
-
component: string;
|
12359
|
-
|
12360
|
-
/**
|
12361
|
-
* Properties that will be passed to the component and accessible using this.props.
|
12362
|
-
*/
|
12363
|
-
props?: any;
|
12364
|
-
}
|
12365
|
-
|
12366
11528
|
/**
|
12367
11529
|
* @interface
|
12368
11530
|
*/
|
@@ -12625,7 +11787,7 @@ declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
|
|
12625
11787
|
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
12626
11788
|
topic: 'application';
|
12627
11789
|
type: 'run-requested';
|
12628
|
-
userAppConfigArgs:
|
11790
|
+
userAppConfigArgs: OpenFin_2.UserAppConfigArgs;
|
12629
11791
|
manifest: OpenFin_2.Manifest;
|
12630
11792
|
};
|
12631
11793
|
|
@@ -12740,7 +11902,7 @@ declare type RvmLaunchOptions = {
|
|
12740
11902
|
* True if no UI when launching
|
12741
11903
|
*/
|
12742
11904
|
noUi?: boolean;
|
12743
|
-
userAppConfigArgs?:
|
11905
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
12744
11906
|
/**
|
12745
11907
|
* Timeout in seconds until RVM launch request expires.
|
12746
11908
|
*/
|
@@ -12839,97 +12001,6 @@ declare type SessionContextGroup = {
|
|
12839
12001
|
}>;
|
12840
12002
|
};
|
12841
12003
|
|
12842
|
-
declare interface Settings {
|
12843
|
-
preventSplitterResize?: boolean;
|
12844
|
-
|
12845
|
-
newTabButton?: {
|
12846
|
-
url?: string;
|
12847
|
-
};
|
12848
|
-
|
12849
|
-
/**
|
12850
|
-
* If true, tabs can't be dragged into the window.
|
12851
|
-
* Default: false
|
12852
|
-
*/
|
12853
|
-
preventDragIn?: boolean;
|
12854
|
-
|
12855
|
-
/**
|
12856
|
-
* If true, tabs can't be dragged out of the window.
|
12857
|
-
* Default: false
|
12858
|
-
*/
|
12859
|
-
preventDragOut?: boolean;
|
12860
|
-
|
12861
|
-
/**
|
12862
|
-
* If true, stack headers are the only areas where tabs can be dropped.
|
12863
|
-
* Default: false
|
12864
|
-
*/
|
12865
|
-
constrainDragToHeaders?: boolean;
|
12866
|
-
/**
|
12867
|
-
* Turns headers on or off. If false, the layout will be displayed with splitters only.
|
12868
|
-
* Default: true
|
12869
|
-
*/
|
12870
|
-
hasHeaders?: boolean;
|
12871
|
-
|
12872
|
-
/**
|
12873
|
-
* (Unused in Openfin Platform) Constrains the area in which items can be dragged to the layout's container. Will be set to false
|
12874
|
-
* automatically when layout.createDragSource() is called.
|
12875
|
-
* Default: true
|
12876
|
-
*/
|
12877
|
-
constrainDragToContainer?: boolean;
|
12878
|
-
|
12879
|
-
/**
|
12880
|
-
* If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.
|
12881
|
-
* Default: true
|
12882
|
-
*/
|
12883
|
-
reorderEnabled?: boolean;
|
12884
|
-
|
12885
|
-
/**
|
12886
|
-
* If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to
|
12887
|
-
* the clicked item, highlights its header and the layout emits a 'selectionChanged' event.
|
12888
|
-
* Default: false
|
12889
|
-
*/
|
12890
|
-
selectionEnabled?: boolean;
|
12891
|
-
|
12892
|
-
/**
|
12893
|
-
* Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will
|
12894
|
-
* be transferred to the new window, if false only the active component will be opened.
|
12895
|
-
* Default: false
|
12896
|
-
*/
|
12897
|
-
popoutWholeStack?: boolean;
|
12898
|
-
|
12899
|
-
/**
|
12900
|
-
* Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically).
|
12901
|
-
* If false, the popout call will fail silently.
|
12902
|
-
* Default: true
|
12903
|
-
*/
|
12904
|
-
blockedPopoutsThrowError?: boolean;
|
12905
|
-
|
12906
|
-
/**
|
12907
|
-
* Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a
|
12908
|
-
* strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand. In
|
12909
|
-
* addition, any changes made to popouts won't be stored after the parent is closed.
|
12910
|
-
* Default: true
|
12911
|
-
*/
|
12912
|
-
closePopoutsOnUnload?: boolean;
|
12913
|
-
|
12914
|
-
/**
|
12915
|
-
* Specifies if the popout icon should be displayed in the header-bar.
|
12916
|
-
* Default: true
|
12917
|
-
*/
|
12918
|
-
showPopoutIcon?: boolean;
|
12919
|
-
|
12920
|
-
/**
|
12921
|
-
* Specifies if the maximise icon should be displayed in the header-bar.
|
12922
|
-
* Default: true
|
12923
|
-
*/
|
12924
|
-
showMaximiseIcon?: boolean;
|
12925
|
-
|
12926
|
-
/**
|
12927
|
-
* Specifies if the close icon should be displayed in the header-bar.
|
12928
|
-
* Default: true
|
12929
|
-
*/
|
12930
|
-
showCloseIcon?: boolean;
|
12931
|
-
}
|
12932
|
-
|
12933
12004
|
/**
|
12934
12005
|
* @interface
|
12935
12006
|
*/
|
@@ -14820,59 +13891,6 @@ declare type SystemShutdownHandler = (shutdownEvent: {
|
|
14820
13891
|
proceed: () => void;
|
14821
13892
|
}) => void;
|
14822
13893
|
|
14823
|
-
declare interface Tab {
|
14824
|
-
_dragListener: TabDragListener;
|
14825
|
-
|
14826
|
-
/**
|
14827
|
-
* True if this tab is the selected tab
|
14828
|
-
*/
|
14829
|
-
isActive: boolean;
|
14830
|
-
|
14831
|
-
/**
|
14832
|
-
* A reference to the header this tab is a child of
|
14833
|
-
*/
|
14834
|
-
header: Header;
|
14835
|
-
|
14836
|
-
/**
|
14837
|
-
* A reference to the content item this tab relates to
|
14838
|
-
*/
|
14839
|
-
contentItem: ContentItem;
|
14840
|
-
|
14841
|
-
/**
|
14842
|
-
* The tabs outer (jQuery) DOM element
|
14843
|
-
*/
|
14844
|
-
element: JQuery;
|
14845
|
-
|
14846
|
-
/**
|
14847
|
-
* The (jQuery) DOM element containing the title
|
14848
|
-
*/
|
14849
|
-
titleElement: JQuery;
|
14850
|
-
|
14851
|
-
/**
|
14852
|
-
* The (jQuery) DOM element that closes the tab
|
14853
|
-
*/
|
14854
|
-
closeElement: JQuery;
|
14855
|
-
|
14856
|
-
/**
|
14857
|
-
* Sets the tab's title. Does not affect the contentItem's title!
|
14858
|
-
* @param title The new title
|
14859
|
-
*/
|
14860
|
-
setTitle(title: string): void;
|
14861
|
-
|
14862
|
-
/**
|
14863
|
-
* Sets this tab's active state. To programmatically switch tabs, use header.setActiveContentItem( item ) instead.
|
14864
|
-
* @param isActive Whether the tab is active
|
14865
|
-
*/
|
14866
|
-
setActive(isActive: boolean): void;
|
14867
|
-
}
|
14868
|
-
|
14869
|
-
declare interface TabDragListener extends EventEmitter_2 {
|
14870
|
-
/**
|
14871
|
-
* A reference to the content item this tab relates to
|
14872
|
-
*/
|
14873
|
-
contentItem: ContentItem;
|
14874
|
-
}
|
14875
|
-
|
14876
13894
|
/**
|
14877
13895
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
14878
13896
|
*/
|
@@ -15238,6 +14256,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15238
14256
|
httpStatusText: string;
|
15239
14257
|
});
|
15240
14258
|
|
14259
|
+
/**
|
14260
|
+
* @interface
|
14261
|
+
*/
|
14262
|
+
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
14263
|
+
|
15241
14264
|
/**
|
15242
14265
|
* A general user bounds change event without event type.
|
15243
14266
|
* @interface
|
@@ -18624,6 +17647,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
18624
17647
|
positioningOptions?: OpenFin_2.PositioningOptions;
|
18625
17648
|
};
|
18626
17649
|
|
17650
|
+
declare type WithUserAppConfigArgs = {
|
17651
|
+
/**
|
17652
|
+
* Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
|
17653
|
+
* that launches this application.
|
17654
|
+
*
|
17655
|
+
* @remarks
|
17656
|
+
* In the link, user defined parameters are separated by the `$$` delimeter, for example:
|
17657
|
+
* `fins://path.to/app/manifest.json?$$use-last-configuration=true`
|
17658
|
+
*
|
17659
|
+
* Results in the following object:
|
17660
|
+
* ```json
|
17661
|
+
* {
|
17662
|
+
* "use-last-configuration": true"
|
17663
|
+
* }
|
17664
|
+
* ```
|
17665
|
+
*
|
17666
|
+
* These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
|
17667
|
+
* ```typescript
|
17668
|
+
* const appInfo = await fin.Application.getCurrentSync().getInfo();
|
17669
|
+
* const { userAppConfigArgs } = appInfo.initialOptions;
|
17670
|
+
* console.log(userAppConfigArgs['use-last-configuration']); // 'true'
|
17671
|
+
* ```
|
17672
|
+
*/
|
17673
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
17674
|
+
};
|
17675
|
+
|
18627
17676
|
/* Excluded from this release type: WorkspacePlatformOptions */
|
18628
17677
|
|
18629
17678
|
/**
|