SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface UseBorderOptions

    interface UseBorderOptions {
        defaultColor?: string;
        forceThinBorder?: boolean;
        getBorderAt?: (value: any, index: number) => IBorders;
        getVisibleCells: (
            pane: IGridPane,
        ) => { cell: CellCoords; range?: Coords; value?: any }[];
        rendererBorder?: (props: BorderRenderProps) => ReactNode;
    }
    Index
    defaultColor? forceThinBorder? getBorderAt? getVisibleCells rendererBorder?
    defaultColor?: string
    forceThinBorder?: boolean

    Force all rendering to be a single border line. Use for previews.

    getBorderAt?: (value: any, index: number) => IBorders

    For finding the border. The value is the value returned from getVisibleCells and the index is the index found.

    Type Declaration

      • (value: any, index: number): IBorders

      • Parameters

        • value: any

          ?

        • index: number

          ?

        Returns IBorders

        The IBorders at the location.

    getVisibleCells: (
        pane: IGridPane,
    ) => { cell: CellCoords; range?: Coords; value?: any }[]

    Returns a list of visible cells.

    Type Declaration

      • (pane: IGridPane): { cell: CellCoords; range?: Coords; value?: any }[]

      • Parameters

        • pane: IGridPane

          IGridPane

        Returns { cell: CellCoords; range?: Coords; value?: any }[]

        An array of visible coords

    rendererBorder?: (props: BorderRenderProps) => ReactNode

    Allow users to customize border rendering. Note - This is wrapped in a single SVG so must be an SVG Element type (like a path).

    Settings
    Member Visibility

    On This Page
    Properties