Element: <oj-row-expander>

Oracle® JavaScript Extension Toolkit (JET)
17.1.0
G12196-01

Since:
  • 1.0.0
Module:
  • ojrowexpander

QuickNav

Slots

Attributes

Events

Methods

Type Definitions

Other Topics


JET RowExpander

Description: A JET RowExpander is primarily used inside the JET Table and JET DataGrid. It enables hierarchical data to be displayed in a JET Table and JET DataGrid.

To enable expand and collapse of rows, developers must specify oj.FlattenedTreeDataProviderView as data when used within JET Table and JET DataGrid.

<oj-row-expander
  context='{{$context}}'>
</oj-row-expander>

Touch End User Information

Target Gesture Action
Icon Tap Expand or collapse the row with the icon in it.

Keyboard End User Information

Target Key Action
Focused Row or Cell with RowExpander Ctrl + RightArrow Expand
Ctrl + LeftArrow Collapse
Icon Enter Expand or Collapse

Reading direction

The location of the RowExpander will be reversed in RTL reading direction.

In the unusual case that the directionality (LTR or RTL) changes post-init, the component containing the RowExpander (JET Table or JET DataGrid) must be refresh()ed.

Performance

Initial expansion

To specify initial expanded rows with RowExpander, it is recommended that applications do this through the initial options in oj.FlattenedTreeDataProvider, especially for expanding all rows initially.


Usage

Signature:

interface RowExpanderElement<K, D>

Generic Parameters
ParameterDescription
KType of key of the dataprovider
DType of data of the dataprovider
Typescript Import Format
//To typecheck the element APIs, import as below.
import { RowExpanderElement } from "ojs/ojrowexpander";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojrowexpander";

For additional information visit:

Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.


Slots

JET components that allow child content support slots. Please see the slots section of the JET component overview doc for more information on allowed slot content and slot types.

contextMenu

The contextMenu slot is set on the oj-menu within this element. This is used to designate the JET Menu that this component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the JET Menu specified in this slot.

The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.

To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc of the individual components for details.

Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.

Deprecated:
Since Description
13.0.0 This web component no longer supports launching a context menu.

Attributes

context :(ojTable.ojTable.RowTemplateContext<K,D> | ojTable.ojTable.CellTemplateContext<K,D> | ojDataGrid.ojDataGrid.CellContext<K,D> | ojDataGrid.ojDataGrid.CellContext<K,D>)

The context object obtained from the column renderer (Table) or cell renderer (DataGrid)
Default Value:
  • null
Names
Item Name
Property context
Property change event contextChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-context-changed

expanded :boolean|null

Specifies if the RowExpander is expanded. The default value is determined by the context obtained from the column renderer (Table) or cell renderer (DataGrid), or null if no context is specified. See performance for recommended usage regarding initial expansion state. This attribute is not supported for use with DataProvider.
Deprecated:
Since Description
7.0.0 The source of truth for expansion is the data source key set.
Default Value:
  • null
Supports writeback:
  • true
Names
Item Name
Property expanded
Property change event expandedChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-expanded-changed

translations :object|null

A collection of translated resources from the translation bundle, or null if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.

If the component does not contain any translatable resource, the default value of this attribute will be null. If not, an object containing all resources relevant to the component.

If this component has translations, their documentation immediately follows this doc entry.

Names
Item Name
Property translations
Property change event translationsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-translations-changed

translations.accessible-level-description :string

Provides properties to customize the accessible context level of the expanded or collapsed row.

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleLevelDescription

translations.accessible-row-collapsed :string

Provides properties to customize the accessible context when a row is collapsed.

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleRowCollapsed

translations.accessible-row-description :string

Provides properties to customize the accessible context level and index of the row.

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleRowDescription

translations.accessible-row-description-at-least :string

Provides properties to customize the accessible context level and index of the row.

See the translations attribute for usage examples.

Since:
  • 17.0.0
Names
Item Name
Property translations.accessibleRowDescriptionAtLeast

translations.accessible-row-expanded :string

Provides properties to customize the accessible context when a row is expanded.

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleRowExpanded

translations.accessible-state-collapsed :string

Provides properties to customize the accessible state of a collapsed row.

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleStateCollapsed

translations.accessible-state-expanded :string

Provides properties to customize the accessible state of an expanded row.

See the translations attribute for usage examples.

Since:
  • 1.1.0
Names
Item Name
Property translations.accessibleStateExpanded

Events

ojCollapse

Triggered when a collapse is performed on the RowExpander
Properties:

All of the event payloads listed below can be found under event.detail. See Events and Listeners for additional information.

Name Type Description
rowKey any the key of the collapsed row

ojExpand

Triggered when a expand is performed on the RowExpander
Properties:

All of the event payloads listed below can be found under event.detail. See Events and Listeners for additional information.

Name Type Description
rowKey any the key of the expanded row

Methods

getProperty(property) : {any}

Retrieves the value of a property or a subproperty. The return type will be the same as the type of the property as specified in this API document. If the method is invoked with an incorrect property/subproperty name, it returns undefined.
Parameters:
Name Type Description
property string The property name to get. Supports dot notation for subproperty access.
Since:
  • 4.0.0
Returns:
Type
any
Example

Get a single subproperty of a complex property:

let subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');

refresh : {void}

Redraw the RowExpander element.
Returns:
Type
void

setProperties(properties) : {void}

Performs a batch set of properties. The type of value for each property being set must match the type of the property as specified in this API document.
Parameters:
Name Type Description
properties Object An object containing the property and value pairs to set.
Since:
  • 4.0.0
Returns:
Type
void
Example

Set a batch of properties:

myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});

setProperty(property, value) : {void}

Sets a property or a subproperty (of a complex property) and notifies the component of the change, triggering a [property]Changed event. The value should be of the same type as the type of the attribute mentioned in this API document.
Parameters:
Name Type Description
property string The property name to set. Supports dot notation for subproperty access.
value any The new value to set the property to.
Since:
  • 4.0.0
Returns:
Type
void
Example

Set a single subproperty of a complex property:

myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");

Type Definitions

Context<K,D>

context object used by cell callbacks.
Properties:
Name Type Argument Description
datasource DataProvider.<K, D> | null a reference to the data source object
isLeaf boolean true if it is a leaf node
key K <nullable>
 the row key
keys Object <nullable>
 the object that contains both the row key and column key which identifies the cell
Properties
Name Type Description
column K the column key
row K the row key
parentKey K the parent row key
treeDepth number the depth of the node