TemplateOptions | @types/arcgis-js-api

Hierarchy

Accessor
- TemplateOptions

Index

Properties

Methods

Properties

attributionEnabled

attributionEnabled: boolean

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

author

author: string

The text used for the author if the specified layout contains an author text element.

copyright

The text used for the copyright if the specified layout contains an copyright text element.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

dpi

dpi: string

Resolution in dots per inch.

fileName

fileName: string

This property only applies when the layout value is map-only.

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.

height

height: number

Map height.

initialized

initialized: boolean

layout

The layout used for the print output.

legendEnabled

legendEnabled: boolean

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

scale

scale: number

The map scale of the printed map.

scaleEnabled

scaleEnabled: boolean

When true, scale is used in the printed map.

title

title: string

The text used for the map title if the specified layout contains a title text element.

width

width: number

Map width.

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

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 TemplateOptions

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): TemplateOptions
set(props: HashMap<any>): TemplateOptions

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

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

attributionEnabled

author

copyright

declaredClass

destroyed

dpi

fileName

forceFeatureAttributes

format

height

initialized

layout

legendEnabled

scale

scaleEnabled

title

width

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 TemplateOptions

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 TemplateOptions

Parameters

props: HashMap<any>

Returns TemplateOptions

watch

Parameters

path: string | string[]

callback: WatchCallback

Optional sync: boolean

Returns WatchHandle