RevGrid - v0.11.1
    Preparing search index...

    Class RevSimpleClientGrid<SF>

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

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

    Accessors

    active activeColumnCount activeColumns activeColumnsViewWidth columnScrollAnchorIndex columnScrollAnchorOffset destroyed fieldColumns fixedColumnsViewWidth nonFixedColumnsViewWidth selectionDynamicAllSubgrids

    Methods

    activate addEventListener areColumnsOrRowsSelected areColumnsSelected areRowsSelected autoSizeActiveColumnWidths autoSizeFieldColumnWidth beginSelectionChange calculateActiveColumnsWidth calculateActiveNonFixedColumnsWidth calculateRowCount clearColumns clearFocus clearSelection deactivate deleteCellSelectionArea deleteRectangleSelectionArea deselectColumn deselectColumns deselectDynamicAll deselectRow deselectRows destroy endSelectionChange findLinedHoverCellAtCanvasOffset focusOnlySelectCell focusOnlySelectRectangle focusReplaceLastArea focusReplaceLastAreaWithRectangle focusSelectCell focusToggleSelectCell getActiveColumn getActiveColumnIndexByFieldIndex getActiveColumns getActiveColumnSettings getActiveColumnWidth getAllCellSelectionAreaTypeIds getAllColumn getBoundsOfCell getFieldColumnRange getHiddenColumns getHiDPI getOneCellSelectionAreaType getRenderedHeight getRenderedWidth getRowHeight getSchema getSelectedAllAreaRowCount getSelectedColumnIndices getSelectedDynamicAllRowIndices getSelectedRowCount getSelectedRowIndices getSelectedSubgridDynamicAllRowIndices getSingletonViewDataRow getSubgridRowCount getValuesInView getViewData getViewValue hideActiveColumn isActiveColumnInView isActiveDocumentElement isCellInView isCellSelected isOnlyThisCellSelected isSelectedCellTheOnlySelectedCell isSubgridRowInView mergeFieldColumnSettings moveActiveColumn onlySelectColumn onlySelectColumns onlySelectRectangle onlySelectRow onlySelectRows onlySelectViewCell registerGridPainter removeEventListener reset scrollBottom scrollFirstColumn scrollLastColumn scrollTop selectAllRows selectCell selectColumn selectColumns selectDynamicAll selectRectangle selectRow selectRows setActiveColumns setActiveColumnsAndWidthsByFieldName setActiveColumnsAutoWidthSizing setActiveColumnWidth setColumnScrollAnchor setColumnWidths setColumnWidthsByName setFieldColumnSettings setRowHeight setValue showHideColumns swapActiveColumns toggleSelectCell toggleSelectColumn toggleSelectRow tryExtendLastSelectionAreaAsCloseAsPossibleToFocus tryFocusBottom tryFocusColumnAndEnsureInView tryFocusColumnRowAndEnsureInView tryFocusFirstColumn tryFocusLastColumn tryFocusRowAndEnsureInView tryFocusTop tryMoveFocusDown tryMoveFocusLeft tryMoveFocusRight tryMoveFocusUp tryOnlySelectFocusedCell tryPageFocusDown tryPageFocusLeft tryPageFocusRight tryPageFocusUp tryScrollDown tryScrollLeft tryScrollPageDown tryScrollPageLeft tryScrollPageRight tryScrollPageUp tryScrollRight tryScrollUp

    Constructors

    Properties

    canvas: RevCanvas<RevSimpleInMemoryBehavioredGridSettings>
    clientId: string
    columnsManager: RevColumnsManager<RevSimpleInMemoryBehavioredColumnSettings, SF>
    externalParent: unknown
    focus: RevFocus<
        RevSimpleInMemoryBehavioredGridSettings,
        RevSimpleInMemoryBehavioredColumnSettings,
        SF,
    >
    horizontalScroller: RevScroller
    id: string
    internalParent: undefined | RevClientObject
    mainDataServer: RevDataServer<SF>
    mainSubgrid: RevMainSubgrid<RevSimpleInMemoryBehavioredColumnSettings, SF>
    mouse: RevMouse<
        RevSimpleInMemoryBehavioredGridSettings,
        RevSimpleInMemoryBehavioredColumnSettings,
        SF,
    >
    renderer: RevRenderer<
        RevSimpleInMemoryBehavioredGridSettings,
        RevSimpleInMemoryBehavioredColumnSettings,
        SF,
    >
    schemaServer: RevSchemaServer<SF>
    selection: RevSelection<
        RevSimpleInMemoryBehavioredGridSettings,
        RevSimpleInMemoryBehavioredColumnSettings,
        SF,
    >
    settings: RevSimpleInMemoryBehavioredGridSettings
    subgridsManager: RevSubgridsManager<
        RevSimpleInMemoryBehavioredColumnSettings,
        SF,
    >
    verticalScroller: RevScroller
    viewLayout: RevViewLayout<
        RevSimpleInMemoryBehavioredGridSettings,
        RevSimpleInMemoryBehavioredColumnSettings,
        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 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 fixedColumnsViewWidth(): number

      Returns number

    • get nonFixedColumnsViewWidth(): number

      Returns number

    • get selectionDynamicAllSubgrids(): readonly RevSubgrid<BCS, SF>[]

      Returns readonly RevSubgrid<BCS, SF>[]

    Methods

    • Parameters

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

      Returns void

    • Parameters

      • OptionalincludeDynamicAll: boolean

      Returns boolean

    • Parameters

      • fieldNameOrIndex: string | number
      • widenOnly: boolean

      Returns void

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

      Returns void

    • Removes a columns from the selection.

      The list of column selection areas will be updated to reflect the necessary deletion, splitting or resizing required.

      Parameters

      • activeColumnIndex: number

        The index of the active column to remove.

      Returns void

    • Removes a range of columns from the selection.

      The list of column selection areas will be updated to reflect the necessary deletion, splitting or resizing required.

      Parameters

      • leftOrExRightActiveColumnIndex: number

        The start index of the range of active columns to deselect if count is positive, or the exclusive end index if count is negative.

      • count: number

        The number of columns to deselect. If negative, count is in reverse direction from the exclusive end index.

      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

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

    • Returns unknown[][]

      Objects with the values that were just rendered.

    • Parameters

      • activeColumnIndex: number
      • Optionalui: boolean

      Returns void

    • Check if the specified active column is in the viewport.

      Parameters

      • activeColumnIndex: number

        The index of the active column to be checked.

      Returns boolean

      true if the active column is in the viewport, otherwise false.

    • Parameters

      • fieldIndex: number
      • settings: Partial<BCS>
      • OptionaloverrideGrid: boolean

      Returns boolean

    • Parameters

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

      Returns void

    • Parameters

      • activeColumnIndex: number
      • count: number

      Returns void

    • Parameters

      • viewLayoutColumnIndex: number
      • viewLayoutRowIndex: number

      Returns void

    • Parameters

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

      Returns void

    • Reset all components, resize and invalidate all

      Returns void

    • Parameters

      • activeColumnIndex: number

      Returns void

    • Parameters

      • activeColumnIndex: number
      • count: number

      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.

    • Enable/disable if this component can receive the focus.

      Parameters

      • source: number
      • target: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    activateaddEventListenerareColumnsOrRowsSelectedareColumnsSelectedareRowsSelectedautoSizeActiveColumnWidthsautoSizeFieldColumnWidthbeginSelectionChangecalculateActiveColumnsWidthcalculateActiveNonFixedColumnsWidthcalculateRowCountclearColumnsclearFocusclearSelectiondeactivatedeleteCellSelectionAreadeleteRectangleSelectionAreadeselectColumndeselectColumnsdeselectDynamicAlldeselectRowdeselectRowsdestroyendSelectionChangefindLinedHoverCellAtCanvasOffsetfocusOnlySelectCellfocusOnlySelectRectanglefocusReplaceLastAreafocusReplaceLastAreaWithRectanglefocusSelectCellfocusToggleSelectCellgetActiveColumngetActiveColumnIndexByFieldIndexgetActiveColumnsgetActiveColumnSettingsgetActiveColumnWidthgetAllCellSelectionAreaTypeIdsgetAllColumngetBoundsOfCellgetFieldColumnRangegetHiddenColumnsgetHiDPIgetOneCellSelectionAreaTypegetRenderedHeightgetRenderedWidthgetRowHeightgetSchemagetSelectedAllAreaRowCountgetSelectedColumnIndicesgetSelectedDynamicAllRowIndicesgetSelectedRowCountgetSelectedRowIndicesgetSelectedSubgridDynamicAllRowIndicesgetSingletonViewDataRowgetSubgridRowCountgetValuesInViewgetViewDatagetViewValuehideActiveColumnisActiveColumnInViewisActiveDocumentElementisCellInViewisCellSelectedisOnlyThisCellSelectedisSelectedCellTheOnlySelectedCellisSubgridRowInViewmergeFieldColumnSettingsmoveActiveColumnonlySelectColumnonlySelectColumnsonlySelectRectangleonlySelectRowonlySelectRowsonlySelectViewCellregisterGridPainterremoveEventListenerresetscrollBottomscrollFirstColumnscrollLastColumnscrollTopselectAllRowsselectCellselectColumnselectColumnsselectDynamicAllselectRectangleselectRowselectRowssetActiveColumnssetActiveColumnsAndWidthsByFieldNamesetActiveColumnsAutoWidthSizingsetActiveColumnWidthsetColumnScrollAnchorsetColumnWidthssetColumnWidthsByNamesetFieldColumnSettingssetRowHeightsetValueshowHideColumnsswapActiveColumnstoggleSelectCelltoggleSelectColumntoggleSelectRowtryExtendLastSelectionAreaAsCloseAsPossibleToFocustryFocusBottomtryFocusColumnAndEnsureInViewtryFocusColumnRowAndEnsureInViewtryFocusFirstColumntryFocusLastColumntryFocusRowAndEnsureInViewtryFocusToptryMoveFocusDowntryMoveFocusLefttryMoveFocusRighttryMoveFocusUptryOnlySelectFocusedCelltryPageFocusDowntryPageFocusLefttryPageFocusRighttryPageFocusUptryScrollDowntryScrollLefttryScrollPageDowntryScrollPageLefttryScrollPageRighttryScrollPageUptryScrollRighttryScrollUp