Class default

Hierarchy

PopupTemplate
- default

Index

Constructors

constructor

new default(properties?: PopupTemplateProperties): default
A PopupTemplate formats and defines the content of a Popup for a specific Layer or Graphic.

Read more...
Parameters
- Optionalproperties: PopupTemplateProperties
Returns default
Inherited from PopupTemplate.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52899

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

lastEditInfoEnabled

lastEditInfoEnabled: boolean

Indicates whether or not editor tracking should display.

Default

true

outFields

outFields: string[] = ...

An array of field names used in the PopupTemplate.

Default

null

overwriteActions

overwriteActions: boolean

Indicates whether actions should replace existing popup actions.

Default

false

returnGeometry

returnGeometry: boolean

Indicates whether to include the feature's geometry for use by the template.

Default

false

title

title: string = '{address}'

The template for defining how to format the title used in a popup.

Accessors

actions

get actions(): nullish | Collection<ActionButton | ActionToggle>
A Collection of action or action toggle objects.

Read more...

Returns nullish | Collection<ActionButton | ActionToggle>
Inherited from PopupTemplate.actions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52905
set actions(
    value:
        | nullish
        | CollectionProperties<
            | ActionButtonProperties & { type: "button" }
            | ActionToggleProperties & { type: "toggle" },
        >,
): void
Parameters
- value:
      | nullish
      | CollectionProperties<
          | ActionButtonProperties & { type: "button" }
          | ActionToggleProperties & { type: "toggle" },
      >
Returns void
Inherited from PopupTemplate.actions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52906

expressionInfos

get expressionInfos(): nullish | popupExpressionInfo[]
An array of objects or ExpressionInfo[] that reference Arcade expressions following the specification defined by the Arcade Popup Profile.

Read more...

Returns nullish | popupExpressionInfo[]
Inherited from PopupTemplate.expressionInfos
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52924
set expressionInfos(value: nullish | popupExpressionInfoProperties[]): void
Parameters
- value: nullish | popupExpressionInfoProperties[]
Returns void
Inherited from PopupTemplate.expressionInfos
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52925

fieldInfos

get fieldInfos(): nullish | FieldInfo[]
An array of FieldInfo that defines how fields in the dataset or values from Arcade expressions participate in a popup.

Read more...

Returns nullish | FieldInfo[]
Inherited from PopupTemplate.fieldInfos
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52933
set fieldInfos(value: nullish | FieldInfoProperties[]): void
Parameters
- value: nullish | FieldInfoProperties[]
Returns void
Inherited from PopupTemplate.fieldInfos
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52934

layerOptions

get layerOptions(): nullish | LayerOptions
Additional options that can be defined for the popup layer.

Read more...

Returns nullish | LayerOptions
Inherited from PopupTemplate.layerOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52940
set layerOptions(value: nullish | LayerOptionsProperties): void
Parameters
- value: nullish | LayerOptionsProperties
Returns void
Inherited from PopupTemplate.layerOptions
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52941

Methods

`Protected`_get

_get(propertyName: string): any
Parameters
- propertyName: string
Returns any
Inherited from PopupTemplate._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName: string): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from PopupTemplate._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected`_set

_set<T>(propertyName: string, value: T): this
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns this
Inherited from PopupTemplate._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(
handles: IHandle | IHandle[],
groupKey?: Exclude<T, IHandle>,
): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- OptionalgroupKey: Exclude<T, IHandle>
Returns void
Inherited from PopupTemplate.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

clone

clone(): this
Creates a deep clone of this object.

Read more...

Returns this
Inherited from PopupTemplate.clone
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52947

content

content(event: { graphic: Graphic }): HTMLElement
Parameters
- event: { graphic: Graphic }
Returns HTMLElement
Overrides PopupTemplate.content
- Defined in src/popups/FloodplainStructurePopupTemplate.tsx:15

destroy

destroy(): void
Returns void
Inherited from PopupTemplate.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

hasHandles

hasHandles<T>(groupKey?: Exclude<T, IHandle>): boolean
Type Parameters
- T
Parameters
- OptionalgroupKey: Exclude<T, IHandle>
Returns boolean
Inherited from PopupTemplate.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

`Protected`notifyChange

notifyChange(propertyName: string): void
Parameters
- propertyName: string
Returns void
Inherited from PopupTemplate.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

removeHandles

removeHandles<T>(groupKey?: Exclude<T, IHandle>): void
Type Parameters
- T
Parameters
- OptionalgroupKey: Exclude<T, IHandle>
Returns void
Inherited from PopupTemplate.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

set

set<T>(propertyName: string, value: T): this
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns this
Inherited from PopupTemplate.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25
set(props: HashMap<any>): this
Parameters
- props: HashMap<any>
Returns this
Inherited from PopupTemplate.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:26

toJSON

toJSON(): any
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any
Inherited from PopupTemplate.toJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52953

watch

watch(
    path: string | string[],
    callback: WatchCallback,
    sync?: boolean,
): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optionalsync: boolean
Returns WatchHandle
Inherited from PopupTemplate.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

`Static`fromJSON

fromJSON(json: any): any
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.
Parameters
- json: any
  A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
  
  Read more...
Returns any
Inherited from PopupTemplate.fromJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52962
fromJSON(json: any): PopupTemplate
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.
Parameters
- json: any
  A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.
  
  Read more...
Returns PopupTemplate
Inherited from PopupTemplate.fromJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:52963

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

declaredClass

destroyed

initialized

lastEditInfoEnabled

Default

outFields

Default

overwriteActions

Default

returnGeometry

Default

title

Accessors

actions

Returns nullish | Collection<ActionButton | ActionToggle>

Parameters

Returns void

expressionInfos

Returns nullish | popupExpressionInfo[]

Parameters

Returns void

fieldInfos

Returns nullish | FieldInfo[]

Parameters

Returns void

layerOptions

Returns nullish | LayerOptions

Parameters

Returns void

Methods

Protected_get

Parameters

Returns any

Type Parameters

Parameters

Returns T

Protected_set

Type Parameters

Parameters

Returns this

addHandles

Type Parameters

Parameters

Returns void

clone

Returns this

content

Parameters

Returns HTMLElement

destroy

Returns void

hasHandles

Type Parameters

Parameters

Returns boolean

ProtectednotifyChange

Parameters

Returns void

removeHandles

Type Parameters

Parameters

Returns void

set

Type Parameters

Parameters

Returns this

Parameters

Returns this

`Protected`_get

`Protected`_set

`Protected`notifyChange

`Static`fromJSON