RevGrid - v0.9.3
    Preparing search index...

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Accessors

    addToggleSelectionAreaModifierKey addToggleSelectionAreaModifierKeyDoesToggle backgroundAnimateTimeInterval backgroundColor cellFocusedBorderColor cellHoverBackgroundColor cellPadding color columnAutoSizingMax columnClip columnHeaderBackgroundColor columnHeaderFont columnHeaderForegroundColor columnHeaderHorizontalAlign columnHeaderHorizontalAlignId columnHeaderSelectionBackgroundColor columnHeaderSelectionFont columnHeaderSelectionForegroundColor columnHoverBackgroundColor columnMoveDragActiveCursorName columnMoveDragActiveTitleText columnMoveDragPossibleCursorName columnMoveDragPossibleTitleText columnResizeDragActiveCursorName columnResizeDragActiveTitleText columnResizeDragPossibleCursorName columnResizeDragPossibleTitleText columnSortPossibleCursorName columnSortPossibleTitleText columnsReorderable columnsReorderableHideable defaultColumnAutoSizing defaultColumnWidth defaultRowHeight defaultUiControllerTypeNames editable editKey editOnClick editOnDoubleClick editOnFocusCell editOnKeyDown editorClickableCursorName eventDispatchEnabled extendLastSelectionAreaModifierKey filterable filterBackgroundColor filterBackgroundSelectionColor filterCellPainter filterColor filterEditor filterFont filterForegroundSelectionColor fixedColumnCount fixedRowCount font gridRightAligned horizontalAlign horizontalAlignId horizontalFixedLineColor horizontalFixedLineEdgeWidth horizontalFixedLineWidth horizontalGridLinesColor horizontalGridLinesVisible horizontalGridLinesWidth horizontalWheelScrollingAllowed maximumColumnWidth minimumAnimateTimeInterval minimumColumnWidth mouseAddToggleExtendSelectionAreaDragModifierKey mouseAddToggleExtendSelectionAreaEnabled mouseColumnSelectionEnabled mouseColumnSelectionModifierKey mouseLastSelectionAreaExtendingDragActiveCursorName mouseLastSelectionAreaExtendingDragActiveTitleText mouseRowSelectionEnabled mouseRowSelectionModifierKey multipleSelectionAreas primarySelectionAreaType resizeColumnInPlace resizedEventDebounceExtendedWhenPossible resizedEventDebounceInterval rowHoverBackgroundColor rowResize rowStripeBackgroundColor scrollerThickness scrollerThumbColor scrollerThumbReducedVisibilityOpacity scrollHorizontallySmoothly scrollingEnabled secondarySelectionAreaType secondarySelectionAreaTypeSpecifierModifierKey selectionBackgroundColor selectionFont selectionForegroundColor selectionRegionOutlineColor selectionRegionOverlayColor showFilterRow showScrollerThumbOnMouseMoveModifierKey sortOnClick sortOnDoubleClick switchNewRectangleSelectionToRowOrColumn textStrikeThrough textTruncateType textTruncateTypeId useHiDPI verticalFixedLineColor verticalFixedLineEdgeWidth verticalFixedLineWidth verticalGridLinesColor verticalGridLinesVisible verticalGridLinesWidth verticalOffset visibleColumnWidthAdjust visibleVerticalGridLinesDrawnInFixedAndPreMainOnly wheelHFactor wheelVFactor

    Methods

    Constructors

    Accessors

    • get addToggleSelectionAreaModifierKeyDoesToggle(): boolean

      Specifies whether the addToggleSelectionAreaModifierKey toggles. If if does not toggle, then it adds

      Returns boolean

    • set addToggleSelectionAreaModifierKeyDoesToggle(value: boolean): void

      Specifies whether the addToggleSelectionAreaModifierKey toggles. If if does not toggle, then it adds

      Parameters

      • value: boolean

      Returns void

    • get backgroundAnimateTimeInterval(): undefined | number

      Specifies the interval (in milliseconds) between regular calls of requestAnimationFrame to paint grid. Set to undefined for no regular calls of requestAnimationFrame. This is normally not required (undefined) as the grid will automatically detect when a repaint and automatically immediately initiate a repaint. However this can be used to force continuous repaints (set to 0) for debugging purpose. It can also be used when data server invalidate callbacks to grid do not notify all data changes and repaints should be triggered by polling.

      Returns undefined | number

    • set backgroundAnimateTimeInterval(value: undefined | number): void

      Specifies the interval (in milliseconds) between regular calls of requestAnimationFrame to paint grid. Set to undefined for no regular calls of requestAnimationFrame. This is normally not required (undefined) as the grid will automatically detect when a repaint and automatically immediately initiate a repaint. However this can be used to force continuous repaints (set to 0) for debugging purpose. It can also be used when data server invalidate callbacks to grid do not notify all data changes and repaints should be triggered by polling.

      Parameters

      • value: undefined | number

      Returns void

    • get columnAutoSizingMax(): undefined | number

      The widest the column will be auto-sized to.

      Returns undefined | number

    • set columnAutoSizingMax(value: undefined | number): void

      The widest the column will be auto-sized to.

      Parameters

      • value: undefined | number

      Returns void

    • get columnClip(): undefined | boolean

      Set up a clipping region around each column before painting cells. This will be interpretted differently by grid painters according to their algorithm

      Returns undefined | boolean

    • set columnClip(value: undefined | boolean): void

      Set up a clipping region around each column before painting cells. This will be interpretted differently by grid painters according to their algorithm

      Parameters

      • value: undefined | boolean

      Returns void

    • get defaultColumnAutoSizing(): boolean

      Whether to automatically expand column width to accommodate widest rendered value.

      Returns boolean

    • set defaultColumnAutoSizing(value: boolean): void

      Whether to automatically expand column width to accommodate widest rendered value.

      Parameters

      • value: boolean

      Returns void

    • get defaultUiControllerTypeNames(): string[]

      Default UiController automatically used by program. Note that order of these in array is important as it defines the order in which UI Events are processed.

      Returns string[]

    • set defaultUiControllerTypeNames(value: string[]): void

      Default UiController automatically used by program. Note that order of these in array is important as it defines the order in which UI Events are processed.

      Parameters

      • value: string[]

      Returns void

    • get editKey(): string

      Keyboard event key for editing a cell

      Returns string

    • set editKey(value: string): void

      Keyboard event key for editing a cell

      Parameters

      • value: string

      Returns void

    • get editOnClick(): boolean

      Open cell editor for cell when clicked by mouse

      Returns boolean

    • set editOnClick(value: boolean): void

      Open cell editor for cell when clicked by mouse

      Parameters

      • value: boolean

      Returns void

    • get editOnDoubleClick(): boolean

      Open cell editor for cell when double clicked by mouse

      Returns boolean

    • set editOnDoubleClick(value: boolean): void

      Open cell editor for cell when double clicked by mouse

      Parameters

      • value: boolean

      Returns void

    • get editOnFocusCell(): boolean

      Open cell editor for cell when cell gains focus

      Returns boolean

    • set editOnFocusCell(value: boolean): void

      Open cell editor for cell when cell gains focus

      Parameters

      • value: boolean

      Returns void

    • get editOnKeyDown(): boolean

      Open cell editor for cell when cell focus and certain keys are pushed down

      Returns boolean

    • set editOnKeyDown(value: boolean): void

      Open cell editor for cell when cell focus and certain keys are pushed down

      Parameters

      • value: boolean

      Returns void

    • get editorClickableCursorName(): undefined | string

      Cursor to display when cell editor can be clicked

      Returns undefined | string

    • set editorClickableCursorName(value: undefined | string): void

      Cursor to display when cell editor can be clicked

      Parameters

      • value: undefined | string

      Returns void

    • get gridRightAligned(): boolean

      Instead of visible columns starting from left side of canvas, they end at the right side of canvas So last column is always visible and the first one visible is dependent on the width of the canvas

      Returns boolean

    • set gridRightAligned(value: boolean): void

      Instead of visible columns starting from left side of canvas, they end at the right side of canvas So last column is always visible and the first one visible is dependent on the width of the canvas

      Parameters

      • value: boolean

      Returns void

    • get horizontalFixedLineEdgeWidth(): undefined | number

      Define this property to render just the edges of the lines between non-scrollable rows & scrollable rows, creating a double-line effect. The value is the thickness of the edges. Undefined means no edge effect Typical definition would be 1 in tandem with setting horizontalFixedLineWidth to 3.

      Returns undefined | number

    • set horizontalFixedLineEdgeWidth(value: undefined | number): void

      Define this property to render just the edges of the lines between non-scrollable rows & scrollable rows, creating a double-line effect. The value is the thickness of the edges. Undefined means no edge effect Typical definition would be 1 in tandem with setting horizontalFixedLineWidth to 3.

      Parameters

      • value: undefined | number

      Returns void

    • get horizontalFixedLineWidth(): undefined | number

      Define this property to style rule lines between non-scrollable rows and scrollable rows differently from horizontalGridLinesWidth. Undefine it to show normal grid line in that position.

      Returns undefined | number

    • set horizontalFixedLineWidth(value: undefined | number): void

      Define this property to style rule lines between non-scrollable rows and scrollable rows differently from horizontalGridLinesWidth. Undefine it to show normal grid line in that position.

      Parameters

      • value: undefined | number

      Returns void

    • get maximumColumnWidth(): undefined | number

      Maximum column width. When defined, column width is clamped to this value. Ignored when falsy. Respects resizeColumnInPlace but may cause user confusion when user can't make column narrower due to next column having reached its maximum.

      Returns undefined | number

    • set maximumColumnWidth(value: undefined | number): void

      Maximum column width. When defined, column width is clamped to this value. Ignored when falsy. Respects resizeColumnInPlace but may cause user confusion when user can't make column narrower due to next column having reached its maximum.

      Parameters

      • value: undefined | number

      Returns void

    • get minimumAnimateTimeInterval(): number

      The minimum time interval (in milliseconds) between call requestAnimationFrame to paint grid. Set low value for minimum latency. Set high value to reduce resource usage.

      Returns number

    • set minimumAnimateTimeInterval(value: number): void

      The minimum time interval (in milliseconds) between call requestAnimationFrame to paint grid. Set low value for minimum latency. Set high value to reduce resource usage.

      Parameters

      • value: number

      Returns void

    • get minimumColumnWidth(): number

      Minimum column width. Adjust this value for different fonts/sizes or exotic cell renderers. The default (5) is enough room for an ellipsis with default font size.

      Returns number

    • set minimumColumnWidth(value: number): void

      Minimum column width. Adjust this value for different fonts/sizes or exotic cell renderers. The default (5) is enough room for an ellipsis with default font size.

      Parameters

      • value: number

      Returns void

    • get mouseAddToggleExtendSelectionAreaEnabled(): boolean

      Allows rectangle selections with more than one cell and/or multiple rectangle selections. If false, then only focused cell is selected

      Returns boolean

    • set mouseAddToggleExtendSelectionAreaEnabled(value: boolean): void

      Allows rectangle selections with more than one cell and/or multiple rectangle selections. If false, then only focused cell is selected

      Parameters

      • value: boolean

      Returns void

    • get primarySelectionAreaType(): "all" | "rectangle" | "row" | "column"

      The area type that is added to a selection by default in a UI operation. Can also be specified in API calls which add an area to a RevSelection.

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

    • set primarySelectionAreaType(
          value: "all" | "rectangle" | "row" | "column",
      ): void

      The area type that is added to a selection by default in a UI operation. Can also be specified in API calls which add an area to a RevSelection.

      Parameters

      • value: "all" | "rectangle" | "row" | "column"

      Returns void

    • get resizedEventDebounceExtendedWhenPossible(): boolean

      Reduce resize processing even more by increasing debounce when lots of resize observer call backs are occurring

      Returns boolean

    • set resizedEventDebounceExtendedWhenPossible(value: boolean): void

      Reduce resize processing even more by increasing debounce when lots of resize observer call backs are occurring

      Parameters

      • value: boolean

      Returns void

    • get rowResize(): boolean

      On mouse hover, whether to repaint the row background and how.

      Returns boolean

    • set rowResize(value: boolean): void

      On mouse hover, whether to repaint the row background and how.

      Parameters

      • value: boolean

      Returns void

    • get rowStripeBackgroundColor(): undefined | string

      Repeating pattern of property overrides for grid rows.

      Returns undefined | string

    • set rowStripeBackgroundColor(value: undefined | string): void

      Repeating pattern of property overrides for grid rows.

      Parameters

      • value: undefined | string

      Returns void

    • get scrollerThickness(): string

      Height or width (depending on orientation) in either pixels (px) or Em (em)

      Returns string

    • set scrollerThickness(value: string): void

      Height or width (depending on orientation) in either pixels (px) or Em (em)

      Parameters

      • value: string

      Returns void

    • get secondarySelectionAreaType(): "all" | "rectangle" | "row" | "column"

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

    • set secondarySelectionAreaType(
          value: "all" | "rectangle" | "row" | "column",
      ): void

      Parameters

      • value: "all" | "rectangle" | "row" | "column"

      Returns void

    • get sortOnClick(): boolean

      Column can be sorted with mouse click on column header

      Returns boolean

    • set sortOnClick(value: boolean): void

      Column can be sorted with mouse click on column header

      Parameters

      • value: boolean

      Returns void

    • get sortOnDoubleClick(): boolean

      Sort column on double-click rather than single-click.

      Returns boolean

    • set sortOnDoubleClick(value: boolean): void

      Sort column on double-click rather than single-click.

      Parameters

      • value: boolean

      Returns void

    • get verticalFixedLineEdgeWidth(): undefined | number

      Define this property to render just the edges of the lines between fixed & scrolling columns, creating a double-line effect. The value is the thickness of the edges. Undefined means no edge effect Typical definition would be 1 in tandem with setting verticalFixedLineWidth to 3. verticalFixedLineWidth

      Returns undefined | number

    • set verticalFixedLineEdgeWidth(value: undefined | number): void

      Define this property to render just the edges of the lines between fixed & scrolling columns, creating a double-line effect. The value is the thickness of the edges. Undefined means no edge effect Typical definition would be 1 in tandem with setting verticalFixedLineWidth to 3. verticalFixedLineWidth

      Parameters

      • value: undefined | number

      Returns void

    • get verticalFixedLineWidth(): undefined | number

      Define this property to style rule lines between non-scrollable columns and scrollable columns differently from verticalGridLinesWidth. Undefine it to show normal grid line in that position.

      Returns undefined | number

    • set verticalFixedLineWidth(value: undefined | number): void

      Define this property to style rule lines between non-scrollable columns and scrollable columns differently from verticalGridLinesWidth. Undefine it to show normal grid line in that position.

      Parameters

      • value: undefined | number

      Returns void

    Methods