RevGrid - v0.9.3
    Preparing search index...
    interface RevSimpleBehavioredGridSettings {
        addToggleSelectionAreaModifierKey: RevModifierKey;
        addToggleSelectionAreaModifierKeyDoesToggle: boolean;
        backgroundAnimateTimeInterval: undefined | number;
        backgroundColor: string;
        cellFocusedBorderColor: undefined | string;
        cellHoverBackgroundColor: undefined | string;
        cellPadding: number;
        color: string;
        columnAutoSizingMax: undefined | number;
        columnClip: undefined | boolean;
        columnHeaderBackgroundColor: undefined | string;
        columnHeaderFont: undefined | string;
        columnHeaderForegroundColor: undefined | string;
        columnHeaderHorizontalAlign: RevHorizontalAlign;
        columnHeaderHorizontalAlignId: RevHorizontalAlignId;
        columnHeaderSelectionBackgroundColor: undefined | string;
        columnHeaderSelectionFont: undefined | string;
        columnHeaderSelectionForegroundColor: undefined | string;
        columnHoverBackgroundColor: undefined | string;
        columnMoveDragActiveCursorName: undefined | string;
        columnMoveDragActiveTitleText: undefined | string;
        columnMoveDragPossibleCursorName: undefined | string;
        columnMoveDragPossibleTitleText: undefined | string;
        columnResizeDragActiveCursorName: undefined | string;
        columnResizeDragActiveTitleText: undefined | string;
        columnResizeDragPossibleCursorName: undefined | string;
        columnResizeDragPossibleTitleText: undefined | string;
        columnSortPossibleCursorName: undefined | string;
        columnSortPossibleTitleText: undefined | string;
        columnsReorderable: boolean;
        columnsReorderableHideable: boolean;
        defaultColumnAutoSizing: boolean;
        defaultColumnWidth: number;
        defaultRowHeight: number;
        defaultUiControllerTypeNames: string[];
        editable: boolean;
        editKey: string;
        editOnClick: boolean;
        editOnDoubleClick: boolean;
        editOnFocusCell: boolean;
        editOnKeyDown: boolean;
        editorClickableCursorName: undefined | string;
        eventDispatchEnabled: boolean;
        extendLastSelectionAreaModifierKey: RevModifierKey;
        filterable: boolean;
        filterBackgroundColor: string;
        filterBackgroundSelectionColor: string;
        filterCellPainter: string;
        filterColor: string;
        filterEditor: string;
        filterFont: string;
        filterForegroundSelectionColor: string;
        fixedColumnCount: number;
        fixedRowCount: number;
        font: string;
        gridRightAligned: boolean;
        horizontalAlign: RevHorizontalAlign;
        horizontalAlignId: RevHorizontalAlignId;
        horizontalFixedLineColor: string;
        horizontalFixedLineEdgeWidth: undefined | number;
        horizontalFixedLineWidth: undefined | number;
        horizontalGridLinesColor: string;
        horizontalGridLinesVisible: boolean;
        horizontalGridLinesWidth: number;
        horizontalWheelScrollingAllowed: RevHorizontalWheelScrollingAllowedId;
        maximumColumnWidth: undefined | number;
        minimumAnimateTimeInterval: number;
        minimumColumnWidth: number;
        mouseAddToggleExtendSelectionAreaDragModifierKey:
            | undefined
            | RevModifierKey;
        mouseAddToggleExtendSelectionAreaEnabled: boolean;
        mouseColumnSelectionEnabled: boolean;
        mouseColumnSelectionModifierKey: undefined
        | RevModifierKey;
        mouseLastSelectionAreaExtendingDragActiveCursorName: undefined | string;
        mouseLastSelectionAreaExtendingDragActiveTitleText: undefined | string;
        mouseRowSelectionEnabled: boolean;
        mouseRowSelectionModifierKey: undefined | RevModifierKey;
        multipleSelectionAreas: boolean;
        primarySelectionAreaType: "all" | "rectangle" | "row" | "column";
        resizeColumnInPlace: boolean;
        resizedEventDebounceExtendedWhenPossible: boolean;
        resizedEventDebounceInterval: number;
        rowHoverBackgroundColor: undefined | string;
        rowResize: boolean;
        rowStripeBackgroundColor: undefined | string;
        scrollerThickness: string;
        scrollerThumbColor: string;
        scrollerThumbReducedVisibilityOpacity: number;
        scrollHorizontallySmoothly: boolean;
        scrollingEnabled: boolean;
        secondarySelectionAreaType: "all" | "rectangle" | "row" | "column";
        secondarySelectionAreaTypeSpecifierModifierKey: undefined | RevModifierKey;
        selectionBackgroundColor: undefined | string;
        selectionFont: undefined | string;
        selectionForegroundColor: undefined | string;
        selectionRegionOutlineColor: undefined | string;
        selectionRegionOverlayColor: undefined | string;
        showFilterRow: boolean;
        showScrollerThumbOnMouseMoveModifierKey: undefined | RevModifierKey;
        sortOnClick: boolean;
        sortOnDoubleClick: boolean;
        switchNewRectangleSelectionToRowOrColumn: undefined | "row" | "column";
        textStrikeThrough: boolean;
        textTruncateType: undefined | RevTextTruncateType;
        textTruncateTypeId: undefined | RevTextTruncateTypeId;
        useHiDPI: boolean;
        verticalFixedLineColor: string;
        verticalFixedLineEdgeWidth: undefined | number;
        verticalFixedLineWidth: undefined | number;
        verticalGridLinesColor: string;
        verticalGridLinesVisible: boolean;
        verticalGridLinesWidth: number;
        verticalOffset: number;
        visibleColumnWidthAdjust: boolean;
        visibleVerticalGridLinesDrawnInFixedAndPreMainOnly: boolean;
        wheelHFactor: number;
        wheelVFactor: number;
        beginChange(): void;
        clone(): RevSimpleBehavioredGridSettings;
        endChange(): boolean;
        merge(settings: Partial<RevSimpleGridSettings>): boolean;
        subscribeChangedEvent(
            handler: RevBehavioredSettings.ChangedEventHandler,
        ): void;
        unsubscribeChangedEvent(
            handler: RevBehavioredSettings.ChangedEventHandler,
        ): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    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

    Properties

    addToggleSelectionAreaModifierKey: RevModifierKey

    Modifier key that indicates a UI action should add a selection area to selection or toggle a selection area within a selection

    addToggleSelectionAreaModifierKeyDoesToggle: boolean

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

    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.

    backgroundColor: string
    cellFocusedBorderColor: undefined | string
    cellHoverBackgroundColor: undefined | string
    cellPadding: number

    Padding to left and right of cell content

    color: string
    columnAutoSizingMax: undefined | number

    The widest the column will be auto-sized to.

    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

    columnHeaderBackgroundColor: undefined | string
    columnHeaderFont: undefined | string
    columnHeaderForegroundColor: undefined | string
    columnHeaderHorizontalAlign: RevHorizontalAlign
    columnHeaderHorizontalAlignId: RevHorizontalAlignId
    columnHeaderSelectionBackgroundColor: undefined | string
    columnHeaderSelectionFont: undefined | string

    Font style for selected columns' headers.

    columnHeaderSelectionForegroundColor: undefined | string
    columnHoverBackgroundColor: undefined | string
    columnMoveDragActiveCursorName: undefined | string
    columnMoveDragActiveTitleText: undefined | string
    columnMoveDragPossibleCursorName: undefined | string
    columnMoveDragPossibleTitleText: undefined | string
    columnResizeDragActiveCursorName: undefined | string
    columnResizeDragActiveTitleText: undefined | string
    columnResizeDragPossibleCursorName: undefined | string
    columnResizeDragPossibleTitleText: undefined | string
    columnSortPossibleCursorName: undefined | string
    columnSortPossibleTitleText: undefined | string
    columnsReorderable: boolean

    Allow user to move columns.

    columnsReorderableHideable: boolean

    Columns can be hidden when being reordered.

    defaultColumnAutoSizing: boolean

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

    defaultColumnWidth: number

    This default column width is used when width property is undefined. (width is defined on column creation unless defaultColumnAutoSizing has been set to false.)

    defaultRowHeight: number
    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.

    editable: boolean
    editKey: string

    Keyboard event key for editing a cell

    editOnClick: boolean

    Open cell editor for cell when clicked by mouse

    editOnDoubleClick: boolean

    Open cell editor for cell when double clicked by mouse

    editOnFocusCell: boolean

    Open cell editor for cell when cell gains focus

    editOnKeyDown: boolean

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

    editorClickableCursorName: undefined | string

    Cursor to display when cell editor can be clicked

    eventDispatchEnabled: boolean

    Whether grid events are dispatched as DOM events

    extendLastSelectionAreaModifierKey: RevModifierKey

    Modifier key that indicates a UI action should extend the selection area

    filterable: boolean

    Validation failure feedback.

    filterBackgroundColor: string
    filterBackgroundSelectionColor: string
    filterCellPainter: string
    filterColor: string
    filterEditor: string
    filterFont: string
    filterForegroundSelectionColor: string
    fixedColumnCount: number
    fixedRowCount: number
    font: string
    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

    horizontalAlign: RevHorizontalAlign
    horizontalAlignId: RevHorizontalAlignId

    Horizontal alignment of content of each cell.

    horizontalFixedLineColor: string

    Define this property to style rule lines between fixed & scolling rows differently from horizontalGridLinesColor.

    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.

    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.

    horizontalGridLinesColor: string

    Color of horizontal grid lines.

    horizontalGridLinesVisible: boolean

    Specifies whether horizontal grid lines are drawn

    horizontalGridLinesWidth: number

    Thickness of horizontal grid lines (pixels). Ignored if horizontalGridLinesVisible is false

    horizontalWheelScrollingAllowed: RevHorizontalWheelScrollingAllowedId
    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.

    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.

    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.

    mouseAddToggleExtendSelectionAreaDragModifierKey: undefined | RevModifierKey
    mouseAddToggleExtendSelectionAreaEnabled: boolean

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

    mouseColumnSelectionEnabled: boolean

    Enables column selections with mouse

    mouseColumnSelectionModifierKey: undefined | RevModifierKey
    mouseLastSelectionAreaExtendingDragActiveCursorName: undefined | string

    Cursor to appear when extending a selection with a mouse drag

    mouseLastSelectionAreaExtendingDragActiveTitleText: undefined | string
    mouseRowSelectionEnabled: boolean

    Enables row selections with mouse

    mouseRowSelectionModifierKey: undefined | RevModifierKey
    multipleSelectionAreas: boolean

    Allow multiple cell region selections.

    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.

    resizeColumnInPlace: boolean
    resizedEventDebounceExtendedWhenPossible: boolean

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

    resizedEventDebounceInterval: number

    Reduce resize processing with debounce. In milliseconds

    rowHoverBackgroundColor: undefined | string
    rowResize: boolean

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

    rowStripeBackgroundColor: undefined | string

    Repeating pattern of property overrides for grid rows.

    scrollerThickness: string

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

    scrollerThumbColor: string
    scrollerThumbReducedVisibilityOpacity: number
    scrollHorizontallySmoothly: boolean

    Anchor column does not need to align with edge of grid

    scrollingEnabled: boolean
    secondarySelectionAreaType: "all" | "rectangle" | "row" | "column"
    secondarySelectionAreaTypeSpecifierModifierKey: undefined | RevModifierKey

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

    selectionBackgroundColor: undefined | string

    Background color for selected cell(s).

    selectionFont: undefined | string

    Font style for selected cell(s).

    selectionForegroundColor: undefined | string

    Font color for selected cell(s).

    selectionRegionOutlineColor: undefined | string

    Stroke color for last selection overlay.

    selectionRegionOverlayColor: undefined | string

    Fill color for last selection overlay.

    showFilterRow: boolean
    showScrollerThumbOnMouseMoveModifierKey: undefined | RevModifierKey
    sortOnClick: boolean

    Column can be sorted with mouse click on column header

    sortOnDoubleClick: boolean

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

    switchNewRectangleSelectionToRowOrColumn: undefined | "row" | "column"
    textStrikeThrough: boolean

    Display cell font with strike-through line drawn over it.

    textTruncateType: undefined | RevTextTruncateType
    textTruncateTypeId: undefined | RevTextTruncateTypeId
    useHiDPI: boolean
    verticalFixedLineColor: string

    Define this property to style rule lines between fixed & scolling columns differently from verticalGridLinesColor.

    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

    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.

    verticalGridLinesColor: string

    Color of vertical grid lines.

    verticalGridLinesVisible: boolean

    Specifies whether vertical grid lines are drawn

    verticalGridLinesWidth: number

    Thickness of vertical grid lines (pixels). Is ignored if verticalGridLinesVisible is false

    verticalOffset: number

    Vertical offset from top of cell of content of each cell.

    visibleColumnWidthAdjust: boolean
    visibleVerticalGridLinesDrawnInFixedAndPreMainOnly: boolean
    wheelHFactor: number
    wheelVFactor: number

    Methods