Type Parameters

Hierarchy

Hierarchy

  • Component<P & Omit<React.HTMLAttributes<HTMLElement>, keyof P>, {}>

Constructors

  • Type parameters

    Type Parameters

    Parameters

    • props: P & Omit<HTMLAttributes<HTMLElement>, keyof P>

    Returns IgrRowDirective<P>

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get data(): any
  • The data passed to the row component.

    // get the row data for the first selected row
    let selectedRowData = this.grid.selectedRows[0].data;

    Returns any

  • set data(v): void
  • Parameters

    • v: any

    Returns void

  • get disabled(): boolean
  • Sets whether this specific row has disabled functionality for editing and row selection. Default value is false.

    this.grid.selectedRows[0].pinned = true;
    

    Returns boolean

  • set disabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get expanded(): boolean
  • Gets the expanded state of the row.

    let isExpanded = row.expanded;
    

    Returns boolean

  • set expanded(v): void
  • Parameters

    • v: boolean

    Returns void

  • get index(): number
  • The index of the row.

    // get the index of the second selected row
    let selectedRowIndex = this.grid.selectedRows[1].index;

    Returns number

  • set index(v): void
  • Parameters

    • v: number

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get pinned(): boolean
  • Sets whether the row is pinned. Default value is false.

    this.grid.selectedRows[0].pinned = true;
    

    Returns boolean

  • set pinned(v): void
  • Parameters

    • v: boolean

    Returns void

Methods

  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • nextContext: any

    Returns void

  • Spawns the add row UI for the specific row.

    Example

    const row = this.grid1.getRowByIndex(1);
    row.beginAddRow();

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Removes the specified row from the grid's data source. This method emits rowDeleted event.

    // delete the third selected row from the grid
    this.grid.selectedRows[2].delete();

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<P & Omit<HTMLAttributes<HTMLElement>, keyof P>>
    • prevState: Readonly<{}>

    Returns any

  • Parameters

    • visibleColumnIndex: any

    Returns void

  • Pins the specified row. This method emits rowPinning``rowPinned event.

    // pin the selected row from the grid
    this.grid.selectedRows[0].pin();

    Returns void

  • Returns DOMElement<{
        children: any[];
        class: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["className"];
        id: (P & Omit<HTMLAttributes<HTMLElement>, keyof P>)["id"];
        ref: ((ref) => void);
        style: {};
    }, any>

  • Parameters

    • element: any

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Unpins the specified row. This method emits rowPinning``rowPinned event.

    // unpin the selected row from the grid
    this.grid.selectedRows[0].unpin();

    Returns void

  • Updates the specified row object and the data source record with the passed value.

    // update the second selected row's value
    let newValue = "Apple";
    this.grid.selectedRows[1].update(newValue);

    Parameters

    • value: any

    Returns void