Interface HeaderDividerAnchorProps

HeaderDividers follow the header // TODO - allow negative resizing (before the current) (easy to do I think)

interface HeaderDividerAnchorProps {
    direction: HeaderDirection;
    disabled?: boolean;
    disabledResize?: boolean;
    dividerRenderer?: ((props, refForward?) => ReactNode);
    headerStyle: GridHeaderStyle;
    headerStyleHover?: GridHeaderStyle;
    headerStyleSelect: GridHeaderStyle;
    headerStyleSelectAll: GridHeaderStyle;
    index: number;
    isHidden?: boolean;
    isNextHidden?: boolean;
    isSelected?: boolean;
    isSelectedAll?: boolean;
    onDividerAutoFit?: ((index) => void);
    onDividerMouseDown?: ((index, size) => void);
    onDividerMouseUp?: ((index) => void);
    onDividerResize?: ((index, size, prevSize) => void);
    onDividerResizeEnd?: ((index, size, prevSize) => void);
    onDividerResizeStart?: ((index, prevSize) => void);
    resizeThreshold?: number;
    showTouchDivider?: boolean;
    view: GridOverlayView;
}

Hierarchy (view full)

Properties

direction disabled? disabledResize? dividerRenderer? headerStyle headerStyleHover? headerStyleSelect headerStyleSelectAll index isHidden? isNextHidden? isSelected? isSelectedAll? onDividerAutoFit? onDividerMouseDown? onDividerMouseUp? onDividerResize? onDividerResizeEnd? onDividerResizeStart? resizeThreshold? showTouchDivider? view

Properties

direction

direction: HeaderDirection

Optional disabled

disabled?: boolean

This should disable interaction. This should also provide a visual cue that the divider is disabled.

Optional disabledResize

disabledResize?: boolean

If the divider does not allow resize.

Remarks

We create a faux divider on the left of the first header and we mark it as disabledResize.

Optional dividerRenderer

dividerRenderer?: ((props, refForward?) => ReactNode)

Type declaration

headerStyle

headerStyle: GridHeaderStyle

Optional headerStyleHover

headerStyleHover?: GridHeaderStyle

headerStyleSelect

headerStyleSelect: GridHeaderStyle

headerStyleSelectAll

headerStyleSelectAll: GridHeaderStyle

index

index: number

Optional isHidden

isHidden?: boolean

If the current header is hidden. This allows the divider to shift location

Optional isNextHidden

isNextHidden?: boolean

If the next header is hidden. This allows the divider to shift location

Optional isSelected

isSelected?: boolean

If the header associated with this divider is selected.

Optional isSelectedAll

isSelectedAll?: boolean

If the header associated with this divider is selected.

Optional onDividerAutoFit

onDividerAutoFit?: ((index) => void)

Type declaration

    • (index): void

    • Parameters

      • index: number

      Returns void

Optional onDividerMouseDown

onDividerMouseDown?: ((index, size) => void)

Called when the mouse is pressed down.

Type declaration

    • (index, size): void

    • Parameters

      • index: number
      • size: number

      Returns void

Returns

Optional onDividerMouseUp

onDividerMouseUp?: ((index) => void)

Called when the mouse is released (regardless of resize)

Type declaration

    • (index): void

    • Parameters

      • index: number

      Returns void

Returns

Optional onDividerResize

onDividerResize?: ((index, size, prevSize) => void)

Call during resize

Type declaration

    • (index, size, prevSize): void

    • Parameters

      • index: number
      • size: number
      • prevSize: number

        the size of the header on resizeStart (not last resize call)

      Returns void

Optional onDividerResizeEnd

onDividerResizeEnd?: ((index, size, prevSize) => void)

Called after the mouse has been released but only if the mouse onDividerResizeStart was called

Type declaration

    • (index, size, prevSize): void

    • Parameters

      • index: number
      • size: number
      • prevSize: number

      Returns void

Returns

Optional onDividerResizeStart

onDividerResizeStart?: ((index, prevSize) => void)

Called after the mouse has dragged beyond the threshold

Type declaration

    • (index, prevSize): void

    • Parameters

      • index: number
      • prevSize: number

      Returns void

Returns

Optional resizeThreshold

resizeThreshold?: number

The number of pixels to mouse before resizing starts. If this number is less than 1 then it will be 1.

Optional showTouchDivider

showTouchDivider?: boolean

If the divider is the last one in view. Useful for touch divider that only show the last one.

view

view: GridOverlayView

Settings

Member Visibility

Theme

On This Page

directiondisableddisabledResizedividerRendererheaderStyleheaderStyleHoverheaderStyleSelectheaderStyleSelectAllindexisHiddenisNextHiddenisSelectedisSelectedAllonDividerAutoFitonDividerMouseDownonDividerMouseUponDividerResizeonDividerResizeEndonDividerResizeStartresizeThresholdshowTouchDividerview