The EXPORT_PDF command exports all currently loaded data to a PDF file. The following parameters are supported by the command.
- FILENAME - full path to file to save the data to
- EXPORT_LAYER - filename or description of layer(s) to export. By default all compatible and exportable layers are exported. You can include multiple EXPORT_LAYER parameters if you have multiple masks to search. Wildcards (* and ?) are supported. Hidden layers are not considered.
- DPI - specifies the DPI that the file is generated at.
- EXPORT_SCALE - specifies the scale to do the export at. For example to export at 1:50,000 scale, use EXPORT_SCALE=50000.
- PDF_PAGE_SIZE - specifies the name of the paper size to use. This should match one of the entries on the PDF export dialog, like Letter, A0, etc. If you would like to define a custom page size, use a format like PDF_PAGE_SIZE="CUSTOM 12in x 18in" (creates a 12 inch wide by 18 inch tall page or PDF_PAGE_SIZE="CUSTOM 30cm X 60cm" which creates a 30 cm by 80 cm page.
- PDF_PAGE_ORIENTATION - specifies the page orientation to use for the generated PDF file. The following values are supported:
- AUTO - Automatically determine whether to use portrait or landscape mode based on export bounds aspect ratio.
- PDF_MARGINS - specifies the margins to use in inches. The value should be a comma-delimited list of numbers for the left, top, right, and bottom margins. For example, PDF_MARGINS="0.5,1.0,0.5,1.25" would result in a 0.5 inch margin for the left and right, 1.0 inch for the top, and 1.25 inches for the bottom.
- PDF_HEADER - specifies the header to use
- PDF_FOOTER - specifies the footer to use
- PDF_COMBINE_RASTERS - specifies whether multiple raster layers should be combined into a single layer or kept separate. Use PDF_COMBINE_RASTERS=YES to combine them or PDF_COMBINE_RASTER_LAYERS=NO to keep separate.
- PDF_VERSION - specifies the version of PDF to export. The default is PDF_VERSION=”1.5”. You can specify versions up to 1.7.
- PDF_EMBED_FONTS - controls whether or not unknown fonts are embedded in the exported PDF file. This is enabled by default, use PDF_EMBED_FONTS=NO to never embed any fonts.
- PDF_FILL_PAGE - specifies whether the PDF export should fill the page or be cropped to the exact bounds specified. Use PDF_FILL_PAGE=YES to enable or PDF_FILL_PAGE=NO to disable.
- PDF_FONT_SCALE - specifies the scale factor to apply to text. For example use PDF_FONT_SCALE=2.0 to double the size of text.
- PDF_SYMBOL_SCALE - specifies the scale factor to apply to point symbols and icons. For example use PDF_SYMBOL_SCALE=2.0 to double the size of symbols.
- LAYER_ATTR - specifies the attribute value to use from each feature for the layer name in the PDF file. The default is to use the feature description. See special Attribute Name parameter details for recognized values.
- VECTOR_ONLY - specifies that only vector layers should be exported to the PDF file. Use VECTOR_ONLY=YES to enable.
- SAVE_GRID_LINES - specifies that if grid line display is enabled that the grid lines should be saved. Specify SAVE_GRID_LINES=NO to disable this option. If it's not specified the grid lines will be saved if enabled.
- SAVE_SCALE_AND_LEGEND - specifies that the distance scale and elevation legend, if applicable and enabled for display on the Configuration dialog, should be exported to the generated PDF file. Specify SAVE_SCALE_AND_LEGEND=NO to disable this option. If it's not specified the current view settings will be used.
- PDF_USE_ADOBE_EXT - specifies that Adobe ISO 32000 Extensions should be used for georeference. Specify PDF_USE_ADOBE_EXT=YES to enable this option (default) or PDF_USE_ADOBE_EXT=NO to disable this option and use standard PDF georeferencing.
- OVERWRITE_EXISTING - specifies that existing files should be overwritten. The default is OVERWRITE_EXISTING=YES, so use OVERWRITE_EXISTING=NO to skip exporting files that already exist.
Specify Bounding Box for Operation
See also Specify Bounds for Operation
- GLOBAL_BOUNDS - specifies the combine bounds in units of the current global projection. There should be 4 values in a comma-delimited list following the parameter name. The values should be in order of minimum x, minimum y, maximum x, maximum y.
- GLOBAL_BOUNDS_SIZE - specifies the combine bounds in units of the current global projection. There should be 4 values in a comma-delimited list following the parameter name. The values should be in order of minimum x, minimum y, width in x, width in y.
- LAT_LON_BOUNDS - specifies the combine bounds in latitude/longitude degrees. There should be 4 values in a comma-delimited list following the parameter name. The values should be in order of west-most longitude, southern-most latitude, eastern-most longitude, northern-most latitude.
- LAYER_BOUNDS - specifies that the operation should use the bounds of the loaded layer(s) with the given filename. For example, to export to the bounds of the file "c:\test.tif", you would use LAYER_BOUNDS="c:\test.tif". Keep in mind that the file must be currently loaded.
- LAYER_BOUNDS_EXPAND - specifies that the operation should expand the used LAYER_BOUNDS bounding box by some amount. The amount to expand the bounding rectangle by should be specified in the current global projection. For example, if you have a UTM/meters projection active and want to expand the bounds retrieved from the LAYER_BOUNDS parameter by 100 meters on the left and right, and 50 meters on the top and bottom, you could use LAYER_BOUNDS_EXPAND="100.0,50.0". You can also specify a single value to apply to all 4 sides, or supply 4 separate values in the order left,top,right,bottom.
- SNAP_BOUNDS_TO_MULTIPLE - specifies that the top-left corner of the bounding box for the operation should be snapped to a multiple of the given value. For example, using SNAP_BOUNDS_TO_MULTIPLE=1 will snap the top-left corner to the nearest whole number. The values will always go smaller for X/easting/longitude and larger to Y/northing/latitude so you always get at least what is requested.
- SNAP_BOUNDS_TO_SPACING - specifies that the top-left corner of the bounding box for the operation should be snapped to a multiple of the resolution of the operation. For example, if you are exporting at 5 meter spacing, the top left corner will be snapped to the nearest multiple of 5. Use SNAP_BOUNDS_TO_SPACING=YES to enable or SNAP_BOUNDS_TO_SPACING=NO to disable. If not provided, the global setting for snapping exports to the nearest sample spacing boundary from the Advanced section of the General tab of the Configuration dialog will be used.
- USE_EXACT_BOUNDS - specifies that the exact bounds that were defined in the command should be used. Generally, when the bounds specified in a command are not the same as the data bounds, the command uses the intersection between the two. When USE_EXACT_BOUNDS=YES is specified, the command will use the bounds as specified, instead of the intersection.
Tiling/Gridding Export into Smaller Chunks
See also Gridding/Tiling Operations into Smaller Chunks
- GRID_TYPE_CELL_SIZE - specifies that the export should be gridded into multiple tiles with each tile having the given size in the export projection. The value should be specified as cell width,cell height. For example, if you are exporting in a metric projection and want to tile the export into cells that are 10,000 meters wide by 5,000 meters tall, you would use GRID_TYPE_CELL_SIZE="10000.0,5000.0".
- GRID_TYPE_PIXEL_SIZE - specifies that the export should be gridded into multiple tiles with each tile having the given size in pixels/samples. The value should be specified as cell pixel width,cell pixel height. For example, if you want to tile the export into cells that are 800 pixels wide by 600 pixels tall, you would use GRID_TYPE_PIXEL_SIZE="800,600".
- GRID_TYPE_PIXEL_SIZE_MAX - specifies that the export should be gridded into multiple tiles with each tile having the given maximum size in pixels/samples. This works by calculating the number of rows and columns needed to hold cells of the given pixel dimensions, then shrinking those pixel dimensions down so that the tiles exactly cover the exported bounds. The value should be specified as cell pixel width,cell pixel height. For example, if you want to tile the export into cells that are at most 800 pixels wide by 600 pixels tall, you would use GRID_TYPE_PIXEL_SIZE_MAX="800,600".
- GRID_TYPE_ROWS_COLS - specifies that the export should be gridded into multiple tiles with a given number of rows and columns of tiles. The value should be specified as number of rows,number of columns. For example, if you want to tile the export into a grid of 8 rows each 4 tiles across, you would use GRID_TYPE_ROWS_COLS="8,4".
- GRID_OVERLAP - specifies how much to overlap tiles when gridding an export into multiple tiles. This is a percentage value from 0 to 100 and only applies when on of the GRID_TYPE_* parameters is used. For example, to make your grid tiles overlap by 5% of the grid tile size, use GRID_OVERLAP="5.0". The default value is 0.0, meaning that the tiles do not overlap.
- GRID_OVERLAP_NUM_PIXELS - indicates whether or not the value specified in GRID_OVERLAP should be interpreted as a number of pixels instead of a percentage. Use GRID_OVERLAP_NUM_PIXELS=YES to specify that the value specified in the GRID_OVERLAP parameter should be interpreted as a number of pixels. Use GRID_OVERLAP_NUM_PIXELS=NO or omit this parameter to specify that the value is a percentage.
- GRID_KEEP_CELL_SIZE - specifies that the size of the grid cells should be maintained over sample spacing. This means that if you specify a grid of 4 rows and 5 columns, each grid cell will be exactly 25% of the total export height and 20% of the total export width. The sample spacing may be slightly smaller than what is specified in order to achieve this. By default, the sample spacing is exactly maintained and each grid cell may be slightly larger than specified to maintain an integer number of exported cells. Use GRID_KEEP_CELL_SIZE=YES to enable.
- GRID_NAMING - specifies how to name tiles when gridding an export into multiple tiles. The value should be SEQUENTIAL for sequential numeric naming starting at 1, SEPARATE for separate prefix appending by row and column, or SEPARATE_COLS_FIRST for separate prefix appending by columns and rows. For the SEPARATE options, use the GRID_NAMING_COLS and GRID_NAMING_ROWS parameters to specify the details of how to name the rows and columns. The value will be appended to FILENAME specified in the EXPORT command. If no GRID_NAMING parameter is supplied, the last selected grid naming options selected in the user interface will be used.
- GRID_NAMING_COLS - specifies how to name the column portion of grid cell names when using the GRID_NAMING=SEPARATE or GRID_NAMING=SEPARATE_COLS_FIRST parameter. The value of this field is a comma-delimited list with the following field values:
- Naming type. Can have the following values:
- NUM - name using numbers in ascending order
- NUM_REVERSE - name using numbers in descending order
- ALPHA - name using letters in ascending order
- ALPHA_REVERSE - name using letters in descending order
- Starting value for numbering or lettering (i.e. '1', or 'A'). If the naming type is numeric you can also specify %left% or %right% as the starting value to use the left or right coordinate of the cell bounding box. For row naming you can use %top% or %bottom%.
- Prefix string to use before the numeric or alphabetic value.
- Step value for numeric naming (default is '1')
You can leave values blank if they don't apply or you want to use the default. As an example, to do numeric naming starting at the number 100, increasing by 10 each time with a prefix of DEM, you would use GRID_NAMING_COLS="NUM,100,DEM,10".
- Naming type. Can have the following values:
- GRID_NAMING_ROWS - specifies how to name the row portion of grid cell names when using the GRID_NAMING=SEPARATE parameter. See the documentation for the GRID_NAMING_COLS parameter above for details on the format.
- GRID_NAMING_PREPEND_ZEROES - specifies whether or not to prepend zeroes to the start of grid column/row names. Use GRID_NAMING_PREPEND_ZEROES=NO to disable the prepending of zeroes.
- GRID_NAMING_SEPARATOR - specifies the separator string to use between pieces of a grid name. The default is an underscore (_).
- GRID_CREATE_FOLDERS - specifies that a separate folder should be generated for each row (or column if GRID_NAMING=SEPARATE_COLS_FIRST is specified) of the export rather than placing every output file in the same folder.
- Tiling to Polygons/Areas - If you would like to tile your export to a series of polygons/areas, use the POLYGON_CROP_FILE and POLYGON_CROP_USE_EACH parameters. Click the link for details.