RevGrid - v0.9.3
    Preparing search index...

    Interface RevGrid<BGS, BCS, SF>

    interface RevGrid<
        BGS extends RevBehavioredGridSettings,
        BCS extends RevBehavioredColumnSettings,
        SF extends RevSchemaField,
    > {
        active: boolean;
        activeColumnCount: number;
        activeColumns: readonly RevColumn<BCS, SF>[];
        activeColumnsViewWidth: number;
        canvas: RevCanvas<BGS>;
        clientId: string;
        columnScrollAnchorIndex: number;
        columnScrollAnchorOffset: number;
        columnsManager: RevColumnsManager<BCS, SF>;
        destroyed: boolean;
        externalParent: unknown;
        fieldColumns: readonly RevColumn<BCS, SF>[];
        fixedColumnsViewWidth: number;
        focus: RevFocus<BGS, BCS, SF>;
        horizontalScroller: RevScroller<BGS, BCS, SF>;
        hostElement: HTMLElement;
        id: string;
        internalParent: undefined | RevClientObject;
        mainDataServer: RevDataServer<SF>;
        mainSubgrid: RevMainSubgrid<BCS, SF>;
        mouse: RevMouse<BGS, BCS, SF>;
        nonFixedColumnsViewWidth: number;
        renderer: RevRenderer<BGS, BCS, SF>;
        schemaServer: RevSchemaServer<SF>;
        selection: RevSelection<BGS, BCS, SF>;
        selectionAllAuto: boolean;
        settings: BGS;
        subgridsManager: RevSubgridsManager<BCS, SF>;
        verticalScroller: RevScroller<BGS, BCS, SF>;
        viewLayout: RevViewLayout<BGS, BCS, SF>;
        activate(): void;
        addEventListener(
            eventName: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | AddEventListenerOptions,
        ): void;
        areColumnsOrRowsSelected(includeAllAuto?: boolean): boolean;
        areColumnsSelected(includeAllAuto?: boolean): boolean;
        areRowsSelected(includeAllAuto: boolean): boolean;
        autoSizeActiveColumnWidths(widenOnly: boolean): void;
        autoSizeFieldColumnWidth(
            fieldNameOrIndex: string | number,
            widenOnly: boolean,
        ): void;
        beginSelectionChange(): void;
        calculateActiveColumnsWidth(): number;
        calculateActiveNonFixedColumnsWidth(): number;
        calculateRowCount(): number;
        clearColumns(): void;
        clearFocus(): void;
        clearSelection(): void;
        deactivate(): void;
        deselectCell(x: number, y: number, subgrid: RevSubgrid<BCS, SF>): void;
        deselectColumn(x: number, subgrid: RevSubgrid<BCS, SF>): void;
        deselectColumns(
            x: number,
            count: number,
            subgrid: RevSubgrid<BCS, SF>,
        ): void;
        deselectRectangle(
            rectangle: RevRectangle,
            subgrid: RevSubgrid<BCS, SF>,
        ): void;
        deselectRow(y: number, subgrid?: RevSubgrid<BCS, SF>): void;
        deselectRows(y: number, count: number, subgrid?: RevSubgrid<BCS, SF>): void;
        endSelectionChange(): void;
        findLinedHoverCellAtCanvasOffset(
            offsetX: number,
            offsetY: number,
        ): undefined | RevLinedHoverCell<BCS, SF>;
        focusOnlySelectCell(
            activeColumnIndex: number,
            subgridRowIndex: number,
            subgrid?: RevSubgrid<BCS, SF>,
            ensureFullyInView?: RevEnsureFullyInViewEnum,
        ): void;
        focusOnlySelectRectangle(
            inexclusiveX: number,
            inexclusiveY: number,
            width: number,
            height: number,
            subgrid?: RevSubgrid<BCS, SF>,
            ensureFullyInView?: RevEnsureFullyInViewEnum,
        ): void;
        focusReplaceLastArea(
            areaType: "all" | "rectangle" | "row" | "column",
            inexclusiveX: number,
            inexclusiveY: number,
            width: number,
            height: number,
            subgrid?: RevSubgrid<BCS, SF>,
            ensureFullyInView?: RevEnsureFullyInViewEnum,
        ): void;
        focusReplaceLastAreaWithRectangle(
            inexclusiveX: number,
            inexclusiveY: number,
            width: number,
            height: number,
            subgrid?: RevSubgrid<BCS, SF>,
            ensureFullyInView?: RevEnsureFullyInViewEnum,
        ): void;
        focusSelectCell(
            x: number,
            y: number,
            subgrid?: RevSubgrid<BCS, SF>,
            ensureFullyInView?: RevEnsureFullyInViewEnum,
        ): void;
        focusToggleSelectCell(
            originX: number,
            originY: number,
            subgrid?: RevSubgrid<BCS, SF>,
            ensureFullyInView?: RevEnsureFullyInViewEnum,
        ): boolean;
        getActiveColumn(activeIndex: number): RevColumn<BCS, SF>;
        getActiveColumnIndexByFieldIndex(fieldIndex: number): number;
        getActiveColumns(begin?: number, end?: number): RevColumn<BCS, SF>[];
        getActiveColumnSettings(activeColumnIndex: number): BCS;
        getActiveColumnWidth(activeIndex: number): number;
        getAllCellSelectionAreaTypeIds(
            activeColumnIndex: number,
            subgridRowIndex: number,
            subgrid: RevSubgrid<BCS, SF>,
        ): ("all" | "rectangle" | "row" | "column")[];
        getAllColumn(allX: number): RevColumn<BCS, SF>;
        getBoundsOfCell(gridCell: RevPoint): RevRectangle;
        getFieldColumnRange(begin?: number, end?: number): RevColumn<BCS, SF>[];
        getHiddenColumns(): RevColumn<BCS, SF>[];
        getHiDPI(): number;
        getOneCellSelectionAreaType(
            activeColumnIndex: number,
            subgridRowIndex: number,
            subgrid: RevSubgrid<BCS, SF>,
        ): undefined | "all" | "rectangle" | "row" | "column";
        getRenderedData(): unknown[][];
        getRenderedHeight(rowIndex: number): number;
        getRenderedWidth(colIndex: number): number;
        getRowHeight(rowIndex: number, subgrid?: RevSubgrid<BCS, SF>): number;
        getSchema(): readonly RevSchemaField[];
        getSelectedAllAutoRowCount(): number;
        getSelectedAllAutoRowIndices(): number[];
        getSelectedColumnIndices(includeAllAuto?: boolean): number[];
        getSelectedRowCount(includeAllAuto?: boolean): number;
        getSelectedRowIndices(includeAllAuto?: boolean): number[];
        getSingletonViewDataRow(y: number, subgrid?: RevSubgrid<BCS, SF>): ViewRow;
        getSubgridRowCount(subgrid: RevSubgrid<BCS, SF>): number;
        getViewData(): readonly ViewRow[];
        getViewValue(x: number, y: number, subgrid?: RevSubgrid<BCS, SF>): unknown;
        getVisibleColumnsCount(): number;
        getVisibleRowsCount(): number;
        hideActiveColumn(activeColumnIndex: number, ui?: boolean): void;
        isActiveDocumentElement(): boolean;
        isCellSelected(
            x: number,
            y: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): boolean;
        isColumnVisible(activeIndex: number): boolean;
        isDataRowVisible(rowIndex: number, subgrid?: RevSubgrid<BCS, SF>): boolean;
        isDataVisible(c: number, rn: number): boolean;
        isOnlyThisCellSelected(
            x: number,
            y: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): undefined | boolean;
        isSelectedCellTheOnlySelectedCell(
            activeColumnIndex: number,
            subgridRowIndex: number,
            subgrid: RevSubgrid<BCS, SF>,
            selectedType?: "all" | "rectangle" | "row" | "column",
        ): boolean;
        mergeFieldColumnSettings(
            fieldIndex: number,
            settings: Partial<BCS>,
        ): boolean;
        moveActiveColumn(fromIndex: number, toIndex: number, ui: boolean): void;
        onlySelectCell(
            x: number,
            y: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): RevLastSelectionArea;
        onlySelectColumn(activeColumnIndex: number): void;
        onlySelectColumns(activeColumnIndex: number, count: number): void;
        onlySelectRectangle(
            firstInexclusiveX: number,
            firstInexclusiveY: number,
            width: number,
            height: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): RevLastSelectionArea;
        onlySelectRow(subgridRowIndex: number, subgrid?: RevSubgrid<BCS, SF>): void;
        onlySelectRows(
            subgridRowIndex: number,
            count: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): void;
        onlySelectViewCell(
            viewLayoutColumnIndex: number,
            viewLayoutRowIndex: number,
        ): void;
        registerGridPainter(
            key: string,
            constructor: RevGridPainter.Constructor<BGS, BCS, SF>,
        ): void;
        removeEventListener(
            eventName: string,
            listener: EventListenerOrEventListenerObject,
            options?: boolean | EventListenerOptions,
        ): void;
        reset(): void;
        scrollBottom(): boolean;
        scrollFirstColumn(): boolean;
        scrollLastColumn(): boolean;
        scrollTop(): boolean;
        selectAllRows(subgrid?: RevSubgrid<BCS, SF>): void;
        selectCell(
            x: number,
            y: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): RevLastSelectionArea;
        selectColumn(activeColumnIndex: number): void;
        selectColumns(activeColumnIndex: number, count: number): void;
        selectRectangle(
            firstInexclusiveX: number,
            firstInexclusiveY: number,
            width: number,
            height: number,
            subgrid: RevSubgrid<BCS, SF>,
        ): RevLastSelectionArea;
        selectRow(subgridRowIndex: number, subgrid?: RevSubgrid<BCS, SF>): void;
        selectRows(
            subgridRowIndex: number,
            count: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): void;
        setActiveColumns(
            columnFieldNameOrFieldIndexArray: readonly (
                string
                | number
                | RevColumn<BCS, SF>
            )[],
        ): void;
        setActiveColumnsAndWidthsByFieldName(
            columnNameWidths: FieldNameAndAutoSizableWidth[],
        ): void;
        setActiveColumnsAutoWidthSizing(widenOnly: boolean): void;
        setActiveColumnWidth(
            columnOrIndex: number | RevColumn<BCS, SF>,
            width: number,
            ui: boolean,
        ): void;
        setColumnScrollAnchor(index: number, offset: number): boolean;
        setColumnWidths(
            columnWidths: RevColumnAutoSizeableWidth<BCS, SF>[],
        ): boolean;
        setColumnWidthsByName(
            columnNameWidths: FieldNameAndAutoSizableWidth[],
        ): boolean;
        setFieldColumnSettings(fieldIndex: number, settings: BCS): boolean;
        setRowHeight(
            rowIndex: number,
            rowHeight: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): void;
        setValue(
            x: number,
            y: number,
            value: unknown,
            subgrid?: RevSubgrid<BCS, SF>,
        ): void;
        showHideColumns(
            fieldColumnIndexes: number | number[],
            insertIndex?: number,
            allowDuplicateColumns?: boolean,
            ui?: boolean,
        ): void;
        showHideColumns(
            indexesAreActive: boolean,
            columnIndexes?: number | number[],
            insertIndex?: number,
            allowDuplicateColumns?: boolean,
            ui?: boolean,
        ): void;
        swapColumns(source: number, target: number): void;
        toggleSelectCell(
            x: number,
            y: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): boolean;
        toggleSelectColumn(activeColumnIndex: number): void;
        toggleSelectRow(
            subgridRowIndex: number,
            subgrid?: RevSubgrid<BCS, SF>,
        ): void;
        tryExtendLastSelectionAreaAsCloseAsPossibleToFocus(): boolean;
        tryFocusBottom(): boolean;
        tryFocusFirstColumn(): boolean;
        tryFocusLastColumn(): boolean;
        tryFocusTop(): boolean;
        tryFocusXAndEnsureInView(x: number): boolean;
        tryFocusXYAndEnsureInView(
            x: number,
            y: number,
            cell?: RevViewCell<BCS, SF>,
        ): boolean;
        tryFocusYAndEnsureInView(y: number): boolean;
        tryMoveFocusDown(): boolean;
        tryMoveFocusLeft(): boolean;
        tryMoveFocusRight(): boolean;
        tryMoveFocusUp(): boolean;
        tryOnlySelectFocusedCell(): boolean;
        tryPageFocusDown(): boolean;
        tryPageFocusLeft(): boolean;
        tryPageFocusRight(): boolean;
        tryPageFocusUp(): boolean;
        tryScrollDown(): boolean;
        tryScrollLeft(): boolean;
        tryScrollPageDown(): boolean;
        tryScrollPageLeft(): boolean;
        tryScrollPageRight(): boolean;
        tryScrollPageUp(): boolean;
        tryScrollRight(): boolean;
        tryScrollUp(): boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    active activeColumnCount activeColumns activeColumnsViewWidth canvas clientId columnScrollAnchorIndex columnScrollAnchorOffset columnsManager destroyed externalParent fieldColumns fixedColumnsViewWidth focus horizontalScroller hostElement id internalParent mainDataServer mainSubgrid mouse nonFixedColumnsViewWidth renderer schemaServer selection selectionAllAuto settings subgridsManager verticalScroller viewLayout

    Methods

    activate addEventListener areColumnsOrRowsSelected areColumnsSelected areRowsSelected autoSizeActiveColumnWidths autoSizeFieldColumnWidth beginSelectionChange calculateActiveColumnsWidth calculateActiveNonFixedColumnsWidth calculateRowCount clearColumns clearFocus clearSelection deactivate deselectCell deselectColumn deselectColumns deselectRectangle deselectRow deselectRows endSelectionChange findLinedHoverCellAtCanvasOffset focusOnlySelectCell focusOnlySelectRectangle focusReplaceLastArea focusReplaceLastAreaWithRectangle focusSelectCell focusToggleSelectCell getActiveColumn getActiveColumnIndexByFieldIndex getActiveColumns getActiveColumnSettings getActiveColumnWidth getAllCellSelectionAreaTypeIds getAllColumn getBoundsOfCell getFieldColumnRange getHiddenColumns getHiDPI getOneCellSelectionAreaType getRenderedData getRenderedHeight getRenderedWidth getRowHeight getSchema getSelectedAllAutoRowCount getSelectedAllAutoRowIndices getSelectedColumnIndices getSelectedRowCount getSelectedRowIndices getSingletonViewDataRow getSubgridRowCount getViewData getViewValue getVisibleColumnsCount getVisibleRowsCount hideActiveColumn isActiveDocumentElement isCellSelected isColumnVisible isDataRowVisible isDataVisible isOnlyThisCellSelected isSelectedCellTheOnlySelectedCell mergeFieldColumnSettings moveActiveColumn onlySelectCell onlySelectColumn onlySelectColumns onlySelectRectangle onlySelectRow onlySelectRows onlySelectViewCell registerGridPainter removeEventListener reset scrollBottom scrollFirstColumn scrollLastColumn scrollTop selectAllRows selectCell selectColumn selectColumns selectRectangle selectRow selectRows setActiveColumns setActiveColumnsAndWidthsByFieldName setActiveColumnsAutoWidthSizing setActiveColumnWidth setColumnScrollAnchor setColumnWidths setColumnWidthsByName setFieldColumnSettings setRowHeight setValue showHideColumns swapColumns toggleSelectCell toggleSelectColumn toggleSelectRow tryExtendLastSelectionAreaAsCloseAsPossibleToFocus tryFocusBottom tryFocusFirstColumn tryFocusLastColumn tryFocusTop tryFocusXAndEnsureInView tryFocusXYAndEnsureInView tryFocusYAndEnsureInView tryMoveFocusDown tryMoveFocusLeft tryMoveFocusRight tryMoveFocusUp tryOnlySelectFocusedCell tryPageFocusDown tryPageFocusLeft tryPageFocusRight tryPageFocusUp tryScrollDown tryScrollLeft tryScrollPageDown tryScrollPageLeft tryScrollPageRight tryScrollPageUp tryScrollRight tryScrollUp

    Properties

    active: boolean
    activeColumnCount: number
    activeColumns: readonly RevColumn<BCS, SF>[]
    activeColumnsViewWidth: number
    canvas: RevCanvas<BGS>
    clientId: string

    A unique string allowing you to identify different instances

    columnScrollAnchorIndex: number
    columnScrollAnchorOffset: number
    columnsManager: RevColumnsManager<BCS, SF>
    destroyed: boolean
    externalParent: unknown
    fieldColumns: readonly RevColumn<BCS, SF>[]
    fixedColumnsViewWidth: number
    focus: RevFocus<BGS, BCS, SF>
    horizontalScroller: RevScroller<BGS, BCS, SF>
    hostElement: HTMLElement
    id: string
    internalParent: undefined | RevClientObject

    The parent of an object allowing you to easily navigate during debugging

    mainDataServer: RevDataServer<SF>
    mainSubgrid: RevMainSubgrid<BCS, SF>
    mouse: RevMouse<BGS, BCS, SF>
    nonFixedColumnsViewWidth: number
    renderer: RevRenderer<BGS, BCS, SF>
    schemaServer: RevSchemaServer<SF>
    selection: RevSelection<BGS, BCS, SF>
    selectionAllAuto: boolean
    settings: BGS
    subgridsManager: RevSubgridsManager<BCS, SF>
    verticalScroller: RevScroller<BGS, BCS, SF>
    viewLayout: RevViewLayout<BGS, BCS, SF>

    Methods

    • Returns void

    • Parameters

      • eventName: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Parameters

      • OptionalincludeAllAuto: boolean

      Returns boolean

    • Parameters

      • OptionalincludeAllAuto: boolean

      Returns boolean

    • Parameters

      • includeAllAuto: boolean

      Returns boolean

    • Parameters

      • widenOnly: boolean

      Returns void

    • Parameters

      • fieldNameOrIndex: string | number
      • widenOnly: boolean

      Returns void

    • Call before multiple selection changes to consolidate SelectionChange events. Pair with endSelectionChange().

      Returns void

    • Returns number

    • Returns number

    • Returns number

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      Returns void

    • Call after multiple selection changes to consolidate SelectionChange events. Pair with beginSelectionChange().

      Returns void

    • Answer which data cell is under a pixel value mouse point.

      Parameters

      • offsetX: number

        X position of pixel in canvas.

      • offsetY: number

        Y position of pixel in canvas.

      Returns undefined | RevLinedHoverCell<BCS, SF>

    • Parameters

      Returns void

    • Parameters

      • areaType: "all" | "rectangle" | "row" | "column"
      • inexclusiveX: number
      • inexclusiveY: number
      • width: number
      • height: number
      • Optionalsubgrid: RevSubgrid<BCS, SF>
      • OptionalensureFullyInView: RevEnsureFullyInViewEnum

      Returns void

    • Parameters

      Returns void

    • Parameters

      • fieldIndex: number

      Returns number

    • Parameters

      • Optionalbegin: number
      • Optionalend: number

      Returns RevColumn<BCS, SF>[]

      A copy of the active columns array by passing the params to Array.prototype.slice.

    • Parameters

      • activeColumnIndex: number

        Data x coordinate.

      Returns BCS

      The properties for a specific column.

    • Parameters

      • activeIndex: number

        The untranslated column index.

      Returns number

      The width of the given column.

    • Parameters

      • activeColumnIndex: number
      • subgridRowIndex: number
      • subgrid: RevSubgrid<BCS, SF>

      Returns ("all" | "rectangle" | "row" | "column")[]

    • Parameters

      • gridCell: RevPoint

        The pixel location of the mouse in physical grid coordinates.

      Returns RevRectangle

      The pixel based bounds rectangle given a data cell point.

    • Parameters

      • Optionalbegin: number
      • Optionalend: number

      Returns RevColumn<BCS, SF>[]

      A copy of the all columns array by passing the params to Array.prototype.slice.

    • Returns number

      The HiDPI ratio.

    • Parameters

      • activeColumnIndex: number
      • subgridRowIndex: number
      • subgrid: RevSubgrid<BCS, SF>

      Returns undefined | "all" | "rectangle" | "row" | "column"

    • Returns unknown[][]

      Objects with the values that were just rendered.

    • Parameters

      • rowIndex: number

        The row index.

      Returns number

      The height of the given (recently rendered) row.

    • Parameters

      • colIndex: number

        The column index.

      Returns number

      The width of the given (recently rendered) column.

    • Parameters

      • rowIndex: number

        The untranslated fixed column index.

      • Optionalsubgrid: RevSubgrid<BCS, SF>

      Returns number

      The height of the given row

    • Returns number

    • Returns number[]

    • Parameters

      • OptionalincludeAllAuto: boolean

      Returns number[]

    • Parameters

      • OptionalincludeAllAuto: boolean

      Returns number

    • Parameters

      • OptionalincludeAllAuto: boolean

      Returns number[]

    • Retrieve a data row from the main data model.

      Parameters

      Returns ViewRow

      The data row object at y index.

    • Gets the number of rows in the main subgrid.

      Parameters

      Returns number

      The number of rows.

    • Retrieve all data rows from the data model. Use with caution!

      Returns readonly ViewRow[]

    • Parameters

      Returns unknown

    • Returns number

      The number of columns that were just rendered

    • Returns number

      The number of rows that were just rendered

    • Parameters

      • activeColumnIndex: number
      • Optionalui: boolean

      Returns void

    • Returns boolean

    • Parameters

      Returns boolean

    • Parameters

      • activeIndex: number

        The column index in question.

      Returns boolean

      The given column is fully visible.

    • Get the visibility of the row matching the provided data row index.

      Parameters

      Returns boolean

      The given row is visible.

      Requested row may not be visible due to being scrolled out of view. Determines visibility of a row.

    • Parameters

      • c: number

        The column index in question.

      • rn: number

        The grid row index in question.

      Returns boolean

      The given cell is fully is visible.

    • Returns undefined if not selected, false if selected with others, true if the only cell selected

      Parameters

      Returns undefined | boolean

    • Parameters

      • activeColumnIndex: number
      • subgridRowIndex: number
      • subgrid: RevSubgrid<BCS, SF>
      • OptionalselectedType: "all" | "rectangle" | "row" | "column"

      Returns boolean

    • Parameters

      • fieldIndex: number
      • settings: Partial<BCS>

      Returns boolean

    • Parameters

      • fromIndex: number
      • toIndex: number
      • ui: boolean

      Returns void

    • Parameters

      • activeColumnIndex: number

      Returns void

    • Parameters

      • activeColumnIndex: number
      • count: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • viewLayoutColumnIndex: number
      • viewLayoutRowIndex: number

      Returns void

    • Parameters

      • eventName: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Returns void

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • activeColumnIndex: number

      Returns void

    • Parameters

      • activeColumnIndex: number
      • count: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • columnFieldNameOrFieldIndexArray: readonly (string | number | RevColumn<BCS, SF>)[]

      Returns void

    • Parameters

      • widenOnly: boolean

      Returns void

    • Set the width of the given column.

      Parameters

      • columnOrIndex: number | RevColumn<BCS, SF>

        Column or active index of column.

      • width: number

        The width in pixels.

      • ui: boolean

      Returns void

      column if width changed otherwise undefined

    • Parameters

      • index: number
      • offset: number

      Returns boolean

    • Parameters

      • fieldIndex: number
      • settings: BCS

      Returns boolean

    • Set the height of the given row.

      Parameters

      • rowIndex: number

        The row index.

      • rowHeight: number

        The width in pixels.

      • Optionalsubgrid: RevSubgrid<BCS, SF>

      Returns void

    • Parameters

      Returns void

    • Show inactive column(s) or move active column(s).

      Parameters

      • fieldColumnIndexes: number | number[]

        A column index or array of field indices which are to be shown or hidden.

      • OptionalinsertIndex: number

        Active index of column to insert before. Set to undefined to add new active columns at end of list. Set to -1 to hide specified columns.

      • OptionalallowDuplicateColumns: boolean

        If true, then if an existing column is already visible, it will not be removed and duplicates of that column will be present. Default: false.

      • Optionalui: boolean

        Whether this was instigated by a UI action. Default: true.

      Returns void

      Adds one or several columns to the "active" column list.

    • Show inactive column(s) or move active column(s).

      Parameters

      • indexesAreActive: boolean

        If true, then column indices specify active column indices. Otherwise field column indices.

      • OptionalcolumnIndexes: number | number[]

        A column index or array of indices. If undefined then all of the columns as per parameter indexesAreActive.

      • OptionalinsertIndex: number

        Active index of column to insert before. Set to undefined to add new active columns at end of list. Set to -1 to hide specified columns.

      • OptionalallowDuplicateColumns: boolean

        If true, then if an existing column is already visible, it will not be removed and duplicates of that column will be present. Default: false.

      • Optionalui: boolean

        Whether this was instigated by a UI action. Default: true.

      Returns void

      Adds one or several columns to the "active" column list.

    • Parameters

      • source: number
      • target: number

      Returns void

    • Parameters

      Returns boolean

    • Parameters

      • activeColumnIndex: number

      Returns void

    • Parameters

      Returns void

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      • x: number

      Returns boolean

    • Parameters

      Returns boolean

    • Parameters

      • y: number

      Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    activateaddEventListenerareColumnsOrRowsSelectedareColumnsSelectedareRowsSelectedautoSizeActiveColumnWidthsautoSizeFieldColumnWidthbeginSelectionChangecalculateActiveColumnsWidthcalculateActiveNonFixedColumnsWidthcalculateRowCountclearColumnsclearFocusclearSelectiondeactivatedeselectCelldeselectColumndeselectColumnsdeselectRectangledeselectRowdeselectRowsendSelectionChangefindLinedHoverCellAtCanvasOffsetfocusOnlySelectCellfocusOnlySelectRectanglefocusReplaceLastAreafocusReplaceLastAreaWithRectanglefocusSelectCellfocusToggleSelectCellgetActiveColumngetActiveColumnIndexByFieldIndexgetActiveColumnsgetActiveColumnSettingsgetActiveColumnWidthgetAllCellSelectionAreaTypeIdsgetAllColumngetBoundsOfCellgetFieldColumnRangegetHiddenColumnsgetHiDPIgetOneCellSelectionAreaTypegetRenderedDatagetRenderedHeightgetRenderedWidthgetRowHeightgetSchemagetSelectedAllAutoRowCountgetSelectedAllAutoRowIndicesgetSelectedColumnIndicesgetSelectedRowCountgetSelectedRowIndicesgetSingletonViewDataRowgetSubgridRowCountgetViewDatagetViewValuegetVisibleColumnsCountgetVisibleRowsCounthideActiveColumnisActiveDocumentElementisCellSelectedisColumnVisibleisDataRowVisibleisDataVisibleisOnlyThisCellSelectedisSelectedCellTheOnlySelectedCellmergeFieldColumnSettingsmoveActiveColumnonlySelectCellonlySelectColumnonlySelectColumnsonlySelectRectangleonlySelectRowonlySelectRowsonlySelectViewCellregisterGridPainterremoveEventListenerresetscrollBottomscrollFirstColumnscrollLastColumnscrollTopselectAllRowsselectCellselectColumnselectColumnsselectRectangleselectRowselectRowssetActiveColumnssetActiveColumnsAndWidthsByFieldNamesetActiveColumnsAutoWidthSizingsetActiveColumnWidthsetColumnScrollAnchorsetColumnWidthssetColumnWidthsByNamesetFieldColumnSettingssetRowHeightsetValueshowHideColumnsswapColumnstoggleSelectCelltoggleSelectColumntoggleSelectRowtryExtendLastSelectionAreaAsCloseAsPossibleToFocustryFocusBottomtryFocusFirstColumntryFocusLastColumntryFocusToptryFocusXAndEnsureInViewtryFocusXYAndEnsureInViewtryFocusYAndEnsureInViewtryMoveFocusDowntryMoveFocusLefttryMoveFocusRighttryMoveFocusUptryOnlySelectFocusedCelltryPageFocusDowntryPageFocusLefttryPageFocusRighttryPageFocusUptryScrollDowntryScrollLefttryScrollPageDowntryScrollPageLefttryScrollPageRighttryScrollPageUptryScrollRighttryScrollUp