The CreateBorder process adds a border to a chart panel. The chart can be a database or a stand-alone PCC chart.
Input
HPD URI containing the Chart Version ID, Project ID, and a Panel Number. Stand-alone chart containing a Chart Version ID and a Panel Number.
Note that the Chart Version ID is always set to 1 for stand-alone charts.
Output
Same chart with a panel border.
Syntax
carisbatch --run CreateBorder --border-style-definition-file <value> --border-style-name <value> [options] <input>
Options
Long | Short | Description | Can Repeat | Notes |
|---|---|---|---|---|
--border-style-definition-file | -D | Path and file name of the border style definition file. | FALSE | Required |
--border-style-name | -N | Name of the border style applied to the panel. | FALSE | Required |
--scale-bar-scaling-latitude | -L | Scale bar scaling latitude in decimal degrees. | FALSE | Optional |
Example
To use this process, refer to the following examples.
Database Chart | ||
Objective | Add an IHO_E border to panel 1 of a database chart. The chart has scaling latitude of 43.607. | |
Description | Command Line Syntax | |
Location of the border definition file. | C:\Program Files\CARIS\HPD\4.0\system\PCEConfig\IH_BorderStyles.bsd" | |
Database chart to which the border is being applied. | hpd://username:password@OracleDB/db?ChartVersionId=4;ProjectId=1;PanelNumber=1 | |
Command Line | carisbatch --run CreateBorder --border-style-definition-file "C:\Program Files\CARIS\HPD\3.2\system\PCEConfig\IH_BorderStyles.bsd" --border-style-name "IHO_E" --scale-bar-scaling-latitude "43.607" hpd://username:password@OracleDB/db?ChartVersionId=4;ProjectId=1;PanelNumber=1 | |
Result | An IHO_E border is added panel 1 in chart 4. | |
Stand-Alone Chart | ||
Objective | Add an IHO_E border to panel 1 of a stand-alone chart. The chart has a scaling latitude of 43.607. | |
Description | Command Line Syntax | |
Location of the border definition file. | C:\Program Files\CARIS\HPD\4.0\system\PCEConfig\IH_BorderStyles.bsd" | |
Stand-alone chart to which the border is being applied. | MyChart.pcc?ChartVersionId=1&PanelNumber=1 | |
Command Line | carisbatch --run CreateBorder --border-style-definition-file "C:\Program Files\CARIS\HPD\3.2\system\PCEConfig\IH_BorderStyles.bsd" --border-style-name "IHO_E" --scale-bar-scaling-latitude "43.607" file:///D:/AllMyCharts/MyChart.pcc?ChartVersionId=1&PanelNumber=1 | |