Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

actions

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

Read more...

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

autoCloseEnabled

autoCloseEnabled: boolean

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

Read more...

autoOpenEnabled

autoOpenEnabled: boolean

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

Read more...

collapseEnabled

collapseEnabled: boolean

Indicates whether to enable collapse functionality for the popup.

Read more...

collapsed

collapsed: boolean

Indicates whether the popup displays its content.

Read more...

container

container: string | HTMLElement

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

Read more...

content

content: string | HTMLElement | Widget

The content of the popup.

Read more...

Readonly currentDockPosition

currentDockPosition: "auto" | "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top-center" | "bottom-center"

Dock position in the View.

Read more...

declaredClass

declaredClass: string

defaultPopupTemplateEnabled

defaultPopupTemplateEnabled: boolean

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

Read more...

destroyed

destroyed: boolean

dockEnabled

dockEnabled: boolean

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

Read more...

dockOptions

dockOptions: PopupDockOptions

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

Read more...

Readonly featureCount

featureCount: number

The number of selected features available to the popup.

Read more...

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

features

features: Graphic[]

An array of features associated with the popup.

Read more...

goToOverride

goToOverride: GoToOverride

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

Read more...

headingLevel

headingLevel: number

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

Read more...

highlightEnabled

highlightEnabled: boolean

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

Read more...

id

id: string

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

Read more...

initialized

initialized: boolean

label

label: string

The widget's label.

Read more...

location

location: Point

Point used to position the popup.

Read more...

maxInlineActions

maxInlineActions: any

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

Read more...

promises

promises: Promise<any>[]

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

Read more...

Readonly selectedFeature

selectedFeature: Graphic

The selected feature accessed by the popup.

Read more...

selectedFeatureIndex

selectedFeatureIndex: number

Index of the feature that is selected.

Read more...

Readonly selectedFeatureWidget

selectedFeatureWidget: Feature

Returns a reference to the current Feature that the Popup is using.

Read more...

spinnerEnabled

spinnerEnabled: boolean

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

Read more...

title

title: string

The title of the popup.

Read more...

view

A reference to the MapView or SceneView.

Read more...

viewModel

viewModel: PopupViewModel

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

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

Read more...

visibleElements

visibleElements: PopupVisibleElements

The visible elements that are displayed within the widget.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Popup
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Popup

blur

  • blur(): void
  • Use this method to remove focus from the Widget.

    Read more...

    Returns void

classes

  • classes(...classNames: any[]): string
  • A utility method used for building the value for a widget's class property.

    Read more...

    Parameters

    • Rest ...classNames: any[]

    Returns string

clear

  • clear(): void

close

  • close(): void
  • Closes the popup by setting its visible property to false.

    Read more...

    Returns void

destroy

  • destroy(): void
  • Destroys the widget instance.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchFeatures

focus

  • focus(): void
  • Use this method to give focus to the Widget if the widget is able to be focused.

    Read more...

    Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

next

  • Selects the feature at the next index in relation to the selected feature.

    Read more...

    Returns PopupViewModel

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

open

  • Opens the popup at the given location with content defined either explicitly with content or driven from the PopupTemplate of input features.

    Read more...

    Parameters

    Returns void

own

  • Widget teardown helper.

    Read more...

    Parameters

    Returns void

postInitialize

  • postInitialize(): void
  • This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

    Read more...

    Returns void

previous

  • Selects the feature at the previous index in relation to the selected feature.

    Read more...

    Returns PopupViewModel

render

  • render(): any
  • This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

    Read more...

    Returns any

renderNow

  • renderNow(): void
  • Renders widget to the DOM immediately.

    Read more...

    Returns void

reposition

  • reposition(): void
  • Positions the popup on the view.

    Read more...

    Returns void

scheduleRender

  • scheduleRender(): void
  • This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Popup

  • Parameters

    Returns Popup

triggerAction

  • triggerAction(actionIndex: number): void
  • Triggers the trigger-action event and executes the action at the specified index in the actions array.

    Read more...

    Parameters

    • actionIndex: number

    Returns void

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc