@openfin/core 41.102.5 → 41.102.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 +237 -199
- package/out/mock-beta.d.ts +237 -199
- package/out/mock-public.d.ts +237 -199
- package/out/stub.d.ts +237 -199
- package/package.json +1 -1
package/out/stub.d.ts
CHANGED
|
@@ -133,13 +133,13 @@ declare type ApiSettings = {
|
|
|
133
133
|
/**
|
|
134
134
|
* Inject OpenFin API into cross-origin iframes
|
|
135
135
|
*
|
|
136
|
-
* @
|
|
136
|
+
* @default false
|
|
137
137
|
*/
|
|
138
138
|
crossOriginInjection?: boolean;
|
|
139
139
|
/**
|
|
140
140
|
* Inject OpenFin API into same-origin iframes
|
|
141
141
|
*
|
|
142
|
-
* @
|
|
142
|
+
* @default true
|
|
143
143
|
*/
|
|
144
144
|
sameOriginInjection?: boolean;
|
|
145
145
|
/**
|
|
@@ -1184,19 +1184,19 @@ declare class ApplicationModule extends Base {
|
|
|
1184
1184
|
*/
|
|
1185
1185
|
declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
1186
1186
|
/**
|
|
1187
|
-
* @defaultValue false
|
|
1188
|
-
*
|
|
1189
1187
|
* Disables IAB secure logging for the app.
|
|
1188
|
+
*
|
|
1189
|
+
* @default false
|
|
1190
1190
|
*/
|
|
1191
1191
|
disableIabSecureLogging: boolean;
|
|
1192
1192
|
/**
|
|
1193
|
-
* @defaultValue 'There was an error loading the application.'
|
|
1194
|
-
*
|
|
1195
1193
|
* An error message to display when the application (launched via manifest) fails to load.
|
|
1196
1194
|
* A dialog box will be launched with the error message just before the runtime exits.
|
|
1197
1195
|
* Load fails such as failed DNS resolutions or aborted connections as well as cancellations, _e.g.,_ `window.stop()`,
|
|
1198
1196
|
* will trigger this dialog.
|
|
1199
1197
|
* Client response codes such as `404 Not Found` are not treated as fails as they are valid server responses.
|
|
1198
|
+
*
|
|
1199
|
+
* @default 'There was an error loading the application.'
|
|
1200
1200
|
*/
|
|
1201
1201
|
loadErrorMessage: string;
|
|
1202
1202
|
/**
|
|
@@ -1215,28 +1215,28 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1215
1215
|
*/
|
|
1216
1216
|
name: string;
|
|
1217
1217
|
/**
|
|
1218
|
-
* @defaultValue false
|
|
1219
|
-
*
|
|
1220
1218
|
* A flag to configure the application as non-persistent.
|
|
1221
1219
|
* Runtime exits when there are no persistent apps running.
|
|
1220
|
+
*
|
|
1221
|
+
* @default false
|
|
1222
1222
|
*/
|
|
1223
1223
|
nonPersistent: boolean;
|
|
1224
1224
|
/**
|
|
1225
|
-
* @defaultValue false
|
|
1226
|
-
*
|
|
1227
1225
|
* Enable Flash at the application level.
|
|
1226
|
+
*
|
|
1227
|
+
* @default false
|
|
1228
1228
|
*/
|
|
1229
1229
|
plugins: boolean;
|
|
1230
1230
|
/**
|
|
1231
|
-
* @defaultValue false
|
|
1232
|
-
*
|
|
1233
1231
|
* Enable spell check at the application level.
|
|
1232
|
+
*
|
|
1233
|
+
* @default false
|
|
1234
1234
|
*/
|
|
1235
1235
|
spellCheck: boolean;
|
|
1236
1236
|
/**
|
|
1237
|
-
* @defaultValue 'about:blank'
|
|
1238
|
-
*
|
|
1239
1237
|
* The url to the application (specifically the application's main window).
|
|
1238
|
+
*
|
|
1239
|
+
* @default 'about:blank'
|
|
1240
1240
|
*/
|
|
1241
1241
|
url: string;
|
|
1242
1242
|
/**
|
|
@@ -1245,9 +1245,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1245
1245
|
*/
|
|
1246
1246
|
uuid: string;
|
|
1247
1247
|
/**
|
|
1248
|
-
* @defaultValue true
|
|
1249
|
-
*
|
|
1250
1248
|
* When set to `false` it will disable the same-origin policy for the app.
|
|
1249
|
+
*
|
|
1250
|
+
* @default true
|
|
1251
1251
|
*/
|
|
1252
1252
|
webSecurity: boolean;
|
|
1253
1253
|
/**
|
|
@@ -1257,10 +1257,10 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1257
1257
|
commands: ShortcutOverride[];
|
|
1258
1258
|
isPlatformController: boolean;
|
|
1259
1259
|
/**
|
|
1260
|
-
* @defaultValue 1000
|
|
1261
|
-
*
|
|
1262
1260
|
* **Platforms Only.** The maximum number of "detached" or "pooled" Views that can exist in the Platform before being closed.
|
|
1263
1261
|
* If you do not wish for views to be pooled on your platform, set this property to zero.
|
|
1262
|
+
*
|
|
1263
|
+
* @default 1000
|
|
1264
1264
|
*/
|
|
1265
1265
|
maxViewPoolSize: number;
|
|
1266
1266
|
/**
|
|
@@ -1276,12 +1276,12 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1276
1276
|
*/
|
|
1277
1277
|
snapshot: Snapshot;
|
|
1278
1278
|
/**
|
|
1279
|
-
* @defaultValue false
|
|
1280
|
-
*
|
|
1281
1279
|
* **Platforms Only.** Prevent the Platform Provider from quitting automatically when the last Platform Window is closed.
|
|
1282
1280
|
*
|
|
1283
1281
|
* Note: if the Platform Provider is showing, it won't close automatically.
|
|
1284
1282
|
* If you want a hidden Platform Provider to remain open after the last Platform Window has been closed, set this property to true.
|
|
1283
|
+
*
|
|
1284
|
+
* @default false
|
|
1285
1285
|
*/
|
|
1286
1286
|
preventQuitOnLastWindowClosed: boolean;
|
|
1287
1287
|
/**
|
|
@@ -1289,9 +1289,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1289
1289
|
*/
|
|
1290
1290
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
1291
1291
|
/**
|
|
1292
|
-
* @defaultValue true
|
|
1293
|
-
*
|
|
1294
1292
|
* When set to `false` it will disable OpenFin Diagnostics for the app.
|
|
1293
|
+
*
|
|
1294
|
+
* @default true
|
|
1295
1295
|
*/
|
|
1296
1296
|
apiDiagnostics: boolean;
|
|
1297
1297
|
/**
|
|
@@ -1307,16 +1307,16 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
|
|
|
1307
1307
|
*/
|
|
1308
1308
|
permissions?: Partial<Permissions_2>;
|
|
1309
1309
|
/**
|
|
1310
|
-
* @defaultValue false
|
|
1311
|
-
*
|
|
1312
1310
|
* Enables the use of the Jumplists API and the 'pin to taskbar' functionality.
|
|
1313
1311
|
* Only relevant in Windows.
|
|
1312
|
+
*
|
|
1313
|
+
* @default false
|
|
1314
1314
|
*/
|
|
1315
1315
|
enableJumpList: boolean;
|
|
1316
1316
|
/**
|
|
1317
|
-
* @defaultValue false
|
|
1318
|
-
*
|
|
1319
1317
|
* When set to `true`, any `beforeunload` handler set on the app will fire.
|
|
1318
|
+
*
|
|
1319
|
+
* @default false
|
|
1320
1320
|
*/
|
|
1321
1321
|
enableBeforeUnload: boolean;
|
|
1322
1322
|
/**
|
|
@@ -1397,25 +1397,25 @@ declare type ApplicationWindowInfo = {
|
|
|
1397
1397
|
*/
|
|
1398
1398
|
declare type ApplySnapshotOptions = {
|
|
1399
1399
|
/**
|
|
1400
|
-
* @defaultValue false
|
|
1401
|
-
*
|
|
1402
1400
|
* When true, applySnapshot will close existing windows,
|
|
1403
1401
|
* replacing current Platform state with the given snapshot.
|
|
1402
|
+
*
|
|
1403
|
+
* @default false
|
|
1404
1404
|
*/
|
|
1405
1405
|
closeExistingWindows?: boolean;
|
|
1406
1406
|
/**
|
|
1407
|
-
* @defaultValue false
|
|
1408
|
-
*
|
|
1409
1407
|
* When true, applySnapshot will close existing includeInSnapshots: true windows,
|
|
1410
1408
|
* replacing current Platform state with the given snapshot.
|
|
1409
|
+
*
|
|
1410
|
+
* @default false
|
|
1411
1411
|
*/
|
|
1412
1412
|
closeSnapshotWindows?: boolean;
|
|
1413
1413
|
/**
|
|
1414
|
-
* @defaultValue false
|
|
1415
|
-
*
|
|
1416
1414
|
* When true, applySnapshot will not check whether any windows in a
|
|
1417
1415
|
* snapshot are off-screen. By default, such windows will be repositioned to be on-screen,
|
|
1418
1416
|
* as defined by {@link PlatformProvider#positionOutOfBoundsWindows PlatformProvider.positionOutOfBoundsWindows}.
|
|
1417
|
+
*
|
|
1418
|
+
* @default false
|
|
1419
1419
|
*/
|
|
1420
1420
|
skipOutOfBoundsCheck?: boolean;
|
|
1421
1421
|
};
|
|
@@ -2098,15 +2098,15 @@ declare type CapturePageOptions = {
|
|
|
2098
2098
|
*/
|
|
2099
2099
|
area?: Rectangle;
|
|
2100
2100
|
/**
|
|
2101
|
-
* @defaultValue 'png'
|
|
2102
|
-
*
|
|
2103
2101
|
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
2102
|
+
*
|
|
2103
|
+
* @default 'png'
|
|
2104
2104
|
*/
|
|
2105
2105
|
format?: 'bmp' | 'jpg' | 'png';
|
|
2106
2106
|
/**
|
|
2107
|
-
* @defaultValue 100
|
|
2108
|
-
*
|
|
2109
2107
|
* Quality of JPEG image. Between 0 - 100.
|
|
2108
|
+
*
|
|
2109
|
+
* @default 100
|
|
2110
2110
|
*/
|
|
2111
2111
|
quality?: number;
|
|
2112
2112
|
};
|
|
@@ -2760,9 +2760,9 @@ declare type ChannelClientDisconnectionListener = (identity: ClientIdentity) =>
|
|
|
2760
2760
|
*/
|
|
2761
2761
|
declare type ChannelConnectOptions = ChannelCreateOptions & {
|
|
2762
2762
|
/**
|
|
2763
|
-
* @defaultValue true
|
|
2764
|
-
*
|
|
2765
2763
|
* If true will wait for ChannelProvider to connect. If false will fail if ChannelProvider is not found.
|
|
2764
|
+
*
|
|
2765
|
+
* @default true
|
|
2766
2766
|
*/
|
|
2767
2767
|
wait?: boolean;
|
|
2768
2768
|
/**
|
|
@@ -3059,6 +3059,10 @@ declare type ChromiumPolicies = {
|
|
|
3059
3059
|
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
3060
3060
|
*/
|
|
3061
3061
|
AutofillAddressEnabled?: PolicyOptions;
|
|
3062
|
+
/**
|
|
3063
|
+
* Disable AutofillCreditCardEnabled policy for a Window or View.
|
|
3064
|
+
*/
|
|
3065
|
+
AutofillCreditCardEnabled?: PolicyOptions;
|
|
3062
3066
|
};
|
|
3063
3067
|
|
|
3064
3068
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
@@ -3424,9 +3428,9 @@ declare interface CloseWindowPayload {
|
|
|
3424
3428
|
windowId: Identity_4;
|
|
3425
3429
|
options: {
|
|
3426
3430
|
/**
|
|
3427
|
-
* @defaultValue false
|
|
3428
|
-
*
|
|
3429
3431
|
* When set to true skips any before handler set on views that are part of the window
|
|
3432
|
+
*
|
|
3433
|
+
* @default false
|
|
3430
3434
|
*/
|
|
3431
3435
|
skipBeforeUnload?: boolean;
|
|
3432
3436
|
};
|
|
@@ -3534,9 +3538,9 @@ declare type ConstViewOptions = {
|
|
|
3534
3538
|
*/
|
|
3535
3539
|
name: string;
|
|
3536
3540
|
/**
|
|
3537
|
-
* @defaultValue "about:blank"
|
|
3538
|
-
*
|
|
3539
3541
|
* The URL of the window
|
|
3542
|
+
*
|
|
3543
|
+
* @default "about:blank"
|
|
3540
3544
|
*/
|
|
3541
3545
|
url: string;
|
|
3542
3546
|
/**
|
|
@@ -3561,6 +3565,15 @@ declare type ConstViewOptions = {
|
|
|
3561
3565
|
* Custom headers for requests sent by the view.
|
|
3562
3566
|
*/
|
|
3563
3567
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3568
|
+
/**
|
|
3569
|
+
* @experimental
|
|
3570
|
+
*
|
|
3571
|
+
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the view.
|
|
3572
|
+
* These css properties are used to enable dragging of a frameless window.
|
|
3573
|
+
*
|
|
3574
|
+
* @default false
|
|
3575
|
+
*/
|
|
3576
|
+
disableAppRegion: boolean;
|
|
3564
3577
|
/**
|
|
3565
3578
|
* Initial bounds given relative to the window.
|
|
3566
3579
|
*/
|
|
@@ -3597,9 +3610,9 @@ declare type ConstViewOptions = {
|
|
|
3597
3610
|
experimental: any;
|
|
3598
3611
|
fdc3InteropApi?: string;
|
|
3599
3612
|
/**
|
|
3600
|
-
* @defaultValue false
|
|
3601
|
-
*
|
|
3602
3613
|
* When set to `true`, any `beforeunload` handler set on Views will fire.
|
|
3614
|
+
*
|
|
3615
|
+
* @default false
|
|
3603
3616
|
*/
|
|
3604
3617
|
enableBeforeUnload: boolean;
|
|
3605
3618
|
/**
|
|
@@ -3680,13 +3693,12 @@ declare type ConstWindowOptions = {
|
|
|
3680
3693
|
*/
|
|
3681
3694
|
backgroundColor: string;
|
|
3682
3695
|
/**
|
|
3683
|
-
* @defaultValue false
|
|
3684
|
-
*
|
|
3685
3696
|
* Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
|
|
3686
3697
|
* This also affects the Page Visibility API.
|
|
3687
3698
|
*
|
|
3688
3699
|
* When `true`, the page is throttled whether it is hidden or not.
|
|
3689
3700
|
*
|
|
3701
|
+
* @default false
|
|
3690
3702
|
*/
|
|
3691
3703
|
backgroundThrottling: boolean;
|
|
3692
3704
|
/**
|
|
@@ -3710,21 +3722,30 @@ declare type ConstWindowOptions = {
|
|
|
3710
3722
|
*/
|
|
3711
3723
|
customRequestHeaders: CustomRequestHeaders[];
|
|
3712
3724
|
/**
|
|
3713
|
-
* @defaultValue true
|
|
3714
|
-
*
|
|
3715
3725
|
* Setting this to false would keep the Window alive even if all its Views were closed.
|
|
3716
3726
|
* This is meant for advanced users and should be used with caution.
|
|
3717
3727
|
* Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
|
|
3718
3728
|
* Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
|
|
3719
3729
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3730
|
+
*
|
|
3731
|
+
* @default true
|
|
3720
3732
|
*/
|
|
3721
3733
|
closeOnLastViewRemoved: boolean;
|
|
3722
3734
|
/**
|
|
3723
|
-
* @
|
|
3735
|
+
* @experimental
|
|
3724
3736
|
*
|
|
3737
|
+
* When set to true, will prevent setting the `-webkit-app-region` and `app-region` css properties on the window.
|
|
3738
|
+
* These css properties are used to enable dragging of a frameless window.
|
|
3739
|
+
*
|
|
3740
|
+
* @default false
|
|
3741
|
+
*/
|
|
3742
|
+
disableAppRegion: boolean;
|
|
3743
|
+
/**
|
|
3725
3744
|
* When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
|
|
3726
|
-
|
|
3745
|
+
* Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
|
|
3727
3746
|
* **NOTE:** - This option is ignored in non-Platforms apps.
|
|
3747
|
+
*
|
|
3748
|
+
* @default 'all'
|
|
3728
3749
|
*/
|
|
3729
3750
|
viewsPreventingClose: 'all' | 'layout';
|
|
3730
3751
|
/**
|
|
@@ -3735,31 +3756,31 @@ declare type ConstWindowOptions = {
|
|
|
3735
3756
|
*/
|
|
3736
3757
|
defaultCentered: boolean;
|
|
3737
3758
|
/**
|
|
3738
|
-
* @defaultValue 500
|
|
3739
|
-
*
|
|
3740
3759
|
* The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
|
|
3741
3760
|
* in favor of the cached value.
|
|
3761
|
+
*
|
|
3762
|
+
* @default 500
|
|
3742
3763
|
*/
|
|
3743
3764
|
defaultHeight: number;
|
|
3744
3765
|
/**
|
|
3745
|
-
* @defaultValue 100
|
|
3746
|
-
*
|
|
3747
3766
|
* The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3748
3767
|
* launches in favor of the cached value.
|
|
3768
|
+
*
|
|
3769
|
+
* @default 100
|
|
3749
3770
|
*/
|
|
3750
3771
|
defaultLeft: number;
|
|
3751
3772
|
/**
|
|
3752
|
-
* @defaultValue 100
|
|
3753
|
-
*
|
|
3754
3773
|
* The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3755
3774
|
* launches in favor of the cached value.
|
|
3775
|
+
*
|
|
3776
|
+
* @default 100
|
|
3756
3777
|
*/
|
|
3757
3778
|
defaultTop: number;
|
|
3758
3779
|
/**
|
|
3759
|
-
* @defaultValue 800
|
|
3760
|
-
*
|
|
3761
3780
|
* The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
|
|
3762
3781
|
* launches in favor of the cached value.
|
|
3782
|
+
*
|
|
3783
|
+
* @default 800
|
|
3763
3784
|
*/
|
|
3764
3785
|
defaultWidth: number;
|
|
3765
3786
|
/**
|
|
@@ -3805,19 +3826,19 @@ declare type ConstWindowOptions = {
|
|
|
3805
3826
|
*/
|
|
3806
3827
|
processAffinity: string;
|
|
3807
3828
|
/**
|
|
3808
|
-
* @defaultValue false
|
|
3809
|
-
*
|
|
3810
3829
|
* Displays a shadow on frameless windows.
|
|
3811
3830
|
* `shadow` and `cornerRounding` are mutually exclusive.
|
|
3812
3831
|
* On Windows 7, Aero theme is required.
|
|
3832
|
+
*
|
|
3833
|
+
* @default false
|
|
3813
3834
|
*/
|
|
3814
3835
|
shadow: boolean;
|
|
3815
3836
|
/**
|
|
3816
|
-
* @defaultValue true
|
|
3817
|
-
*
|
|
3818
3837
|
* Caches the location of the window.
|
|
3819
3838
|
*
|
|
3820
3839
|
* Note: this option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
|
|
3840
|
+
*
|
|
3841
|
+
* @default true
|
|
3821
3842
|
*/
|
|
3822
3843
|
saveWindowState: boolean;
|
|
3823
3844
|
/**
|
|
@@ -3826,22 +3847,22 @@ declare type ConstWindowOptions = {
|
|
|
3826
3847
|
*/
|
|
3827
3848
|
ignoreSavedWindowState: boolean;
|
|
3828
3849
|
/**
|
|
3829
|
-
* @defaultValue false
|
|
3830
|
-
*
|
|
3831
3850
|
* Makes this window a frameless window that can be created and resized to less than 41x36 px (width x height).
|
|
3832
3851
|
*
|
|
3833
3852
|
* Note: Caveats of small windows are no Aero Snap and drag to/from maximize.
|
|
3834
3853
|
* _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
|
|
3854
|
+
*
|
|
3855
|
+
* @default false
|
|
3835
3856
|
*/
|
|
3836
3857
|
smallWindow: boolean;
|
|
3837
3858
|
/**
|
|
3838
|
-
* @defaultValue "normal"
|
|
3839
|
-
*
|
|
3840
3859
|
* The visible state of the window on creation.
|
|
3841
3860
|
* One of:
|
|
3842
3861
|
* * `"maximized"`
|
|
3843
3862
|
* * `"minimized"`
|
|
3844
3863
|
* * `"normal"`
|
|
3864
|
+
*
|
|
3865
|
+
* @default "normal"
|
|
3845
3866
|
*/
|
|
3846
3867
|
state: WindowState;
|
|
3847
3868
|
/**
|
|
@@ -3856,26 +3877,26 @@ declare type ConstWindowOptions = {
|
|
|
3856
3877
|
*/
|
|
3857
3878
|
taskbarIconGroup: string;
|
|
3858
3879
|
/**
|
|
3859
|
-
* @defaultValue "about:blank"
|
|
3860
|
-
*
|
|
3861
3880
|
* The URL of the window
|
|
3881
|
+
*
|
|
3882
|
+
* @default "about:blank"
|
|
3862
3883
|
*/
|
|
3863
3884
|
url: string;
|
|
3864
3885
|
/**
|
|
3865
|
-
* @defaultValue <application UUID>
|
|
3866
|
-
*
|
|
3867
3886
|
* The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
|
|
3868
3887
|
* If omitted, defaults to the `uuid` of the application spawning the window.
|
|
3869
3888
|
* If given, must match the `uuid` of the application spawning the window.
|
|
3870
3889
|
* In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
|
|
3871
3890
|
* really no need to provide it.
|
|
3891
|
+
*
|
|
3892
|
+
* @default <application UUID>
|
|
3872
3893
|
*/
|
|
3873
3894
|
uuid: string;
|
|
3874
3895
|
/**
|
|
3875
|
-
* @defaultValue false
|
|
3876
|
-
*
|
|
3877
3896
|
* When set to `true`, the window will not appear until the `window` object's `load` event fires.
|
|
3878
3897
|
* When set to `false`, the window will appear immediately without waiting for content to be loaded.
|
|
3898
|
+
*
|
|
3899
|
+
* @default false
|
|
3879
3900
|
*/
|
|
3880
3901
|
waitForPageLoad: boolean;
|
|
3881
3902
|
width: number;
|
|
@@ -3895,6 +3916,10 @@ declare type ConstWindowOptions = {
|
|
|
3895
3916
|
* Control which options to ignore when creating a Platform Window.
|
|
3896
3917
|
*/
|
|
3897
3918
|
excludeOptions: ExcludeOptions;
|
|
3919
|
+
/**
|
|
3920
|
+
* Controls whether frameless window should have rounded corners. Default is false for Windows and true for MacOS. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
|
|
3921
|
+
*/
|
|
3922
|
+
roundedCorners: boolean;
|
|
3898
3923
|
};
|
|
3899
3924
|
|
|
3900
3925
|
/**
|
|
@@ -4157,13 +4182,13 @@ declare type CopyBlockedEventReason = 'disabled';
|
|
|
4157
4182
|
*/
|
|
4158
4183
|
declare type CopyPermissions = {
|
|
4159
4184
|
/**
|
|
4160
|
-
* @defaultValue 'allowed'
|
|
4161
|
-
*
|
|
4162
4185
|
* Controls the behavior for copy operations for a matched URL.
|
|
4163
4186
|
*
|
|
4164
4187
|
* allow: Enables all copy operations.
|
|
4165
4188
|
* block: Disables all copy operations.
|
|
4166
4189
|
* protect: Protects any copied content. Only URLs that have set paste.behavior: 'all-content' will be allowed to paste this content.
|
|
4190
|
+
*
|
|
4191
|
+
* @default 'allowed'
|
|
4167
4192
|
*/
|
|
4168
4193
|
behavior: 'allow' | 'block' | 'protect';
|
|
4169
4194
|
/**
|
|
@@ -4171,9 +4196,9 @@ declare type CopyPermissions = {
|
|
|
4171
4196
|
*/
|
|
4172
4197
|
options?: {
|
|
4173
4198
|
/**
|
|
4174
|
-
* @defaultValue ''
|
|
4175
|
-
*
|
|
4176
4199
|
* When setting behavior = 'protected' , this string will be pasted to other applications that do not have a matching URL instead of the original content.
|
|
4200
|
+
*
|
|
4201
|
+
* @default ''
|
|
4177
4202
|
*/
|
|
4178
4203
|
replacementText: string;
|
|
4179
4204
|
};
|
|
@@ -4187,15 +4212,15 @@ declare type CopyPermissions = {
|
|
|
4187
4212
|
*/
|
|
4188
4213
|
declare type CornerRounding = {
|
|
4189
4214
|
/**
|
|
4190
|
-
* @defaultValue 0
|
|
4191
|
-
*
|
|
4192
4215
|
* The height in pixels.
|
|
4216
|
+
*
|
|
4217
|
+
* @default 0
|
|
4193
4218
|
*/
|
|
4194
4219
|
height: number;
|
|
4195
4220
|
/**
|
|
4196
|
-
* @defaultValue 0
|
|
4197
|
-
*
|
|
4198
4221
|
* The width in pixels.
|
|
4222
|
+
*
|
|
4223
|
+
* @default 0
|
|
4199
4224
|
*/
|
|
4200
4225
|
width: number;
|
|
4201
4226
|
};
|
|
@@ -4285,8 +4310,6 @@ declare type CreateLayoutOptions = {
|
|
|
4285
4310
|
layoutName: string;
|
|
4286
4311
|
layout: LayoutOptions;
|
|
4287
4312
|
/**
|
|
4288
|
-
* @defaultValue 'default'
|
|
4289
|
-
*
|
|
4290
4313
|
* Controls the View behavior for the given `layout` property. Note
|
|
4291
4314
|
* that the selected behavior only applies to unnamed Views or
|
|
4292
4315
|
* Views with the prefix `internal-generated-`. In all cases, if any
|
|
@@ -4308,6 +4331,8 @@ declare type CreateLayoutOptions = {
|
|
|
4308
4331
|
* override. Note that during applyLayoutSnapshot, Views are created and
|
|
4309
4332
|
* attached to the Provider while the Window is being created, so it's
|
|
4310
4333
|
* important to not 'duplicate' Views in this workflow.
|
|
4334
|
+
*
|
|
4335
|
+
* @default 'default'
|
|
4311
4336
|
*/
|
|
4312
4337
|
multiInstanceViewBehavior?: MultiInstanceViewBehavior;
|
|
4313
4338
|
};
|
|
@@ -4566,7 +4591,7 @@ declare type DomainApiSettings = {
|
|
|
4566
4591
|
* * 'none': The `fin` API will be not available.
|
|
4567
4592
|
* * 'global': The entire `fin` API will be available.
|
|
4568
4593
|
*
|
|
4569
|
-
* @
|
|
4594
|
+
* @default 'global'
|
|
4570
4595
|
*/
|
|
4571
4596
|
fin?: InjectionType;
|
|
4572
4597
|
/**
|
|
@@ -5165,9 +5190,9 @@ declare type EventWithId<Event extends AppVersionEvent> = Event extends infer E
|
|
|
5165
5190
|
*/
|
|
5166
5191
|
declare type ExcludeOptions = {
|
|
5167
5192
|
/**
|
|
5168
|
-
* @defaultValue false
|
|
5169
|
-
*
|
|
5170
5193
|
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
5194
|
+
*
|
|
5195
|
+
* @default false
|
|
5171
5196
|
*/
|
|
5172
5197
|
preloadScripts: boolean;
|
|
5173
5198
|
};
|
|
@@ -5653,34 +5678,34 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
|
|
|
5653
5678
|
*/
|
|
5654
5679
|
declare type FindInPageOptions = {
|
|
5655
5680
|
/**
|
|
5656
|
-
* @defaultValue true
|
|
5657
|
-
*
|
|
5658
5681
|
* Searches in the forward direction (backward otherwise)
|
|
5682
|
+
*
|
|
5683
|
+
* @default true
|
|
5659
5684
|
*/
|
|
5660
5685
|
forward?: boolean;
|
|
5661
5686
|
/**
|
|
5662
|
-
* @defaultValue false
|
|
5663
|
-
*
|
|
5664
5687
|
* Begins a new text-finding session; should be true for first request only, and false on subsequent requests.
|
|
5688
|
+
*
|
|
5689
|
+
* @default false
|
|
5665
5690
|
*/
|
|
5666
5691
|
findNext?: boolean;
|
|
5667
5692
|
/**
|
|
5668
|
-
* @defaultValue false
|
|
5669
|
-
*
|
|
5670
5693
|
* Enables case-sensitive searching.
|
|
5694
|
+
*
|
|
5695
|
+
* @default false
|
|
5671
5696
|
*/
|
|
5672
5697
|
matchCase?: boolean;
|
|
5673
5698
|
/**
|
|
5674
|
-
* @defaultValue false
|
|
5675
|
-
*
|
|
5676
5699
|
* Only searches from the start of words.
|
|
5700
|
+
*
|
|
5701
|
+
* @default false
|
|
5677
5702
|
*/
|
|
5678
5703
|
wordStart?: boolean;
|
|
5679
5704
|
/**
|
|
5680
|
-
* @defaultValue false
|
|
5681
|
-
*
|
|
5682
5705
|
* 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>
|
|
5683
5706
|
* lowercase or non-letter. Accepts several other intra-word matches.
|
|
5707
|
+
*
|
|
5708
|
+
* @default false
|
|
5684
5709
|
*/
|
|
5685
5710
|
medialCapitalAsWordStart?: boolean;
|
|
5686
5711
|
};
|
|
@@ -6194,9 +6219,9 @@ declare type Hotkey = {
|
|
|
6194
6219
|
*/
|
|
6195
6220
|
keys: string;
|
|
6196
6221
|
/**
|
|
6197
|
-
* @defaultValue false
|
|
6198
|
-
*
|
|
6199
6222
|
* Prevent default key handling before emitting the event.
|
|
6223
|
+
*
|
|
6224
|
+
* @default false
|
|
6200
6225
|
*/
|
|
6201
6226
|
preventDefault?: boolean;
|
|
6202
6227
|
};
|
|
@@ -8758,77 +8783,79 @@ declare type LayoutOptions = {
|
|
|
8758
8783
|
*/
|
|
8759
8784
|
newTabButtonUrl?: string;
|
|
8760
8785
|
/**
|
|
8761
|
-
* @defaultValue false
|
|
8762
|
-
*
|
|
8763
8786
|
* When true the splitters will not be draggable and the layout will not resize.
|
|
8787
|
+
*
|
|
8788
|
+
* @default false
|
|
8764
8789
|
*/
|
|
8765
8790
|
preventSplitterResize?: boolean;
|
|
8766
8791
|
/**
|
|
8767
|
-
* @defaultValue false
|
|
8768
|
-
*
|
|
8769
8792
|
* Whether the popout button will only act on the entire stack,
|
|
8770
8793
|
* as opposed to only the active tab.
|
|
8794
|
+
*
|
|
8795
|
+
* @default false
|
|
8771
8796
|
*/
|
|
8772
8797
|
popoutWholeStack?: boolean;
|
|
8773
8798
|
/**
|
|
8774
|
-
* @defaultValue false
|
|
8775
|
-
*
|
|
8776
8799
|
* Limits the area to which tabs can be dragged.
|
|
8777
8800
|
* If true, the layout container is the only area where tabs can be dropped.
|
|
8801
|
+
*
|
|
8802
|
+
* @default false
|
|
8778
8803
|
*/
|
|
8779
8804
|
constrainDragToContainer?: boolean;
|
|
8780
8805
|
/**
|
|
8781
|
-
* @defaultValue false
|
|
8782
|
-
*
|
|
8783
8806
|
* Whether to show the popout button on stack header.
|
|
8784
8807
|
* The button will create a new window with current tab as its content.
|
|
8785
8808
|
* In case `popoutWholeStack` is set to true, all tabs in the stack will be in the new window.
|
|
8809
|
+
*
|
|
8810
|
+
* @default false
|
|
8786
8811
|
*/
|
|
8787
8812
|
showPopoutIcon?: boolean;
|
|
8788
8813
|
/**
|
|
8789
|
-
* @defaultValue false
|
|
8790
|
-
*
|
|
8791
8814
|
* Whether to show the maximize button on stack header.
|
|
8792
8815
|
* The button will maximize the current tab to fill the entire window.
|
|
8816
|
+
*
|
|
8817
|
+
* @default false
|
|
8793
8818
|
*/
|
|
8794
8819
|
showMaximiseIcon?: boolean;
|
|
8795
8820
|
/**
|
|
8796
|
-
* @defaultValue false
|
|
8797
|
-
*
|
|
8798
8821
|
* Whether to show the close button on stack header
|
|
8799
8822
|
* (not to be confused with close button on every tab).
|
|
8823
|
+
*
|
|
8824
|
+
* @default false
|
|
8800
8825
|
*/
|
|
8801
8826
|
showCloseIcon?: boolean;
|
|
8802
8827
|
/**
|
|
8803
|
-
* @defaultValue false
|
|
8804
|
-
*
|
|
8805
8828
|
* Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
|
|
8829
|
+
*
|
|
8830
|
+
* @default false
|
|
8806
8831
|
*/
|
|
8807
8832
|
constrainDragToHeaders?: boolean;
|
|
8808
8833
|
/**
|
|
8809
|
-
* @defaultValue true
|
|
8810
|
-
*
|
|
8811
8834
|
* Turns tab headers on or off.
|
|
8812
8835
|
* If false, the layout will be displayed with splitters only.
|
|
8836
|
+
*
|
|
8837
|
+
* @default true
|
|
8813
8838
|
*/
|
|
8814
8839
|
hasHeaders?: boolean;
|
|
8815
8840
|
/**
|
|
8816
|
-
* @defaultValue true
|
|
8817
|
-
*
|
|
8818
8841
|
* If true, the user can re-arrange the layout by
|
|
8819
8842
|
* dragging items by their tabs to the desired location.
|
|
8843
|
+
*
|
|
8844
|
+
* @default true
|
|
8820
8845
|
*/
|
|
8821
8846
|
reorderEnabled?: boolean;
|
|
8822
8847
|
/**
|
|
8823
|
-
* @defaultValue false
|
|
8824
|
-
*
|
|
8825
8848
|
* If true, tabs can't be dragged out of the window.
|
|
8849
|
+
*
|
|
8850
|
+
* @default false
|
|
8826
8851
|
*/
|
|
8827
8852
|
preventDragOut?: boolean;
|
|
8828
8853
|
/**
|
|
8829
8854
|
* @defaultValue=false
|
|
8830
8855
|
*
|
|
8831
8856
|
* If true, tabs can't be dragged into the window.
|
|
8857
|
+
*
|
|
8858
|
+
* @default false
|
|
8832
8859
|
*/
|
|
8833
8860
|
preventDragIn?: boolean;
|
|
8834
8861
|
};
|
|
@@ -9280,10 +9307,10 @@ declare type MutableViewOptions = {
|
|
|
9280
9307
|
/**
|
|
9281
9308
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9282
9309
|
*
|
|
9283
|
-
* @defaultValue true
|
|
9284
|
-
*
|
|
9285
9310
|
* Show the context menu when right-clicking on the view.
|
|
9286
9311
|
* Gives access to the devtools for the view.
|
|
9312
|
+
*
|
|
9313
|
+
* @default true
|
|
9287
9314
|
*/
|
|
9288
9315
|
contextMenu: boolean;
|
|
9289
9316
|
/**
|
|
@@ -9330,24 +9357,25 @@ declare type MutableViewOptions = {
|
|
|
9330
9357
|
contentNavigation: ContentNavigation;
|
|
9331
9358
|
contentRedirect: ContentRedirect;
|
|
9332
9359
|
/**
|
|
9333
|
-
* @defaultValue false
|
|
9334
9360
|
* @deprecated
|
|
9335
9361
|
* **Platforms Only.** If true, will hide and detach the View from the window for later use instead of closing,
|
|
9336
9362
|
* allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
|
|
9363
|
+
*
|
|
9364
|
+
* @default false
|
|
9337
9365
|
*/
|
|
9338
9366
|
detachOnClose: boolean;
|
|
9339
9367
|
/**
|
|
9340
|
-
* @defaultValue true
|
|
9341
|
-
*
|
|
9342
9368
|
* **Platforms Only.** If false, the view will be persistent and can't be closed through
|
|
9343
9369
|
* either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
|
|
9344
9370
|
* if the view isn't part of the new layout when running `Layout.replace`.
|
|
9371
|
+
*
|
|
9372
|
+
* @default true
|
|
9345
9373
|
*/
|
|
9346
9374
|
isClosable: boolean;
|
|
9347
9375
|
/**
|
|
9348
|
-
* @defaultValue false
|
|
9349
|
-
*
|
|
9350
9376
|
* **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
|
|
9377
|
+
*
|
|
9378
|
+
* @default false
|
|
9351
9379
|
*/
|
|
9352
9380
|
preventDragOut: boolean;
|
|
9353
9381
|
interop?: InteropConfig;
|
|
@@ -9359,7 +9387,7 @@ declare type MutableViewOptions = {
|
|
|
9359
9387
|
/**
|
|
9360
9388
|
* {@inheritDoc ViewThrottling}
|
|
9361
9389
|
*
|
|
9362
|
-
* @
|
|
9390
|
+
* @default 'enabled'
|
|
9363
9391
|
*/
|
|
9364
9392
|
throttling: ViewThrottling;
|
|
9365
9393
|
/**
|
|
@@ -9378,7 +9406,7 @@ declare type MutableWindowOptions = {
|
|
|
9378
9406
|
* Turns anything of matching RGB value transparent.
|
|
9379
9407
|
*
|
|
9380
9408
|
* Caveats:
|
|
9381
|
-
* *
|
|
9409
|
+
* * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
|
|
9382
9410
|
* * User cannot click-through transparent regions
|
|
9383
9411
|
* * Not supported on Mac
|
|
9384
9412
|
* * Windows Aero must be enabled
|
|
@@ -9387,25 +9415,25 @@ declare type MutableWindowOptions = {
|
|
|
9387
9415
|
*/
|
|
9388
9416
|
alphaMask: RGB;
|
|
9389
9417
|
/**
|
|
9390
|
-
* @defaultValue false
|
|
9391
|
-
*
|
|
9392
9418
|
* Always position the window at the top of the window stack.
|
|
9419
|
+
*
|
|
9420
|
+
* @default false
|
|
9393
9421
|
*/
|
|
9394
9422
|
alwaysOnTop: boolean;
|
|
9395
9423
|
/**
|
|
9396
|
-
* @defaultValue 0
|
|
9397
|
-
*
|
|
9398
9424
|
* The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
|
|
9399
9425
|
* an aspect ratio will not be enforced.
|
|
9426
|
+
*
|
|
9427
|
+
* @default 0
|
|
9400
9428
|
*/
|
|
9401
9429
|
aspectRatio: number;
|
|
9402
9430
|
/**
|
|
9403
9431
|
* @deprecated Superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
|
|
9404
9432
|
*
|
|
9405
|
-
* @defaultValue true
|
|
9406
|
-
*
|
|
9407
9433
|
* Show the context menu when right-clicking on the window.
|
|
9408
9434
|
* Gives access to the devtools for the window.
|
|
9435
|
+
*
|
|
9436
|
+
* @default true
|
|
9409
9437
|
*/
|
|
9410
9438
|
contextMenu: boolean;
|
|
9411
9439
|
/**
|
|
@@ -9472,15 +9500,18 @@ declare type MutableWindowOptions = {
|
|
|
9472
9500
|
*/
|
|
9473
9501
|
customData: any;
|
|
9474
9502
|
/**
|
|
9503
|
+
* @deprecated Will be removed in runtime version 45
|
|
9475
9504
|
* @defaultValue true
|
|
9476
9505
|
*
|
|
9477
9506
|
* Show the window's frame.
|
|
9507
|
+
*
|
|
9508
|
+
* @default true
|
|
9478
9509
|
*/
|
|
9479
9510
|
frame: boolean;
|
|
9480
9511
|
/**
|
|
9481
|
-
* @defaultValue false
|
|
9482
|
-
*
|
|
9483
9512
|
* Hides the window instead of closing it when the close button is pressed.
|
|
9513
|
+
*
|
|
9514
|
+
* @default false
|
|
9484
9515
|
*/
|
|
9485
9516
|
hideOnClose: boolean;
|
|
9486
9517
|
/**
|
|
@@ -9533,60 +9564,61 @@ declare type MutableWindowOptions = {
|
|
|
9533
9564
|
*/
|
|
9534
9565
|
icon: string;
|
|
9535
9566
|
/**
|
|
9536
|
-
* @defaultValue true
|
|
9537
|
-
*
|
|
9538
9567
|
* Include window in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
|
|
9539
9568
|
* inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
|
|
9569
|
+
*
|
|
9570
|
+
* @default true
|
|
9540
9571
|
*/
|
|
9541
9572
|
includeInSnapshots: boolean;
|
|
9542
9573
|
/**
|
|
9543
|
-
* @defaultValue -1
|
|
9544
|
-
*
|
|
9545
9574
|
* The maximum height of a window. Will default to the OS defined value if set to -1.
|
|
9575
|
+
*
|
|
9576
|
+
* @default -1
|
|
9546
9577
|
*/
|
|
9547
9578
|
maxHeight: number;
|
|
9548
9579
|
/**
|
|
9549
|
-
* @defaultValue true
|
|
9550
|
-
*
|
|
9551
9580
|
* Allows the window to be maximized.
|
|
9581
|
+
*
|
|
9582
|
+
* @default true
|
|
9552
9583
|
*/
|
|
9553
9584
|
maximizable: boolean;
|
|
9554
9585
|
/**
|
|
9555
|
-
* @defaultValue -1
|
|
9556
|
-
*
|
|
9557
9586
|
* The maximum width of a window. Will default to the OS defined value if set to -1.
|
|
9587
|
+
*
|
|
9588
|
+
* @default -1
|
|
9558
9589
|
*/
|
|
9559
9590
|
maxWidth: number;
|
|
9560
9591
|
/**
|
|
9561
|
-
* @defaultValue 0
|
|
9562
|
-
*
|
|
9563
9592
|
* The minimum height of the window.
|
|
9593
|
+
*
|
|
9594
|
+
* @default 0
|
|
9564
9595
|
*/
|
|
9565
9596
|
minHeight: number;
|
|
9566
9597
|
/**
|
|
9567
|
-
* @defaultValue true
|
|
9568
|
-
*
|
|
9569
9598
|
* Allows the window to be minimized.
|
|
9599
|
+
*
|
|
9600
|
+
* @default true
|
|
9570
9601
|
*/
|
|
9571
9602
|
minimizable: boolean;
|
|
9572
9603
|
/**
|
|
9573
|
-
* @defaultValue true
|
|
9574
|
-
*
|
|
9575
9604
|
* The minimum width of the window.
|
|
9605
|
+
*
|
|
9606
|
+
* @default true
|
|
9576
9607
|
*/
|
|
9577
9608
|
minWidth: number;
|
|
9578
9609
|
/**
|
|
9579
|
-
* @defaultValue 1
|
|
9580
|
-
*
|
|
9581
9610
|
* A flag that specifies how transparent the window will be.
|
|
9582
9611
|
* Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
|
|
9583
9612
|
* This value is clamped between `0.0` and `1.0`.
|
|
9613
|
+
* In software composition mode, the runtime flag --allow-unsafe-compositing is required.
|
|
9614
|
+
*
|
|
9615
|
+
* @default 1
|
|
9584
9616
|
*/
|
|
9585
9617
|
opacity: number;
|
|
9586
9618
|
/**
|
|
9587
|
-
* @defaultValue true
|
|
9588
|
-
*
|
|
9589
9619
|
* A flag to allow the user to resize the window.
|
|
9620
|
+
*
|
|
9621
|
+
* @default true
|
|
9590
9622
|
*/
|
|
9591
9623
|
resizable: boolean;
|
|
9592
9624
|
/**
|
|
@@ -9594,16 +9626,22 @@ declare type MutableWindowOptions = {
|
|
|
9594
9626
|
*/
|
|
9595
9627
|
resizeRegion: ResizeRegion;
|
|
9596
9628
|
/**
|
|
9597
|
-
* @defaultValue false
|
|
9598
|
-
*
|
|
9599
9629
|
* **Platforms Only.** If true, will show background images in the layout when the Views are hidden.
|
|
9600
9630
|
* This occurs when the window is resizing or a tab is being dragged within the layout.
|
|
9631
|
+
*
|
|
9632
|
+
* @default false
|
|
9601
9633
|
*/
|
|
9602
9634
|
showBackgroundImages: boolean;
|
|
9603
9635
|
/**
|
|
9604
|
-
* @defaultValue true
|
|
9605
|
-
*
|
|
9606
9636
|
* Shows the window's icon in the taskbar.
|
|
9637
|
+
*
|
|
9638
|
+
* @remarks
|
|
9639
|
+
* In Windows, setting `showTaskbarIcon` to false will cause the window to display on all virtual desktops.
|
|
9640
|
+
* In order to prevent this while keeping `showTaskbarIcon` false, pass the identity of the parent via the
|
|
9641
|
+
* `modalParentIdentity` (see {@link WindowCreationOptions}). This is useful for popups managed by
|
|
9642
|
+
* {@link Window._Window.showPopupWindow}.
|
|
9643
|
+
*
|
|
9644
|
+
* @default true
|
|
9607
9645
|
*/
|
|
9608
9646
|
showTaskbarIcon: boolean;
|
|
9609
9647
|
/**
|
|
@@ -9630,7 +9668,7 @@ declare type MutableWindowOptions = {
|
|
|
9630
9668
|
/**
|
|
9631
9669
|
* {@inheritDoc WindowThrottling}
|
|
9632
9670
|
*
|
|
9633
|
-
* @
|
|
9671
|
+
* @default 'enabled'
|
|
9634
9672
|
*
|
|
9635
9673
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9636
9674
|
*/
|
|
@@ -10252,12 +10290,12 @@ declare type PasteBlockedEventReason = 'invalid-data' | 'disabled';
|
|
|
10252
10290
|
*/
|
|
10253
10291
|
declare type PastePermissions = {
|
|
10254
10292
|
/**
|
|
10255
|
-
* @defaultValue 'non-protected-content'
|
|
10256
|
-
*
|
|
10257
10293
|
* Controls the behavior for paste operations for a matched URL.
|
|
10258
10294
|
*
|
|
10259
10295
|
* non-protected-content: All matching URLs will be able to paste content copied from non-protected URLs.
|
|
10260
10296
|
* 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.
|
|
10297
|
+
*
|
|
10298
|
+
* @default 'non-protected-content'
|
|
10261
10299
|
*/
|
|
10262
10300
|
behavior: 'non-protected-content' | 'all-content';
|
|
10263
10301
|
};
|
|
@@ -11326,11 +11364,11 @@ declare type PlatformOptions = ApplicationCreationOptions & {
|
|
|
11326
11364
|
*/
|
|
11327
11365
|
providerUrl?: string;
|
|
11328
11366
|
/**
|
|
11329
|
-
* @defaultValue true
|
|
11330
|
-
*
|
|
11331
11367
|
* Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
|
|
11332
11368
|
*
|
|
11333
11369
|
* NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
|
|
11370
|
+
*
|
|
11371
|
+
* @default true
|
|
11334
11372
|
*/
|
|
11335
11373
|
allowLaunchIntoPlatform?: boolean;
|
|
11336
11374
|
};
|
|
@@ -12019,22 +12057,22 @@ declare type PopupOptions = {
|
|
|
12019
12057
|
url?: string;
|
|
12020
12058
|
/**
|
|
12021
12059
|
* Height of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12022
|
-
* @
|
|
12060
|
+
* @default 300
|
|
12023
12061
|
*/
|
|
12024
12062
|
height?: number;
|
|
12025
12063
|
/**
|
|
12026
12064
|
* Width of the popup window in pixels (takes priority over `intialOptions` size properties).
|
|
12027
|
-
* @
|
|
12065
|
+
* @default 300
|
|
12028
12066
|
*/
|
|
12029
12067
|
width?: number;
|
|
12030
12068
|
/**
|
|
12031
12069
|
* Left position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12032
|
-
* @
|
|
12070
|
+
* @default 0
|
|
12033
12071
|
*/
|
|
12034
12072
|
x?: number;
|
|
12035
12073
|
/**
|
|
12036
12074
|
* Top position in pixels where the popup window will be shown (relative to the window calling `showPopupWindow`).
|
|
12037
|
-
* @
|
|
12075
|
+
* @default 0
|
|
12038
12076
|
*/
|
|
12039
12077
|
y?: number;
|
|
12040
12078
|
/**
|
|
@@ -12042,7 +12080,7 @@ declare type PopupOptions = {
|
|
|
12042
12080
|
* * 'modal' restricts resizing and positioning in the caller.
|
|
12043
12081
|
* * 'hide' hides the popup window on blur.
|
|
12044
12082
|
* * 'close' closes the popup window on blur.
|
|
12045
|
-
* @
|
|
12083
|
+
* @default 'close'
|
|
12046
12084
|
*/
|
|
12047
12085
|
blurBehavior?: PopupBlurBehavior;
|
|
12048
12086
|
/**
|
|
@@ -12050,19 +12088,19 @@ declare type PopupOptions = {
|
|
|
12050
12088
|
* * 'none' will do nothing.
|
|
12051
12089
|
* * 'hide' hides the popup window on `dispatchPopupResult`.
|
|
12052
12090
|
* * 'close' closes the popup window on `dispatchPopupResult`.
|
|
12053
|
-
* @
|
|
12091
|
+
* @default 'close'
|
|
12054
12092
|
*/
|
|
12055
12093
|
resultDispatchBehavior?: PopupResultBehavior;
|
|
12056
12094
|
/**
|
|
12057
12095
|
* Hide the popup window instead of closing when `close` is called on it.
|
|
12058
12096
|
*
|
|
12059
12097
|
* Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
|
|
12060
|
-
* @
|
|
12098
|
+
* @default false
|
|
12061
12099
|
*/
|
|
12062
12100
|
hideOnClose?: boolean;
|
|
12063
12101
|
/**
|
|
12064
12102
|
* Determines if the popup window should or should not be focused when it is shown.
|
|
12065
|
-
* @
|
|
12103
|
+
* @default true
|
|
12066
12104
|
*/
|
|
12067
12105
|
focus?: boolean;
|
|
12068
12106
|
/**
|
|
@@ -12156,9 +12194,9 @@ declare type PrebuiltContextMenuItem = 'separator' | 'undo' | 'redo' | 'cut' | '
|
|
|
12156
12194
|
*/
|
|
12157
12195
|
declare type PreloadScript = {
|
|
12158
12196
|
/**
|
|
12159
|
-
* @defaultValue false
|
|
12160
|
-
*
|
|
12161
12197
|
* Fail to load the window if this preload script fails
|
|
12198
|
+
*
|
|
12199
|
+
* @default false
|
|
12162
12200
|
*/
|
|
12163
12201
|
mandatory?: boolean;
|
|
12164
12202
|
/**
|
|
@@ -12254,15 +12292,15 @@ declare type PrinterInfo = {
|
|
|
12254
12292
|
declare type PrintOptions = {
|
|
12255
12293
|
content?: 'self';
|
|
12256
12294
|
/**
|
|
12257
|
-
* @defaultValue false
|
|
12258
|
-
*
|
|
12259
12295
|
* Disables prompting the user for print settings.
|
|
12296
|
+
*
|
|
12297
|
+
* @default false
|
|
12260
12298
|
*/
|
|
12261
12299
|
silent?: boolean;
|
|
12262
12300
|
/**
|
|
12263
|
-
* @defaultValue false
|
|
12264
|
-
*
|
|
12265
12301
|
* Includes the webpage background color and image when printing.
|
|
12302
|
+
*
|
|
12303
|
+
* @default false
|
|
12266
12304
|
*/
|
|
12267
12305
|
printBackground?: boolean;
|
|
12268
12306
|
/**
|
|
@@ -12270,9 +12308,9 @@ declare type PrintOptions = {
|
|
|
12270
12308
|
*/
|
|
12271
12309
|
deviceName?: string;
|
|
12272
12310
|
/**
|
|
12273
|
-
* @defaultValue true
|
|
12274
|
-
*
|
|
12275
12311
|
* Prints in full color (greyscale otherwise).
|
|
12312
|
+
*
|
|
12313
|
+
* @default true
|
|
12276
12314
|
*/
|
|
12277
12315
|
color?: boolean;
|
|
12278
12316
|
/**
|
|
@@ -12280,9 +12318,9 @@ declare type PrintOptions = {
|
|
|
12280
12318
|
*/
|
|
12281
12319
|
margins?: Margins;
|
|
12282
12320
|
/**
|
|
12283
|
-
* @defaultValue true
|
|
12284
|
-
*
|
|
12285
12321
|
* Prints in landscape mode (portrait otherwise).
|
|
12322
|
+
*
|
|
12323
|
+
* @default true
|
|
12286
12324
|
*/
|
|
12287
12325
|
landscape?: boolean;
|
|
12288
12326
|
/**
|
|
@@ -13463,15 +13501,15 @@ declare type ReplaceViewPayload = {
|
|
|
13463
13501
|
*/
|
|
13464
13502
|
declare type ResizeRegion = {
|
|
13465
13503
|
/**
|
|
13466
|
-
* @defaultValue 7
|
|
13467
|
-
*
|
|
13468
13504
|
* The size of the resize region in pixels.
|
|
13505
|
+
*
|
|
13506
|
+
* @default 7
|
|
13469
13507
|
*/
|
|
13470
13508
|
size?: number;
|
|
13471
13509
|
/**
|
|
13472
|
-
* @defaultValue 9
|
|
13473
|
-
*
|
|
13474
13510
|
* The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
|
|
13511
|
+
*
|
|
13512
|
+
* @default 9
|
|
13475
13513
|
*/
|
|
13476
13514
|
bottomRightCorner?: number;
|
|
13477
13515
|
/**
|
|
@@ -13479,27 +13517,27 @@ declare type ResizeRegion = {
|
|
|
13479
13517
|
*/
|
|
13480
13518
|
sides?: {
|
|
13481
13519
|
/**
|
|
13482
|
-
* @defaultValue true
|
|
13483
|
-
*
|
|
13484
13520
|
* Enables resizing from the top of the window.
|
|
13521
|
+
*
|
|
13522
|
+
* @default true
|
|
13485
13523
|
*/
|
|
13486
13524
|
top?: boolean;
|
|
13487
13525
|
/**
|
|
13488
|
-
* @defaultValue true
|
|
13489
|
-
*
|
|
13490
13526
|
* Enables resizing from the bottom of the window.
|
|
13527
|
+
*
|
|
13528
|
+
* @default true
|
|
13491
13529
|
*/
|
|
13492
13530
|
bottom?: boolean;
|
|
13493
13531
|
/**
|
|
13494
|
-
* @defaultValue true
|
|
13495
|
-
*
|
|
13496
13532
|
* Enables resizing from the left side of the window.
|
|
13533
|
+
*
|
|
13534
|
+
* @default true
|
|
13497
13535
|
*/
|
|
13498
13536
|
left?: boolean;
|
|
13499
13537
|
/**
|
|
13500
|
-
* @defaultValue true
|
|
13501
|
-
*
|
|
13502
13538
|
* Enables resizing from the right side of the window.
|
|
13539
|
+
*
|
|
13540
|
+
* @default true
|
|
13503
13541
|
*/
|
|
13504
13542
|
right?: boolean;
|
|
13505
13543
|
};
|
|
@@ -14051,9 +14089,9 @@ declare type ShowTrayIconPopupMenuOptions<Data extends unknown = unknown> = {
|
|
|
14051
14089
|
*/
|
|
14052
14090
|
declare type ShowViewOnWindowResizeOptions = ViewVisibilityOption & {
|
|
14053
14091
|
/**
|
|
14054
|
-
* @defaultValue 0
|
|
14055
|
-
*
|
|
14056
14092
|
* Number of milliseconds to wait between view repaints.
|
|
14093
|
+
*
|
|
14094
|
+
* @default 0
|
|
14057
14095
|
*/
|
|
14058
14096
|
paintIntervalMs?: number;
|
|
14059
14097
|
};
|
|
@@ -16110,9 +16148,9 @@ declare type TransitionBase = {
|
|
|
16110
16148
|
*/
|
|
16111
16149
|
duration: number;
|
|
16112
16150
|
/**
|
|
16113
|
-
* @defaultValue false
|
|
16114
|
-
*
|
|
16115
16151
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16152
|
+
*
|
|
16153
|
+
* @default false
|
|
16116
16154
|
*/
|
|
16117
16155
|
relative?: boolean;
|
|
16118
16156
|
};
|
|
@@ -16128,9 +16166,9 @@ declare type TransitionOptions = {
|
|
|
16128
16166
|
*/
|
|
16129
16167
|
interrupt: boolean;
|
|
16130
16168
|
/**
|
|
16131
|
-
* @defaultValue false
|
|
16132
|
-
*
|
|
16133
16169
|
* Treats 'opacity' as absolute or as a delta. Defaults to false.
|
|
16170
|
+
*
|
|
16171
|
+
* @default false
|
|
16134
16172
|
*/
|
|
16135
16173
|
relative?: boolean;
|
|
16136
16174
|
tween?: tween;
|
|
@@ -17095,9 +17133,9 @@ declare type ViewTitlePriority = 'document' | 'options';
|
|
|
17095
17133
|
*/
|
|
17096
17134
|
declare type ViewVisibilityOption = {
|
|
17097
17135
|
/**
|
|
17098
|
-
* @defaultValue false
|
|
17099
|
-
*
|
|
17100
17136
|
* Enables or disables showing views when the layout splitter or a tab is being dragged or a Platform Window is being resized.
|
|
17137
|
+
*
|
|
17138
|
+
* @default false
|
|
17101
17139
|
*/
|
|
17102
17140
|
enabled?: boolean;
|
|
17103
17141
|
};
|