Print

Specify the print output file format(s) that the user can select based on the options available from the print service. This property can take a string value or an array of string values.

When this value is "all" (default value), all the print service formats are available to be used. When an array of string values is used, only those values that match the options available from the print service will be used. If none of the input string values match those available from the print service, allowedFormats will fallback to default behavior.

Attribute

allowed-formats

Default value

"all"

Specifies the print output file format(s) that the user can select when saving the exported map printout. This property can take a string value or an array of string values.

Attribute

allowed-formats-for-saving

Specify the print output layout(s) that the user can select based on the options available from the print service. This property can take a string value or an array of string values.

When this value is "all" (default value), all the print service layouts are available to be used. When an array of string values is used, only those values that match the options available from the print service will be used. If none of the input string values match those available from the print service, allowedLayouts will fallback to default behavior.

Attribute

allowed-layouts

Default value

"all"

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy method when you are done to prevent memory leaks.

Attribute

auto-destroy-disabled

Default value

false

Indicates whether or not to include defaultTemplates.

Attribute

exclude-default-templates

Default value

false

Indicates whether or not to include templates from an organization's portal.

Attribute

exclude-organization-templates

Default value

false

The collection of links exported from the Print component.

This option allows passing extra parameters (in addition to templateOptions) to the print (export webmap) requests.

Attribute

extra-parameters

Indicates the heading level to use for the "Exported files" text where users can access the exported map printout. By default, this text is rendered as a level 3 heading (e.g. <h3>Exported files</h3>). Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Attribute

heading-level

Default value

3

Indicates whether the component's header is hidden.

Attribute

hide-header

Default value

false

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

See also

• Calcite Icons

Attribute

icon

Default value

"print"

The component's default label.

Attribute

label

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

The spatial reference used to render the printed map on the server.

It is possible to search a specified portal instance's locator services. Use this property to set this ArcGIS Portal instance to search. This is especially helpful when working with a custom template.

If this property is set, it is not necessary to set the printServiceUrl property.

The UI position of a component.

Attribute

position

Default value

"top-left"

The URL of the REST endpoint of the Export Web Map Task. Defaults to the ArcGIS Online print service if this property is not specified. If the portal property is set, this property will use the portal's print service URL.

Attribute

print-service-url

By passing the id of the Map or Scene component into this property, you can position components from the @arcgis/map-components package anywhere in the DOM while still maintaining a connection to the Map or Scene.

See Associate components with a Map or Scene component.

Attribute

reference-element

The initial state of the print area toggle in the Print component UI. When set to true, the print area toggle is enabled by default. When set to false, the print area toggle is disabled by default.

Attribute

show-print-area-enabled

Default value

false

The state of the Print component.

Attribute

state

Default value

"disabled"

An object containing an array of customTextElements name-value pair objects for each print template in a custom print service. Use this property to update the text for custom text elements on the page layout.

The Print component calls the Get Layout Templates Info task on the GPServer to discover possible customTextElements values for each template. The name of the task must match Get Layout Templates Info, templates must be published with customTextElements, and values must be strings. Values found there will be populated in the Print component under Advanced options. These values can be overwritten in the Print component UI, or programmatically using this property. To list all print templates available on the print service to see see which templates were published with customTextElements, use the effectiveTemplateCustomTextElements property.

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

Emitted when the component is complete.

Emitted when the value of a property is changed. Use this to listen to changes to properties.

Emitted when the component associated with a map or scene view is is ready to be interacted with.

Emitted when the component is submitted.

Create a promise that resolves once component is fully loaded.

Example

1
2
3
4
const arcgisPrint = document.querySelector("arcgis-print");
document.body.append(arcgisPrint);
await arcgisPrint.componentOnReady();
console.log("arcgis-print is ready to go!");

Returns

Promise<void>

Permanently destroy the component.

Returns

Promise<void>