@vertigis/viewer-spec/messaging/schema/web-printing-command-definitions.md

VertiGIS Viewer Specification

# command: printing.print-features
Description: Opens the print component with the option to print specified features. Web only.

Inputs: `PrintFeaturesArgs`

PrintFeaturesArgs properties:
```json
{
  "features": {
    "description": "The feature(s) to print.",
    "isRequired": "true"
  }
}
```

---
# command: printing.run
Description: Run a print job with a given map and template/layout.

Inputs: `( RunLayoutPrintArgs | RunPrintArgs )`

RunLayoutPrintArgs properties:
```json
{
  "dpi": {
    "description": "The DPI with which to print.",
    "type": "number"
  },
  "extent": {
    "description": "The map extent. Defaults to the map's current extent. The actual print extent is calculated from the center point of the map extent, the print scale and the layout frame- or the output dimensions."
  },
  "id": {
    "description": "The ID of the layout item to print with. Deprecated; use portalItem instead.",
    "type": "string"
  },
  "instanceId": {
    "description": "A unique ID used to track a print job.",
    "type": "string"
  },
  "layoutId": {
    "description": "The ID of the layout- (e.g.: vglay_xxx) or layout package (e.g.: vglaypk_xxx) item to print with. Deprecated; use portalItem instead.",
    "type": "string"
  },
  "maps": {
    "description": "The map(s) to print.",
    "isRequired": "true"
  },
  "outputDimensions": {
    "description": "The print output dimensions for a MAP ONLY print."
  },
  "outputFormat": {
    "description": "The print output format. Defaults to PDF if undefined or if layout package print is performed."
  },
  "parameters": {
    "description": "Custom layout field parameters, specified as key-value pairs. The key is related to the layout field key. If a field for a specified key has an auto-filled value, this value is overwritten by the value provided here. NOTE: See VGS Printing documentation to learn more about layout fields."
  },
  "portalItem": {
    "description": "The portal item where the print layout or layout package is located. If not defined, a MAP ONLY print is performed."
  },
  "scale": {
    "description": "The print scale.",
    "type": "number",
    "isRequired": "true"
  },
  "title": {
    "description": "The title of the print.",
    "type": "string"
  }
}
```

RunPrintArgs properties:
```json
{
  "dpi": {
    "description": "The DPI with which to print.",
    "type": "number"
  },
  "extent": {
    "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."
  },
  "grid": {
    "description": "The WKID of the spatial reference used to draw a grid on the map(s)."
  },
  "id": {
    "description": "The ID of the report item.",
    "type": "string"
  },
  "instanceId": {
    "description": "A unique ID used to track a print job.",
    "type": "string"
  },
  "maps": {
    "description": "The map(s) to print.",
    "isRequired": "true"
  },
  "parameters": {
    "description": "Additional parameters used in the print template, specified as key-value pairs."
  },
  "portalItem": {
    "description": "The portal item where the print template is located."
  },
  "rotation": {
    "description": "The rotation of the map(s). Defaults to the map's current rotation.",
    "type": "number"
  },
  "scale": {
    "description": "The scale of the map(s). Defaults to the map's current scale.",
    "type": "number"
  },
  "title": {
    "description": "The title of the print.",
    "type": "string"
  },
  "viewpoint": {
    "description": "The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint."
  }
}
```

---