import Print from "@arcgis/core/widgets/Print.js";const Print = await $arcgis.import("@arcgis/core/widgets/Print.js");- Inheritance:
- Print→
Widget<PrintProperties>→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.2
The Print widget connects your application with a printing service to allow the map to be printed. It takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS, which can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc. The Print widget works with the print which generates a printer-ready version of the map.
The Print widget has two required properties: view (reference to the MapView) and printServiceUrl (URL of the REST endpoint of the Export Web Map Task). The widget can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use TemplateOptions.scaleEnabled to preserve scale instead.
The Print widget prints a localized date for all layouts
except map-only. If using a custom print service, then customTextElements are supported for each print
template. Values found there will be populated in the Print widget under Advanced options. These values can
be overwritten in the Print widget UI, or programmatically using the
templateCustomTextElements property.
For more information about printing with the MAP_ONLY layout, please see
PrintTemplate.exportOptions.
Known Limitations
See print for a detailed list of known limitations.
Example
const print = new Print({ view: view, // specify your own print service printServiceUrl: "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"});
// Adds widget below other elements in the top left corner of the viewview.ui.add(print, "top-left");Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Example
// typical usageconst print = new Print({ view: view, printServiceUrl: "https://www.example.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"});Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
container inherited | HTMLElement | null | undefined | |
declaredClass readonly inherited | ||
destroyed readonly inherited | ||
| | ||
| | ||
| | ||
Icon["icon"] | | |
id inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
PrintViewModel["templateCustomTextElements"] | | |
| | ||
| | ||
| | ||
visible inherited |
allowedFormats
- Type
- Formats
- Since
- ArcGIS Maps SDK for JavaScript 4.15
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.
- See also
- Default value
- "all"
Example
const print = new Print({ view: view, printServiceUrl: "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task", allowedFormats: ["jpg", "png8", "png32"]}); allowedLayouts
- Type
- Layouts
- Since
- ArcGIS Maps SDK for JavaScript 4.15
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.
- See also
- Default value
- "all"
Example
const print = new Print({ view: view, printServiceUrl: "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task", allowedLayouts: ["a3-landscape", "a3-portrait"]}); container
- Type
- HTMLElement | null | undefined
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples
// Create the HTML div element programmatically at runtime and set to the widget's containerconst basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div")});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"});// Specify an already-defined HTML div element in the widget's container
const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"});
// HTML markup<body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div></body>// Specify the widget while adding to the view's UIconst basemapGallery = new BasemapGallery({ view: view});
// Add the widget to the top-right corner of the viewview.ui.add(basemapGallery, { position: "top-right"}); exportedLinks
- Type
- Collection<FileLink>
- Since
- ArcGIS Maps SDK for JavaScript 4.17
The collection of links exported from the Print widget.
Example
const [Print, esriConfig] = await $arcgis.import([ "@arcgis/core/widgets/Print.js", "@arcgis/core/config.js"]);
// ...
view.when(function () { print = new Print({ view: view, // specify your own print service printServiceUrl: "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task" });
// Add widget to the top right corner of the view view.ui.add(print, "top-right");
// use a requestInterceptor to monitor the print widget // for print completion esriConfig.request.interceptors.push({ // set the `urls` property to the URL of the print service so that this // interceptor only applies to requests made to the print service URL urls: print.printServiceUrl, // use the AfterInterceptorCallback to interrogate the exportedLinks property after: (response) => { console.log("exportedLinks: ", print.exportedLinks.items[0]); } });}); headingLevel
- Type
- HeadingLevel
- Since
- ArcGIS Maps SDK for JavaScript 4.20
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 widget's placement
in your app, you may need to adjust this heading for proper semantics. This is
important for meeting accessibility standards.
- See also
- Default value
- 3
Example
// "Exported files" will render as an <h4>print.headingLevel = 4; icon
- Type
- Icon["icon"]
- Since
- ArcGIS Maps SDK for JavaScript 4.27
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
- Default value
- "print"
includeDefaultTemplates
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.18
Indicates whether or not to include PrintViewModel.defaultTemplates.
- Default value
- true
Example
const printWidget = new Print({ view: view, includeDefaultTemplates: false, portal: { url: "https://.example.arcgis.com/sharing/" }, container: "printDiv"}); includeOrganizationTemplates
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.32
Indicates whether or not to include templates from an organization's portal.
- Default value
- true
Example
const printWidget = new Print({ view: view, includeOrganizationTemplates: false, portal: { url: "https://.example.arcgis.com/sharing/" }, container: "printDiv"}); portal
- Type
- Portal
- Since
- ArcGIS Maps SDK for JavaScript 4.18
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 print template.
If this property is set, it is not necessary to set the printServiceUrl property.
- See also
Example
const printWidget = new Print({ view: view, portal: { url: "https://example.arcgis.com/sharing/" }, container: "printDiv"}); showPrintAreaEnabled
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.30
The initial state of the print area toggle in the Print widget 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.
- Default value
- false
templateCustomTextElements
- Type
- PrintViewModel["templateCustomTextElements"]
- Since
- ArcGIS Maps SDK for JavaScript 4.22
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 widget 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 widget under Advanced options. These values can be
overwritten in the Print widget 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
PrintViewModel.effectiveTemplateCustomTextElements
property.
Example
const printWidget = new Print({ view: view, // specify your custom print service printServiceUrl: "", // `customTextElements` are defined per print template // this example has one template with `customTextElements` templateCustomTextElements: { // if there were more applicable templates, then we would // create another object with the template name containing // an array of more name-value pairs "Landscape_TextElements": [ // the possible values are defined in the print service { "headquarters": "Foxborough, Massachusetts" }, { "division": "AFC East" }, { "founded": "1959" } ] }}); templateOptions
- Type
- TemplateOptions
- Since
- ArcGIS Maps SDK for JavaScript 4.6
Defines the layout template options used by the Print widget to generate the print page.
Example
templateOptions: { title: "My Print", author: "Sam", copyright: "My Company", legendEnabled: false} viewModel
- Type
- PrintViewModel
The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the PrintViewModel class to access all properties and methods on the widget.
visible
- Type
- boolean
Indicates whether the widget is visible.
If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is
the first of three widgets associated to the upper right hand corner of the DefaultUI, then the other widgets will reposition when this widget is made invisible.
For more information, refer to the css display value of "none".
- Default value
- true
Example
// Hides the widget in the viewwidget.visible = false;Methods
| Method | Signature | Class |
|---|---|---|
classes inherited | classes(...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string | |
destroy inherited | destroy(): void | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
postInitialize inherited | postInitialize(): void | |
render inherited | render(): any | null | |
renderNow inherited | renderNow(): void | |
scheduleRender inherited | scheduleRender(): void | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
classes
- Signature
-
classes (...classNames: ((string | null | undefined) | ((string[] | Record<string, boolean>) | null | undefined) | false | null | undefined)[]): string
- Since
- ArcGIS Maps SDK for JavaScript 4.7
A utility method used for building the value for a widget's class property.
This aids in simplifying css class setup.
Parameters
- Returns
- string
The computed class name.
Example
// .tsx syntax showing how to set css classes while rendering the widget
render() { const dynamicClasses = { [css.flip]: this.flip, [css.primary]: this.primary };
return ( <div class={classes(css.root, css.mixin, dynamicClasses)} /> );} emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
- Since
- ArcGIS Maps SDK for JavaScript 4.5
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
- Since
- ArcGIS Maps SDK for JavaScript 4.6
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){ // This function will execute once the promise is resolved}, function(error){ // This function will execute if the promise is rejected due to an error});Events
complete
complete: CustomEvent<CompleteEvent> - Since
- ArcGIS Maps SDK for JavaScript 4.17
Fires when a print request has been completed and returns its results. This event will fire whether an export succeeds or fails.
Example
const printWidget = new Print();
printWidget.on("complete", function(results){ // The results are stored in the results object console.log("Results of the print: ", results.link);}); submit
submit: CustomEvent<SubmitEvent> - Since
- ArcGIS Maps SDK for JavaScript 4.17
Fires when an export request begins, and returns a reference to the exported link.
Example
const printWidget = new Print();
printWidget.on("submit", function(results){ // The results are stored in the event object console.log("Results of submitting the print: ", results.link);});