A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://www.ag-grid.com/javascript-data-grid/row-object/ below:

JavaScript Grid: Row Reference | AG Grid

Attributes and methods available on the IRowNode<TData> interface.

Data

string | undefined

Unique ID for the node. Either provided by the application, or generated by the grid if not.

number

The index of the row in the source rowData array including any updates via transactions. It does not change when sorting, filtering, grouping, pivoting or any other UI related operations. If this is a filler node (a visual row created by AG Grid in tree data or grouping) the value is set to -1.

TData | undefined

The data as provided by the application. Can be undefined when using row grouping or during grid initialisation.

Function

Updates the data on the rowNode. When this method is called, the grid refreshes the entire rendered row if it is displayed.

Function

Replaces the data on the rowNode. When this method is called, the grid refreshes the entire rendered row if it is displayed.

Client-Side Single Row Update

Function

Replaces the value on the rowNode for the specified column. When complete, the grid refreshes the rendered cell on the required row only. Note: This method only fires onCellEditRequest when the Grid is in Read Only mode. Note: This method defers to EditModule if available and batches the edit when fullRow or batchEdit is enabled. colKey: The column where the value should be updatednewValue: The new valueeventSource: The source of the event Returns: true if the value was changed, otherwise false.

Client-Side Single Cell Update Display

number | null

The current row index. If the row is filtered out or in a collapsed group, this value is set to null.

number | null

The row top position in pixels.

boolean

This is true if it has a rowIndex assigned, otherwise false.

Function

Returns:

  • true if the node is currently hovered.
  • false if the node is not hovered.
  • Events

    Function

    Add an event listener.

    Function

    Remove event listener.

    Expand / Collapse expandedCopy Link

    boolean

    true if group is expanded, otherwise false.

    isExpandableCopy Link

    Function

    Returns:

  • true if the node can be expanded, i.e it is a group or master row.
  • false if the node cannot be expanded.
  • setExpandedCopy Link

    Function

    Set the expanded state of this rowNode.

    Grouping

    boolean | undefined

    true if this node has children.

  • In case of grouping, this is true for group nodes. Group nodes are generated and do not have a data field.
  • In case of treeData, this is true for any kind of node that have children. Filler nodes or user provided nodes with children.
  • { [key: string]: any | null } | null

    If using row grouping, contains the group values for this group.

    any

    If using row grouping and aggregation, contains the aggregation data.

    string | null

    The key value for this group.

    string | null

    The field we are grouping on from our row data.

    rowGroupColumnCopy Link Column | null

    The row group column used for this group.

    number | null

    If doing in-memory (client-side) grouping, this is the index of the group column this cell is for. This is always the same as the level, unless we are collapsing groups, i.e. groupHideParentOfSingleChild=true.

    boolean | undefined

    true if row is a footer. Footers have group = true and footer = true.

    IRowNode | null

    The parent node to this node, or empty if top level.

    number

    How many levels this node is from the top when grouping.

    number

    How many levels this node is from the top when grouping in the UI (only different to parent when groupHideParentOfSingleChild=true).

    IRowNode[] | null

    All the row nodes that have user provided data below this node. Can be null if empty. This excludes:

  • filler nodes when using treeData and getDataPath
  • group nodes when using grouping
  • footer nodes
  • IRowNode[] | null

    Children of this group. If multi levels of grouping, shows only immediate children.

    IRowNode[] | null

    Filtered children of this group.

    IRowNode[] | null

    Sorted children of this group.

    number | null

    Number of children and grand children.

    boolean | undefined

    true if this node is a group and the group is the bottom level in the tree.

    IRowNode

    If using footers, reference to the footer node for this group.

    Function

    Perform a depth-first search of this node and its children.

    Height

    number | null | undefined

    The height, in pixels, of this row.

    Function

    Sets the row height. Call if you want to change the height initially assigned to the row. After calling, you must call api.onRowHeightChanged() so the grid knows it needs to work out the placement of the rows. rowHeight: new height of the rowestimated: is this an estimated height. Default: false

    Master Detail

    boolean

    true if this row is a master row, part of master / detail (ie row can be expanded to show detail).

    boolean | undefined

    true if this row is a detail row, part of master / detail (ie child row of an expanded master row).

    Pinned Rows

    RowPinnedType

    Either 'top' or 'bottom' if row pinned, otherwise undefined or null.

    Function

    Returns:

  • true if node is either pinned to the top or bottom.
  • false if the node isn't pinned.
  • Quick Filter

    string | null

    If using quick filter, stores a string representation of the row for searching against.

    Function

    The first time quickFilter runs, the grid creates a one-off string representation of the row. This string is then used for the quick filter instead of hitting each column separately. When you edit, using grid editing, this string gets cleared down. However, if you edit without using grid editing, you need to clear this string down for the row to be updated with the new values. Otherwise, new values would not work with the quickFilter.

    Selection

    boolean

    Is this row selectable.

    Function

    Select (or deselect) the node.

    Function

    Returns:

  • true if node is selected.
  • false if the node isn't selected.
  • undefined if it's partially selected (group where not all children are selected).
  • Server Side Row Model

    boolean | undefined

    Used by server-side row model. true if this row node is a stub. A stub is a placeholder row with loading icon while waiting from row to be loaded.

    boolean | undefined

    Used by server side row model, true if this row node failed a load.

    Function

    Returns the route of the row node. If the Row Node does not have a key (i.e it's a group) returns undefined

    Server-Side Model: Open by Default

    RetroSearch is an open source project built by @garambo | Open a GitHub Issue

    Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

    HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4