Class: TreeDataProviderView

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

class TreeDataProviderView<K, D, Kin, Din> implements DataProvider<K, D>

QuickNav

Fields


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

TreeDataProviderView

Version:
  • 7.1.0
Since:
  • 6.2.0
Module:
  • ojtreedataproviderview

Module usage

See JET Module Loading for an overview of module usage within JET.

Javascript Import Format
define(['ojs/ojtreedataproviderview'], function(TreeDataProviderView) {
 // Application should call API on TreeDataProviderView 
})
Typescript Import Format
//This class is exported directly as module. To import it
import TreeDataProviderView= require("ojs/ojtreedataproviderview");

Generic Parameters
ParameterDescription
KType of output key
DType of output data
KinType of input key
DinType of input data

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

Description

Provides list based optimizations for oj.DataProvider. Supports fetchFirst starting at arbitrary key or index offset, sortCriteria, and field mapping. Please see the select demos for examples of DataMapping Select

Constructor

new TreeDataProviderView(dataProvider, options)

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Parameters:
Name Type Argument Description
dataProvider DataProvider<K, D> the DataProvider.
options Object <optional>
Options for the TreeDataProviderView
Properties
Name Type Argument Description
dataMapping DataMapping<K, D, Kin, Din> <optional>
mapping to apply to the data.

Fields

dataMapping

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Optional dataMapping to apply
Since:
  • 6.2.0

Methods

addEventListener(eventType: string, listener: EventListener): void

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

containsKeys(params: FetchByKeysParameters<K>): Promise<ContainsKeysResults<K>>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Check if there are rows containing the specified keys
Parameters:
Name Type Description
params oj.FetchByKeysParameters Fetch by keys parameters
Since:
  • 6.2.0
Returns:
Promise which resolves to oj.ContainsKeysResults
Type
Promise.<oj.ContainsKeysResults>

dispatchEvent(evt: Event): boolean

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

fetchByKeys(params: FetchByKeysParameters<K>): Promise<FetchByKeysResults<K, D>>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Fetch rows by keys
Parameters:
Name Type Description
params oj.FetchByKeysParameters Fetch by keys parameters
Since:
  • 6.2.0
Returns:
Promise which resolves to oj.FetchByKeysResults
Type
Promise.<oj.FetchByKeysResults>

fetchByOffset(params: FetchByOffsetParameters<D>): Promise<FetchByOffsetResults<K, D>>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Fetch rows by offset
Parameters:
Name Type Description
params oj.FetchByOffsetParameters Fetch by offset parameters
Since:
  • 4.2.0
Returns:
Promise which resolves to oj.FetchByOffsetResults
Type
Promise.<oj.FetchByOffsetResults>

fetchFirst(params?: FetchListParameters<D>): AsyncIterable<FetchListResult<K, D>>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Fetch the first block of data.
Parameters:
Name Type Argument Description
params oj.FetchListParameters <optional>
Fetch parameters
Since:
  • 6.2.0
See:
Returns:
AsyncIterable with oj.FetchListResult
Type
AsyncIterable.<oj.FetchListResult>

getCapability(capabilityName: string): any

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Determines whether this DataProvider supports certain feature.
Parameters:
Name Type Description
capabilityName string capability name. Supported capability names are determined by the underlying dataprovider.
Since:
  • 6.2.0
Returns:
capability information or null if unsupported
Type
Object

getChildDataProvider(parentKey: any): TreeDataProviderView<K, D, Kin, Din>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Get a data provider for the children of the row identified by parentKey.
Parameters:
Name Type Description
parentKey any key of the row to get child data provider for.
Returns:
A TreeDataProviderView if the row can (but doesn't have to) have children; or null if the row cannot have children. Use the isEmpty method on the returned TreeDataProviderView to determine if it currently has children.
Type
TreeDataProviderView | null

getTotalSize() → {Promise.<number>}

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Return the total number of rows in this dataprovider
Returns:
Returns a Promise which resolves to the total number of rows. -1 is unknown row count.
Type
Promise.<number>

isEmpty() → {"yes"|"no"|"unknown"}

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Return a string that indicates if this data provider is empty
Returns:
a string that indicates if this data provider is empty. Valid values are: "yes": this data provider is empty. "no": this data provider is not empty. "unknown": it is not known if this data provider is empty until a fetch is made.
Type
"yes" | "no" | "unknown"

removeEventListener(eventType: string, listener: EventListener): void

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.