PrintViewModel | @types/arcgis-js-api

Hierarchy

Accessor
- PrintViewModel

Index

Properties

Methods

Properties

allowedFormats

allowedFormats: string | string[]

Specify the print output file format(s) that the user can select based on the options available from the print service.

allowedLayouts

allowedLayouts: string | string[]

Specify the print output layout(s) that the user can select based on the options available from the print service.

declaredClass

declaredClass: string

Readonly defaultTemplates

defaultTemplates: Collection<CustomTemplate>

A collection of print templates defined on the Portal.

destroyed

destroyed: boolean

Readonly effectivePrintServiceUrl

effectivePrintServiceUrl: string

The effective URL of the REST endpoint of the Export Web Map Task.

extraParameters

extraParameters: any

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

includeDefaultTemplates

includeDefaultTemplates: boolean

Indicates whether or not to include defaultTemplates.

initialized

initialized: boolean

portal

portal: Portal

It is possible to search a specified portal instance's locator services.

printServiceUrl

printServiceUrl: string

The URL of the REST endpoint of the Export Web Map Task.

scaleEnabled

scaleEnabled: boolean

When true, scale is used in the printed map.

Readonly state

state: "disabled" | "ready" | "error" | "initializing"

The view model's state.

Readonly templatesInfo

templatesInfo: any

The service metadata that contains the format and layout information for the printout.

updateDelay

updateDelay: number

The time interval in milliseconds between each job status request sent to an asynchronous GP task.

view

view: MapView

The view from which the widget will operate.

Methods

Protected _get

_get(propertyName: string): any
_get<T>(propertyName: string): T

Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Accessor._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): PrintViewModel

Inherited from Accessor._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns PrintViewModel

destroy

destroy(): void

Inherited from Accessor.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Accessor.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

load

load(): Promise<any>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:82885
This method should be called to load the view model's printing resources.

Read more...

Returns Promise<any>

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Accessor.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

print

print(printTemplate: supportPrintTemplate): Promise<any>

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:82891
Prints (exports) the current MapView according to selected options.

Read more...

Parameters
- printTemplate: supportPrintTemplate
Returns Promise<any>

set

set<T>(propertyName: string, value: T): PrintViewModel
set(props: HashMap<any>): PrintViewModel

Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns PrintViewModel
Inherited from Accessor.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns PrintViewModel

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Accessor.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Hierarchy

Index

Properties

Methods

Properties

allowedFormats

allowedLayouts

declaredClass

Readonly defaultTemplates

destroyed

Readonly effectivePrintServiceUrl

extraParameters

includeDefaultTemplates

initialized

portal

printServiceUrl

scaleEnabled

Readonly state

Readonly templatesInfo

updateDelay

view

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type parameters

T

Parameters

propertyName: string

value: T

Returns PrintViewModel

destroy

Returns void

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

load

Returns Promise<any>

Protected notifyChange

Parameters

propertyName: string

Returns void

print

Parameters

printTemplate: supportPrintTemplate

Returns Promise<any>

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns PrintViewModel

Parameters

props: HashMap<any>

Returns PrintViewModel

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle