RevGrid - v0.9.3
    Preparing search index...

    Class RevDataRowArrayGrid<BGS, BCS, SF>

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    canvas clientId columnsManager externalParent focus headerDataServer horizontalScroller hostElement id internalParent mainDataServer mainSubgrid mouse renderer schemaServer selection settings subgridsManager verticalScroller viewLayout

    Accessors

    active activeColumnCount activeColumns activeColumnsViewWidth allowedFields beenUsable columnLayout columnScrollAnchorIndex columnScrollAnchorOffset data destroyed emWidth fieldColumns fieldCount fieldNames fixedColumnsViewWidth focusedRecordIndex gridRightAligned headerRowCount mainRowCount nonFixedColumnsViewWidth recordFocused rowHeight selectionAllAuto

    Methods

    activate addEventListener applyColumnLayoutDefinition applyFirstUsable areColumnsOrRowsSelected areColumnsSelected areRowsSelected autoSizeActiveColumnWidths autoSizeFieldColumnWidth beginSelectionChange calculateActiveColumnsWidth calculateActiveNonFixedColumnsWidth calculateRowCount clearColumns clearFocus clearSelection createColumnLayoutDefinition createColumnLayoutDefinitionColumns deactivate deselectCell deselectColumn deselectColumns deselectRectangle deselectRow deselectRows destroy endSelectionChange findLinedHoverCellAtCanvasOffset focusOnlySelectCell focusOnlySelectRectangle focusReplaceLastArea focusReplaceLastAreaWithRectangle focusSelectCell focusToggleSelectCell getActiveColumn getActiveColumnIndexByFieldIndex getActiveColumns getActiveColumnSettings getActiveColumnWidth getAllCellSelectionAreaTypeIds getAllColumn getBoundsOfCell getField getFieldByName getFieldColumnRange getHiddenColumns getHiDPI getOneCellSelectionAreaType getRenderedData getRenderedHeight getRenderedWidth getRowHeight getSchema getSelectedAllAutoRowCount getSelectedAllAutoRowIndices getSelectedColumnIndices getSelectedRowCount getSelectedRowIndices getSingletonViewDataRow getSubgridRowCount getViewAnchor getViewData getViewValue getVisibleColumnsCount getVisibleRowsCount hideActiveColumn initialiseAllowedFields invalidateAll isActiveDocumentElement isCellSelected isColumnVisible isDataRowVisible isDataVisible isHeaderRow isOnlyThisCellSelected isSelectedCellTheOnlySelectedCell mergeFieldColumnSettings moveActiveColumn onlySelectCell onlySelectColumn onlySelectColumns onlySelectRectangle onlySelectRow onlySelectRows onlySelectViewCell registerGridPainter removeEventListener reset resetUsable 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 updateAllowedFields updateColumnLayout

    Constructors

    Properties

    canvas: RevCanvas<BGS>
    clientId: string
    columnsManager: RevColumnsManager<BCS, SF>
    externalParent: unknown
    focus: RevFocus<BGS, BCS, SF>
    headerDataServer: undefined | RevDataServer<SF>
    horizontalScroller: RevScroller<BGS, BCS, SF>
    hostElement: HTMLElement
    id: string
    internalParent: undefined | RevClientObject
    mainDataServer: RevDataRowArrayDataServer<SF>
    mainSubgrid: RevMainSubgrid<BCS, SF>
    mouse: RevMouse<BGS, BCS, SF>
    renderer: RevRenderer<BGS, BCS, SF>
    schemaServer: RevDataRowArraySchemaServer<SF>
    selection: RevSelection<BGS, BCS, SF>
    settings: BGS
    subgridsManager: RevSubgridsManager<BCS, SF>
    verticalScroller: RevScroller<BGS, BCS, SF>
    viewLayout: RevViewLayout<BGS, BCS, SF>

    Accessors

    • get active(): boolean

      Returns boolean

    • set active(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get activeColumnCount(): number

      Returns number

    • get activeColumnsViewWidth(): number

      Returns number

    • get allowedFields(): undefined | readonly SF[]

      Returns undefined | readonly SF[]

    • get beenUsable(): boolean

      Returns boolean

    • get columnScrollAnchorIndex(): number

      The index of the active column which is first in view (either on left or right depending on Grid alignment)

      Returns number

    • get columnScrollAnchorOffset(): number

      The number of pixels that the scroll anchored column is offset. Changes to allow smooth scrolling

      Returns number

    • get destroyed(): boolean

      Returns boolean

    • get emWidth(): number

      Returns number

    • get fieldCount(): number

      Returns number

    • get fieldNames(): readonly SF[]

      Returns readonly SF[]

    • get fixedColumnsViewWidth(): number

      Returns number

    • get focusedRecordIndex(): undefined | number

      Returns undefined | number

    • get gridRightAligned(): boolean

      Returns boolean

    • get headerRowCount(): number

      Returns number

    • get mainRowCount(): number

      Returns number

    • get nonFixedColumnsViewWidth(): number

      Returns number

    • get recordFocused(): boolean

      Returns boolean

    • get rowHeight(): number

      Returns number

    • get selectionAllAuto(): boolean

      Returns boolean

    • set selectionAllAuto(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Parameters

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

      Returns void

    • Parameters

      • fieldNameOrIndex: string | number
      • widenOnly: boolean

      Returns void

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

      Returns void

    • Be a responsible citizen and call this function on instance disposal! If multiple grids are used in an application (simultaneously or not), then destroy() must be called otherwise canvase paint loop will continue to run

      Returns void

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

      Returns void

    • Parameters

      • activeIndex: number

        The untranslated column index.

      Returns number

      The width of the given column.

    • Parameters

      • fieldIndex: number

      Returns SF

    • Parameters

      • fieldName: string

      Returns SF

    • Parameters

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

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

    • 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

      • activeColumnIndex: number
      • Optionalui: boolean

      Returns void

    • Parameters

      • fields: readonly SF[]

      Returns void

    • Returns void

    • 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.

    • Parameters

      • rowIndex: number

      Returns boolean

    • 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>
      • OptionaloverrideGrid: boolean

      Returns boolean

    • Parameters

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

      Returns void

    • Parameters

      • viewLayoutColumnIndex: number
      • viewLayoutRowIndex: number

      Returns void

    • Parameters

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

      Returns void

    • Returns void

    • Parameters

      • activeColumnIndex: number
      • count: number

      Returns void

    • Parameters

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

      Returns void

    • Set the width of the given column.

      Parameters

      • columnOrIndex: number | RevColumn<BCS, SF>

        Column or index of active column whose width is to be set.

      • width: number

        The width in pixels.

      • ui: boolean

        Whether this was instigated by a UI action

      Returns boolean

      true if column width was changed

    • 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

    • 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.

      • OptionalfieldColumnIndexes: number | number[]

        A column index or array of indices. If undefined then all of the columns as per 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

      • fields: readonly SF[]

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    activateaddEventListenerapplyColumnLayoutDefinitionapplyFirstUsableareColumnsOrRowsSelectedareColumnsSelectedareRowsSelectedautoSizeActiveColumnWidthsautoSizeFieldColumnWidthbeginSelectionChangecalculateActiveColumnsWidthcalculateActiveNonFixedColumnsWidthcalculateRowCountclearColumnsclearFocusclearSelectioncreateColumnLayoutDefinitioncreateColumnLayoutDefinitionColumnsdeactivatedeselectCelldeselectColumndeselectColumnsdeselectRectangledeselectRowdeselectRowsdestroyendSelectionChangefindLinedHoverCellAtCanvasOffsetfocusOnlySelectCellfocusOnlySelectRectanglefocusReplaceLastAreafocusReplaceLastAreaWithRectanglefocusSelectCellfocusToggleSelectCellgetActiveColumngetActiveColumnIndexByFieldIndexgetActiveColumnsgetActiveColumnSettingsgetActiveColumnWidthgetAllCellSelectionAreaTypeIdsgetAllColumngetBoundsOfCellgetFieldgetFieldByNamegetFieldColumnRangegetHiddenColumnsgetHiDPIgetOneCellSelectionAreaTypegetRenderedDatagetRenderedHeightgetRenderedWidthgetRowHeightgetSchemagetSelectedAllAutoRowCountgetSelectedAllAutoRowIndicesgetSelectedColumnIndicesgetSelectedRowCountgetSelectedRowIndicesgetSingletonViewDataRowgetSubgridRowCountgetViewAnchorgetViewDatagetViewValuegetVisibleColumnsCountgetVisibleRowsCounthideActiveColumninitialiseAllowedFieldsinvalidateAllisActiveDocumentElementisCellSelectedisColumnVisibleisDataRowVisibleisDataVisibleisHeaderRowisOnlyThisCellSelectedisSelectedCellTheOnlySelectedCellmergeFieldColumnSettingsmoveActiveColumnonlySelectCellonlySelectColumnonlySelectColumnsonlySelectRectangleonlySelectRowonlySelectRowsonlySelectViewCellregisterGridPainterremoveEventListenerresetresetUsablescrollBottomscrollFirstColumnscrollLastColumnscrollTopselectAllRowsselectCellselectColumnselectColumnsselectRectangleselectRowselectRowssetActiveColumnssetActiveColumnsAndWidthsByFieldNamesetActiveColumnsAutoWidthSizingsetActiveColumnWidthsetColumnScrollAnchorsetColumnWidthssetColumnWidthsByNamesetFieldColumnSettingssetRowHeightsetValueshowHideColumnsswapColumnstoggleSelectCelltoggleSelectColumntoggleSelectRowtryExtendLastSelectionAreaAsCloseAsPossibleToFocustryFocusBottomtryFocusFirstColumntryFocusLastColumntryFocusToptryFocusXAndEnsureInViewtryFocusXYAndEnsureInViewtryFocusYAndEnsureInViewtryMoveFocusDowntryMoveFocusLefttryMoveFocusRighttryMoveFocusUptryOnlySelectFocusedCelltryPageFocusDowntryPageFocusLefttryPageFocusRighttryPageFocusUptryScrollDowntryScrollLefttryScrollPageDowntryScrollPageLefttryScrollPageRighttryScrollPageUptryScrollRighttryScrollUpupdateAllowedFieldsupdateColumnLayout