Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PopupViewModel

Hierarchy

Index

Properties

actions

Readonly active

active: boolean

Indicates if the Popup is active when it is visible and is not waiting for results.

Read more...

Readonly allActions

A collection of actions or action toggles used within the Popup.

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

content

content: string | HTMLElement | Widget

The content of the popup.

Read more...

declaredClass

declaredClass: string

Readonly defaultActions

A read-only property that specifies a Collection of action buttons and/or toggles within the popup.

Read more...

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

Readonly featureCount

featureCount: number

The number of selected features available to the popup.

Read more...

features

features: Graphic[]

An array of features associated with the popup.

Read more...

featuresPerPage

featuresPerPage: number

The number of features to fetch at one time.

Read more...

goToOverride

goToOverride: GoToOverride

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

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

includeDefaultActions

includeDefaultActions: boolean

Indicates whether or not to include defaultActions in the Popup's UI.

Read more...

initialized

initialized: boolean

location

location: Point

Geometry used to position the popup.

Read more...

Readonly pendingPromisesCount

pendingPromisesCount: number

The number of promises remaining to be resolved.

Read more...

Readonly promiseCount

promiseCount: number

The number of selected promises available to the popup.

Read more...

promises

promises: Promise<any>[]

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

Read more...

Readonly selectedClusterBoundaryFeature

selectedClusterBoundaryFeature: Graphic

The graphic used to represent the cluster extent when the Browse features action is active in a cluster popup.

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 state

state: "disabled" | "ready"

The view model's state.

Read more...

title

title: string

The title of the popup.

Read more...

view

The view associated with the Popup instance.

Read more...

visible

visible: boolean

Indicates whether the popup is visible.

Read more...

Readonly waitingForResult

waitingForResult: boolean

Indicates whether the popup has found a feature while resolving promises.

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

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PopupViewModel

clear

  • clear(): void

destroy

  • destroy(): void
  • 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

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

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

previous

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

    Read more...

    Returns PopupViewModel

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PopupViewModel

  • Parameters

    Returns PopupViewModel

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

Generated using TypeDoc