RevGrid - v0.10.0
    Preparing search index...

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Accessors

    addToggleSelectionAreaModifierKey addToggleSelectionAreaModifierKeyDoesToggle backgroundAnimateTimeInterval backgroundColor cellEditPossibleCursorName color columnAutoSizingMax columnClip columnMoveDragActiveCursorName columnMoveDragActiveTitleText columnMoveDragPossibleCursorName columnMoveDragPossibleTitleText columnResizeDragActiveCursorName columnResizeDragActiveTitleText columnResizeDragPossibleCursorName columnResizeDragPossibleTitleText columnSortPossibleCursorName columnSortPossibleTitleText columnsReorderable columnsReorderableHideable defaultColumnAutoSizing defaultColumnWidth defaultRowHeight defaultUiControllerTypeNames editable editKey editOnClick editOnDoubleClick editOnFocusCell editOnKeyDown eventDispatchEnabled extendLastSelectionAreaModifierKey filterable filterBackgroundColor filterBackgroundSelectionColor filterCellPainter filterColor filterEditor filterFont filterForegroundSelectionColor fixedColumnCount fixedRowCount gridRightAligned horizontalFixedLineColor horizontalFixedLineEdgeWidth horizontalFixedLineWidth horizontalGridLinesColor horizontalGridLinesVisible horizontalGridLinesWidth horizontalWheelScrollingAllowed maximumColumnWidth minimumAnimateTimeInterval minimumColumnWidth mouseAddToggleExtendSelectionAreaDragModifierKey mouseAddToggleExtendSelectionAreaEnabled mouseColumnSelectionEnabled mouseColumnSelectionModifierKey mouseLastSelectionAreaExtendingDragActiveCursorName mouseLastSelectionAreaExtendingDragActiveTitleText mouseRowSelectionEnabled mouseRowSelectionModifierKey multipleSelectionAreas primarySelectionAreaType resizeColumnInPlace resizedEventDebounceExtendedWhenPossible resizedEventDebounceInterval rowResize rowStripeBackgroundColor scrollerThickness scrollerThumbColor scrollerThumbReducedVisibilityOpacity scrollHorizontallySmoothly scrollingEnabled secondarySelectionAreaType secondarySelectionAreaTypeSpecifierModifierKey selectionRegionOutlineColor selectionRegionOverlayColor showFilterRow showScrollerThumbOnMouseMoveModifierKey sortOnClick sortOnDoubleClick switchNewRectangleSelectionToRowOrColumn useHiDPI verticalFixedLineColor verticalFixedLineEdgeWidth verticalFixedLineWidth verticalGridLinesColor verticalGridLinesVisible verticalGridLinesWidth viewColumnWidthAdjust visibleVerticalGridLinesDrawnInFixedAndPreMainOnly wheelHFactor wheelVFactor

    Methods

    Constructors

    Accessors

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

      Specifies whether the grid view is aligned to the right of the canvas. If true the grid is aligned to the right and in view columns end at the right side of the canvas (that is, instead starting from left side of canvas). In this case, the last column is always in view (if canvas is wide enough) and the first will be partially in view unless it exactly fits into the space available for it (in the width of the canvas).

      Returns boolean

    • set gridRightAligned(value: boolean): void

      Specifies whether the grid view is aligned to the right of the canvas. If true the grid is aligned to the right and in view columns end at the right side of the canvas (that is, instead starting from left side of canvas). In this case, the last column is always in view (if canvas is wide enough) and the first will be partially in view unless it exactly fits into the space available for it (in 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 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 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 viewColumnWidthAdjust(): boolean

      Whether the width of view columns should be adjusted to reflect their width in the view. Cell painters use the view column width to determine how to render cell content. If this is true (default), then the rendering of cells in columns that are partially in view, will better reflect the visible width of those columns. If it is false, then the rendering of cells in these columns does not change with scrolling however clipping will be needed.

      Returns boolean

    • set viewColumnWidthAdjust(value: boolean): void

      Whether the width of view columns should be adjusted to reflect their width in the view. Cell painters use the view column width to determine how to render cell content. If this is true (default), then the rendering of cells in columns that are partially in view, will better reflect the visible width of those columns. If it is false, then the rendering of cells in these columns does not change with scrolling however clipping will be needed.

      Parameters

      • value: boolean

      Returns void

    Methods