RevGrid - v0.9.3
    Preparing search index...

    Class RevSymbolTableGrid

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    canvas clientId columnLayoutSetEventer columnsManager dataServersRowListChangedEventer externalParent focus headerDataServer horizontalScroller hostElement id internalParent keepPreviousLayoutIfPossible keptColumnLayoutOrReferenceDefinition mainClickEventer mainDataServer mainDblClickEventer mainSubgrid mouse openedEventer opener recordFocusedEventer recordStore renderer schemaServer selection selectionChangedEventer settings subgridsManager tableFieldSourceDefinitionCachingFactory tableRecordSourceDefinitionFromJsonFactory verticalScroller viewLayout

    Accessors

    active activeColumnCount activeColumns activeColumnsViewWidth allowedFields badness beenUsable columnLayout columnScrollAnchorIndex columnScrollAnchorOffset continuousFiltering destroyed emWidth fieldColumns fieldCount fieldNames fixedColumnsViewWidth focusedRecordIndex gridRightAligned headerRowCount isFiltered mainRowCount nonFixedColumnsViewWidth opened openedRecordSource openedTable recordCount recordFocused rowHeight rowOrderReversed rowRecIndices selectionAllAuto

    Methods

    activate addEventListener applyColumnLayoutDefinition applyColumnLayoutOrReferenceDefinition applyFilter applyFirstUsable areColumnsOrRowsSelected areColumnsSelected areRowsSelected autoSizeActiveColumnWidths autoSizeFieldColumnWidth beginSelectionChange calculateActiveColumnsWidth calculateActiveNonFixedColumnsWidth calculateRowCount canCreateAllowedSourcedFieldsColumnLayoutDefinition clearColumns clearFilter clearFocus clearRendering clearSelection clearSort closeDataSource createAllowedSourcedFieldsColumnLayoutDefinition createColumnLayoutDefinition createColumnLayoutDefinitionColumns createColumnLayoutOrReferenceDefinition createDataSourceOrReferenceDefinition createRecordDefinition createTableRecordSourceDefinition 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 getFieldSortAscending getFieldSortPriority getHiddenColumns getHiDPI getOneCellSelectionAreaType getRenderedData getRenderedHeight getRenderedWidth getRowHeight getRowOrderDefinition getSchema getSelectedAllAutoRowCount getSelectedAllAutoRowIndices getSelectedColumnIndices getSelectedRowCount getSelectedRowIndices getSingletonViewDataRow getSortFields getSortSpecifier 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 recordToRowIndex registerGridPainter removeEventListener reorderRecRows reset resetUsable rowToRecordIndex scrollBottom scrollFirstColumn scrollLastColumn scrollTop selectAllRows selectCell selectColumn selectColumns selectRectangle selectRow selectRows setActiveColumns setActiveColumnsAndWidthsByFieldName setActiveColumnsAutoWidthSizing setActiveColumnWidth setColumnScrollAnchor setColumnWidths setColumnWidthsByName setFieldColumnSettings setRowHeight setValue showHideColumns sortBy sortByMany subscribeBadnessChangedEvent swapColumns toggleSelectCell toggleSelectColumn toggleSelectRow tryExtendLastSelectionAreaAsCloseAsPossibleToFocus tryFocusBottom tryFocusFirstColumn tryFocusLastColumn tryFocusTop tryFocusXAndEnsureInView tryFocusXYAndEnsureInView tryFocusYAndEnsureInView tryMoveFocusDown tryMoveFocusLeft tryMoveFocusRight tryMoveFocusUp tryOnlySelectFocusedCell tryOpenColumnLayoutOrReferenceDefinition tryOpenDataSource tryPageFocusDown tryPageFocusLeft tryPageFocusRight tryPageFocusUp tryScrollDown tryScrollLeft tryScrollPageDown tryScrollPageLeft tryScrollPageRight tryScrollPageUp tryScrollRight tryScrollUp unsubscribeBadnessChangedEvent updateAllowedFields updateColumnLayout

    Constructors

    Properties

    canvas: RevCanvas<RevInMemoryBehavioredGridSettings>
    clientId: string
    columnLayoutSetEventer: undefined | ColumnLayoutSetEventer
    columnsManager: RevColumnsManager<
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    dataServersRowListChangedEventer:
        | undefined
        | DataServersRowListChangedEventer<RevRecordSourcedField<symbol, symbol>>
    externalParent: unknown
    focus: RevFocus<
        RevInMemoryBehavioredGridSettings,
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    headerDataServer:
        | undefined
        | RevDataServer<RevRecordSourcedField<symbol, symbol>>
    horizontalScroller: RevScroller<
        RevInMemoryBehavioredGridSettings,
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    hostElement: HTMLElement
    id: string
    internalParent: undefined | RevClientObject
    keepPreviousLayoutIfPossible: boolean
    keptColumnLayoutOrReferenceDefinition:
        | undefined
        | RevColumnLayoutOrReferenceDefinition
    mainClickEventer: undefined | MainClickEventer
    mainDataServer: RevRecordDataServer<RevRecordSourcedField<symbol, symbol>>
    mainDblClickEventer: undefined | MainDblClickEventer
    mainSubgrid: RevMainSubgrid<
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    mouse: RevMouse<
        RevInMemoryBehavioredGridSettings,
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    openedEventer: undefined | OpenedEventer
    opener: NamedLocker
    recordFocusedEventer: undefined | RecordFocusEventer
    recordStore: RevTableRecordStore<object, symbol, symbol, symbol, symbol>
    renderer: RevRenderer<
        RevInMemoryBehavioredGridSettings,
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    schemaServer: RevRecordSchemaServer<RevRecordSourcedField<symbol, symbol>>
    selection: RevSelection<
        RevInMemoryBehavioredGridSettings,
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    selectionChangedEventer: undefined | SelectionChangedEventer
    settings: RevInMemoryBehavioredGridSettings
    subgridsManager: RevSubgridsManager<
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    tableFieldSourceDefinitionCachingFactory: RevTableFieldSourceDefinitionCachingFactory<
        symbol,
        symbol,
        symbol,
    >
    tableRecordSourceDefinitionFromJsonFactory: RevTableRecordSourceDefinitionFromJsonFactory<
        symbol,
        symbol,
        symbol,
        symbol,
    >
    verticalScroller: RevScroller<
        RevInMemoryBehavioredGridSettings,
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >
    viewLayout: RevViewLayout<
        RevInMemoryBehavioredGridSettings,
        RevInMemoryBehavioredColumnSettings,
        RevRecordSourcedField<symbol, symbol>,
    >

    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 badness(): Badness

      Returns Badness

    • 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 continuousFiltering(): boolean

      Returns boolean

    • set continuousFiltering(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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

    • set focusedRecordIndex(recordIndex: undefined | number): void

      Parameters

      • recordIndex: undefined | number

      Returns void

    • get gridRightAligned(): boolean

      Returns boolean

    • get headerRowCount(): number

      Returns number

    • get isFiltered(): boolean

      Returns boolean

    • get mainRowCount(): number

      Returns number

    • get nonFixedColumnsViewWidth(): number

      Returns number

    • get opened(): boolean

      Returns boolean

    • get recordCount(): number

      Returns number

    • get recordFocused(): boolean

      Returns boolean

    • get rowHeight(): number

      Returns number

    • get rowOrderReversed(): boolean

      Returns boolean

    • set rowOrderReversed(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get rowRecIndices(): 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

      • OptionalincludeAllAuto: boolean

      Returns boolean

    • Parameters

      • OptionalincludeAllAuto: 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

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

    • 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

      • OptionalincludeAllAuto: boolean

      Returns number

    • Parameters

      • activeColumnIndex: number
      • Optionalui: boolean

      Returns void

    • Parameters

      • activeIndex: number

        The column index in question.

      Returns boolean

      The given column is fully visible.

    • 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

    • Parameters

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

      Returns boolean

    • Parameters

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

      Returns void

    • Parameters

      • activeColumnIndex: number

      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

    • Parameters

      • _itemIndices: number[]

      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.

    • Parameters

      • OptionalfieldIndex: number
      • OptionalisAscending: boolean

      Returns boolean

    • Parameters

      • handler: BadnessChangedEventHandler

      Returns SubscriptionId

    • Parameters

      • source: number
      • target: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    activateaddEventListenerapplyColumnLayoutDefinitionapplyColumnLayoutOrReferenceDefinitionapplyFilterapplyFirstUsableareColumnsOrRowsSelectedareColumnsSelectedareRowsSelectedautoSizeActiveColumnWidthsautoSizeFieldColumnWidthbeginSelectionChangecalculateActiveColumnsWidthcalculateActiveNonFixedColumnsWidthcalculateRowCountcanCreateAllowedSourcedFieldsColumnLayoutDefinitionclearColumnsclearFilterclearFocusclearRenderingclearSelectionclearSortcloseDataSourcecreateAllowedSourcedFieldsColumnLayoutDefinitioncreateColumnLayoutDefinitioncreateColumnLayoutDefinitionColumnscreateColumnLayoutOrReferenceDefinitioncreateDataSourceOrReferenceDefinitioncreateRecordDefinitioncreateTableRecordSourceDefinitiondeactivatedeselectCelldeselectColumndeselectColumnsdeselectRectangledeselectRowdeselectRowsdestroyendSelectionChangefindLinedHoverCellAtCanvasOffsetfocusOnlySelectCellfocusOnlySelectRectanglefocusReplaceLastAreafocusReplaceLastAreaWithRectanglefocusSelectCellfocusToggleSelectCellgetActiveColumngetActiveColumnIndexByFieldIndexgetActiveColumnsgetActiveColumnSettingsgetActiveColumnWidthgetAllCellSelectionAreaTypeIdsgetAllColumngetBoundsOfCellgetFieldgetFieldByNamegetFieldColumnRangegetFieldSortAscendinggetFieldSortPrioritygetHiddenColumnsgetHiDPIgetOneCellSelectionAreaTypegetRenderedDatagetRenderedHeightgetRenderedWidthgetRowHeightgetRowOrderDefinitiongetSchemagetSelectedAllAutoRowCountgetSelectedAllAutoRowIndicesgetSelectedColumnIndicesgetSelectedRowCountgetSelectedRowIndicesgetSingletonViewDataRowgetSortFieldsgetSortSpecifiergetSubgridRowCountgetViewAnchorgetViewDatagetViewValuegetVisibleColumnsCountgetVisibleRowsCounthideActiveColumninitialiseAllowedFieldsinvalidateAllisActiveDocumentElementisCellSelectedisColumnVisibleisDataRowVisibleisDataVisibleisHeaderRowisOnlyThisCellSelectedisSelectedCellTheOnlySelectedCellmergeFieldColumnSettingsmoveActiveColumnonlySelectCellonlySelectColumnonlySelectColumnsonlySelectRectangleonlySelectRowonlySelectRowsonlySelectViewCellrecordToRowIndexregisterGridPainterremoveEventListenerreorderRecRowsresetresetUsablerowToRecordIndexscrollBottomscrollFirstColumnscrollLastColumnscrollTopselectAllRowsselectCellselectColumnselectColumnsselectRectangleselectRowselectRowssetActiveColumnssetActiveColumnsAndWidthsByFieldNamesetActiveColumnsAutoWidthSizingsetActiveColumnWidthsetColumnScrollAnchorsetColumnWidthssetColumnWidthsByNamesetFieldColumnSettingssetRowHeightsetValueshowHideColumnssortBysortByManysubscribeBadnessChangedEventswapColumnstoggleSelectCelltoggleSelectColumntoggleSelectRowtryExtendLastSelectionAreaAsCloseAsPossibleToFocustryFocusBottomtryFocusFirstColumntryFocusLastColumntryFocusToptryFocusXAndEnsureInViewtryFocusXYAndEnsureInViewtryFocusYAndEnsureInViewtryMoveFocusDowntryMoveFocusLefttryMoveFocusRighttryMoveFocusUptryOnlySelectFocusedCelltryOpenColumnLayoutOrReferenceDefinitiontryOpenDataSourcetryPageFocusDowntryPageFocusLefttryPageFocusRighttryPageFocusUptryScrollDowntryScrollLefttryScrollPageDowntryScrollPageLefttryScrollPageRighttryScrollPageUptryScrollRighttryScrollUpunsubscribeBadnessChangedEventupdateAllowedFieldsupdateColumnLayout