AMD: require(["esri/widgets/Print/CustomTemplate"], (CustomTemplate) => { /* code goes here */ });
ESM: import CustomTemplate from "@arcgis/core/widgets/Print/CustomTemplate";
Class: esri/widgets/Print/CustomTemplate
Inheritance: CustomTemplate Accessor
Since: ArcGIS API for JavaScript 4.18

Defines the custom layout template options used by the Print widget to generate the print page. While custom templates can be published from ArcGIS Pro to a portal, custom layout templates are defined in a portal, where they can be added, removed, or edited as necessary without having to republish the print service. There are a limited number of options available for customization.

The main benefit of this class is that is allows developers to give a name to a preferred format and layout and if there should be a Legend present or not, in a reusable way. This is what the UI looks like in a portal:


See also:


new CustomTemplate(properties)
properties Object

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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The template's description.

more detailsCustomTemplate
Stringmore details

The output format for the printed map.

more detailsCustomTemplate
Stringmore details

The text that appears inside the Print Widget's Select template button.

more detailsCustomTemplate
Stringmore details

The layout used for the print output.

more detailsCustomTemplate
Objectmore details

Defines the layout elements.

more detailsCustomTemplate

Property Details

declaredClass Stringreadonly inherited

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

description Stringreadonly

The template's description.

format String

The output format for the printed map.

Possible Values:"pdf"|"png32"|"png8"|"jpg"|"gif"|"eps"|"svg"|"svgz"

Default Value:pdf
label Stringreadonly

The text that appears inside the Print Widget's Select template button. This is the label for the template as defined in a portal.

layout Stringreadonly

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: 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:

Value Description
map-only Map does not contain any layout elements. Only map image is printed.
a3-landscape A3 Landscape
a3-portrait A3 Portrait
a4-landscape A4 Landscape
a4-portrait A4 Portrait
letter-ansi-a-landscape Letter ANSI A Landscape
letter-ansi-a-portrait Letter ANSI A Portrait
tabloid-ansi-b-landscape Tabloid ANSI B Landscape
tabloid-ansi-b-portrait Tabloid ANSI B Portrait

Possible Values:"map-only"|"a3-landscape"|"a3-portrait"|"a4-landscape"|"a4-portrait"|"letter-ansi-a-landscape"|"letter-ansi-a-portrait"|"tabloid-ansi-b-landscape"|"tabloid-ansi-b-portrait"

Default Value:letter-ansi-a-landscape
layoutOptions Objectreadonly

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

legend Boolean

Indicates whether the legend will be included in the print-out.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.