The ExportChartToPDF process exports an HPD or standalone (*.pcc) paper chart to PDF.
This process is similar to the GUI command in Paper Chart Editor and Paper Chart Composer, but does not allow two additional options:
• Extent: All Data or Current view. Because there is no view in CARIS Batch, the Extent is always set to All Data.
• Preserve Layers: The preserved layers are layers in the Layers window. Because there is no Layers window for this process, there is no option to preserve layers.
The paper size and orientation are set by the sheet's properties (SHEET feature).
Input
HPD URI containing a Chart Version ID or a path to a standalone chart.
Output
Path of the resulting exported PDF file.
Command Line Syntax
carisbatch --run ExportChartToPDF [options] <input> <output>
Options
Long | Short | Description | Can Repeat | Notes |
|---|---|---|---|---|
--dpi | -D | Number of pixels per square inch (DPI) in the output image. A greater resolution means a sharper image. The image resolution must be an integer greater than 0. Default value is 300. | FALSE | Optional |
--use-fit-to-page | -P | If set, automatically fit the data to the page as defined in the sheet's properties. Default value is FALSE. | FALSE | Optional |
--scaling | -S | Scale the data to a percentage of the size. If Use Fit To Page is TRUE, this is ignored. The scaling value must be an integer greater than 0. Default value is 100%. | FALSE | Optional |
--render-text-as-curves | -C | If set, convert text to vector graphics. Default value is FALSE. | FALSE | Optional |
--include-trim-marks | -T | Add lines at the corners to facilitate trimming the sheet to the specified size. This is used mainly for printing to oversized sheets. When exported, the sheet will be 10 mm larger on each side to accommodate the trim marks. Default value is FALSE. | FALSE | Optional |
--trim-marks-thickness | -M | Thickness of the trim marks, in millimetres, on the paper. If Include Trim Marks is FALSE, this is ignored. Default value is 0.1 mm. | FALSE | Optional |
--colour-format | -O | Colour format for the chart. An enum type with the following values is supported: • RGB • CMYK. Default value is RGB. | FALSE | Optional |
-icc-profile-file | -I | Path to the ICC profile to associate to the chart. When set, this option will allow colours to be converted to those of the ICC profile. Default value is FALSE. | FALSE | Optional |
--print-ready | -y | If set and ICC Profile File is specified, the colours are converted and no ICC profile is stored in the PDF export file. Default value is FALSE. | FALSE | Optional |
Examples
.
Database to PDF | ||
Objective | Export a database chart to a PDF file. | |
Description | Command Line Syntax | |
Database chart for export to PDF. | hpd://username:password@ | |
File path and name of the PDF file. | C:\ExportedPDFs\chart_3218.pdf | |
Command Line | carisbatch -run ExportChartToPDF hpd://username:password@ | |
.
Database to PDF with specified options | ||
Objective | Export a database chart to a PDF file and set the process options. | |
Description | Command Line Syntax | |
Set the DPI of the PDF file to 762. | --dpi 762 | |
Scale the chart data to 75% of the PDF page size. | --scaling 75 | |
Convert all text to vector graphics. | --render-text-as-curves | |
Add lines at the corners to facilitate trimming the sheet to the specified size. | --include-trim-marks | |
Set the thickness of the trim marks to 0.5 mm. | --trim-marks-thickness 0.5 | |
Set the colour format of the chart to CMYK. | --colour-format CMYK | |
Set the ICC profile file to use for the chart colours. | --icc-profile-file C:\profile.icc | |
Convert the chart colours to those of the ICC profile. | --print-ready | |
Database chart for export to PDF. | hpd://username:password@ | |
File path and name of the PDF file. | C:\ExportedPDFs\chart_3218.pdf | |
Command Line | carisbatch --run ExportChartToPDF --dpi 762 --scaling 75 --render-text-as-curves --include-trim-marks --trim-marks-thickness 0.5 --colour-format CMYK --icc-profile-file C:\profile.icc --print-ready hpd://username:password@ | |
Standalone Chart to PDF | ||
Objective | Export a standalone chart to a PDF file. | |
Description | Command Line Syntax | |
Standalone chart for export to PDF. | D:\Charts\chart_3128.pcc | |
File path and name of the PDF file. | C:\ExportedPDFs\chart_3218.pdf | |
Command Line | carisbatch --run ExportChartToPDF D:\Charts\chart_3128.pcc C:\ExportedPDFs\chart_3218.pdf | |