Options
All
  • Public
  • Public/Protected
  • All
Menu

A class to hold parameters that will be used by the Report and PrintTemplate classes to produce their output.

Hierarchy

  • ReportParameters

Index

Properties

customExtent

customExtent: Extent

The extent to use.

extentType

extentType: string

The type of extent that will be used for the map image in the report.

featureIds

featureIds: string[]

Array of feature ID strings on which to run the report.

fields

fields: TextField[]

The list of fields that are defined for the report.

grid

grid: MapGrid

The map grid to include in the report.

imageHeight

imageHeight: number

The image hight in pixels.

imageWidth

imageWidth: number

The image width in pixels.

includeData

includeData: boolean

Include BASE64 encoded data of the file in the output when available.

includeGeoreferenceData

includeGeoreferenceData: boolean

Indicates whether to include georeference data in the output.

mapGraphicsLayers

mapGraphicsLayers: object

The graphics that will be used on the map image in the report.

Type declaration

  • layers: object[]
  • symbols: Symbol[]

notificationEmailAddress

notificationEmailAddress: string

The email address to which to send a notification upon print completion.

outputFormat

outputFormat: string

The format for the report output.

resolution

resolution: Resolution

The resolution that will be used to create the report.

scale

scale: Scale

The scale that will be used for the map image in the report.

targetSpatialReference

targetSpatialReference: SpatialReference

The spatial reference in which to create the printed map.

useTransparentBackground

useTransparentBackground: boolean

Indicates whether to use a transparent background when rendering the map image.

Static Private CURRENT_EXTENT

CURRENT_EXTENT: string

String constant representing the current extent of the map.

Static Private CUSTOM_EXTENT

CUSTOM_EXTENT: string

String constant representing a custom extent.

Static Private FULL_EXTENT

FULL_EXTENT: string

String constant representing the full extent of the map.

Static Private INITIAL_EXTENT

INITIAL_EXTENT: string

String constant representing the initial extent.

Methods

populateMapGraphicsLayers

  • populateMapGraphicsLayers(esriMap: Map): void
  • Extracts the geometries and symbols from the map graphics layers.

    Parameters

    • esriMap: Map

      The {@link esri.Map} that contains the graphics layers.

    Returns void

toJson

  • Given an {@link esri.Map} and a {@link essentials.Map}, turns the ReportParameters into a JSON object ready for serialization.

    Parameters

    Returns any