PrintTemplate | @types/arcgis-js-api

Hierarchy

Accessor
- PrintTemplate

Index

Properties

Methods

Properties

attributionVisible

attributionVisible: boolean

When false, the attribution is not displayed on the printout.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

exportOptions

exportOptions: PrintTemplateExportOptions

Define the map width, height and dpi.

forceFeatureAttributes

forceFeatureAttributes: boolean

When true, the feature's attributes are included in feature collection layers even when they are not needed for rendering.

format

format: "png8" | "png32" | "jpg" | "gif" | "pdf" | "svg" | "svgz" | "eps"

The output format for the printed map.

initialized

initialized: boolean

layout

The layout used for the print output.

layoutOptions

layoutOptions: PrintTemplateLayoutOptions

Defines the layout elements.

outScale

outScale: number

The optional map scale of the printed map.

scalePreserved

scalePreserved: boolean

Define whether the printed map should preserve map scale or map extent.

showLabels

showLabels: boolean

When true, labels will be shown on the layout.

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): PrintTemplate

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 PrintTemplate

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

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

set

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

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 PrintTemplate
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 PrintTemplate

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

attributionVisible

declaredClass

destroyed

exportOptions

forceFeatureAttributes

format

initialized

layout

layoutOptions

outScale

scalePreserved

showLabels

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 PrintTemplate

destroy

Returns void

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

Protected notifyChange

Parameters

propertyName: string

Returns void

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns PrintTemplate

Parameters

props: HashMap<any>

Returns PrintTemplate

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle