@openfin/core 40.105.4 → 40.105.7
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 +207 -198
- package/out/mock-beta.d.ts +207 -198
- package/out/mock-public.d.ts +207 -198
- package/out/stub.d.ts +207 -198
- package/package.json +1 -1
package/out/stub.d.ts
CHANGED
|
@@ -129,13 +129,13 @@ declare type ApiSettings = {
|
|
|
129
129
|
/**
|
|
130
130
|
* Inject OpenFin API into cross-origin iframes
|
|
131
131
|
*
|
|
132
|
-
* @
|
|
132
|
+
* @default false
|
|
133
133
|
*/
|
|
134
134
|
crossOriginInjection?: boolean;
|
|
135
135
|
/**
|
|
136
136
|
* Inject OpenFin API into same-origin iframes
|
|
137
137
|
*
|
|
138
|
-
* @
|
|
138
|
+
* @default true
|
|
139
139
|
*/
|
|
140
140
|
sameOriginInjection?: boolean;
|
|
141
141
|
/**
|
|
@@ -1180,19 +1180,19 @@ declare class ApplicationModule extends Base {
|
|
|
1180
1180
|
*/
|
|
1181
1181
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1182
1182
|
/**
|
|
1183
|
-
* @defaultValue false
|
|
1184
|
-
*
|
|
1185
1183
|
* Disables IAB secure logging for the app.
|
|
1184
|
+
*
|
|
1185
|
+
* @default false
|
|
1186
1186
|
*/
|
|
1187
1187
|
disableIabSecureLogging: boolean;
|
|
1188
1188
|
/**
|
|
1189
|
-
* @defaultValue 'There was an error loading the application.'
|
|
1190
|
-
*
|
|
1191
1189
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1192
1190
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1193
1191
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1194
1192
|
* will trigger this dialog.
|
|
1195
1193
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1194
|
+
*
|
|
1195
|
+
* @default 'There was an error loading the application.'
|
|
1196
1196
|
*/
|
|
1197
1197
|
loadErrorMessage: string;
|
|
1198
1198
|
/**
|
|
@@ -1211,28 +1211,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1211
1211
|
*/
|
|
1212
1212
|
name: string;
|
|
1213
1213
|
/**
|
|
1214
|
-
* @defaultValue false
|
|
1215
|
-
*
|
|
1216
1214
|
* A flag to configure the application as non-persistent.
|
|
1217
1215
|
* Runtime exits when there are no persistent apps running.
|
|
1216
|
+
*
|
|
1217
|
+
* @default false
|
|
1218
1218
|
*/
|
|
1219
1219
|
nonPersistent: boolean;
|
|
1220
1220
|
/**
|
|
1221
|
-
* @defaultValue false
|
|
1222
|
-
*
|
|
1223
1221
|
* Enable Flash at the application level.
|
|
1222
|
+
*
|
|
1223
|
+
* @default false
|
|
1224
1224
|
*/
|
|
1225
1225
|
plugins: boolean;
|
|
1226
1226
|
/**
|
|
1227
|
-
* @defaultValue false
|
|
1228
|
-
*
|
|
1229
1227
|
* Enable spell check at the application level.
|
|
1228
|
+
*
|
|
1229
|
+
* @default false
|
|
1230
1230
|
*/
|
|
1231
1231
|
spellCheck: boolean;
|
|
1232
1232
|
/**
|
|
1233
|
-
* @defaultValue 'about:blank'
|
|
1234
|
-
*
|
|
1235
1233
|
* The url to the application (specifically the application's main window).
|
|
1234
|
+
*
|
|
1235
|
+
* @default 'about:blank'
|
|
1236
1236
|
*/
|
|
1237
1237
|
url: string;
|
|
1238
1238
|
/**
|
|
@@ -1241,9 +1241,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1241
1241
|
*/
|
|
1242
1242
|
uuid: string;
|
|
1243
1243
|
/**
|
|
1244
|
-
* @defaultValue true
|
|
1245
|
-
*
|
|
1246
1244
|
* When set to `false` it will disable the same-origin policy for the app.
|
|
1245
|
+
*
|
|
1246
|
+
* @default true
|
|
1247
1247
|
*/
|
|
1248
1248
|
webSecurity: boolean;
|
|
1249
1249
|
/**
|
|
@@ -1253,10 +1253,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1253
1253
|
commands: ShortcutOverride[];
|
|
1254
1254
|
isPlatformController: boolean;
|
|
1255
1255
|
/**
|
|
1256
|
-
* @defaultValue 1000
|
|
1257
|
-
*
|
|
1258
1256
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1259
1257
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1258
|
+
*
|
|
1259
|
+
* @default 1000
|
|
1260
1260
|
*/
|
|
1261
1261
|
maxViewPoolSize: number;
|
|
1262
1262
|
/**
|
|
@@ -1272,12 +1272,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1272
1272
|
*/
|
|
1273
1273
|
snapshot: Snapshot;
|
|
1274
1274
|
/**
|
|
1275
|
-
* @defaultValue false
|
|
1276
|
-
*
|
|
1277
1275
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1278
1276
|
*
|
|
1279
1277
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1280
1278
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1279
|
+
*
|
|
1280
|
+
* @default false
|
|
1281
1281
|
*/
|
|
1282
1282
|
preventQuitOnLastWindowClosed: boolean;
|
|
1283
1283
|
/**
|
|
@@ -1285,9 +1285,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1285
1285
|
*/
|
|
1286
1286
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1287
1287
|
/**
|
|
1288
|
-
* @defaultValue true
|
|
1289
|
-
*
|
|
1290
1288
|
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1289
|
+
*
|
|
1290
|
+
* @default true
|
|
1291
1291
|
*/
|
|
1292
1292
|
apiDiagnostics: boolean;
|
|
1293
1293
|
/**
|
|
@@ -1303,16 +1303,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1303
1303
|
*/
|
|
1304
1304
|
permissions?: Partial<Permissions_2>;
|
|
1305
1305
|
/**
|
|
1306
|
-
* @defaultValue false
|
|
1307
|
-
*
|
|
1308
1306
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1309
1307
|
* Only relevant in Windows.
|
|
1308
|
+
*
|
|
1309
|
+
* @default false
|
|
1310
1310
|
*/
|
|
1311
1311
|
enableJumpList: boolean;
|
|
1312
1312
|
/**
|
|
1313
|
-
* @defaultValue false
|
|
1314
|
-
*
|
|
1315
1313
|
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1314
|
+
*
|
|
1315
|
+
* @default false
|
|
1316
1316
|
*/
|
|
1317
1317
|
enableBeforeUnload: boolean;
|
|
1318
1318
|
/**
|
|
@@ -1393,25 +1393,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1393
1393
|
*/
|
|
1394
1394
|
declare type ApplySnapshotOptions = {
|
|
1395
1395
|
/**
|
|
1396
|
-
* @defaultValue false
|
|
1397
|
-
*
|
|
1398
1396
|
* When true, applySnapshot will close existing windows,
|
|
1399
1397
|
* replacing current Platform state with the given snapshot.
|
|
1398
|
+
*
|
|
1399
|
+
* @default false
|
|
1400
1400
|
*/
|
|
1401
1401
|
closeExistingWindows?: boolean;
|
|
1402
1402
|
/**
|
|
1403
|
-
* @defaultValue false
|
|
1404
|
-
*
|
|
1405
1403
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1406
1404
|
* replacing current Platform state with the given snapshot.
|
|
1405
|
+
*
|
|
1406
|
+
* @default false
|
|
1407
1407
|
*/
|
|
1408
1408
|
closeSnapshotWindows?: boolean;
|
|
1409
1409
|
/**
|
|
1410
|
-
* @defaultValue false
|
|
1411
|
-
*
|
|
1412
1410
|
* When true, applySnapshot will not check whether any windows in a
|
|
1413
1411
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1414
1412
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1413
|
+
*
|
|
1414
|
+
* @default false
|
|
1415
1415
|
*/
|
|
1416
1416
|
skipOutOfBoundsCheck?: boolean;
|
|
1417
1417
|
};
|
|
@@ -2094,15 +2094,15 @@ declare type CapturePageOptions = {
|
|
|
2094
2094
|
*/
|
|
2095
2095
|
area?: Rectangle;
|
|
2096
2096
|
/**
|
|
2097
|
-
* @defaultValue 'png'
|
|
2098
|
-
*
|
|
2099
2097
|
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2098
|
+
*
|
|
2099
|
+
* @default 'png'
|
|
2100
2100
|
*/
|
|
2101
2101
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2102
2102
|
/**
|
|
2103
|
-
* @defaultValue 100
|
|
2104
|
-
*
|
|
2105
2103
|
* Quality of JPEG image. Between 0 - 100.
|
|
2104
|
+
*
|
|
2105
|
+
* @default 100
|
|
2106
2106
|
*/
|
|
2107
2107
|
quality?: number;
|
|
2108
2108
|
};
|
|
@@ -2756,9 +2756,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2756
2756
|
*/
|
|
2757
2757
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2758
2758
|
/**
|
|
2759
|
-
* @defaultValue true
|
|
2760
|
-
*
|
|
2761
2759
|
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2760
|
+
*
|
|
2761
|
+
* @default true
|
|
2762
2762
|
*/
|
|
2763
2763
|
wait?: boolean;
|
|
2764
2764
|
/**
|
|
@@ -3055,6 +3055,10 @@ declare type ChromiumPolicies = {
|
|
|
3055
3055
|
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3056
3056
|
*/
|
|
3057
3057
|
AutofillAddressEnabled?: PolicyOptions;
|
|
3058
|
+
/**
|
|
3059
|
+
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3060
|
+
*/
|
|
3061
|
+
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3058
3062
|
};
|
|
3059
3063
|
|
|
3060
3064
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
@@ -3420,9 +3424,9 @@ declare interface CloseWindowPayload {
|
|
|
3420
3424
|
windowId: Identity_4;
|
|
3421
3425
|
options: {
|
|
3422
3426
|
/**
|
|
3423
|
-
* @defaultValue false
|
|
3424
|
-
*
|
|
3425
3427
|
* When set to true skips any before handler set on views that are part of the window
|
|
3428
|
+
*
|
|
3429
|
+
* @default false
|
|
3426
3430
|
*/
|
|
3427
3431
|
skipBeforeUnload?: boolean;
|
|
3428
3432
|
};
|
|
@@ -3530,9 +3534,9 @@ declare type ConstViewOptions = {
|
|
|
3530
3534
|
*/
|
|
3531
3535
|
name: string;
|
|
3532
3536
|
/**
|
|
3533
|
-
* @defaultValue "about:blank"
|
|
3534
|
-
*
|
|
3535
3537
|
* The URL of the window
|
|
3538
|
+
*
|
|
3539
|
+
* @default "about:blank"
|
|
3536
3540
|
*/
|
|
3537
3541
|
url: string;
|
|
3538
3542
|
/**
|
|
@@ -3590,9 +3594,9 @@ declare type ConstViewOptions = {
|
|
|
3590
3594
|
experimental: any;
|
|
3591
3595
|
fdc3InteropApi?: string;
|
|
3592
3596
|
/**
|
|
3593
|
-
* @defaultValue false
|
|
3594
|
-
*
|
|
3595
3597
|
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3598
|
+
*
|
|
3599
|
+
* @default false
|
|
3596
3600
|
*/
|
|
3597
3601
|
enableBeforeUnload: boolean;
|
|
3598
3602
|
/**
|
|
@@ -3673,13 +3677,12 @@ declare type ConstWindowOptions = {
|
|
|
3673
3677
|
*/
|
|
3674
3678
|
backgroundColor: string;
|
|
3675
3679
|
/**
|
|
3676
|
-
* @defaultValue false
|
|
3677
|
-
*
|
|
3678
3680
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3679
3681
|
* This also affects the Page Visibility API.
|
|
3680
3682
|
*
|
|
3681
3683
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3682
3684
|
*
|
|
3685
|
+
* @default false
|
|
3683
3686
|
*/
|
|
3684
3687
|
backgroundThrottling: boolean;
|
|
3685
3688
|
/**
|
|
@@ -3703,21 +3706,21 @@ declare type ConstWindowOptions = {
|
|
|
3703
3706
|
*/
|
|
3704
3707
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3705
3708
|
/**
|
|
3706
|
-
* @defaultValue true
|
|
3707
|
-
*
|
|
3708
3709
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3709
3710
|
* This is meant for advanced users and should be used with caution.
|
|
3710
3711
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3711
3712
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3712
3713
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3714
|
+
*
|
|
3715
|
+
* @default true
|
|
3713
3716
|
*/
|
|
3714
3717
|
closeOnLastViewRemoved: boolean;
|
|
3715
3718
|
/**
|
|
3716
|
-
* @defaultValue 'all'
|
|
3717
|
-
*
|
|
3718
3719
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3719
|
-
|
|
3720
|
+
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3720
3721
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3722
|
+
*
|
|
3723
|
+
* @default 'all'
|
|
3721
3724
|
*/
|
|
3722
3725
|
viewsPreventingClose: 'all' | 'layout';
|
|
3723
3726
|
/**
|
|
@@ -3728,31 +3731,31 @@ declare type ConstWindowOptions = {
|
|
|
3728
3731
|
*/
|
|
3729
3732
|
defaultCentered: boolean;
|
|
3730
3733
|
/**
|
|
3731
|
-
* @defaultValue 500
|
|
3732
|
-
*
|
|
3733
3734
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3734
3735
|
* in favor of the cached value.
|
|
3736
|
+
*
|
|
3737
|
+
* @default 500
|
|
3735
3738
|
*/
|
|
3736
3739
|
defaultHeight: number;
|
|
3737
3740
|
/**
|
|
3738
|
-
* @defaultValue 100
|
|
3739
|
-
*
|
|
3740
3741
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3741
3742
|
* launches in favor of the cached value.
|
|
3743
|
+
*
|
|
3744
|
+
* @default 100
|
|
3742
3745
|
*/
|
|
3743
3746
|
defaultLeft: number;
|
|
3744
3747
|
/**
|
|
3745
|
-
* @defaultValue 100
|
|
3746
|
-
*
|
|
3747
3748
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3748
3749
|
* launches in favor of the cached value.
|
|
3750
|
+
*
|
|
3751
|
+
* @default 100
|
|
3749
3752
|
*/
|
|
3750
3753
|
defaultTop: number;
|
|
3751
3754
|
/**
|
|
3752
|
-
* @defaultValue 800
|
|
3753
|
-
*
|
|
3754
3755
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3755
3756
|
* launches in favor of the cached value.
|
|
3757
|
+
*
|
|
3758
|
+
* @default 800
|
|
3756
3759
|
*/
|
|
3757
3760
|
defaultWidth: number;
|
|
3758
3761
|
/**
|
|
@@ -3798,19 +3801,19 @@ declare type ConstWindowOptions = {
|
|
|
3798
3801
|
*/
|
|
3799
3802
|
processAffinity: string;
|
|
3800
3803
|
/**
|
|
3801
|
-
* @defaultValue false
|
|
3802
|
-
*
|
|
3803
3804
|
* Displays a shadow on frameless windows.
|
|
3804
3805
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3805
3806
|
* On Windows 7, Aero theme is required.
|
|
3807
|
+
*
|
|
3808
|
+
* @default false
|
|
3806
3809
|
*/
|
|
3807
3810
|
shadow: boolean;
|
|
3808
3811
|
/**
|
|
3809
|
-
* @defaultValue true
|
|
3810
|
-
*
|
|
3811
3812
|
* Caches the location of the window.
|
|
3812
3813
|
*
|
|
3813
3814
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3815
|
+
*
|
|
3816
|
+
* @default true
|
|
3814
3817
|
*/
|
|
3815
3818
|
saveWindowState: boolean;
|
|
3816
3819
|
/**
|
|
@@ -3819,22 +3822,22 @@ declare type ConstWindowOptions = {
|
|
|
3819
3822
|
*/
|
|
3820
3823
|
ignoreSavedWindowState: boolean;
|
|
3821
3824
|
/**
|
|
3822
|
-
* @defaultValue false
|
|
3823
|
-
*
|
|
3824
3825
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3825
3826
|
*
|
|
3826
3827
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3827
3828
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3829
|
+
*
|
|
3830
|
+
* @default false
|
|
3828
3831
|
*/
|
|
3829
3832
|
smallWindow: boolean;
|
|
3830
3833
|
/**
|
|
3831
|
-
* @defaultValue "normal"
|
|
3832
|
-
*
|
|
3833
3834
|
* The visible state of the window on creation.
|
|
3834
3835
|
* One of:
|
|
3835
3836
|
* * `"maximized"`
|
|
3836
3837
|
* * `"minimized"`
|
|
3837
3838
|
* * `"normal"`
|
|
3839
|
+
*
|
|
3840
|
+
* @default "normal"
|
|
3838
3841
|
*/
|
|
3839
3842
|
state: WindowState;
|
|
3840
3843
|
/**
|
|
@@ -3848,20 +3851,20 @@ declare type ConstWindowOptions = {
|
|
|
3848
3851
|
*/
|
|
3849
3852
|
url: string;
|
|
3850
3853
|
/**
|
|
3851
|
-
* @defaultValue <application UUID>
|
|
3852
|
-
*
|
|
3853
3854
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3854
3855
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3855
3856
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3856
3857
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3857
3858
|
* really no need to provide it.
|
|
3859
|
+
*
|
|
3860
|
+
* @default <application UUID>
|
|
3858
3861
|
*/
|
|
3859
3862
|
uuid: string;
|
|
3860
3863
|
/**
|
|
3861
|
-
* @defaultValue false
|
|
3862
|
-
*
|
|
3863
3864
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3864
3865
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3866
|
+
*
|
|
3867
|
+
* @default false
|
|
3865
3868
|
*/
|
|
3866
3869
|
waitForPageLoad: boolean;
|
|
3867
3870
|
width: number;
|
|
@@ -4133,13 +4136,13 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
|
4133
4136
|
*/
|
|
4134
4137
|
declare type CopyPermissions = {
|
|
4135
4138
|
/**
|
|
4136
|
-
* @defaultValue 'allowed'
|
|
4137
|
-
*
|
|
4138
4139
|
* Controls the behavior for copy operations for a matched URL.
|
|
4139
4140
|
*
|
|
4140
4141
|
* allow: Enables all copy operations.
|
|
4141
4142
|
* block: Disables all copy operations.
|
|
4142
4143
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4144
|
+
*
|
|
4145
|
+
* @default 'allowed'
|
|
4143
4146
|
*/
|
|
4144
4147
|
behavior: 'allow' | 'block' | 'protect';
|
|
4145
4148
|
/**
|
|
@@ -4147,9 +4150,9 @@ declare type CopyPermissions = {
|
|
|
4147
4150
|
*/
|
|
4148
4151
|
options?: {
|
|
4149
4152
|
/**
|
|
4150
|
-
* @defaultValue ''
|
|
4151
|
-
*
|
|
4152
4153
|
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4154
|
+
*
|
|
4155
|
+
* @default ''
|
|
4153
4156
|
*/
|
|
4154
4157
|
replacementText: string;
|
|
4155
4158
|
};
|
|
@@ -4163,15 +4166,15 @@ declare type CopyPermissions = {
|
|
|
4163
4166
|
*/
|
|
4164
4167
|
declare type CornerRounding = {
|
|
4165
4168
|
/**
|
|
4166
|
-
* @defaultValue 0
|
|
4167
|
-
*
|
|
4168
4169
|
* The height in pixels.
|
|
4170
|
+
*
|
|
4171
|
+
* @default 0
|
|
4169
4172
|
*/
|
|
4170
4173
|
height: number;
|
|
4171
4174
|
/**
|
|
4172
|
-
* @defaultValue 0
|
|
4173
|
-
*
|
|
4174
4175
|
* The width in pixels.
|
|
4176
|
+
*
|
|
4177
|
+
* @default 0
|
|
4175
4178
|
*/
|
|
4176
4179
|
width: number;
|
|
4177
4180
|
};
|
|
@@ -4261,8 +4264,6 @@ declare type CreateLayoutOptions = {
|
|
|
4261
4264
|
layoutName: string;
|
|
4262
4265
|
layout: LayoutOptions;
|
|
4263
4266
|
/**
|
|
4264
|
-
* @defaultValue 'default'
|
|
4265
|
-
*
|
|
4266
4267
|
* Controls the View behavior for the given `layout` property. Note
|
|
4267
4268
|
* that the selected behavior only applies to unnamed Views or
|
|
4268
4269
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4284,6 +4285,8 @@ declare type CreateLayoutOptions = {
|
|
|
4284
4285
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4285
4286
|
* attached to the Provider while the Window is being created, so it's
|
|
4286
4287
|
* important to not 'duplicate' Views in this workflow.
|
|
4288
|
+
*
|
|
4289
|
+
* @default 'default'
|
|
4287
4290
|
*/
|
|
4288
4291
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4289
4292
|
};
|
|
@@ -4543,7 +4546,7 @@ declare type DomainApiSettings = {
|
|
|
4543
4546
|
* * 'none': The `fin` API will be not available.
|
|
4544
4547
|
* * 'global': The entire `fin` API will be available.
|
|
4545
4548
|
*
|
|
4546
|
-
* @
|
|
4549
|
+
* @default 'global'
|
|
4547
4550
|
*/
|
|
4548
4551
|
fin?: InjectionType;
|
|
4549
4552
|
/**
|
|
@@ -5135,9 +5138,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
|
5135
5138
|
*/
|
|
5136
5139
|
declare type ExcludeOptions = {
|
|
5137
5140
|
/**
|
|
5138
|
-
* @defaultValue false
|
|
5139
|
-
*
|
|
5140
5141
|
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5142
|
+
*
|
|
5143
|
+
* @default false
|
|
5141
5144
|
*/
|
|
5142
5145
|
preloadScripts: boolean;
|
|
5143
5146
|
};
|
|
@@ -5623,34 +5626,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
|
|
|
5623
5626
|
*/
|
|
5624
5627
|
declare type FindInPageOptions = {
|
|
5625
5628
|
/**
|
|
5626
|
-
* @defaultValue true
|
|
5627
|
-
*
|
|
5628
5629
|
* Searches in the forward direction (backward otherwise)
|
|
5630
|
+
*
|
|
5631
|
+
* @default true
|
|
5629
5632
|
*/
|
|
5630
5633
|
forward?: boolean;
|
|
5631
5634
|
/**
|
|
5632
|
-
* @defaultValue false
|
|
5633
|
-
*
|
|
5634
5635
|
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5636
|
+
*
|
|
5637
|
+
* @default false
|
|
5635
5638
|
*/
|
|
5636
5639
|
findNext?: boolean;
|
|
5637
5640
|
/**
|
|
5638
|
-
* @defaultValue false
|
|
5639
|
-
*
|
|
5640
5641
|
* Enables case-sensitive searching.
|
|
5642
|
+
*
|
|
5643
|
+
* @default false
|
|
5641
5644
|
*/
|
|
5642
5645
|
matchCase?: boolean;
|
|
5643
5646
|
/**
|
|
5644
|
-
* @defaultValue false
|
|
5645
|
-
*
|
|
5646
5647
|
* Only searches from the start of words.
|
|
5648
|
+
*
|
|
5649
|
+
* @default false
|
|
5647
5650
|
*/
|
|
5648
5651
|
wordStart?: boolean;
|
|
5649
5652
|
/**
|
|
5650
|
-
* @defaultValue false
|
|
5651
|
-
*
|
|
5652
5653
|
* When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
|
|
5653
5654
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5655
|
+
*
|
|
5656
|
+
* @default false
|
|
5654
5657
|
*/
|
|
5655
5658
|
medialCapitalAsWordStart?: boolean;
|
|
5656
5659
|
};
|
|
@@ -6164,9 +6167,9 @@ declare type Hotkey = {
|
|
|
6164
6167
|
*/
|
|
6165
6168
|
keys: string;
|
|
6166
6169
|
/**
|
|
6167
|
-
* @defaultValue false
|
|
6168
|
-
*
|
|
6169
6170
|
* Prevent default key handling before emitting the event.
|
|
6171
|
+
*
|
|
6172
|
+
* @default false
|
|
6170
6173
|
*/
|
|
6171
6174
|
preventDefault?: boolean;
|
|
6172
6175
|
};
|
|
@@ -8707,77 +8710,79 @@ declare type LayoutOptions = {
|
|
|
8707
8710
|
*/
|
|
8708
8711
|
settings?: {
|
|
8709
8712
|
/**
|
|
8710
|
-
* @defaultValue false
|
|
8711
|
-
*
|
|
8712
8713
|
* When true the splitters will not be draggable and the layout will not resize.
|
|
8714
|
+
*
|
|
8715
|
+
* @default false
|
|
8713
8716
|
*/
|
|
8714
8717
|
preventSplitterResize?: boolean;
|
|
8715
8718
|
/**
|
|
8716
|
-
* @defaultValue false
|
|
8717
|
-
*
|
|
8718
8719
|
* Whether the popout button will only act on the entire stack,
|
|
8719
8720
|
* as opposed to only the active tab.
|
|
8721
|
+
*
|
|
8722
|
+
* @default false
|
|
8720
8723
|
*/
|
|
8721
8724
|
popoutWholeStack?: boolean;
|
|
8722
8725
|
/**
|
|
8723
|
-
* @defaultValue false
|
|
8724
|
-
*
|
|
8725
8726
|
* Limits the area to which tabs can be dragged.
|
|
8726
8727
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
8728
|
+
*
|
|
8729
|
+
* @default false
|
|
8727
8730
|
*/
|
|
8728
8731
|
constrainDragToContainer?: boolean;
|
|
8729
8732
|
/**
|
|
8730
|
-
* @defaultValue false
|
|
8731
|
-
*
|
|
8732
8733
|
* Whether to show the popout button on stack header.
|
|
8733
8734
|
* The button will create a new window with current tab as its content.
|
|
8734
8735
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
8736
|
+
*
|
|
8737
|
+
* @default false
|
|
8735
8738
|
*/
|
|
8736
8739
|
showPopoutIcon?: boolean;
|
|
8737
8740
|
/**
|
|
8738
|
-
* @defaultValue false
|
|
8739
|
-
*
|
|
8740
8741
|
* Whether to show the maximize button on stack header.
|
|
8741
8742
|
* The button will maximize the current tab to fill the entire window.
|
|
8743
|
+
*
|
|
8744
|
+
* @default false
|
|
8742
8745
|
*/
|
|
8743
8746
|
showMaximiseIcon?: boolean;
|
|
8744
8747
|
/**
|
|
8745
|
-
* @defaultValue false
|
|
8746
|
-
*
|
|
8747
8748
|
* Whether to show the close button on stack header
|
|
8748
8749
|
* (not to be confused with close button on every tab).
|
|
8750
|
+
*
|
|
8751
|
+
* @default false
|
|
8749
8752
|
*/
|
|
8750
8753
|
showCloseIcon?: boolean;
|
|
8751
8754
|
/**
|
|
8752
|
-
* @defaultValue false
|
|
8753
|
-
*
|
|
8754
8755
|
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
8756
|
+
*
|
|
8757
|
+
* @default false
|
|
8755
8758
|
*/
|
|
8756
8759
|
constrainDragToHeaders?: boolean;
|
|
8757
8760
|
/**
|
|
8758
|
-
* @defaultValue true
|
|
8759
|
-
*
|
|
8760
8761
|
* Turns tab headers on or off.
|
|
8761
8762
|
* If false, the layout will be displayed with splitters only.
|
|
8763
|
+
*
|
|
8764
|
+
* @default true
|
|
8762
8765
|
*/
|
|
8763
8766
|
hasHeaders?: boolean;
|
|
8764
8767
|
/**
|
|
8765
|
-
* @defaultValue true
|
|
8766
|
-
*
|
|
8767
8768
|
* If true, the user can re-arrange the layout by
|
|
8768
8769
|
* dragging items by their tabs to the desired location.
|
|
8770
|
+
*
|
|
8771
|
+
* @default true
|
|
8769
8772
|
*/
|
|
8770
8773
|
reorderEnabled?: boolean;
|
|
8771
8774
|
/**
|
|
8772
|
-
* @defaultValue false
|
|
8773
|
-
*
|
|
8774
8775
|
* If true, tabs can't be dragged out of the window.
|
|
8776
|
+
*
|
|
8777
|
+
* @default false
|
|
8775
8778
|
*/
|
|
8776
8779
|
preventDragOut?: boolean;
|
|
8777
8780
|
/**
|
|
8778
8781
|
* @defaultValue=false
|
|
8779
8782
|
*
|
|
8780
8783
|
* If true, tabs can't be dragged into the window.
|
|
8784
|
+
*
|
|
8785
|
+
* @default false
|
|
8781
8786
|
*/
|
|
8782
8787
|
preventDragIn?: boolean;
|
|
8783
8788
|
};
|
|
@@ -9220,10 +9225,10 @@ declare type MutableViewOptions = {
|
|
|
9220
9225
|
/**
|
|
9221
9226
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9222
9227
|
*
|
|
9223
|
-
* @defaultValue true
|
|
9224
|
-
*
|
|
9225
9228
|
* Show the context menu when right-clicking on the view.
|
|
9226
9229
|
* Gives access to the devtools for the view.
|
|
9230
|
+
*
|
|
9231
|
+
* @default true
|
|
9227
9232
|
*/
|
|
9228
9233
|
contextMenu: boolean;
|
|
9229
9234
|
/**
|
|
@@ -9270,24 +9275,25 @@ declare type MutableViewOptions = {
|
|
|
9270
9275
|
contentNavigation: ContentNavigation;
|
|
9271
9276
|
contentRedirect: ContentRedirect;
|
|
9272
9277
|
/**
|
|
9273
|
-
* @defaultValue false
|
|
9274
9278
|
* @deprecated
|
|
9275
9279
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9276
9280
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9281
|
+
*
|
|
9282
|
+
* @default false
|
|
9277
9283
|
*/
|
|
9278
9284
|
detachOnClose: boolean;
|
|
9279
9285
|
/**
|
|
9280
|
-
* @defaultValue true
|
|
9281
|
-
*
|
|
9282
9286
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9283
9287
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9284
9288
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9289
|
+
*
|
|
9290
|
+
* @default true
|
|
9285
9291
|
*/
|
|
9286
9292
|
isClosable: boolean;
|
|
9287
9293
|
/**
|
|
9288
|
-
* @defaultValue false
|
|
9289
|
-
*
|
|
9290
9294
|
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9295
|
+
*
|
|
9296
|
+
* @default false
|
|
9291
9297
|
*/
|
|
9292
9298
|
preventDragOut: boolean;
|
|
9293
9299
|
interop?: InteropConfig;
|
|
@@ -9299,7 +9305,7 @@ declare type MutableViewOptions = {
|
|
|
9299
9305
|
/**
|
|
9300
9306
|
* {@inheritDoc ViewThrottling}
|
|
9301
9307
|
*
|
|
9302
|
-
* @
|
|
9308
|
+
* @default 'enabled'
|
|
9303
9309
|
*/
|
|
9304
9310
|
throttling: ViewThrottling;
|
|
9305
9311
|
/**
|
|
@@ -9318,7 +9324,7 @@ declare type MutableWindowOptions = {
|
|
|
9318
9324
|
* Turns anything of matching RGB value transparent.
|
|
9319
9325
|
*
|
|
9320
9326
|
* Caveats:
|
|
9321
|
-
* *
|
|
9327
|
+
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
|
9322
9328
|
* * User cannot click-through transparent regions
|
|
9323
9329
|
* * Not supported on Mac
|
|
9324
9330
|
* * Windows Aero must be enabled
|
|
@@ -9327,25 +9333,25 @@ declare type MutableWindowOptions = {
|
|
|
9327
9333
|
*/
|
|
9328
9334
|
alphaMask: RGB;
|
|
9329
9335
|
/**
|
|
9330
|
-
* @defaultValue false
|
|
9331
|
-
*
|
|
9332
9336
|
* Always position the window at the top of the window stack.
|
|
9337
|
+
*
|
|
9338
|
+
* @default false
|
|
9333
9339
|
*/
|
|
9334
9340
|
alwaysOnTop: boolean;
|
|
9335
9341
|
/**
|
|
9336
|
-
* @defaultValue 0
|
|
9337
|
-
*
|
|
9338
9342
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9339
9343
|
* an aspect ratio will not be enforced.
|
|
9344
|
+
*
|
|
9345
|
+
* @default 0
|
|
9340
9346
|
*/
|
|
9341
9347
|
aspectRatio: number;
|
|
9342
9348
|
/**
|
|
9343
9349
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9344
9350
|
*
|
|
9345
|
-
* @defaultValue true
|
|
9346
|
-
*
|
|
9347
9351
|
* Show the context menu when right-clicking on the window.
|
|
9348
9352
|
* Gives access to the devtools for the window.
|
|
9353
|
+
*
|
|
9354
|
+
* @default true
|
|
9349
9355
|
*/
|
|
9350
9356
|
contextMenu: boolean;
|
|
9351
9357
|
/**
|
|
@@ -9415,12 +9421,14 @@ declare type MutableWindowOptions = {
|
|
|
9415
9421
|
* @defaultValue true
|
|
9416
9422
|
*
|
|
9417
9423
|
* Show the window's frame.
|
|
9424
|
+
*
|
|
9425
|
+
* @default true
|
|
9418
9426
|
*/
|
|
9419
9427
|
frame: boolean;
|
|
9420
9428
|
/**
|
|
9421
|
-
* @defaultValue false
|
|
9422
|
-
*
|
|
9423
9429
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9430
|
+
*
|
|
9431
|
+
* @default false
|
|
9424
9432
|
*/
|
|
9425
9433
|
hideOnClose: boolean;
|
|
9426
9434
|
/**
|
|
@@ -9473,60 +9481,61 @@ declare type MutableWindowOptions = {
|
|
|
9473
9481
|
*/
|
|
9474
9482
|
icon: string;
|
|
9475
9483
|
/**
|
|
9476
|
-
* @defaultValue true
|
|
9477
|
-
*
|
|
9478
9484
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9479
9485
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9486
|
+
*
|
|
9487
|
+
* @default true
|
|
9480
9488
|
*/
|
|
9481
9489
|
includeInSnapshots: boolean;
|
|
9482
9490
|
/**
|
|
9483
|
-
* @defaultValue -1
|
|
9484
|
-
*
|
|
9485
9491
|
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9492
|
+
*
|
|
9493
|
+
* @default -1
|
|
9486
9494
|
*/
|
|
9487
9495
|
maxHeight: number;
|
|
9488
9496
|
/**
|
|
9489
|
-
* @defaultValue true
|
|
9490
|
-
*
|
|
9491
9497
|
* Allows the window to be maximized.
|
|
9498
|
+
*
|
|
9499
|
+
* @default true
|
|
9492
9500
|
*/
|
|
9493
9501
|
maximizable: boolean;
|
|
9494
9502
|
/**
|
|
9495
|
-
* @defaultValue -1
|
|
9496
|
-
*
|
|
9497
9503
|
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9504
|
+
*
|
|
9505
|
+
* @default -1
|
|
9498
9506
|
*/
|
|
9499
9507
|
maxWidth: number;
|
|
9500
9508
|
/**
|
|
9501
|
-
* @defaultValue 0
|
|
9502
|
-
*
|
|
9503
9509
|
* The minimum height of the window.
|
|
9510
|
+
*
|
|
9511
|
+
* @default 0
|
|
9504
9512
|
*/
|
|
9505
9513
|
minHeight: number;
|
|
9506
9514
|
/**
|
|
9507
|
-
* @defaultValue true
|
|
9508
|
-
*
|
|
9509
9515
|
* Allows the window to be minimized.
|
|
9516
|
+
*
|
|
9517
|
+
* @default true
|
|
9510
9518
|
*/
|
|
9511
9519
|
minimizable: boolean;
|
|
9512
9520
|
/**
|
|
9513
|
-
* @defaultValue true
|
|
9514
|
-
*
|
|
9515
9521
|
* The minimum width of the window.
|
|
9522
|
+
*
|
|
9523
|
+
* @default true
|
|
9516
9524
|
*/
|
|
9517
9525
|
minWidth: number;
|
|
9518
9526
|
/**
|
|
9519
|
-
* @defaultValue 1
|
|
9520
|
-
*
|
|
9521
9527
|
* A flag that specifies how transparent the window will be.
|
|
9522
9528
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9523
9529
|
* This value is clamped between `0.0` and `1.0`.
|
|
9530
|
+
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
9531
|
+
*
|
|
9532
|
+
* @default 1
|
|
9524
9533
|
*/
|
|
9525
9534
|
opacity: number;
|
|
9526
9535
|
/**
|
|
9527
|
-
* @defaultValue true
|
|
9528
|
-
*
|
|
9529
9536
|
* A flag to allow the user to resize the window.
|
|
9537
|
+
*
|
|
9538
|
+
* @default true
|
|
9530
9539
|
*/
|
|
9531
9540
|
resizable: boolean;
|
|
9532
9541
|
/**
|
|
@@ -9534,16 +9543,16 @@ declare type MutableWindowOptions = {
|
|
|
9534
9543
|
*/
|
|
9535
9544
|
resizeRegion: ResizeRegion;
|
|
9536
9545
|
/**
|
|
9537
|
-
* @defaultValue false
|
|
9538
|
-
*
|
|
9539
9546
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9540
9547
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9548
|
+
*
|
|
9549
|
+
* @default false
|
|
9541
9550
|
*/
|
|
9542
9551
|
showBackgroundImages: boolean;
|
|
9543
9552
|
/**
|
|
9544
|
-
* @defaultValue true
|
|
9545
|
-
*
|
|
9546
9553
|
* Shows the window's icon in the taskbar.
|
|
9554
|
+
*
|
|
9555
|
+
* @default true
|
|
9547
9556
|
*/
|
|
9548
9557
|
showTaskbarIcon: boolean;
|
|
9549
9558
|
/**
|
|
@@ -9566,7 +9575,7 @@ declare type MutableWindowOptions = {
|
|
|
9566
9575
|
/**
|
|
9567
9576
|
* {@inheritDoc WindowThrottling}
|
|
9568
9577
|
*
|
|
9569
|
-
* @
|
|
9578
|
+
* @default 'enabled'
|
|
9570
9579
|
*
|
|
9571
9580
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9572
9581
|
*/
|
|
@@ -10185,12 +10194,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
|
10185
10194
|
*/
|
|
10186
10195
|
declare type PastePermissions = {
|
|
10187
10196
|
/**
|
|
10188
|
-
* @defaultValue 'non-protected-content'
|
|
10189
|
-
*
|
|
10190
10197
|
* Controls the behavior for paste operations for a matched URL.
|
|
10191
10198
|
*
|
|
10192
10199
|
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10193
10200
|
* all-content: All matching URLs will be able to paste content copied from both protected (copy.behavior = 'protect') and on-protected (copy.behavior = 'allow') URLs.
|
|
10201
|
+
*
|
|
10202
|
+
* @default 'non-protected-content'
|
|
10194
10203
|
*/
|
|
10195
10204
|
behavior: 'non-protected-content' | 'all-content';
|
|
10196
10205
|
};
|
|
@@ -11255,11 +11264,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11255
11264
|
*/
|
|
11256
11265
|
providerUrl?: string;
|
|
11257
11266
|
/**
|
|
11258
|
-
* @defaultValue true
|
|
11259
|
-
*
|
|
11260
11267
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11261
11268
|
*
|
|
11262
11269
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11270
|
+
*
|
|
11271
|
+
* @default true
|
|
11263
11272
|
*/
|
|
11264
11273
|
allowLaunchIntoPlatform?: boolean;
|
|
11265
11274
|
};
|
|
@@ -11948,22 +11957,22 @@ declare type PopupOptions = {
|
|
|
11948
11957
|
url?: string;
|
|
11949
11958
|
/**
|
|
11950
11959
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
11951
|
-
* @
|
|
11960
|
+
* @default 300
|
|
11952
11961
|
*/
|
|
11953
11962
|
height?: number;
|
|
11954
11963
|
/**
|
|
11955
11964
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
11956
|
-
* @
|
|
11965
|
+
* @default 300
|
|
11957
11966
|
*/
|
|
11958
11967
|
width?: number;
|
|
11959
11968
|
/**
|
|
11960
11969
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
11961
|
-
* @
|
|
11970
|
+
* @default 0
|
|
11962
11971
|
*/
|
|
11963
11972
|
x?: number;
|
|
11964
11973
|
/**
|
|
11965
11974
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
11966
|
-
* @
|
|
11975
|
+
* @default 0
|
|
11967
11976
|
*/
|
|
11968
11977
|
y?: number;
|
|
11969
11978
|
/**
|
|
@@ -11971,7 +11980,7 @@ declare type PopupOptions = {
|
|
|
11971
11980
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
11972
11981
|
* * 'hide' hides the popup window on blur.
|
|
11973
11982
|
* * 'close' closes the popup window on blur.
|
|
11974
|
-
* @
|
|
11983
|
+
* @default 'close'
|
|
11975
11984
|
*/
|
|
11976
11985
|
blurBehavior?: PopupBlurBehavior;
|
|
11977
11986
|
/**
|
|
@@ -11979,19 +11988,19 @@ declare type PopupOptions = {
|
|
|
11979
11988
|
* * 'none' will do nothing.
|
|
11980
11989
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
11981
11990
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
11982
|
-
* @
|
|
11991
|
+
* @default 'close'
|
|
11983
11992
|
*/
|
|
11984
11993
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
11985
11994
|
/**
|
|
11986
11995
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
11987
11996
|
*
|
|
11988
11997
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
11989
|
-
* @
|
|
11998
|
+
* @default false
|
|
11990
11999
|
*/
|
|
11991
12000
|
hideOnClose?: boolean;
|
|
11992
12001
|
/**
|
|
11993
12002
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
11994
|
-
* @
|
|
12003
|
+
* @default true
|
|
11995
12004
|
*/
|
|
11996
12005
|
focus?: boolean;
|
|
11997
12006
|
/**
|
|
@@ -12085,9 +12094,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12085
12094
|
*/
|
|
12086
12095
|
declare type PreloadScript = {
|
|
12087
12096
|
/**
|
|
12088
|
-
* @defaultValue false
|
|
12089
|
-
*
|
|
12090
12097
|
* Fail to load the window if this preload script fails
|
|
12098
|
+
*
|
|
12099
|
+
* @default false
|
|
12091
12100
|
*/
|
|
12092
12101
|
mandatory?: boolean;
|
|
12093
12102
|
/**
|
|
@@ -12183,15 +12192,15 @@ declare type PrinterInfo = {
|
|
|
12183
12192
|
declare type PrintOptions = {
|
|
12184
12193
|
content?: 'self';
|
|
12185
12194
|
/**
|
|
12186
|
-
* @defaultValue false
|
|
12187
|
-
*
|
|
12188
12195
|
* Disables prompting the user for print settings.
|
|
12196
|
+
*
|
|
12197
|
+
* @default false
|
|
12189
12198
|
*/
|
|
12190
12199
|
silent?: boolean;
|
|
12191
12200
|
/**
|
|
12192
|
-
* @defaultValue false
|
|
12193
|
-
*
|
|
12194
12201
|
* Includes the webpage background color and image when printing.
|
|
12202
|
+
*
|
|
12203
|
+
* @default false
|
|
12195
12204
|
*/
|
|
12196
12205
|
printBackground?: boolean;
|
|
12197
12206
|
/**
|
|
@@ -12199,9 +12208,9 @@ declare type PrintOptions = {
|
|
|
12199
12208
|
*/
|
|
12200
12209
|
deviceName?: string;
|
|
12201
12210
|
/**
|
|
12202
|
-
* @defaultValue true
|
|
12203
|
-
*
|
|
12204
12211
|
* Prints in full color (greyscale otherwise).
|
|
12212
|
+
*
|
|
12213
|
+
* @default true
|
|
12205
12214
|
*/
|
|
12206
12215
|
color?: boolean;
|
|
12207
12216
|
/**
|
|
@@ -12209,9 +12218,9 @@ declare type PrintOptions = {
|
|
|
12209
12218
|
*/
|
|
12210
12219
|
margins?: Margins;
|
|
12211
12220
|
/**
|
|
12212
|
-
* @defaultValue true
|
|
12213
|
-
*
|
|
12214
12221
|
* Prints in landscape mode (portrait otherwise).
|
|
12222
|
+
*
|
|
12223
|
+
* @default true
|
|
12215
12224
|
*/
|
|
12216
12225
|
landscape?: boolean;
|
|
12217
12226
|
/**
|
|
@@ -13382,15 +13391,15 @@ declare type ReplaceViewPayload = {
|
|
|
13382
13391
|
*/
|
|
13383
13392
|
declare type ResizeRegion = {
|
|
13384
13393
|
/**
|
|
13385
|
-
* @defaultValue 7
|
|
13386
|
-
*
|
|
13387
13394
|
* The size of the resize region in pixels.
|
|
13395
|
+
*
|
|
13396
|
+
* @default 7
|
|
13388
13397
|
*/
|
|
13389
13398
|
size?: number;
|
|
13390
13399
|
/**
|
|
13391
|
-
* @defaultValue 9
|
|
13392
|
-
*
|
|
13393
13400
|
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13401
|
+
*
|
|
13402
|
+
* @default 9
|
|
13394
13403
|
*/
|
|
13395
13404
|
bottomRightCorner?: number;
|
|
13396
13405
|
/**
|
|
@@ -13398,27 +13407,27 @@ declare type ResizeRegion = {
|
|
|
13398
13407
|
*/
|
|
13399
13408
|
sides?: {
|
|
13400
13409
|
/**
|
|
13401
|
-
* @defaultValue true
|
|
13402
|
-
*
|
|
13403
13410
|
* Enables resizing from the top of the window.
|
|
13411
|
+
*
|
|
13412
|
+
* @default true
|
|
13404
13413
|
*/
|
|
13405
13414
|
top?: boolean;
|
|
13406
13415
|
/**
|
|
13407
|
-
* @defaultValue true
|
|
13408
|
-
*
|
|
13409
13416
|
* Enables resizing from the bottom of the window.
|
|
13417
|
+
*
|
|
13418
|
+
* @default true
|
|
13410
13419
|
*/
|
|
13411
13420
|
bottom?: boolean;
|
|
13412
13421
|
/**
|
|
13413
|
-
* @defaultValue true
|
|
13414
|
-
*
|
|
13415
13422
|
* Enables resizing from the left side of the window.
|
|
13423
|
+
*
|
|
13424
|
+
* @default true
|
|
13416
13425
|
*/
|
|
13417
13426
|
left?: boolean;
|
|
13418
13427
|
/**
|
|
13419
|
-
* @defaultValue true
|
|
13420
|
-
*
|
|
13421
13428
|
* Enables resizing from the right side of the window.
|
|
13429
|
+
*
|
|
13430
|
+
* @default true
|
|
13422
13431
|
*/
|
|
13423
13432
|
right?: boolean;
|
|
13424
13433
|
};
|
|
@@ -13962,9 +13971,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
13962
13971
|
*/
|
|
13963
13972
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
13964
13973
|
/**
|
|
13965
|
-
* @defaultValue 0
|
|
13966
|
-
*
|
|
13967
13974
|
* Number of milliseconds to wait between view repaints.
|
|
13975
|
+
*
|
|
13976
|
+
* @default 0
|
|
13968
13977
|
*/
|
|
13969
13978
|
paintIntervalMs?: number;
|
|
13970
13979
|
};
|
|
@@ -16015,9 +16024,9 @@ declare type TransitionBase = {
|
|
|
16015
16024
|
*/
|
|
16016
16025
|
duration: number;
|
|
16017
16026
|
/**
|
|
16018
|
-
* @defaultValue false
|
|
16019
|
-
*
|
|
16020
16027
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16028
|
+
*
|
|
16029
|
+
* @default false
|
|
16021
16030
|
*/
|
|
16022
16031
|
relative?: boolean;
|
|
16023
16032
|
};
|
|
@@ -16033,9 +16042,9 @@ declare type TransitionOptions = {
|
|
|
16033
16042
|
*/
|
|
16034
16043
|
interrupt: boolean;
|
|
16035
16044
|
/**
|
|
16036
|
-
* @defaultValue false
|
|
16037
|
-
*
|
|
16038
16045
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16046
|
+
*
|
|
16047
|
+
* @default false
|
|
16039
16048
|
*/
|
|
16040
16049
|
relative?: boolean;
|
|
16041
16050
|
tween?: tween;
|
|
@@ -16994,9 +17003,9 @@ declare type ViewThrottling = 'enabled' | 'scheduler-disabled';
|
|
|
16994
17003
|
*/
|
|
16995
17004
|
declare type ViewVisibilityOption = {
|
|
16996
17005
|
/**
|
|
16997
|
-
* @defaultValue false
|
|
16998
|
-
*
|
|
16999
17006
|
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17007
|
+
*
|
|
17008
|
+
* @default false
|
|
17000
17009
|
*/
|
|
17001
17010
|
enabled?: boolean;
|
|
17002
17011
|
};
|