types | References | ArcGIS Maps SDK for JavaScript

Types

import type { Alignment, PopupAction, InitialDisplayOptions, PopupOpenOptions, DockOptions } from "@arcgis/core/popup/types.js";

Type definitions

Alignment

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: PopupPositionValue | (() => PopupPositionValue)

PopupAction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Type: ActionButton | ActionToggle

InitialDisplayOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Type: "list" | "feature"

PopupOpenOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

DockOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

buttonEnabled

Property

Type: boolean | undefined

Indicates whether the dock button is enabled.

position

Property

Type: PopupDockPosition | undefined

The position of the docked popup.

breakpoint

Property

Type: DockOptionsBreakpoint | boolean | undefined

The breakpoint options for docking.

DockOptionsBreakpoint

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

width

Property

Type: number | undefined

The width breakpoint for docking.

height

Property

Type: number | undefined

The height breakpoint for docking.

FetchFeaturesOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

event

Property

Type: ClickEvent | undefined

The view click event that is passed into the fetchFeatures method.

signal

Property

Type: AbortSignal | undefined

An AbortSignal to cancel the fetch operation.

PopupDockPosition

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: PopupPositionValue | (() => PopupPositionValue)

PopupOutsideViewOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

popupHeight

Property

Type: number

The height of the popup.

popupWidth

Property

Type: number

The width of the popup.

screenLocation

Property

Type: ScreenPoint

The location on the screen where the popup is anchored.

view

Property

Type: MapView | SceneView

The view in which the popup is displayed.

side

Property

Type: PopupOutsideViewSide

The side of the view where the popup is located.

PopupOutsideViewSide

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "bottom" | "left" | "right" | "top"

PopupPosition

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

left

Property

Type: number | undefined

The offset from the left edge of the screen.

top

Property

Type: number | undefined

The offset from the top edge of the screen.

right

Property

Type: number | undefined

The offset from the right edge of the screen.

bottom

Property

Type: number | undefined

The offset from the bottom edge of the screen.

PopupPositionResult

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "bottom-center" | "bottom-left" | "bottom-right" | "top-center" | "top-left" | "top-right"

PopupPositionStyle

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

left

Property

Type: string | undefined

The offset from the left edge of the screen.

top

Property

Type: string | undefined

The offset from the top edge of the screen.

right

Property

Type: string | undefined

The offset from the right edge of the screen.

bottom

Property

Type: string | undefined

The offset from the bottom edge of the screen.

PopupPositionValue

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: PopupPositionResult | PopupPositionVariable

PopupPositionVariable

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "auto" | "bottom-end" | "bottom-start" | "top-end" | "top-start"

PopupTemplateContent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: PopupTemplateContentResolved | PopupTemplateContentPromise | PopupTemplateContentFunction

PopupTemplateContentCreated

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Custom element content.

Type: string | HTMLElement | null | undefined

PopupTemplateContentCreator

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: PopupTemplateContentCreatorFunction | PopupTemplateContentCreatorPromise | PopupTemplateContentCreated

PopupTemplateContentCreatorFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The function that is called to create the custom content element.

Parameters

Parameter	Type	Description	Required
event	PopupTemplateCreatorEvent	The event that contains the Graphic used to represent the feature.

Returns: PopupTemplateContentCreated | PopupTemplateContentCreatorPromise
The created custom content element.

PopupTemplateContentCreatorPromise

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: Promise<PopupTemplateContentCreated>

PopupTemplateContentDestroyer

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The function that is called to destroy the custom content element.

Parameters

Parameter	Type	Description	Required
event	PopupTemplateCreatorEvent	The event that contains the Graphic used to represent the feature.

Returns: void

PopupTemplateContentFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Parameters

Parameter	Type	Description	Required
event	PopupTemplateCreatorEvent	The event that contains the Graphic used to represent the feature.

Returns: PopupTemplateContentResolved | PopupTemplateContentPromise

PopupTemplateContentPromise

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: Promise<PopupTemplateContentResolved>

PopupTemplateContentResolved

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: PopupTemplateContentCreated | Content[]

PopupTemplateCreatorEvent

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The event that contains the Graphic used to represent the feature.

graphic

Property

Type: Graphic

Since: ArcGIS Maps SDK for JavaScript 5.0

The Graphic used to represent the feature.

PopupTemplateTitle

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: PopupTemplateTitleResolved | PopupTemplateTitlePromise | PopupTemplateTitleFunction

PopupTemplateTitleFunction

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Parameters

Parameter	Type	Description	Required
event	PopupTemplateCreatorEvent	The event that contains the Graphic used to represent the feature.

Returns: PopupTemplateTitleResolved | PopupTemplateTitlePromise

PopupTemplateTitlePromise

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: Promise<PopupTemplateTitleResolved>

PopupTemplateTitleResolved

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: string

State

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "disabled" | "ready" | "error" | "loading"

FeatureFormattedAttributes

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

global

Property

Type: Record<string, any>

Since: ArcGIS Maps SDK for JavaScript 5.1

The formatted attributes specified at the root level of the PopupTemplate using the PopupTemplate.fieldInfos property.

content

Property

Type: Record<string, any>[]

Since: ArcGIS Maps SDK for JavaScript 5.1

The formatted attributes for an individual content element. This is derived from the PopupTemplate, or per an individual content element. This element is defined with a FieldsContent popup element set on the PopupTemplate's PopupTemplate.content.

LastEditInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

user

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

User who performed the last edit on a feature.

date

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

Date that the edit was performed.

type

Property

Type: "edit" | "create"

Since: ArcGIS Maps SDK for JavaScript 5.1

The type of edit that was performed on the feature.

LayerInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

Information about the layer associated with the feature.

fields

Property

Type: Field[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of the layer's fields.

relationships

Property

Type: Relationship[]

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of the layer's relationships.

objectIdField

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The object ID field of the layer.

supportsStatistics

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates whether the layer supports statistics.

RelatedInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.1

url

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.1

The URL of the related layer.

outStatistics

Property

Type: StatisticDefinition[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of statistics to be calculated for the related features.

relatedFields

Property

Type: string[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of related fields that are related to the current feature.

relatedFeatures

Property

Type: Graphic[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of features related to the current feature.

relatedStatsFeatures

Property

Type: Graphic[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

An array of related features with statistics for the current feature.

relation

Property

Type: Relationship | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

The relationship between the current feature and the related features.

layerInfo

Property

Type: LayerInfo | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

The layer information for the related features.

sourceSpatialReference

Property

Type: SpatialReference | undefined

Since: ArcGIS Maps SDK for JavaScript 5.1

The spatial reference of the source feature.