PrintTemplate

Property Overview

Property Details

attributionVisible Boolean

When false, the attribution is not displayed on the printout. This only applies when the layout value is map-only. Reference our policies on Licensing & Attribution for specific attribution requirements.

Default Value:true

declaredClass Stringreadonly inherited

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

exportOptions Object

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. If the dpi value is modified, then the width and height will be modified proportional to the dpi change. If the width value is modified independently, the dpi and height values will not be modified.

height Number optional Map height. Default value is 1100. If the dpi value is modified, then the width and height will be modified proportional to the dpi change. If the height value is modified independently, the dpi and width values will not be modified.

dpi Number optional Resolution in dots per inch. Default value is 96. If the dpi value is modified, then the width and height will be modified proportional to the dpi change.

forceFeatureAttributes Boolean

When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering. By default they are removed to reduce the request size. Only applicable to custom print services which use the feature attributes, for example to display a table of features and their attributes.

Default Value:false

format String

The output format for the printed map.

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

Default Value:png32

includeTables Boolean

Since: ArcGIS Maps SDK for JavaScript 4.26

When true, tables will be included in the printout request. A table is a non-spatial dataset in a feature service or map service.

Note that for the table to display in the printout, the print template must be configured to support tables.

Default Value:false

See also

• Map.tables
• FeatureLayer.isTable

layout String

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:

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

layoutItem PortalItem

Since: ArcGIS Maps SDK for JavaScript 4.25

A custom layout hosted as a portal item. To use this property, the print service must be hosted on an ArcGIS Server that is federated with the same portal as the portal item.

Known Limitations

This capability is only available with ArcGIS Enterprise 11.1 or later.

See also

• Share custom layouts for printing from ArcGIS Pro

• Federate an ArcGIS Server site with your portal

Example

let item = new PortalItem({
  id: "affa021c51944b5694132b2d61fe1057"
});

// specify your own print service
const printURL = "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task";

const template = new PrintTemplate({
  layoutItem: item
});
const params = new PrintParameters({
  view,
  template
});

print.execute(printURL, params).then(printResult, printError);

layoutOptions Object

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

Properties

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

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

copyrightText String optional The text used for the copyright if the specified layout contains a copyright text element.

scalebarUnit String optional Default Value:Miles The unit used for the scalebar. Possible Values:"Miles"|"Kilometers"|"Meters"|"Feet"

legendLayers LegendLayer[] optional An array of LegendLayer containing the ids of the layers that will be included in the legend. GraphicsLayer will not appear in the legend. If legendLayers is not specified, all layers where legendEnabled is true, except GraphicsLayer, will be present in the legend. To specify that no layers will be included in the legend, set legendLayer = [].

customTextElements Object[] optional An array of name-value pair objects. Use this property to update the text for custom text elements on the page layout. Values must be strings. The custom text elements must exist in the print service. All out-of-the-box print service layout templates contain a text element named date that gets populated by default with the system date-time, but can be overwritten.

elementOverrides Object optional An object containing optional elements from the print service that can be updated.

Example

layoutOptions: {
  titleText: "My Print",
  authorText: "Sam",
  copyrightText: "My Company",
  scalebarUnit: "Miles",
  // the following text elements must
  // exist in the print service to appear
  customTextElements: [
    {"description": "My description"},
    {"location": "My Location"},
    {"date": "11/11/2020, 11:11:20 AM"}
  ],
  elementOverrides: {
    "North Arrow": {
      "visible": true
    }
  }
}

outScale Number

The optional map scale of the printed map. Only applies when scalePreserved is true. If outScale is 0, then the printed map will use the scale of the input map.

Default Value:0

scalePreserved Boolean

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

showLabels Boolean

When true, labels will be shown on the layout.

Default Value:true

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	Description
Boolean	Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");