Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PopupProperties

Hierarchy

Index

Properties

Optional actions

actions: CollectionProperties<(ActionButtonProperties & { type: "button" }) | (ActionToggleProperties & { type: "toggle" })>

Defines actions that may be executed by clicking the icon or image symbolizing them in the popup.

Read more...

Optional alignment

alignment: Function | "auto" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"

Position of the popup in relation to the selected feature.

Read more...

Optional autoCloseEnabled

autoCloseEnabled: boolean

This closes the popup when the View camera or Viewpoint changes.

Read more...

Optional autoOpenEnabled

autoOpenEnabled: boolean

This property indicates to the Popup that it needs to allow or disallow the click event propagation.

Read more...

Optional collapseEnabled

collapseEnabled: boolean

Indicates whether to enable collapse functionality for the popup.

Read more...

Optional collapsed

collapsed: boolean

Indicates whether the popup displays its content.

Read more...

Optional container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Read more...

Optional content

content: string | HTMLElement | WidgetProperties

The content of the popup.

Read more...

Optional defaultPopupTemplateEnabled

defaultPopupTemplateEnabled: boolean

Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.

Read more...

Optional dockEnabled

dockEnabled: boolean

Indicates whether the placement of the popup is docked to the side of the view.

Read more...

Optional dockOptions

dockOptions: PopupDockOptions

Docking the popup allows for a better user experience, particularly when opening popups in apps on mobile devices.

Read more...

Optional featureMenuOpen

featureMenuOpen: boolean

When enabled, the popup displays a list of all available features (using each feature's popup template title) rather than displaying the popup template of the first selected feature.

Read more...

Optional features

features: GraphicProperties[]

An array of features associated with the popup.

Read more...

Optional goToOverride

goToOverride: GoToOverride

This function provides the ability to override either the IMapView goTo() or SceneView goTo() methods.

Read more...

Optional headingLevel

headingLevel: number

Indicates the heading level to use for the title of the popup.

Read more...

Optional highlightEnabled

highlightEnabled: boolean

Highlight the selected popup feature using the highlightOptions set on the MapView or the highlightOptions set on the SceneView.

Read more...

Optional id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

Optional label

label: string

The widget's label.

Read more...

Optional location

location: PointProperties

Point used to position the popup.

Read more...

Optional maxInlineActions

maxInlineActions: any

Defines the maximum icons displayed at one time in the action area.

Read more...

Optional promises

promises: Promise<any>[]

An array of pending Promises that have not yet been fulfilled.

Read more...

Optional selectedFeatureIndex

selectedFeatureIndex: number

Index of the feature that is selected.

Read more...

Optional spinnerEnabled

spinnerEnabled: boolean

Indicates whether to display a spinner at the popup location prior to its display when it has pending promises.

Read more...

Optional title

title: string

The title of the popup.

Read more...

Optional view

view: (MapViewProperties & { type: "2d" }) | (SceneViewProperties & { type: "3d" })

A reference to the MapView or SceneView.

Read more...

Optional viewModel

This is a class that contains all the logic (properties and methods) that controls this widget's behavior.

Read more...

Optional visible

visible: boolean

Indicates whether the widget is visible.

Read more...

Optional visibleElements

visibleElements: PopupVisibleElements

The visible elements that are displayed within the widget.

Read more...

Generated using TypeDoc