igniteui-react-grids/lib/igr-cell-type.d.ts

Ignite UI React grid components.

import { IgrColumn } from "./igr-column";
import { IgrRowType } from "./igr-row-type";
import { IgrGridBaseDirective } from "./igr-grid-base-directive";
import { IgrGridCellIdentifier } from "./igr-grid-cell-identifier";
import { IgrGridValidationState } from "./igr-grid-validation-state";
import { CellType as CellType_internal } from "./CellType";
import { ContentChildrenManager } from "igniteui-react-core";
/**
 * Interface representing a cell in the grid. It is essentially the blueprint to a cell object.
 * Contains definitions of properties and methods, relevant to a cell
*/
export declare class IgrCellType {
    protected createImplementation(): CellType_internal;
    protected _implementation: any;
    protected mounted: boolean;
    get nativeElement(): HTMLElement;
    /**
     * @hidden
     */
    get i(): CellType_internal;
    protected onImplementationCreated(): void;
    protected _contentChildrenManager: ContentChildrenManager;
    constructor();
    protected _provideImplementation(i: any): void;
    /**
     * The current value of the cell.
    */
    get value(): any;
    set value(v: any);
    /**
     * The value to display when the cell is in edit mode.
    */
    get editValue(): any;
    set editValue(v: any);
    /**
     * Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is.
    */
    get selected(): boolean;
    set selected(v: boolean);
    /**
     * Indicates whether the cell is currently active (focused).
    */
    get active(): boolean;
    set active(v: boolean);
    /**
     * Indicates whether the cell can be edited.
    */
    get editable(): boolean;
    set editable(v: boolean);
    /**
     * Indicates whether the cell is currently in edit mode.
    */
    get editMode(): boolean;
    set editMode(v: boolean);
    /**
     * Represents the column that the cell belongs to.
    */
    get column(): IgrColumn;
    set column(v: IgrColumn);
    /**
     * Represents the row that the cell belongs to
    */
    get row(): IgrRowType;
    set row(v: IgrRowType);
    /**
     * Represents the grid instance containing the cell
    */
    get grid(): IgrGridBaseDirective;
    set grid(v: IgrGridBaseDirective);
    /**
     * Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell.
    */
    get id(): IgrGridCellIdentifier;
    set id(v: IgrGridCellIdentifier);
    /**
     * Optional; The `cellID` is the unique key, used to identify the cell
    */
    get cellID(): any;
    set cellID(v: any);
    /**
     * Optional; An object representing the validation state of the cell.
     * Whether it's valid or invalid, and if it has errors
    */
    get validation(): IgrGridValidationState;
    set validation(v: IgrGridValidationState);
    get readonly(): boolean;
    set readonly(v: boolean);
    /**
     * An optional title to display for the cell
    */
    get title(): any;
    set title(v: any);
    /**
     * The CSS width of the cell as a string.
    */
    get width(): string;
    set width(v: string);
    /**
     * The index of the column that the cell belongs to. It counts only the visible (not hidden) columns
    */
    get visibleColumnIndex(): number;
    set visibleColumnIndex(v: number);
    findByName(name: string): any;
    setNativeElement(element: any): void;
    /**
     * A method definition to update the value of the cell.
    
    */
    update(value: any): void;
    /**
     * A method definition to start or end the edit mode of the cell. It takes a boolean value as an argument
    
    */
    setEditMode(value: boolean): void;
    /**
     * Optional;
     * A method definition to calculate the size of the cell to fit the content
     * The method can be used to calculate the size of the cell with the longest content and resize all cells to that size
    
    */
    calculateSizeToFit(range: any): number;
}