@vertigis/viewer-spec 56.19.0 → 56.20.0
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.
|
@@ -12,9 +12,37 @@ import type { MapsLike } from "../common.js";
|
|
|
12
12
|
*/
|
|
13
13
|
export type JobParameters = Record<string, unknown>;
|
|
14
14
|
/**
|
|
15
|
-
* The
|
|
15
|
+
* The export formats allowed for the layout print.
|
|
16
16
|
*/
|
|
17
|
-
export
|
|
17
|
+
export type LayoutExportFormats = "AIX" | "BMP" | "MF" | "EPS" | "GIF" | "JPG" | "PDF" | "PNG" | "PNG32" | "SVG" | "SVGZ" | "TGA" | "TIFF";
|
|
18
|
+
/**
|
|
19
|
+
* The arguments required by the printing.run command when printing with ArcGIS
|
|
20
|
+
* Pro layouts.
|
|
21
|
+
*/
|
|
22
|
+
export interface RunLayoutPrintArgs extends RunPrintArgsBase {
|
|
23
|
+
/**
|
|
24
|
+
* The ID of the layout item to be printed.
|
|
25
|
+
*/
|
|
26
|
+
layoutId: string;
|
|
27
|
+
/**
|
|
28
|
+
* The export format of the layout print.
|
|
29
|
+
*/
|
|
30
|
+
exportFormat?: LayoutExportFormats;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* The arguments required by the printing.run command when printing with
|
|
34
|
+
* templates.
|
|
35
|
+
*/
|
|
36
|
+
export interface RunPrintArgs extends RunPrintArgsBase {
|
|
37
|
+
/**
|
|
38
|
+
* The WKID of the spatial reference used to draw a grid on the map(s).
|
|
39
|
+
*/
|
|
40
|
+
grid?: SpatialReference;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* The base arguments for the printing.run command.
|
|
44
|
+
*/
|
|
45
|
+
interface RunPrintArgsBase {
|
|
18
46
|
/**
|
|
19
47
|
* The map(s) to print.
|
|
20
48
|
*/
|
|
@@ -53,10 +81,6 @@ export interface RunPrintArgs {
|
|
|
53
81
|
* The rotation of the map(s). Defaults to the map's current rotation.
|
|
54
82
|
*/
|
|
55
83
|
rotation?: number;
|
|
56
|
-
/**
|
|
57
|
-
* The WKID of the spatial reference used to draw a grid on the map(s).
|
|
58
|
-
*/
|
|
59
|
-
grid?: SpatialReference;
|
|
60
84
|
/**
|
|
61
85
|
* Additional parameters used in the print template, specified as key-value
|
|
62
86
|
* pairs.
|
|
@@ -115,9 +139,9 @@ export interface PrintStartedEventArgs extends PrintEventArgsBase {
|
|
|
115
139
|
export declare class PrintCommands extends CommandRegistry {
|
|
116
140
|
protected readonly _prefix = "printing";
|
|
117
141
|
/**
|
|
118
|
-
* Run a print job with a given map and template.
|
|
142
|
+
* Run a print job with a given map and template/layout.
|
|
119
143
|
*/
|
|
120
|
-
get run(): Command<RunPrintArgs>;
|
|
144
|
+
get run(): Command<RunPrintArgs | RunLayoutPrintArgs>;
|
|
121
145
|
}
|
|
122
146
|
export declare class PrintEvents extends EventRegistry {
|
|
123
147
|
protected readonly _prefix = "printing";
|
|
@@ -139,3 +163,4 @@ export declare class PrintEvents extends EventRegistry {
|
|
|
139
163
|
*/
|
|
140
164
|
get printError(): Event<PrintErrorEventArgs>;
|
|
141
165
|
}
|
|
166
|
+
export {};
|
|
@@ -2349,6 +2349,25 @@
|
|
|
2349
2349
|
],
|
|
2350
2350
|
"description": "One or more objects that are convertible to layer extensions."
|
|
2351
2351
|
},
|
|
2352
|
+
"LayoutExportFormats": {
|
|
2353
|
+
"description": "The export formats allowed for the layout print.",
|
|
2354
|
+
"enum": [
|
|
2355
|
+
"AIX",
|
|
2356
|
+
"BMP",
|
|
2357
|
+
"EPS",
|
|
2358
|
+
"GIF",
|
|
2359
|
+
"JPG",
|
|
2360
|
+
"MF",
|
|
2361
|
+
"PDF",
|
|
2362
|
+
"PNG",
|
|
2363
|
+
"PNG32",
|
|
2364
|
+
"SVG",
|
|
2365
|
+
"SVGZ",
|
|
2366
|
+
"TGA",
|
|
2367
|
+
"TIFF"
|
|
2368
|
+
],
|
|
2369
|
+
"type": "string"
|
|
2370
|
+
},
|
|
2352
2371
|
"MapRotateArgs": {
|
|
2353
2372
|
"additionalProperties": false,
|
|
2354
2373
|
"description": "Arguments for the \"map.rotate-by\" and \"map.rotate-to\" commands.",
|
|
@@ -2590,9 +2609,72 @@
|
|
|
2590
2609
|
],
|
|
2591
2610
|
"type": "object"
|
|
2592
2611
|
},
|
|
2612
|
+
"RunLayoutPrintArgs": {
|
|
2613
|
+
"additionalProperties": false,
|
|
2614
|
+
"description": "The arguments required by the printing.run command when printing with ArcGIS Pro layouts.",
|
|
2615
|
+
"properties": {
|
|
2616
|
+
"dpi": {
|
|
2617
|
+
"description": "The DPI with which to print.",
|
|
2618
|
+
"type": "number"
|
|
2619
|
+
},
|
|
2620
|
+
"exportFormat": {
|
|
2621
|
+
"$ref": "#/definitions/LayoutExportFormats",
|
|
2622
|
+
"description": "The export format of the layout print."
|
|
2623
|
+
},
|
|
2624
|
+
"extent": {
|
|
2625
|
+
"$ref": "#/definitions/esri.Extent",
|
|
2626
|
+
"description": "The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used."
|
|
2627
|
+
},
|
|
2628
|
+
"id": {
|
|
2629
|
+
"description": "The ID of the report item.",
|
|
2630
|
+
"type": "string"
|
|
2631
|
+
},
|
|
2632
|
+
"instanceId": {
|
|
2633
|
+
"description": "A unique ID used to track a print job.",
|
|
2634
|
+
"type": "string"
|
|
2635
|
+
},
|
|
2636
|
+
"layoutId": {
|
|
2637
|
+
"description": "The ID of the layout item to be printed.",
|
|
2638
|
+
"type": "string"
|
|
2639
|
+
},
|
|
2640
|
+
"maps": {
|
|
2641
|
+
"$ref": "MapsLike",
|
|
2642
|
+
"description": "The map(s) to print."
|
|
2643
|
+
},
|
|
2644
|
+
"parameters": {
|
|
2645
|
+
"$ref": "#/definitions/JobParameters",
|
|
2646
|
+
"description": "Additional parameters used in the print template, specified as key-value pairs."
|
|
2647
|
+
},
|
|
2648
|
+
"portalItem": {
|
|
2649
|
+
"$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
|
|
2650
|
+
"description": "The portal item where the report is located."
|
|
2651
|
+
},
|
|
2652
|
+
"rotation": {
|
|
2653
|
+
"description": "The rotation of the map(s). Defaults to the map's current rotation.",
|
|
2654
|
+
"type": "number"
|
|
2655
|
+
},
|
|
2656
|
+
"scale": {
|
|
2657
|
+
"description": "The scale of the map(s). Defaults to the map's current scale.",
|
|
2658
|
+
"type": "number"
|
|
2659
|
+
},
|
|
2660
|
+
"title": {
|
|
2661
|
+
"description": "The title of the report.",
|
|
2662
|
+
"type": "string"
|
|
2663
|
+
},
|
|
2664
|
+
"viewpoint": {
|
|
2665
|
+
"$ref": "#/definitions/esri.Viewpoint",
|
|
2666
|
+
"description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
|
|
2667
|
+
}
|
|
2668
|
+
},
|
|
2669
|
+
"required": [
|
|
2670
|
+
"layoutId",
|
|
2671
|
+
"maps"
|
|
2672
|
+
],
|
|
2673
|
+
"type": "object"
|
|
2674
|
+
},
|
|
2593
2675
|
"RunPrintArgs": {
|
|
2594
2676
|
"additionalProperties": false,
|
|
2595
|
-
"description": "The arguments required by the printing.run command.",
|
|
2677
|
+
"description": "The arguments required by the printing.run command when printing with templates.",
|
|
2596
2678
|
"properties": {
|
|
2597
2679
|
"dpi": {
|
|
2598
2680
|
"description": "The DPI with which to print.",
|
|
@@ -13710,13 +13792,20 @@
|
|
|
13710
13792
|
]
|
|
13711
13793
|
},
|
|
13712
13794
|
"printing.run": {
|
|
13713
|
-
"description": "Run a print job with a given map and template.",
|
|
13795
|
+
"description": "Run a print job with a given map and template/layout.",
|
|
13714
13796
|
"enum": [
|
|
13715
13797
|
"printing.run"
|
|
13716
13798
|
]
|
|
13717
13799
|
},
|
|
13718
13800
|
"printing.run:input": {
|
|
13719
|
-
"
|
|
13801
|
+
"anyOf": [
|
|
13802
|
+
{
|
|
13803
|
+
"$ref": "#/definitions/RunLayoutPrintArgs"
|
|
13804
|
+
},
|
|
13805
|
+
{
|
|
13806
|
+
"$ref": "#/definitions/RunPrintArgs"
|
|
13807
|
+
}
|
|
13808
|
+
]
|
|
13720
13809
|
},
|
|
13721
13810
|
"results.add": {
|
|
13722
13811
|
"description": "Adds features to a currently shown set of features.",
|
|
@@ -2861,6 +2861,25 @@
|
|
|
2861
2861
|
],
|
|
2862
2862
|
"description": "One or more objects that are convertible to layer extensions."
|
|
2863
2863
|
},
|
|
2864
|
+
"LayoutExportFormats": {
|
|
2865
|
+
"description": "The export formats allowed for the layout print.",
|
|
2866
|
+
"enum": [
|
|
2867
|
+
"AIX",
|
|
2868
|
+
"BMP",
|
|
2869
|
+
"EPS",
|
|
2870
|
+
"GIF",
|
|
2871
|
+
"JPG",
|
|
2872
|
+
"MF",
|
|
2873
|
+
"PDF",
|
|
2874
|
+
"PNG",
|
|
2875
|
+
"PNG32",
|
|
2876
|
+
"SVG",
|
|
2877
|
+
"SVGZ",
|
|
2878
|
+
"TGA",
|
|
2879
|
+
"TIFF"
|
|
2880
|
+
],
|
|
2881
|
+
"type": "string"
|
|
2882
|
+
},
|
|
2864
2883
|
"LengthUnitsMobile": {
|
|
2865
2884
|
"description": "The units for distance supported by Mobile.",
|
|
2866
2885
|
"enum": [
|
|
@@ -3395,9 +3414,72 @@
|
|
|
3395
3414
|
],
|
|
3396
3415
|
"type": "object"
|
|
3397
3416
|
},
|
|
3417
|
+
"RunLayoutPrintArgs": {
|
|
3418
|
+
"additionalProperties": false,
|
|
3419
|
+
"description": "The arguments required by the printing.run command when printing with ArcGIS Pro layouts.",
|
|
3420
|
+
"properties": {
|
|
3421
|
+
"dpi": {
|
|
3422
|
+
"description": "The DPI with which to print.",
|
|
3423
|
+
"type": "number"
|
|
3424
|
+
},
|
|
3425
|
+
"exportFormat": {
|
|
3426
|
+
"$ref": "#/definitions/LayoutExportFormats",
|
|
3427
|
+
"description": "The export format of the layout print."
|
|
3428
|
+
},
|
|
3429
|
+
"extent": {
|
|
3430
|
+
"$ref": "#/definitions/esri.Extent",
|
|
3431
|
+
"description": "The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used."
|
|
3432
|
+
},
|
|
3433
|
+
"id": {
|
|
3434
|
+
"description": "The ID of the report item.",
|
|
3435
|
+
"type": "string"
|
|
3436
|
+
},
|
|
3437
|
+
"instanceId": {
|
|
3438
|
+
"description": "A unique ID used to track a print job.",
|
|
3439
|
+
"type": "string"
|
|
3440
|
+
},
|
|
3441
|
+
"layoutId": {
|
|
3442
|
+
"description": "The ID of the layout item to be printed.",
|
|
3443
|
+
"type": "string"
|
|
3444
|
+
},
|
|
3445
|
+
"maps": {
|
|
3446
|
+
"$ref": "MapsLike",
|
|
3447
|
+
"description": "The map(s) to print."
|
|
3448
|
+
},
|
|
3449
|
+
"parameters": {
|
|
3450
|
+
"$ref": "#/definitions/JobParameters",
|
|
3451
|
+
"description": "Additional parameters used in the print template, specified as key-value pairs."
|
|
3452
|
+
},
|
|
3453
|
+
"portalItem": {
|
|
3454
|
+
"$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
|
|
3455
|
+
"description": "The portal item where the report is located."
|
|
3456
|
+
},
|
|
3457
|
+
"rotation": {
|
|
3458
|
+
"description": "The rotation of the map(s). Defaults to the map's current rotation.",
|
|
3459
|
+
"type": "number"
|
|
3460
|
+
},
|
|
3461
|
+
"scale": {
|
|
3462
|
+
"description": "The scale of the map(s). Defaults to the map's current scale.",
|
|
3463
|
+
"type": "number"
|
|
3464
|
+
},
|
|
3465
|
+
"title": {
|
|
3466
|
+
"description": "The title of the report.",
|
|
3467
|
+
"type": "string"
|
|
3468
|
+
},
|
|
3469
|
+
"viewpoint": {
|
|
3470
|
+
"$ref": "#/definitions/esri.Viewpoint",
|
|
3471
|
+
"description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
|
|
3472
|
+
}
|
|
3473
|
+
},
|
|
3474
|
+
"required": [
|
|
3475
|
+
"layoutId",
|
|
3476
|
+
"maps"
|
|
3477
|
+
],
|
|
3478
|
+
"type": "object"
|
|
3479
|
+
},
|
|
3398
3480
|
"RunPrintArgs": {
|
|
3399
3481
|
"additionalProperties": false,
|
|
3400
|
-
"description": "The arguments required by the printing.run command.",
|
|
3482
|
+
"description": "The arguments required by the printing.run command when printing with templates.",
|
|
3401
3483
|
"properties": {
|
|
3402
3484
|
"dpi": {
|
|
3403
3485
|
"description": "The DPI with which to print.",
|
|
@@ -15676,13 +15758,20 @@
|
|
|
15676
15758
|
]
|
|
15677
15759
|
},
|
|
15678
15760
|
"printing.run": {
|
|
15679
|
-
"description": "Run a print job with a given map and template.",
|
|
15761
|
+
"description": "Run a print job with a given map and template/layout.",
|
|
15680
15762
|
"enum": [
|
|
15681
15763
|
"printing.run"
|
|
15682
15764
|
]
|
|
15683
15765
|
},
|
|
15684
15766
|
"printing.run:input": {
|
|
15685
|
-
"
|
|
15767
|
+
"anyOf": [
|
|
15768
|
+
{
|
|
15769
|
+
"$ref": "#/definitions/RunLayoutPrintArgs"
|
|
15770
|
+
},
|
|
15771
|
+
{
|
|
15772
|
+
"$ref": "#/definitions/RunPrintArgs"
|
|
15773
|
+
}
|
|
15774
|
+
]
|
|
15686
15775
|
},
|
|
15687
15776
|
"results.add": {
|
|
15688
15777
|
"description": "Adds features to a currently shown set of features.",
|
|
@@ -4684,6 +4684,25 @@
|
|
|
4684
4684
|
],
|
|
4685
4685
|
"description": "One or more objects that are convertible to layer extensions."
|
|
4686
4686
|
},
|
|
4687
|
+
"LayoutExportFormats": {
|
|
4688
|
+
"description": "The export formats allowed for the layout print.",
|
|
4689
|
+
"enum": [
|
|
4690
|
+
"AIX",
|
|
4691
|
+
"BMP",
|
|
4692
|
+
"EPS",
|
|
4693
|
+
"GIF",
|
|
4694
|
+
"JPG",
|
|
4695
|
+
"MF",
|
|
4696
|
+
"PDF",
|
|
4697
|
+
"PNG",
|
|
4698
|
+
"PNG32",
|
|
4699
|
+
"SVG",
|
|
4700
|
+
"SVGZ",
|
|
4701
|
+
"TGA",
|
|
4702
|
+
"TIFF"
|
|
4703
|
+
],
|
|
4704
|
+
"type": "string"
|
|
4705
|
+
},
|
|
4687
4706
|
"LengthMeasurementUnits": {
|
|
4688
4707
|
"description": "The units for length measurements supported by ArcGIS.",
|
|
4689
4708
|
"enum": [
|
|
@@ -5695,9 +5714,72 @@
|
|
|
5695
5714
|
},
|
|
5696
5715
|
"type": "object"
|
|
5697
5716
|
},
|
|
5717
|
+
"RunLayoutPrintArgs": {
|
|
5718
|
+
"additionalProperties": false,
|
|
5719
|
+
"description": "The arguments required by the printing.run command when printing with ArcGIS Pro layouts.",
|
|
5720
|
+
"properties": {
|
|
5721
|
+
"dpi": {
|
|
5722
|
+
"description": "The DPI with which to print.",
|
|
5723
|
+
"type": "number"
|
|
5724
|
+
},
|
|
5725
|
+
"exportFormat": {
|
|
5726
|
+
"$ref": "#/definitions/LayoutExportFormats",
|
|
5727
|
+
"description": "The export format of the layout print."
|
|
5728
|
+
},
|
|
5729
|
+
"extent": {
|
|
5730
|
+
"$ref": "#/definitions/esri.Extent",
|
|
5731
|
+
"description": "The initial extent of the 2D map(s). Defaults to the map's current extent. If scale is provided, only the center point is used."
|
|
5732
|
+
},
|
|
5733
|
+
"id": {
|
|
5734
|
+
"description": "The ID of the report item.",
|
|
5735
|
+
"type": "string"
|
|
5736
|
+
},
|
|
5737
|
+
"instanceId": {
|
|
5738
|
+
"description": "A unique ID used to track a print job.",
|
|
5739
|
+
"type": "string"
|
|
5740
|
+
},
|
|
5741
|
+
"layoutId": {
|
|
5742
|
+
"description": "The ID of the layout item to be printed.",
|
|
5743
|
+
"type": "string"
|
|
5744
|
+
},
|
|
5745
|
+
"maps": {
|
|
5746
|
+
"$ref": "MapsLike",
|
|
5747
|
+
"description": "The map(s) to print."
|
|
5748
|
+
},
|
|
5749
|
+
"parameters": {
|
|
5750
|
+
"$ref": "#/definitions/JobParameters",
|
|
5751
|
+
"description": "Additional parameters used in the print template, specified as key-value pairs."
|
|
5752
|
+
},
|
|
5753
|
+
"portalItem": {
|
|
5754
|
+
"$ref": "#/definitions/@vertigis.arcgis-extensions.utilities.portal.PortalItemLike",
|
|
5755
|
+
"description": "The portal item where the report is located."
|
|
5756
|
+
},
|
|
5757
|
+
"rotation": {
|
|
5758
|
+
"description": "The rotation of the map(s). Defaults to the map's current rotation.",
|
|
5759
|
+
"type": "number"
|
|
5760
|
+
},
|
|
5761
|
+
"scale": {
|
|
5762
|
+
"description": "The scale of the map(s). Defaults to the map's current scale.",
|
|
5763
|
+
"type": "number"
|
|
5764
|
+
},
|
|
5765
|
+
"title": {
|
|
5766
|
+
"description": "The title of the report.",
|
|
5767
|
+
"type": "string"
|
|
5768
|
+
},
|
|
5769
|
+
"viewpoint": {
|
|
5770
|
+
"$ref": "#/definitions/esri.Viewpoint",
|
|
5771
|
+
"description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
|
|
5772
|
+
}
|
|
5773
|
+
},
|
|
5774
|
+
"required": [
|
|
5775
|
+
"layoutId",
|
|
5776
|
+
"maps"
|
|
5777
|
+
],
|
|
5778
|
+
"type": "object"
|
|
5779
|
+
},
|
|
5698
5780
|
"RunPrintArgs": {
|
|
5699
5781
|
"additionalProperties": false,
|
|
5700
|
-
"description": "The arguments required by the printing.run command.",
|
|
5782
|
+
"description": "The arguments required by the printing.run command when printing with templates.",
|
|
5701
5783
|
"properties": {
|
|
5702
5784
|
"dpi": {
|
|
5703
5785
|
"description": "The DPI with which to print.",
|
|
@@ -20602,13 +20684,20 @@
|
|
|
20602
20684
|
]
|
|
20603
20685
|
},
|
|
20604
20686
|
"printing.run": {
|
|
20605
|
-
"description": "Run a print job with a given map and template.",
|
|
20687
|
+
"description": "Run a print job with a given map and template/layout.",
|
|
20606
20688
|
"enum": [
|
|
20607
20689
|
"printing.run"
|
|
20608
20690
|
]
|
|
20609
20691
|
},
|
|
20610
20692
|
"printing.run:input": {
|
|
20611
|
-
"
|
|
20693
|
+
"anyOf": [
|
|
20694
|
+
{
|
|
20695
|
+
"$ref": "#/definitions/RunLayoutPrintArgs"
|
|
20696
|
+
},
|
|
20697
|
+
{
|
|
20698
|
+
"$ref": "#/definitions/RunPrintArgs"
|
|
20699
|
+
}
|
|
20700
|
+
]
|
|
20612
20701
|
},
|
|
20613
20702
|
"project.create": {
|
|
20614
20703
|
"description": "Creates app config for a project, based on the current state of the application. Web only.",
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
package/version.js
CHANGED