Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Events

onInitializationFailed

onInitializationFailed: function

Occurs when initialization of this object fails.

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

onInitialized

onInitialized: function

Occurs when initialization succeeds with a response from the REST endpoint. Depending on the API, this response may actually be an error message served as a correct HTTP response.

Type declaration

    • (sender: any): void
    • Parameters

      • sender: any

      Returns void

Properties

Private _initializing

_initializing: boolean

defaultGrid

defaultGrid: MapGrid

Default grid for this print template.

defaultMapScale

defaultMapScale: Scale

Default map scale for this print template.

defaultMapScaleName

defaultMapScaleName: string

Default map scale name for this print template.

defaultOutputFormat

defaultOutputFormat: string

Default output format for this print template.

defaultResolution

defaultResolution: Resolution

Default resolution for this print template.

description

description: string

The description of the PrintTemplate.

displayName

displayName: string

The display name of the PrintTemplate.

extensions

extensions: Extension[]

The extensions of the PrintTemplate, as defined by an administrator.

grids

grids: MapGrid[]

The map grids (for example, graticules) that are available for the print template.

id

id: string

The ID of the PrintTemplate.

initializationFailure

initializationFailure: Error

The exception that occurred if the object could not be initialized.

isDefault

isDefault: boolean

Whether or not this print template is default.

isInitialized

isInitialized: boolean

Whether or not the object was successfully initialized.

mainMapHeight

mainMapHeight: number

The height of the main Map control on the print template.

mainMapWidth

mainMapWidth: number

The width of the main Map control on the print template.

maximumResolution

maximumResolution: number

The maximum resolution at which this template can be printed.

properties

properties: any

The properties of the PrintTemplate, defined by the administrator on the server.

reportUrl

reportUrl: string

The URL of the PrintTemplate if it is a URL-based report.

site

site: Site

The Site that the PrintTemplate belongs to.

supportedMapScales

supportedMapScales: Scale[]

The collection of supported {@link geocortex.essentials.Scale}s for the PrintTemplate.

supportedOutputFormats

supportedOutputFormats: string[]

The collection of supported output formats for the PrintTemplate.

supportedResolutions

supportedResolutions: Resolution[]

The collection of supported Resolution settings for the PrintTemplate.

supportsEmailNotification

supportsEmailNotification: boolean

Whether or not this print template supports asynchronous execution providing an email to the user upon completion.

templateParameters

templateParameters: TemplateParameter[]

The parameters associated with this template if it is a URL-based report.

textFields

textFields: TextField[]

The collection of TextField for the PrintTemplate.

type

type: string

The type of report. One of ReportType. (currently only supporting MAP_TEMPLATE_REPORT).

url

url: string

The URL that this resource was initialized from.

visible

visible: boolean

The visibility of the PrintTemplate.

Methods

_configureObject

  • _configureObject(obj: any, deepInitialize?: boolean): void

Private _initializationFailedHandler

  • _initializationFailedHandler(err: Error): void

Private _initializedHandler

  • _initializedHandler(sender: any): void

Private _restErrorHandler

  • _restErrorHandler(error: Error): void

Private _restLoadHandler

  • _restLoadHandler(deepInitialize: boolean, result: any): void

doWhenInitialized

  • doWhenInitialized(callback: function): void
  • doWhenInitialized(scope: any, callback: function): void
  • Parameters

    Returns void

  • Performs a callback function when this instance has been initialized. If this instance is already initialized when this function is called, the callback function will execute immediately.

    Parameters

    • scope: any

      The scope to using when executing the callback - i.e. the value of the 'this' variable in the callback function. This parameter may be ommitted in which cased the first parameter will be used as the callback function.

    • callback: function

      The callback function to execute when this instance has been initialized.

    Returns void

initialize

  • initialize(obj?: any): void
  • Initializes the {@link geocortex.essentials.AsyncInitializable}. This is an asynchronous method, you may subscribe to the onInitialized and onInitializationFailed events for completion information.

    Parameters

    • Optional obj: any

    Returns void

isPrinting

  • isPrinting(): boolean
  • Gets whether the PrintTemplate is currently being printed.

    Returns boolean

    True if a print operation is currently being performed, false otherwise.

print

  • print(printParameters: ReportParameters, printComplete: function, printError: function): void
  • Prints the template using ReportParameters. This is an asynchronous method, you may provide delegates for completion or error information.

    Parameters

    • printParameters: ReportParameters

      The print parameters.

    • printComplete: function

      The delegate that will be called when the print has completed (even if an error occurs). This delegate expects one argument: a string representing the URL of the prepared report.

        • (results: any): void
        • Parameters

          • results: any

          Returns void

    • printError: function

      The delegate that will be called if an error occurs. This delegate expects two arguments: a reference to the PrintTemplate instance, and an Error.

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void