Types
import type { Alignment, DockOptions, DockOptionsBreakpoint, FetchFeaturesOptions, PopupDockPosition } from "@arcgis/core/popup/types.js";

Type definitions

Alignment

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

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

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

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

PopupTemplateContentCreated

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Custom element content.

PopupTemplateContentCreator

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

PopupTemplateContentCreatorFunction

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

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

Parameters

ParameterTypeDescriptionRequired
event

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

PopupTemplateContentDestroyer

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

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

Parameters

ParameterTypeDescriptionRequired
event

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

ParameterTypeDescriptionRequired
event

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

PopupTemplateContentResolved

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

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

PopupTemplateTitleFunction

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0

Parameters

ParameterTypeDescriptionRequired
event

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

PopupTemplateTitleResolved

Type definition
Since
ArcGIS Maps SDK for JavaScript 5.0
Type
string