Skip to contentEsri Developer
  • Documentation

    Maps and scenes

    Build 2D and 3D mapping applications with client APIs, the basemap styles service, and data services.

    Learn more in the Mapping and location services guide

    Topics

    • Mapping
    • Types of mapping apps
    • How to build a mapping app
    • Maps (2D)
    • Scenes (3D)
    • Basemaps
    • Custom basemap styles
    • Data layers
    • Web maps
    • Web scenes

    Tutorials

    • JavaScript Maps SDK
    • .NET Maps SDK
    • Kotlin Maps SDK
    • Swift Maps SDK
    • Flutter Maps SDK
    • Java Maps SDK
    • Qt Maps SDK
    • Unity Maps SDK
    • Unreal Engine Maps SDK
    • Leaflet
    • MapLibre GL JS
    • OpenLayers
    • CesiumJS
    • Python API
    • Map Viewer
    • Scene Viewer
    • Vector tile style editor
  • SDKs and APIs
  • Explore developer products
  • Explore help resources

ArcGIS Maps SDK for JavaScriptReferences

  • Home
  • Sample Code
  • References
  • Showcase
  • Blogs
  • core
    • AttributeBinsGraphic
    • Basemap
    • Camera
    • CameraLayout
    • Color
    • Graphic
    • Ground
    • Map
    • PopupTemplate
    • Viewpoint
    • WebDocument2D
    • WebLinkChart
    • WebMap
    • WebScene
    • arcade
    • config
    • intl
    • kernel
    • request
    • unionTypes
      • AreaMeasurement2D
      • AreaMeasurement3D
      • Attachments
      • Attribution
      • BasemapGallery
      • BasemapLayerList
      • BasemapToggle
      • BatchAttributeForm
      • Bookmarks
      • BuildingExplorer
      • CatalogLayerList
      • Compass
      • CoordinateConversion
      • Daylight
      • DirectLineMeasurement3D
      • DirectionalPad
      • Directions
      • DistanceMeasurement2D
      • Editor
      • ElevationProfile
      • Expand
      • Feature
      • FeatureForm
      • FeatureTable
      • FeatureTemplates
      • Features
      • FloorFilter
      • Fullscreen
      • Histogram
      • HistogramRangeSlider
      • Home
      • LayerList
      • Legend
      • LineOfSight
      • Locate
      • Measurement
      • NavigationToggle
      • OrientedImageryViewer
      • Popup
      • Print
        • CustomTemplate
        • FileLink
        • LayoutOptions
        • LayoutTemplateInfo
        • MapSurroundInfoBase
        • MapSurroundInfoGroupElement
        • MapSurroundInfoLegend
        • MapSurroundInfoNorthArrow
        • MapSurroundInfoScaleLine
        • PrintViewModel
        • TemplateOptions
        • types
      • ScaleBar
      • ScaleRangeSlider
      • Search
      • ShadowCast
      • Sketch
      • Slice
      • Slider
      • Swipe
      • TableList
      • TimeSlider
      • TimeZoneLabel
      • Track
      • UtilityNetworkAssociations
      • UtilityNetworkTrace
      • UtilityNetworkValidateTopology
      • ValuePicker
      • VideoPlayer
      • Weather
      • Widget
      • Zoom
      • types
  • map-components
  • charts-components
  • ai-components
  • embeddable-components
  • common-components
  • coding-components

FileLink

import FileLink from "@arcgis/core/widgets/Print/FileLink.js";
const FileLink = await $arcgis.import("@arcgis/core/widgets/Print/FileLink.js");
Inheritance
FileLink→Accessor
Since
ArcGIS Maps SDK for JavaScript 5.0

Represents an exported map request from the result of the Print widget. Successful exports will have a URL that links to the printout. Failed ones will have information on what went wrong.

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: function(response) {
console.log("exportedLinks: ", print.exportedLinks.items[0]);
}
});
});

Constructors

Constructor

Constructor

Parameters

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
PropertyTypeClass
count
number | null | undefined
declaredClass
readonly inherited
string
Accessor
error
EsriError | null | undefined
extension
string | null | undefined
formattedName
string | null | undefined
name
string | null | undefined
portalItem
IPortalItem | null | undefined
state
"ready" | "error" | "pending"
url
string

count

Property
Type
number | null | undefined

The location of the FileLink element in the array.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

error

Property
Type
EsriError | null | undefined

The Error from the Print widget, if any.

extension

Property
Type
string | null | undefined

The file type of the print-out.

formattedName

Property
Type
string | null | undefined

The name of the FileLink, formatted with name, extension and count.

name

Property
Type
string | null | undefined

The TemplateOptions.fileName or TemplateOptions.title of the print-out.

portalItem

autocast Property
Type
IPortalItem | null | undefined

The PortalItem of the template.

state

Property
Type
"ready" | "error" | "pending"

The state of the print-out. Either "ready" or "pending" or "error".

Default value
"pending"

url

Property
Type
string

The Print.printServiceUrl of the print-out.

Default value
""
  • Constructors
  • Properties
Was this page helpful?

Copyright © 2026 Esri . All rights reserved.

  • Privacy
  • Terms of Use

Sign up to receive the latest news from Esri