Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FeatureTable

Hierarchy

Index

Properties

attachmentsEnabled

attachmentsEnabled: boolean

Indicates whether to display the Attachments field in the table.

Read more...

columnReorderingEnabled

columnReorderingEnabled: boolean

When true, columns can be reordered by dragging a column's header.

Read more...

columns

A collection of columns within the table.

Read more...

container

container: string | HTMLElement

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

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

editingEnabled

editingEnabled: boolean

Indicates whether editing is enabled on the data within the feature table.

Read more...

fieldConfigs

fieldConfigs: FieldColumnConfig[]

An array of individual field configuration objects.

Read more...

filterGeometry

filterGeometry: Geometry

Set this property to filter the features displayed in the table.

Read more...

highlightOnRowSelectEnabled

highlightOnRowSelectEnabled: boolean

Indicates whether to highlight the associated feature when a row is selected.

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

layer

The associated FeatureLayer or SceneLayer containing the fields and attributes to display within the widget.

Read more...

Readonly menu

Reference to the FeatureTable's primary menu.

Read more...

menuConfig

menuConfig: ButtonMenuConfig

Set this object to customize the feature table's menu content.

Read more...

pageSize

pageSize: number

The default page size used when displaying features within the table.

Read more...

view

view: MapView

A reference to the MapView.

Read more...

viewModel

The view model for this widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

Read more...

visibleElements

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

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns FeatureTable

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

clearHighlights

  • clearHighlights(): void
  • This clears any highlighted features.

    Read more...

    Returns void

clearSelection

  • clearSelection(): void
  • Clears the current selection within the table.

    Read more...

    Returns void

deselectRows

  • Unselects the specified rows within the table.

    Read more...

    Parameters

    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

findColumn

  • Finds the specified column within the feature table.

    Read more...

    Parameters

    • fieldName: string

    Returns FieldColumn

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

hideColumn

  • hideColumn(fieldName: string): void
  • Hides the specified column from the feature table.

    Read more...

    Parameters

    • fieldName: string

    Returns void

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

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

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

refresh

  • refresh(): void
  • Refreshes the table contents.

    Read more...

    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

scrollToIndex

  • scrollToIndex(): void
  • Scrolls the table to a row based on specified index.

    Read more...

    Returns void

selectRows

  • Selects the specified rows within the table.

    Read more...

    Parameters

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns FeatureTable

  • Parameters

    Returns FeatureTable

showAllColumns

  • showAllColumns(): void
  • Shows all the columns in the table.

    Read more...

    Returns void

showColumn

  • showColumn(fieldName: string): void
  • Shows the specified column within the feature table.

    Read more...

    Parameters

    • fieldName: string

    Returns void

sortColumn

  • sortColumn(path: string, direction: "asc" | "desc"): void
  • Sorts the column.

    Read more...

    Parameters

    • path: string
    • direction: "asc" | "desc"

    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