Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Feature

Hierarchy

Index

Properties

container

container: string | HTMLElement

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

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

graphic

graphic: Graphic

The Graphic used to represent the feature.

Read more...

headingLevel

headingLevel: number

Indicates the heading level to use for the title of the feature widget.

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

map

map: Map

A reference to the view's Map.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference used for Arcade operations.

Read more...

Readonly title

title: string

The title for the feature.

Read more...

view

A reference to the MapView or SceneView.

Read more...

viewModel

viewModel: FeatureViewModel

The view model for this widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

Read more...

visibleElements

visibleElements: FeatureVisibleElements

The visible elements that are displayed within the widget's graphic.popupTemplate.content.

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): Feature
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Feature

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

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

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

nextMedia

  • nextMedia(contentElementIndex: number): void
  • Paginates to the next media info.

    Read more...

    Parameters

    • contentElementIndex: number

    Returns void

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Registers an event handler on the instance.

    Read more...

    Parameters

    Returns IHandle

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

previousMedia

  • previousMedia(contentElementIndex: number): void
  • Paginates to the previous media info in the specified media content element.

    Read more...

    Parameters

    • contentElementIndex: number

    Returns void

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

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 Feature

  • Parameters

    Returns Feature

setActiveMedia

  • setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): void
  • Paginates to a specified media info object.

    Read more...

    Parameters

    • contentElementIndex: number
    • mediaInfoIndex: 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