PrintTemplate

require(["esri/tasks/support/PrintTemplate"], function(PrintTemplate) { /* code goes here */ });
Class: esri/tasks/support/PrintTemplate
Inheritance: PrintTemplate Accessor
Since: ArcGIS API for JavaScript 4.1

Defines the layout template options used by the PrintTask to generate the print page.

Constructors

new PrintTemplate(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Boolean

When false, the attribution is not displayed on the printout.

more details
more detailsPrintTemplate
String

The name of the class.

more details
more detailsAccessor
Object

Define the map width, height and dpi.

more details
more detailsPrintTemplate
String

The output format for the printed map.

more details
more detailsPrintTemplate
String

The layout used for the print output.

more details
more detailsPrintTemplate
Object

Defines the layout elements.

more details
more detailsPrintTemplate
Number

The optional map scale of the printed map.

more details
more detailsPrintTemplate
Boolean

Define whether the printed map should preserve map scale or map extent.

more details
more detailsPrintTemplate
Boolean

When true, labels will be shown on the layout.

more details
more detailsPrintTemplate

Property Details

attributionVisibleBoolean

When false, the attribution is not displayed on the printout.

Default Value: true

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

exportOptionsObject

Define the map width, height and dpi. Required when layout = 'map-only'. See the object specification table below for available options to set for exportOptions.

Properties:
width Number
optional

Map width. Default value is 800.

height Number
optional

Map height. Default value is 1100.

dpi Number
optional

Resolution in dots per inch. Default value is 96.

formatString

The output format for the printed map.

Known Values: pdf | png32 | png8 | jpg | gif | eps | svg | svgz

Default Value: png32

layoutString

The layout used for the print output. When the value is map-only or is empty, the output map does not contain any page layout surroundings (for example, title, legend, scale bar and so forth). The print service provides out-of-the-box templates listed in possible values. The server administrator can add additional templates to the print service.

Possible values are listed below:

ValueDescription
map-onlyMap does not contain any layout elements. Only map image is printed.
a3-landscape16.54 x 11.69 in
a3-portrait11.69 x 16.54 in
a4-landscape11.69 x 8.27 in
a4-portrait8.27 × 11.69 in
letter-ansi-a-landscape11.0 x 8.5 in
letter-ansi-a-portrait8.5 x 11.0 in
tabloid-ansi-b-landscape17.0 x 11.0 in
tabloid-ansi-b-portrait11.0 x 17.0 in
Default Value: map-only

layoutOptionsObject

Defines the layout elements. It's an object with the following properties:

Properties:
titleText String

The text used for the map title if the specified layout contains a title text element.

authorText String

The text used for the author if the specified layout contains an author text element.

copyrightText String

The text used for the copyright if the specified layout contains an copyright text element.

scalebarUnit String

The unit used for the scalebar.
Known Values: 'Miles' | 'Kilometers' | 'Meters' | 'Feet'.
Default Value 'Miles'.

legendLayers LegendLayer[]

An array of LegendLayer containing the id's of the layers that will be included in the legend. If legendLayers is not specified, all operational layers will be present in the legend. To specify that no layers will be included in the legend set legendLayer = [].

customTextElements Object[]

An array of name-value pairs. Use this property to update the text for custom text elements on the page layout. Values must be strings.

Example:
layoutOptions: {
  titleText: "My Print",
  authorText: "Sam",
  copyrightText: "My Company",
  scalebarUnit: "Miles",
  // the following text elements must
  // exist in your print service
  customTextElements: [{
     "description": "My description",
     "location": "My Location"
  }]
}

outScaleNumber

The optional map scale of the printed map. Only applies when preserveScale = true. If outScale is less than 1, then the printed map will use the scale of the input map.

Default Value: 0

preserveScaleBoolean

Define whether the printed map should preserve map scale or map extent. If true, the printed map will use the outScale property or default to the scale of the input map. If false, the printed map will use the same extent as the input map and thus scale might change.

Default Value: true

showLabelsBoolean

When true, labels will be shown on the layout.

Default Value: true

API Reference search results

NameTypeModule

There were no match results from your search criteria.