diff --git a/404.html b/404.html index 9d4bcf60..412881b6 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ Page Not Found | React Spreadsheet - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/api/class/EmptySelection/index.html b/api/class/EmptySelection/index.html index 81419e4f..688ed58c 100644 --- a/api/class/EmptySelection/index.html +++ b/api/class/EmptySelection/index.html @@ -4,13 +4,13 @@ EmptySelection | API | React Spreadsheet - +
Skip to main content
- + \ No newline at end of file diff --git a/api/class/EntireAxisSelection/index.html b/api/class/EntireAxisSelection/index.html index 92bb4c33..caa8c48a 100644 --- a/api/class/EntireAxisSelection/index.html +++ b/api/class/EntireAxisSelection/index.html @@ -4,13 +4,13 @@ EntireAxisSelection | API | React Spreadsheet - +
-
Skip to main content

abstractEntireAxisSelection

Selection of an entire axis in the spreadsheet

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • @throws

    InvalidIndexError

    Parameters

    • start: number

      row index where the selection starts, integer

    • end: number

      row index where the selection ends, integer

    Returns EntireAxisSelection

Properties

readonlyend

end: number

Selection end index, integer

readonlystart

start: number

Selection start index, integer

Methods

abstracthas

  • Determines whether the given point is within the selection

    Parameters

    Returns boolean

abstracthasEntireColumn

  • hasEntireColumn(column: number): boolean

  • Determines whether the given column is entirely selected in given selection

    Parameters

    • column: number

    Returns boolean

abstracthasEntireRow

  • hasEntireRow(row: number): boolean

  • Determines whether the given row is entirely selected in given selection

    Parameters

    • row: number

    Returns boolean

abstractnormalizeTo

  • Normalize the selection according to the given data

    Parameters

    Returns EntireAxisSelection

abstractsize

  • size(data: Matrix<unknown>): number

  • Get the number of selected points according to given data

    Parameters

    Returns number

abstracttoRange

  • Get concrete range of the selection in the given data

    Parameters

    Returns null | PointRange

- +
Skip to main content

abstractEntireAxisSelection

Selection of an entire axis in the spreadsheet

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • @throws

    InvalidIndexError

    Parameters

    • start: number

      row index where the selection starts, integer

    • end: number

      row index where the selection ends, integer

    Returns EntireAxisSelection

Properties

readonlyend

end: number

Selection end index, integer

readonlystart

start: number

Selection start index, integer

Methods

abstracthas

  • Determines whether the given point is within the selection

    Parameters

    Returns boolean

abstracthasEntireColumn

  • hasEntireColumn(column: number): boolean

  • Determines whether the given column is entirely selected in given selection

    Parameters

    • column: number

    Returns boolean

abstracthasEntireRow

  • hasEntireRow(row: number): boolean

  • Determines whether the given row is entirely selected in given selection

    Parameters

    • row: number

    Returns boolean

abstractnormalizeTo

  • Normalize the selection according to the given data

    Parameters

    Returns EntireAxisSelection

abstractsize

  • size(data: Matrix<unknown>): number

  • Get the number of selected points according to given data

    Parameters

    Returns number

abstracttoRange

  • Get concrete range of the selection in the given data

    Parameters

    Returns null | PointRange

+ \ No newline at end of file diff --git a/api/class/EntireColumnsSelection/index.html b/api/class/EntireColumnsSelection/index.html index 69417bd3..d6194f86 100644 --- a/api/class/EntireColumnsSelection/index.html +++ b/api/class/EntireColumnsSelection/index.html @@ -4,13 +4,13 @@ EntireColumnsSelection | API | React Spreadsheet - +
-
Skip to main content

EntireColumnsSelection

Selection of entire columns in the spreadsheet

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • @throws

    InvalidIndexError

    Parameters

    • start: number

      row index where the selection starts, integer

    • end: number

      row index where the selection ends, integer

    Returns EntireColumnsSelection

Properties

readonlyend

end: number

Selection end index, integer

readonlystart

start: number

Selection start index, integer

- +
Skip to main content

EntireColumnsSelection

Selection of entire columns in the spreadsheet

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • @throws

    InvalidIndexError

    Parameters

    • start: number

      row index where the selection starts, integer

    • end: number

      row index where the selection ends, integer

    Returns EntireColumnsSelection

Properties

readonlyend

end: number

Selection end index, integer

readonlystart

start: number

Selection start index, integer

+ \ No newline at end of file diff --git a/api/class/EntireRowsSelection/index.html b/api/class/EntireRowsSelection/index.html index 59e47ae6..7e2211bb 100644 --- a/api/class/EntireRowsSelection/index.html +++ b/api/class/EntireRowsSelection/index.html @@ -4,13 +4,13 @@ EntireRowsSelection | API | React Spreadsheet - +
-
Skip to main content

EntireRowsSelection

Selection of entire rows in the spreadsheet

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • @throws

    InvalidIndexError

    Parameters

    • start: number

      row index where the selection starts, integer

    • end: number

      row index where the selection ends, integer

    Returns EntireRowsSelection

Properties

readonlyend

end: number

Selection end index, integer

readonlystart

start: number

Selection start index, integer

- +
Skip to main content

EntireRowsSelection

Selection of entire rows in the spreadsheet

Hierarchy

Index

Constructors

Properties

Constructors

constructor

  • @throws

    InvalidIndexError

    Parameters

    • start: number

      row index where the selection starts, integer

    • end: number

      row index where the selection ends, integer

    Returns EntireRowsSelection

Properties

readonlyend

end: number

Selection end index, integer

readonlystart

start: number

Selection start index, integer

+ \ No newline at end of file diff --git a/api/class/EntireSelection/index.html b/api/class/EntireSelection/index.html index 9bcea817..fa5f0f11 100644 --- a/api/class/EntireSelection/index.html +++ b/api/class/EntireSelection/index.html @@ -4,13 +4,13 @@ EntireSelection | API | React Spreadsheet - +
-
Skip to main content

abstractEntireSelection

Selection of an entire part of the spreadsheet

Hierarchy

Index

Methods

Methods

abstractequals

  • Determines whether the given selection is equal to this selection

    Parameters

    Returns boolean

abstracthas

  • Determines whether the given point is within the selection

    Parameters

    Returns boolean

abstracthasEntireColumn

  • hasEntireColumn(column: number): boolean

  • Determines whether the given column is entirely selected in given selection

    Parameters

    • column: number

    Returns boolean

abstracthasEntireRow

  • hasEntireRow(row: number): boolean

  • Determines whether the given row is entirely selected in given selection

    Parameters

    • row: number

    Returns boolean

abstractnormalizeTo

  • Normalize the selection according to the given data

    Parameters

    Returns EntireSelection

abstractsize

  • size(data: Matrix<unknown>): number

  • Get the number of selected points according to given data

    Parameters

    Returns number

abstracttoRange

  • Get concrete range of the selection in the given data

    Parameters

    Returns null | PointRange

- +
Skip to main content

abstractEntireSelection

Selection of an entire part of the spreadsheet

Hierarchy

Index

Methods

Methods

abstractequals

  • Determines whether the given selection is equal to this selection

    Parameters

    Returns boolean

abstracthas

  • Determines whether the given point is within the selection

    Parameters

    Returns boolean

abstracthasEntireColumn

  • hasEntireColumn(column: number): boolean

  • Determines whether the given column is entirely selected in given selection

    Parameters

    • column: number

    Returns boolean

abstracthasEntireRow

  • hasEntireRow(row: number): boolean

  • Determines whether the given row is entirely selected in given selection

    Parameters

    • row: number

    Returns boolean

abstractnormalizeTo

  • Normalize the selection according to the given data

    Parameters

    Returns EntireSelection

abstractsize

  • size(data: Matrix<unknown>): number

  • Get the number of selected points according to given data

    Parameters

    Returns number

abstracttoRange

  • Get concrete range of the selection in the given data

    Parameters

    Returns null | PointRange

+ \ No newline at end of file diff --git a/api/class/EntireWorksheetSelection/index.html b/api/class/EntireWorksheetSelection/index.html index a7cc048d..123566d0 100644 --- a/api/class/EntireWorksheetSelection/index.html +++ b/api/class/EntireWorksheetSelection/index.html @@ -4,13 +4,13 @@ EntireWorksheetSelection | API | React Spreadsheet - +
Skip to main content
- + \ No newline at end of file diff --git a/api/class/InvalidIndexError/index.html b/api/class/InvalidIndexError/index.html index fe3ddba0..ac2f2808 100644 --- a/api/class/InvalidIndexError/index.html +++ b/api/class/InvalidIndexError/index.html @@ -4,13 +4,13 @@ InvalidIndexError | API | React Spreadsheet - +
Skip to main content

InvalidIndexError

Error thrown when passing a non-index value where an index value is expected

Hierarchy

  • Error
    • InvalidIndexError
- + \ No newline at end of file diff --git a/api/class/PointRange/index.html b/api/class/PointRange/index.html index 590edb28..c6f09ae8 100644 --- a/api/class/PointRange/index.html +++ b/api/class/PointRange/index.html @@ -4,13 +4,13 @@ PointRange | API | React Spreadsheet - +
-
Skip to main content

PointRange

Range between two points. Creates a normalized range between two given points

Index

Properties

Methods

Properties

end

end: Point

The bottom-right point

start

start: Point

The top-left point

Methods

[iterator]

  • [iterator](): Iterator<Point, any, undefined>

  • Iterates through all the existing points in given range

    Returns Iterator<Point, any, undefined>

equals

  • Returns whether given range is equal to this range

    Parameters

    Returns boolean

has

  • has(point: Point): boolean

  • Returns whether given point exists in given range

    Parameters

    Returns boolean

mask

size

  • size(): number

  • Returns the size (rows x columns) of the given range

    Returns number

- +
Skip to main content

PointRange

Range between two points. Creates a normalized range between two given points

Index

Properties

Methods

Properties

end

end: Point

The bottom-right point

start

start: Point

The top-left point

Methods

[iterator]

  • [iterator](): Iterator<Point, any, undefined>

  • Iterates through all the existing points in given range

    Returns Iterator<Point, any, undefined>

equals

  • Returns whether given range is equal to this range

    Parameters

    Returns boolean

has

  • has(point: Point): boolean

  • Returns whether given point exists in given range

    Parameters

    Returns boolean

mask

size

  • size(): number

  • Returns the size (rows x columns) of the given range

    Returns number

+ \ No newline at end of file diff --git a/api/class/RangeSelection/index.html b/api/class/RangeSelection/index.html index c56ffe36..50f0f6c6 100644 --- a/api/class/RangeSelection/index.html +++ b/api/class/RangeSelection/index.html @@ -4,13 +4,13 @@ RangeSelection | API | React Spreadsheet - +
Skip to main content
- + \ No newline at end of file diff --git a/api/class/Selection/index.html b/api/class/Selection/index.html index 47dc5ede..c2b16a95 100644 --- a/api/class/Selection/index.html +++ b/api/class/Selection/index.html @@ -4,13 +4,13 @@ Selection | API | React Spreadsheet - +
-
Skip to main content

abstractSelection

Selection from a spreadsheet

Hierarchy

Index

Methods

Methods

abstractequals

  • Determines whether the given selection is equal to this selection

    Parameters

    Returns boolean

abstracthas

  • Determines whether the given point is within the selection

    Parameters

    Returns boolean

abstracthasEntireColumn

  • hasEntireColumn(column: number): boolean

  • Determines whether the given column is entirely selected in given selection

    Parameters

    • column: number

    Returns boolean

abstracthasEntireRow

  • hasEntireRow(row: number): boolean

  • Determines whether the given row is entirely selected in given selection

    Parameters

    • row: number

    Returns boolean

abstractnormalizeTo

  • Normalize the selection according to the given data

    Parameters

    Returns Selection

abstractsize

  • size(data: Matrix<unknown>): number

  • Get the number of selected points according to given data

    Parameters

    Returns number

abstracttoRange

  • Get concrete range of the selection in the given data

    Parameters

    Returns null | PointRange

- +
Skip to main content

abstractSelection

Selection from a spreadsheet

Hierarchy

Index

Methods

Methods

abstractequals

  • Determines whether the given selection is equal to this selection

    Parameters

    Returns boolean

abstracthas

  • Determines whether the given point is within the selection

    Parameters

    Returns boolean

abstracthasEntireColumn

  • hasEntireColumn(column: number): boolean

  • Determines whether the given column is entirely selected in given selection

    Parameters

    • column: number

    Returns boolean

abstracthasEntireRow

  • hasEntireRow(row: number): boolean

  • Determines whether the given row is entirely selected in given selection

    Parameters

    • row: number

    Returns boolean

abstractnormalizeTo

  • Normalize the selection according to the given data

    Parameters

    Returns Selection

abstractsize

  • size(data: Matrix<unknown>): number

  • Get the number of selected points according to given data

    Parameters

    Returns number

abstracttoRange

  • Get concrete range of the selection in the given data

    Parameters

    Returns null | PointRange

+ \ No newline at end of file diff --git a/api/function/DataEditor/index.html b/api/function/DataEditor/index.html index 1237aa35..3d6b34ac 100644 --- a/api/function/DataEditor/index.html +++ b/api/function/DataEditor/index.html @@ -4,13 +4,13 @@ DataEditor | API | React Spreadsheet - +
Skip to main content
- + \ No newline at end of file diff --git a/api/function/DataViewer/index.html b/api/function/DataViewer/index.html index ee8926a4..b2e845dd 100644 --- a/api/function/DataViewer/index.html +++ b/api/function/DataViewer/index.html @@ -4,13 +4,13 @@ DataViewer | API | React Spreadsheet - +
Skip to main content

DataViewer

Callable

  • DataViewer<Cell, Value>(__namedParameters: DataViewerProps<Cell>): ReactElement<any, string | JSXElementConstructor<any>>

  • The default Spreadsheet DataViewer component

    Type parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

- + \ No newline at end of file diff --git a/api/function/Spreadsheet/index.html b/api/function/Spreadsheet/index.html index 1d836276..22a2d4be 100644 --- a/api/function/Spreadsheet/index.html +++ b/api/function/Spreadsheet/index.html @@ -4,13 +4,13 @@ Spreadsheet | API | React Spreadsheet - +
Skip to main content

Spreadsheet

Callable

  • Spreadsheet<CellType>(props: Props<CellType>): ReactElement<any, string | JSXElementConstructor<any>>

  • The Spreadsheet component

    Type parameters

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

- + \ No newline at end of file diff --git a/api/function/createEmptyMatrix/index.html b/api/function/createEmptyMatrix/index.html index 7e0f1587..f44e76a1 100644 --- a/api/function/createEmptyMatrix/index.html +++ b/api/function/createEmptyMatrix/index.html @@ -4,13 +4,13 @@ createEmptyMatrix | API | React Spreadsheet - +
Skip to main content

createEmptyMatrix

Callable

  • createEmptyMatrix<T>(rows: number, columns: number): Matrix<T>

  • Creates an empty matrix with given rows and columns

    Type parameters

    • T

    Parameters

    • rows: number

      integer, the amount of rows the matrix should have

    • columns: number

      integer, the amount of columns the matrix should have

    Returns Matrix<T>

    an empty matrix with given rows and columns

- + \ No newline at end of file diff --git a/api/index.html b/api/index.html index 3c011948..b140353c 100644 --- a/api/index.html +++ b/api/index.html @@ -4,16 +4,16 @@ react-spreadsheet | API | React Spreadsheet - +
-
Skip to main content

react-spreadsheet

Index

Classes

Functions

Type Aliases

Type Aliases

CellBase

CellBase<Value>: { DataEditor?: DataEditorComponent<CellBase<Value>>; DataViewer?: DataViewerComponent<CellBase<Value>>; className?: string; readOnly?: boolean; value: Value }

The base type of cell data in Spreadsheet

Type parameters

  • Value = any

Type declaration

  • optionalDataEditor?: DataEditorComponent<CellBase<Value>>

    Custom component to render when the cell is edited, if not defined would default to the component defined for the Spreadsheet

  • optionalDataViewer?: DataViewerComponent<CellBase<Value>>

    Custom component to render when the cell is viewed, if not defined would default to the component defined for the Spreadsheet

  • optionalclassName?: string

    Class to be given for the cell element

  • optionalreadOnly?: boolean

    Whether the cell should not be editable

  • value: Value

    The value of the cell

CellComponent

CellComponent<Cell>: React.ComponentType<CellComponentProps<Cell>>

Type of the Spreadsheet Cell component

Type parameters

CellComponentProps

CellComponentProps<Cell>: { DataViewer: DataViewerComponent<Cell>; activate: (point: Point) => void; active: boolean; column: number; copied: boolean; data: Cell | undefined; dragging: boolean; evaluatedData: Cell | undefined; mode: Mode; row: number; select: (point: Point) => void; selected: boolean; setCellData: (cell: Cell) => void; setCellDimensions: (point: Point, dimensions: Dimensions) => void }

Type of Spreadsheet Cell component props

Type parameters

Type declaration

  • DataViewer: DataViewerComponent<Cell>

    The DataViewer component to be used by the cell

  • activate: (point: Point) => void

      • Activate the cell at the given point

        Parameters

        Returns void

  • active: boolean

    Whether the cell is active

  • column: number

    The column of the cell

  • copied: boolean

    Whether the cell is copied

  • data: Cell | undefined

    The data of the cell

  • dragging: boolean

    Whether the user is dragging

  • evaluatedData: Cell | undefined

    The evaluated data of the cell

  • mode: Mode

    The mode of the cell

  • row: number

    The row of the cell

  • select: (point: Point) => void

      • Select the cell at the given point

        Parameters

        Returns void

  • selected: boolean

    Whether the cell is selected

  • setCellData: (cell: Cell) => void
      • (cell: Cell): void

      • Set data of the cell

        Parameters

        • cell: Cell

        Returns void

  • setCellDimensions: (point: Point, dimensions: Dimensions) => void

      • Set the dimensions of the cell at the given point with the given dimensions

        Parameters

        Returns void

CellDescriptor

CellDescriptor<Cell>: { data: Cell | undefined } & Point

A cell with it’s coordinates

@deprecated

the component does not use cell descriptors anymore. Instead it passes cell point and cell value explicitly.

Type parameters

  • Cell

ColumnIndicatorComponent

ColumnIndicatorComponent: React.ComponentType<ColumnIndicatorProps>

Type of the ColumnIndicator component

ColumnIndicatorProps

ColumnIndicatorProps: { column: number; label?: React.ReactNode | null; onSelect: (column: number, extend: boolean) => void; selected: boolean }

Type of the Spreadsheet ColumnIndicator component props

Type declaration

  • column: number

    The column the indicator indicates

  • optionallabel?: React.ReactNode | null

    A custom label for the indicator as provided in columnLabels

  • onSelect: (column: number, extend: boolean) => void
      • (column: number, extend: boolean): void

      • Callback to be called when the column is selected

        Parameters

        • column: number
        • extend: boolean

        Returns void

  • selected: boolean

    Whether the entire column in selected

CornerIndicatorComponent

CornerIndicatorComponent: React.ComponentType<CornerIndicatorProps>

Type of the CornerIndicator component

CornerIndicatorProps

CornerIndicatorProps: { onSelect: () => void; selected: boolean }

Type of the Spreadsheet CornerIndicator component props

Type declaration

  • onSelect: () => void
      • (): void

      • Callback to select the entire table

        Returns void

  • selected: boolean

    Whether the entire table is selected

DataEditorComponent

DataEditorComponent<Cell>: React.ComponentType<DataEditorProps<Cell>>

Type of the Spreadsheet DataEditor component

Type parameters

DataEditorProps

DataEditorProps<Cell>: DataComponentProps<Cell> & { exitEditMode: () => void; onChange: (cell: Cell) => void }

Type of the Spreadsheet DataEditor component props

Type parameters

DataViewerComponent

DataViewerComponent<Cell>: React.ComponentType<DataViewerProps<Cell>>

Type of the Spreadsheet DataViewer component

Type parameters

DataViewerProps

DataViewerProps<Cell>: DataComponentProps<Cell> & { evaluatedCell: Cell | undefined; setCellData: (cell: Cell) => void }

Type of the Spreadsheet DataViewer component props

Type parameters

Dimensions

Dimensions: { height: number; left: number; top: number; width: number }

Dimensions of an element

Type declaration

  • height: number

    The element’s height in pixels

  • left: number

    The distance of the element from it’s container left border in pixels

  • top: number

    The distance of the element from it’s container top border in pixels

  • width: number

    The element’s width in pixels

HeaderRowComponent

HeaderRowComponent: React.ComponentType<HeaderRowProps>

Type of the HeaderRow component

HeaderRowProps

HeaderRowProps: React.PropsWithChildren<{}>

Type of the Spreadsheet HeaderRow component props

Matrix

Matrix<T>: (T | undefined)[][]

A two-dimensional array of given type T in rows and columns

Type parameters

  • T

Mode

Mode: view | edit

The spreadsheet’s write mode

Point

Point: { column: number; row: number }

A cell coordinates in the spreadsheet

Type declaration

  • column: number

    The cell’s column

  • row: number

    The cell’s row

Props

Props<CellType>: { Cell?: Types.CellComponent<CellType>; ColumnIndicator?: Types.ColumnIndicatorComponent; CornerIndicator?: Types.CornerIndicatorComponent; DataEditor?: Types.DataEditorComponent<CellType>; DataViewer?: Types.DataViewerComponent<CellType>; HeaderRow?: Types.HeaderRowComponent; Row?: Types.RowComponent; RowIndicator?: Types.RowIndicatorComponent; Table?: Types.TableComponent; className?: string; columnLabels?: string[]; createFormulaParser?: Types.CreateFormulaParser; darkMode?: boolean; data: Matrix.Matrix<CellType>; hideColumnIndicators?: boolean; hideRowIndicators?: boolean; onActivate?: (active: Point.Point) => void; onBlur?: () => void; onCellCommit?: (prevCell: null | CellType, nextCell: null | CellType, coords: null | Point.Point) => void; onChange?: (data: Matrix.Matrix<CellType>) => void; onKeyDown?: (event: React.KeyboardEvent) => void; onModeChange?: (mode: Types.Mode) => void; onSelect?: (selected: Selection) => void; rowLabels?: string[]; selected?: Selection }

The Spreadsheet component props

Type parameters

Type declaration

  • optionalCell?: Types.CellComponent<CellType>

    The Spreadsheet’s cell component.

  • optionalColumnIndicator?: Types.ColumnIndicatorComponent

    Component rendered above each column.

  • optionalCornerIndicator?: Types.CornerIndicatorComponent

    Component rendered in the corner of row and column indicators.

  • optionalDataEditor?: Types.DataEditorComponent<CellType>

    Component rendered for cells in edit mode.

  • optionalDataViewer?: Types.DataViewerComponent<CellType>

    Component rendered for cells in view mode.

  • optionalHeaderRow?: Types.HeaderRowComponent

    The spreadsheet’s header row component

  • optionalRow?: Types.RowComponent

    The Spreadsheet’s row component.

  • optionalRowIndicator?: Types.RowIndicatorComponent

    Component rendered next to each row.

  • optionalTable?: Types.TableComponent

    The Spreadsheet’s table component.

  • optionalclassName?: string

    Class name to be added to the spreadsheet’s root element

  • optionalcolumnLabels?: string[]

    Labels to use in column indicators.

    @defaultValue

    alphabetical labels.

  • optionalcreateFormulaParser?: Types.CreateFormulaParser

    Function used to create the formula parser (instance of +

    react-spreadsheet

    Index

    Classes

    Functions

    Type Aliases

    Type Aliases

    CellBase

    CellBase<Value>: { DataEditor?: DataEditorComponent<CellBase<Value>>; DataViewer?: DataViewerComponent<CellBase<Value>>; className?: string; readOnly?: boolean; value: Value }

    The base type of cell data in Spreadsheet

    Type parameters

    • Value = any

    Type declaration

    • optionalDataEditor?: DataEditorComponent<CellBase<Value>>

      Custom component to render when the cell is edited, if not defined would default to the component defined for the Spreadsheet

    • optionalDataViewer?: DataViewerComponent<CellBase<Value>>

      Custom component to render when the cell is viewed, if not defined would default to the component defined for the Spreadsheet

    • optionalclassName?: string

      Class to be given for the cell element

    • optionalreadOnly?: boolean

      Whether the cell should not be editable

    • value: Value

      The value of the cell

    CellComponent

    CellComponent<Cell>: React.ComponentType<CellComponentProps<Cell>>

    Type of the Spreadsheet Cell component

    Type parameters

    CellComponentProps

    CellComponentProps<Cell>: { DataViewer: DataViewerComponent<Cell>; activate: (point: Point) => void; active: boolean; column: number; copied: boolean; data: Cell | undefined; dragging: boolean; evaluatedData: Cell | undefined; mode: Mode; row: number; select: (point: Point) => void; selected: boolean; setCellData: (cell: Cell) => void; setCellDimensions: (point: Point, dimensions: Dimensions) => void }

    Type of Spreadsheet Cell component props

    Type parameters

    Type declaration

    • DataViewer: DataViewerComponent<Cell>

      The DataViewer component to be used by the cell

    • activate: (point: Point) => void

        • Activate the cell at the given point

          Parameters

          Returns void

    • active: boolean

      Whether the cell is active

    • column: number

      The column of the cell

    • copied: boolean

      Whether the cell is copied

    • data: Cell | undefined

      The data of the cell

    • dragging: boolean

      Whether the user is dragging

    • evaluatedData: Cell | undefined

      The evaluated data of the cell

    • mode: Mode

      The mode of the cell

    • row: number

      The row of the cell

    • select: (point: Point) => void

        • Select the cell at the given point

          Parameters

          Returns void

    • selected: boolean

      Whether the cell is selected

    • setCellData: (cell: Cell) => void
        • (cell: Cell): void

        • Set data of the cell

          Parameters

          • cell: Cell

          Returns void

    • setCellDimensions: (point: Point, dimensions: Dimensions) => void

        • Set the dimensions of the cell at the given point with the given dimensions

          Parameters

          Returns void

    CellDescriptor

    CellDescriptor<Cell>: { data: Cell | undefined } & Point

    A cell with it’s coordinates

    @deprecated

    the component does not use cell descriptors anymore. Instead it passes cell point and cell value explicitly.

    Type parameters

    • Cell

    ColumnIndicatorComponent

    ColumnIndicatorComponent: React.ComponentType<ColumnIndicatorProps>

    Type of the ColumnIndicator component

    ColumnIndicatorProps

    ColumnIndicatorProps: { column: number; label?: React.ReactNode | null; onSelect: (column: number, extend: boolean) => void; selected: boolean }

    Type of the Spreadsheet ColumnIndicator component props

    Type declaration

    • column: number

      The column the indicator indicates

    • optionallabel?: React.ReactNode | null

      A custom label for the indicator as provided in columnLabels

    • onSelect: (column: number, extend: boolean) => void
        • (column: number, extend: boolean): void

        • Callback to be called when the column is selected

          Parameters

          • column: number
          • extend: boolean

          Returns void

    • selected: boolean

      Whether the entire column in selected

    CornerIndicatorComponent

    CornerIndicatorComponent: React.ComponentType<CornerIndicatorProps>

    Type of the CornerIndicator component

    CornerIndicatorProps

    CornerIndicatorProps: { onSelect: () => void; selected: boolean }

    Type of the Spreadsheet CornerIndicator component props

    Type declaration

    • onSelect: () => void
        • (): void

        • Callback to select the entire table

          Returns void

    • selected: boolean

      Whether the entire table is selected

    DataEditorComponent

    DataEditorComponent<Cell>: React.ComponentType<DataEditorProps<Cell>>

    Type of the Spreadsheet DataEditor component

    Type parameters

    DataEditorProps

    DataEditorProps<Cell>: DataComponentProps<Cell> & { exitEditMode: () => void; onChange: (cell: Cell) => void }

    Type of the Spreadsheet DataEditor component props

    Type parameters

    DataViewerComponent

    DataViewerComponent<Cell>: React.ComponentType<DataViewerProps<Cell>>

    Type of the Spreadsheet DataViewer component

    Type parameters

    DataViewerProps

    DataViewerProps<Cell>: DataComponentProps<Cell> & { evaluatedCell: Cell | undefined; setCellData: (cell: Cell) => void }

    Type of the Spreadsheet DataViewer component props

    Type parameters

    Dimensions

    Dimensions: { height: number; left: number; top: number; width: number }

    Dimensions of an element

    Type declaration

    • height: number

      The element’s height in pixels

    • left: number

      The distance of the element from it’s container left border in pixels

    • top: number

      The distance of the element from it’s container top border in pixels

    • width: number

      The element’s width in pixels

    HeaderRowComponent

    HeaderRowComponent: React.ComponentType<HeaderRowProps>

    Type of the HeaderRow component

    HeaderRowProps

    HeaderRowProps: React.PropsWithChildren<{}>

    Type of the Spreadsheet HeaderRow component props

    Matrix

    Matrix<T>: (T | undefined)[][]

    A two-dimensional array of given type T in rows and columns

    Type parameters

    • T

    Mode

    Mode: view | edit

    The spreadsheet’s write mode

    Point

    Point: { column: number; row: number }

    A cell coordinates in the spreadsheet

    Type declaration

    • column: number

      The cell’s column

    • row: number

      The cell’s row

    Props

    Props<CellType>: { Cell?: Types.CellComponent<CellType>; ColumnIndicator?: Types.ColumnIndicatorComponent; CornerIndicator?: Types.CornerIndicatorComponent; DataEditor?: Types.DataEditorComponent<CellType>; DataViewer?: Types.DataViewerComponent<CellType>; HeaderRow?: Types.HeaderRowComponent; Row?: Types.RowComponent; RowIndicator?: Types.RowIndicatorComponent; Table?: Types.TableComponent; className?: string; columnLabels?: string[]; createFormulaParser?: Types.CreateFormulaParser; darkMode?: boolean; data: Matrix.Matrix<CellType>; hideColumnIndicators?: boolean; hideRowIndicators?: boolean; onActivate?: (active: Point.Point) => void; onBlur?: () => void; onCellCommit?: (prevCell: null | CellType, nextCell: null | CellType, coords: null | Point.Point) => void; onChange?: (data: Matrix.Matrix<CellType>) => void; onKeyDown?: (event: React.KeyboardEvent) => void; onModeChange?: (mode: Types.Mode) => void; onSelect?: (selected: Selection) => void; rowLabels?: string[]; selected?: Selection }

    The Spreadsheet component props

    Type parameters

    Type declaration

    • optionalCell?: Types.CellComponent<CellType>

      The Spreadsheet’s cell component.

    • optionalColumnIndicator?: Types.ColumnIndicatorComponent

      Component rendered above each column.

    • optionalCornerIndicator?: Types.CornerIndicatorComponent

      Component rendered in the corner of row and column indicators.

    • optionalDataEditor?: Types.DataEditorComponent<CellType>

      Component rendered for cells in edit mode.

    • optionalDataViewer?: Types.DataViewerComponent<CellType>

      Component rendered for cells in view mode.

    • optionalHeaderRow?: Types.HeaderRowComponent

      The spreadsheet’s header row component

    • optionalRow?: Types.RowComponent

      The Spreadsheet’s row component.

    • optionalRowIndicator?: Types.RowIndicatorComponent

      Component rendered next to each row.

    • optionalTable?: Types.TableComponent

      The Spreadsheet’s table component.

    • optionalclassName?: string

      Class name to be added to the spreadsheet’s root element

    • optionalcolumnLabels?: string[]

      Labels to use in column indicators.

      @defaultValue

      alphabetical labels.

    • optionalcreateFormulaParser?: Types.CreateFormulaParser

      Function used to create the formula parser (instance of “fast-formula-parser”) used by the Spreadsheet by getting the spreadsheet’s data.

      @defaultValue

      function which creates a formula parser bound to the -Spreadsheet’s data.

      @see
    • optionaldarkMode?: boolean

      Use dark colors that complement dark mode

      @defaultValue

      false

    • data: Matrix.Matrix<CellType>

      The spreadsheet’s data

    • optionalhideColumnIndicators?: boolean

      If set to true, hides the column indicators of the spreadsheet.

      @defaultValue

      false.

    • optionalhideRowIndicators?: boolean

      If set to true, hides the row indicators of the spreadsheet.

      @defaultValue

      false.

    • optionalonActivate?: (active: Point.Point) => void

        • Callback called when Spreadsheet’s active cell changes.

          Parameters

          Returns void

    • optionalonBlur?: () => void
        • (): void

        • Callback called when the Spreadsheet loses focus

          Returns void

    • optionalonCellCommit?: (prevCell: null | CellType, nextCell: null | CellType, coords: null | Point.Point) => void
        • (prevCell: null | CellType, nextCell: null | CellType, coords: null | Point.Point): void

        • Parameters

          • prevCell: null | CellType
          • nextCell: null | CellType
          • coords: null | Point.Point

          Returns void

    • optionalonChange?: (data: Matrix.Matrix<CellType>) => void

        • Callback called when the Spreadsheet’s data changes.

          Parameters

          Returns void

    • optionalonKeyDown?: (event: React.KeyboardEvent) => void
        • (event: React.KeyboardEvent): void

        • Callback called on key down inside the spreadsheet.

          Parameters

          • event: React.KeyboardEvent

          Returns void

    • optionalonModeChange?: (mode: Types.Mode) => void

        • Callback called when the Spreadsheet’s edit mode changes.

          Parameters

          Returns void

    • optionalonSelect?: (selected: Selection) => void

        • Callback called when the Spreadsheet’s selection changes.

          Parameters

          Returns void

    • optionalrowLabels?: string[]

      Labels to use in row indicators.

      @defaultValue

      row index labels.

    • optionalselected?: Selection

      The selected cells in the worksheet.

    RowComponent

    RowComponent: React.ComponentType<RowProps>

    Type of the Row component

    RowIndicatorComponent

    RowIndicatorComponent: React.ComponentType<RowIndicatorProps>

    Type of the RowIndicator component

    RowIndicatorProps

    RowIndicatorProps: { label?: React.ReactNode | null; onSelect: (row: number, extend: boolean) => void; row: number; selected: boolean }

    Type of the Spreadsheet RowIndicator component props

    Type declaration

    • optionallabel?: React.ReactNode | null

      A custom label for the indicator as provided in rowLabels

    • onSelect: (row: number, extend: boolean) => void
        • (row: number, extend: boolean): void

        • Callback to be called when the row is selected

          Parameters

          • row: number
          • extend: boolean

          Returns void

    • row: number

      The row the indicator indicates

    • selected: boolean

      Whether the entire row is selected

    RowProps

    RowProps: React.PropsWithChildren<{ row: number }>

    Type of the Spreadsheet Row component props

    TableComponent

    TableComponent: React.ComponentType<TableProps>

    Type of the Spreadsheet Table component

    TableProps

    TableProps: React.PropsWithChildren<{ columns: number; hideColumnIndicators?: boolean | null }>

    Type of the Spreadsheet Table component props

    Built with Docusaurus.
    - +Spreadsheet’s data.

    @see
  • optionaldarkMode?: boolean

    Use dark colors that complement dark mode

    @defaultValue

    false

  • data: Matrix.Matrix<CellType>

    The spreadsheet’s data

  • optionalhideColumnIndicators?: boolean

    If set to true, hides the column indicators of the spreadsheet.

    @defaultValue

    false.

  • optionalhideRowIndicators?: boolean

    If set to true, hides the row indicators of the spreadsheet.

    @defaultValue

    false.

  • optionalonActivate?: (active: Point.Point) => void

      • Callback called when Spreadsheet’s active cell changes.

        Parameters

        Returns void

  • optionalonBlur?: () => void
      • (): void

      • Callback called when the Spreadsheet loses focus

        Returns void

  • optionalonCellCommit?: (prevCell: null | CellType, nextCell: null | CellType, coords: null | Point.Point) => void
      • (prevCell: null | CellType, nextCell: null | CellType, coords: null | Point.Point): void

      • Parameters

        • prevCell: null | CellType
        • nextCell: null | CellType
        • coords: null | Point.Point

        Returns void

  • optionalonChange?: (data: Matrix.Matrix<CellType>) => void

      • Callback called when the Spreadsheet’s data changes.

        Parameters

        Returns void

  • optionalonKeyDown?: (event: React.KeyboardEvent) => void
      • (event: React.KeyboardEvent): void

      • Callback called on key down inside the spreadsheet.

        Parameters

        • event: React.KeyboardEvent

        Returns void

  • optionalonModeChange?: (mode: Types.Mode) => void

      • Callback called when the Spreadsheet’s edit mode changes.

        Parameters

        Returns void

  • optionalonSelect?: (selected: Selection) => void

      • Callback called when the Spreadsheet’s selection changes.

        Parameters

        Returns void

  • optionalrowLabels?: string[]

    Labels to use in row indicators.

    @defaultValue

    row index labels.

  • optionalselected?: Selection

    The selected cells in the worksheet.

RowComponent

RowComponent: React.ComponentType<RowProps>

Type of the Row component

RowIndicatorComponent

RowIndicatorComponent: React.ComponentType<RowIndicatorProps>

Type of the RowIndicator component

RowIndicatorProps

RowIndicatorProps: { label?: React.ReactNode | null; onSelect: (row: number, extend: boolean) => void; row: number; selected: boolean }

Type of the Spreadsheet RowIndicator component props

Type declaration

  • optionallabel?: React.ReactNode | null

    A custom label for the indicator as provided in rowLabels

  • onSelect: (row: number, extend: boolean) => void
      • (row: number, extend: boolean): void

      • Callback to be called when the row is selected

        Parameters

        • row: number
        • extend: boolean

        Returns void

  • row: number

    The row the indicator indicates

  • selected: boolean

    Whether the entire row is selected

RowProps

RowProps: React.PropsWithChildren<{ row: number }>

Type of the Spreadsheet Row component props

TableComponent

TableComponent: React.ComponentType<TableProps>

Type of the Spreadsheet Table component

TableProps

TableProps: React.PropsWithChildren<{ columns: number; hideColumnIndicators?: boolean | null }>

Type of the Spreadsheet Table component props

+ \ No newline at end of file diff --git a/assets/js/6325140b.75280456.js b/assets/js/6325140b.51f1b10a.js similarity index 86% rename from assets/js/6325140b.75280456.js rename to assets/js/6325140b.51f1b10a.js index 0a9a9fa6..4f5c0d39 100644 --- a/assets/js/6325140b.75280456.js +++ b/assets/js/6325140b.51f1b10a.js @@ -1 +1 @@ -"use strict";(self.webpackChunkreact_spreadsheet=self.webpackChunkreact_spreadsheet||[]).push([[663],{457:function(e){e.exports=JSON.parse('[{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":0,"name":"react-spreadsheet","kind":1,"kindString":"Project","flags":{},"originalName":"","children":[{"id":96,"name":"EmptySelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of no cells"}]},"sources":[{"fileName":"src/selection.ts","line":30,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L30"}],"extendedTypes":[{"type":"reference","id":71,"name":"Selection"}],"permalink":"/react-spreadsheet/api/class/EmptySelection","nextId":118},{"id":118,"name":"EntireAxisSelection","kind":128,"kindString":"Class","flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Selection of an entire axis in the spreadsheet"}]},"children":[{"id":119,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/selection.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L142"}],"signatures":[{"id":120,"name":"new EntireAxisSelection","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@throws","content":[{"kind":"inline-tag","tag":"@link","text":"InvalidIndexError","target":255}]}]},"parameters":[{"id":121,"name":"start","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection starts, integer"}]},"type":{"type":"intrinsic","name":"number"}},{"id":122,"name":"end","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection ends, integer"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":118,"name":"EntireAxisSelection"},"overwrites":{"type":"reference","name":"EntireSelection.constructor"}}],"overwrites":{"type":"reference","name":"EntireSelection.constructor"}},{"id":124,"name":"end","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection end index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":135,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L135"}],"type":{"type":"intrinsic","name":"number"}},{"id":123,"name":"start","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection start index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":133,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L133"}],"type":{"type":"intrinsic","name":"number"}},{"id":143,"name":"has","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":23,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L23"}],"signatures":[{"id":144,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given point is within the selection"}]},"parameters":[{"id":145,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}},{"id":146,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":224,"name":"EntireSelection.has"}}],"inheritedFrom":{"type":"reference","id":223,"name":"EntireSelection.has"}},{"id":137,"name":"hasEntireColumn","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":17,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L17"}],"signatures":[{"id":138,"name":"hasEntireColumn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given column is entirely selected in given selection"}]},"parameters":[{"id":139,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":218,"name":"EntireSelection.hasEntireColumn"}}],"inheritedFrom":{"type":"reference","id":217,"name":"EntireSelection.hasEntireColumn"}},{"id":134,"name":"hasEntireRow","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":14,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L14"}],"signatures":[{"id":135,"name":"hasEntireRow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given row is entirely selected in given selection"}]},"parameters":[{"id":136,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":215,"name":"EntireSelection.hasEntireRow"}}],"inheritedFrom":{"type":"reference","id":214,"name":"EntireSelection.hasEntireRow"}},{"id":131,"name":"normalizeTo","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":11,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L11"}],"signatures":[{"id":132,"name":"normalizeTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize the selection according to the given data"}]},"parameters":[{"id":133,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"reference","id":118,"name":"EntireAxisSelection"},"inheritedFrom":{"type":"reference","id":212,"name":"EntireSelection.normalizeTo"}}],"inheritedFrom":{"type":"reference","id":211,"name":"EntireSelection.normalizeTo"}},{"id":140,"name":"size","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":20,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L20"}],"signatures":[{"id":141,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get the number of selected points according to given data"}]},"parameters":[{"id":142,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":221,"name":"EntireSelection.size"}}],"inheritedFrom":{"type":"reference","id":220,"name":"EntireSelection.size"}},{"id":128,"name":"toRange","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":8,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L8"}],"signatures":[{"id":129,"name":"toRange","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get concrete range of the selection in the given data"}]},"parameters":[{"id":130,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":286,"name":"PointRange"}]},"inheritedFrom":{"type":"reference","id":209,"name":"EntireSelection.toRange"}}],"inheritedFrom":{"type":"reference","id":208,"name":"EntireSelection.toRange"}}],"groups":[{"title":"Constructors","children":[119]},{"title":"Properties","children":[124,123]},{"title":"Methods","children":[143,137,134,131,140,128]}],"sources":[{"fileName":"src/selection.ts","line":131,"character":22,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L131"}],"extendedTypes":[{"type":"reference","id":205,"name":"EntireSelection"}],"extendedBy":[{"type":"reference","id":147,"name":"EntireColumnsSelection"},{"type":"reference","id":176,"name":"EntireRowsSelection"}],"permalink":"/react-spreadsheet/api/class/EntireAxisSelection","previousId":96,"nextId":147},{"id":147,"name":"EntireColumnsSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of entire columns in the spreadsheet"}]},"children":[{"id":148,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/selection.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L142"}],"signatures":[{"id":149,"name":"new EntireColumnsSelection","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@throws","content":[{"kind":"inline-tag","tag":"@link","text":"InvalidIndexError","target":255}]}]},"parameters":[{"id":150,"name":"start","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection starts, integer"}]},"type":{"type":"intrinsic","name":"number"}},{"id":151,"name":"end","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection ends, integer"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":147,"name":"EntireColumnsSelection"},"inheritedFrom":{"type":"reference","id":120,"name":"EntireAxisSelection.constructor"}}],"inheritedFrom":{"type":"reference","id":119,"name":"EntireAxisSelection.constructor"}},{"id":172,"name":"end","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection end index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":135,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L135"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":124,"name":"EntireAxisSelection.end"}},{"id":171,"name":"start","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection start index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":133,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L133"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":123,"name":"EntireAxisSelection.start"}}],"groups":[{"title":"Constructors","children":[148]},{"title":"Properties","children":[172,171]}],"sources":[{"fileName":"src/selection.ts","line":203,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L203"}],"extendedTypes":[{"type":"reference","id":118,"name":"EntireAxisSelection"}],"permalink":"/react-spreadsheet/api/class/EntireColumnsSelection","previousId":118,"nextId":176},{"id":176,"name":"EntireRowsSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of entire rows in the spreadsheet"}]},"children":[{"id":177,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/selection.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L142"}],"signatures":[{"id":178,"name":"new EntireRowsSelection","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@throws","content":[{"kind":"inline-tag","tag":"@link","text":"InvalidIndexError","target":255}]}]},"parameters":[{"id":179,"name":"start","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection starts, integer"}]},"type":{"type":"intrinsic","name":"number"}},{"id":180,"name":"end","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection ends, integer"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":176,"name":"EntireRowsSelection"},"inheritedFrom":{"type":"reference","id":120,"name":"EntireAxisSelection.constructor"}}],"inheritedFrom":{"type":"reference","id":119,"name":"EntireAxisSelection.constructor"}},{"id":201,"name":"end","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection end index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":135,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L135"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":124,"name":"EntireAxisSelection.end"}},{"id":200,"name":"start","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection start index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":133,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L133"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":123,"name":"EntireAxisSelection.start"}}],"groups":[{"title":"Constructors","children":[177]},{"title":"Properties","children":[201,200]}],"sources":[{"fileName":"src/selection.ts","line":165,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L165"}],"extendedTypes":[{"type":"reference","id":118,"name":"EntireAxisSelection"}],"permalink":"/react-spreadsheet/api/class/EntireRowsSelection","previousId":147,"nextId":205},{"id":205,"name":"EntireSelection","kind":128,"kindString":"Class","flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Selection of an entire part of the spreadsheet"}]},"children":[{"id":227,"name":"equals","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":26,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L26"}],"signatures":[{"id":228,"name":"equals","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given selection is equal to this selection"}]},"parameters":[{"id":229,"name":"selection","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":71,"name":"Selection"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":94,"name":"Selection.equals"}}],"inheritedFrom":{"type":"reference","id":93,"name":"Selection.equals"}},{"id":223,"name":"has","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":23,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L23"}],"signatures":[{"id":224,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given point is within the selection"}]},"parameters":[{"id":225,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}},{"id":226,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":90,"name":"Selection.has"}}],"inheritedFrom":{"type":"reference","id":89,"name":"Selection.has"}},{"id":217,"name":"hasEntireColumn","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":17,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L17"}],"signatures":[{"id":218,"name":"hasEntireColumn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given column is entirely selected in given selection"}]},"parameters":[{"id":219,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":84,"name":"Selection.hasEntireColumn"}}],"inheritedFrom":{"type":"reference","id":83,"name":"Selection.hasEntireColumn"}},{"id":214,"name":"hasEntireRow","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":14,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L14"}],"signatures":[{"id":215,"name":"hasEntireRow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given row is entirely selected in given selection"}]},"parameters":[{"id":216,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":81,"name":"Selection.hasEntireRow"}}],"inheritedFrom":{"type":"reference","id":80,"name":"Selection.hasEntireRow"}},{"id":211,"name":"normalizeTo","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":11,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L11"}],"signatures":[{"id":212,"name":"normalizeTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize the selection according to the given data"}]},"parameters":[{"id":213,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"reference","id":205,"name":"EntireSelection"},"inheritedFrom":{"type":"reference","id":78,"name":"Selection.normalizeTo"}}],"inheritedFrom":{"type":"reference","id":77,"name":"Selection.normalizeTo"}},{"id":220,"name":"size","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":20,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L20"}],"signatures":[{"id":221,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get the number of selected points according to given data"}]},"parameters":[{"id":222,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":87,"name":"Selection.size"}}],"inheritedFrom":{"type":"reference","id":86,"name":"Selection.size"}},{"id":208,"name":"toRange","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":8,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L8"}],"signatures":[{"id":209,"name":"toRange","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get concrete range of the selection in the given data"}]},"parameters":[{"id":210,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":286,"name":"PointRange"}]},"inheritedFrom":{"type":"reference","id":75,"name":"Selection.toRange"}}],"inheritedFrom":{"type":"reference","id":74,"name":"Selection.toRange"}}],"groups":[{"title":"Methods","children":[227,223,217,214,211,220,208]}],"sources":[{"fileName":"src/selection.ts","line":97,"character":22,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L97"}],"extendedTypes":[{"type":"reference","id":71,"name":"Selection"}],"extendedBy":[{"type":"reference","id":118,"name":"EntireAxisSelection"},{"type":"reference","id":230,"name":"EntireWorksheetSelection"}],"permalink":"/react-spreadsheet/api/class/EntireSelection","previousId":176,"nextId":230},{"id":230,"name":"EntireWorksheetSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of the entire worksheet"}]},"sources":[{"fileName":"src/selection.ts","line":100,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L100"}],"extendedTypes":[{"type":"reference","id":205,"name":"EntireSelection"}],"permalink":"/react-spreadsheet/api/class/EntireWorksheetSelection","previousId":205,"nextId":255},{"id":255,"name":"InvalidIndexError","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Error thrown when passing a non-index value where an index value is expected"}]},"sources":[{"fileName":"src/selection.ts","line":252,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L252"}],"extendedTypes":[{"type":"reference","name":"Error","qualifiedName":"Error","package":"typescript"}],"permalink":"/react-spreadsheet/api/class/InvalidIndexError","previousId":230,"nextId":286},{"id":286,"name":"PointRange","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Range between two points. Creates a normalized range between two given points"}]},"children":[{"id":292,"name":"end","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The bottom-right point"}]},"sources":[{"fileName":"src/point-range.ts","line":12,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L12"}],"type":{"type":"reference","id":306,"name":"Point"}},{"id":291,"name":"start","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The top-left point"}]},"sources":[{"fileName":"src/point-range.ts","line":10,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L10"}],"type":{"type":"reference","id":306,"name":"Point"}},{"id":304,"name":"[iterator]","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":26,"character":3,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L26"}],"signatures":[{"id":305,"name":"[iterator]","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Iterates through all the existing points in given range"}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":306,"name":"Point"},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"undefined"}],"name":"Iterator","qualifiedName":"Iterator","package":"typescript"}}]},{"id":301,"name":"equals","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":74,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L74"}],"signatures":[{"id":302,"name":"equals","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Returns whether given range is equal to this range"}]},"parameters":[{"id":303,"name":"range","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":286,"name":"PointRange"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":295,"name":"has","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":46,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L46"}],"signatures":[{"id":296,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Returns whether given point exists in given range"}]},"parameters":[{"id":297,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":298,"name":"mask","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":56,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L56"}],"signatures":[{"id":299,"name":"mask","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Limits given masked range with given mask"}]},"parameters":[{"id":300,"name":"mask","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":286,"name":"PointRange"}}],"type":{"type":"reference","id":286,"name":"PointRange"}}]},{"id":293,"name":"size","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":39,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L39"}],"signatures":[{"id":294,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the size (rows x columns) of the given range"}]},"type":{"type":"intrinsic","name":"number"}}]}],"groups":[{"title":"Properties","children":[292,291]},{"title":"Methods","children":[304,301,295,298,293]}],"sources":[{"fileName":"src/point-range.ts","line":8,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point-range.ts#L8"}],"permalink":"/react-spreadsheet/api/class/PointRange","previousId":255,"nextId":259},{"id":259,"name":"RangeSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of a range of cells"}]},"sources":[{"fileName":"src/selection.ts","line":55,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L55"}],"extendedTypes":[{"type":"reference","id":71,"name":"Selection"}],"permalink":"/react-spreadsheet/api/class/RangeSelection","previousId":286,"nextId":71},{"id":71,"name":"Selection","kind":128,"kindString":"Class","flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Selection from a spreadsheet"}]},"children":[{"id":93,"name":"equals","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":26,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L26"}],"signatures":[{"id":94,"name":"equals","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given selection is equal to this selection"}]},"parameters":[{"id":95,"name":"selection","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":71,"name":"Selection"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":89,"name":"has","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":23,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L23"}],"signatures":[{"id":90,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given point is within the selection"}]},"parameters":[{"id":91,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}},{"id":92,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":83,"name":"hasEntireColumn","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":17,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L17"}],"signatures":[{"id":84,"name":"hasEntireColumn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given column is entirely selected in given selection"}]},"parameters":[{"id":85,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":80,"name":"hasEntireRow","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":14,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L14"}],"signatures":[{"id":81,"name":"hasEntireRow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given row is entirely selected in given selection"}]},"parameters":[{"id":82,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":77,"name":"normalizeTo","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":11,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L11"}],"signatures":[{"id":78,"name":"normalizeTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize the selection according to the given data"}]},"parameters":[{"id":79,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"reference","id":71,"name":"Selection"}}]},{"id":86,"name":"size","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":20,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L20"}],"signatures":[{"id":87,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get the number of selected points according to given data"}]},"parameters":[{"id":88,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"intrinsic","name":"number"}}]},{"id":74,"name":"toRange","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":8,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L8"}],"signatures":[{"id":75,"name":"toRange","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get concrete range of the selection in the given data"}]},"parameters":[{"id":76,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":286,"name":"PointRange"}]}}]}],"groups":[{"title":"Methods","children":[93,89,83,80,77,86,74]}],"sources":[{"fileName":"src/selection.ts","line":6,"character":22,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/selection.ts#L6"}],"extendedBy":[{"type":"reference","id":96,"name":"EmptySelection"},{"type":"reference","id":205,"name":"EntireSelection"},{"type":"reference","id":259,"name":"RangeSelection"}],"permalink":"/react-spreadsheet/api/class/Selection","previousId":259,"nextId":5},{"id":310,"name":"CellBase","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The base type of cell data in Spreadsheet"}]},"sources":[{"fileName":"src/types.ts","line":11,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L11"}],"typeParameters":[{"id":317,"name":"Value","kind":131072,"kindString":"Type parameter","flags":{},"default":{"type":"intrinsic","name":"any"}}],"type":{"type":"reflection","declaration":{"id":311,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":315,"name":"DataEditor","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom component to render when the cell is edited, if not defined would default to the component defined for the Spreadsheet"}]},"sources":[{"fileName":"src/types.ts","line":19,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L19"}],"type":{"type":"reference","id":386,"typeArguments":[{"type":"reference","id":310,"typeArguments":[{"type":"reference","id":317,"name":"Value"}],"name":"CellBase"}],"name":"DataEditorComponent"}},{"id":316,"name":"DataViewer","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom component to render when the cell is viewed, if not defined would default to the component defined for the Spreadsheet"}]},"sources":[{"fileName":"src/types.ts","line":21,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L21"}],"type":{"type":"reference","id":374,"typeArguments":[{"type":"reference","id":310,"typeArguments":[{"type":"reference","id":317,"name":"Value"}],"name":"CellBase"}],"name":"DataViewerComponent"}},{"id":313,"name":"className","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Class to be given for the cell element"}]},"sources":[{"fileName":"src/types.ts","line":15,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"}},{"id":312,"name":"readOnly","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the cell should not be editable"}]},"sources":[{"fileName":"src/types.ts","line":13,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L13"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":314,"name":"value","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The value of the cell"}]},"sources":[{"fileName":"src/types.ts","line":17,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L17"}],"type":{"type":"reference","id":317,"name":"Value"}}],"groups":[{"title":"Properties","children":[315,316,313,312,314]}],"sources":[{"fileName":"src/types.ts","line":11,"character":36,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L11"}]}},"permalink":"/react-spreadsheet/api#CellBase","previousId":64,"nextId":364},{"id":364,"name":"CellComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Cell component"}]},"sources":[{"fileName":"src/types.ts","line":104,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L104"}],"typeParameters":[{"id":365,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":334,"typeArguments":[{"type":"reference","id":365,"name":"Cell"}],"name":"CellComponentProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#CellComponent","previousId":310,"nextId":334},{"id":334,"name":"CellComponentProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of Spreadsheet Cell component props"}]},"sources":[{"fileName":"src/types.ts","line":72,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L72"}],"typeParameters":[{"id":363,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reflection","declaration":{"id":335,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":338,"name":"DataViewer","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The DataViewer component to be used by the cell"}]},"sources":[{"fileName":"src/types.ts","line":78,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L78"}],"type":{"type":"reference","id":374,"typeArguments":[{"type":"reference","id":363,"name":"Cell"}],"name":"DataViewerComponent"}},{"id":350,"name":"activate","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":96,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L96"}],"type":{"type":"reflection","declaration":{"id":351,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":96,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L96"}],"signatures":[{"id":352,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Activate the cell at the given point"}]},"parameters":[{"id":353,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":340,"name":"active","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the cell is active"}]},"sources":[{"fileName":"src/types.ts","line":82,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L82"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":337,"name":"column","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The column of the cell"}]},"sources":[{"fileName":"src/types.ts","line":76,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L76"}],"type":{"type":"intrinsic","name":"number"}},{"id":341,"name":"copied","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the cell is copied"}]},"sources":[{"fileName":"src/types.ts","line":84,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":344,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The data of the cell"}]},"sources":[{"fileName":"src/types.ts","line":90,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L90"}],"type":{"type":"union","types":[{"type":"reference","id":363,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}},{"id":342,"name":"dragging","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the user is dragging"}]},"sources":[{"fileName":"src/types.ts","line":86,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":345,"name":"evaluatedData","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The evaluated data of the cell"}]},"sources":[{"fileName":"src/types.ts","line":92,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L92"}],"type":{"type":"union","types":[{"type":"reference","id":363,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}},{"id":343,"name":"mode","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The mode of the cell"}]},"sources":[{"fileName":"src/types.ts","line":88,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L88"}],"type":{"type":"reference","id":322,"name":"Mode"}},{"id":336,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The row of the cell"}]},"sources":[{"fileName":"src/types.ts","line":74,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L74"}],"type":{"type":"intrinsic","name":"number"}},{"id":346,"name":"select","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":94,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L94"}],"type":{"type":"reflection","declaration":{"id":347,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":94,"character":10,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L94"}],"signatures":[{"id":348,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Select the cell at the given point"}]},"parameters":[{"id":349,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":339,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the cell is selected"}]},"sources":[{"fileName":"src/types.ts","line":80,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L80"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":359,"name":"setCellData","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":100,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L100"}],"type":{"type":"reflection","declaration":{"id":360,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":100,"character":15,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L100"}],"signatures":[{"id":361,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Set data of the cell"}]},"parameters":[{"id":362,"name":"cell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":363,"name":"Cell"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":354,"name":"setCellDimensions","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":98,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L98"}],"type":{"type":"reflection","declaration":{"id":355,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":98,"character":21,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L98"}],"signatures":[{"id":356,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Set the dimensions of the cell at the given point with the given dimensions"}]},"parameters":[{"id":357,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}},{"id":358,"name":"dimensions","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":323,"name":"Dimensions"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[338,350,340,337,341,344,342,345,343,336,346,339,359,354]}],"sources":[{"fileName":"src/types.ts","line":72,"character":67,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L72"}]}},"permalink":"/react-spreadsheet/api#CellComponentProps","previousId":364,"nextId":318},{"id":318,"name":"CellDescriptor","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"A cell with it\'s coordinates"}],"blockTags":[{"tag":"@deprecated","content":[{"kind":"text","text":"the component does not use cell descriptors anymore. Instead it passes cell point and cell value explicitly."}]}]},"sources":[{"fileName":"src/types.ts","line":28,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L28"}],"typeParameters":[{"id":321,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{}}],"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":319,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":320,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The cell\'s data"}]},"sources":[{"fileName":"src/types.ts","line":30,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L30"}],"type":{"type":"union","types":[{"type":"reference","id":321,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}}],"groups":[{"title":"Properties","children":[320]}],"sources":[{"fileName":"src/types.ts","line":28,"character":35,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L28"}]}},{"type":"reference","id":306,"name":"Point"}]},"permalink":"/react-spreadsheet/api#CellDescriptor","previousId":334,"nextId":388},{"id":388,"name":"ColumnIndicatorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the ColumnIndicator component"}]},"sources":[{"fileName":"src/types.ts","line":191,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L191"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":389,"name":"ColumnIndicatorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#ColumnIndicatorComponent","previousId":318,"nextId":389},{"id":389,"name":"ColumnIndicatorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet ColumnIndicator component props"}]},"sources":[{"fileName":"src/types.ts","line":179,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L179"}],"type":{"type":"reflection","declaration":{"id":390,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":391,"name":"column","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The column the indicator indicates"}]},"sources":[{"fileName":"src/types.ts","line":181,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L181"}],"type":{"type":"intrinsic","name":"number"}},{"id":392,"name":"label","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom label for the indicator as provided in columnLabels"}]},"sources":[{"fileName":"src/types.ts","line":183,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L183"}],"type":{"type":"union","types":[{"type":"reference","name":"React.ReactNode","qualifiedName":"React.ReactNode","package":"@types/react"},{"type":"literal","value":null}]}},{"id":394,"name":"onSelect","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":187,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L187"}],"type":{"type":"reflection","declaration":{"id":395,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":187,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L187"}],"signatures":[{"id":396,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when the column is selected"}]},"parameters":[{"id":397,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":398,"name":"extend","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":393,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the entire column in selected"}]},"sources":[{"fileName":"src/types.ts","line":185,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L185"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[391,392,394,393]}],"sources":[{"fileName":"src/types.ts","line":179,"character":35,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L179"}]}},"permalink":"/react-spreadsheet/api#ColumnIndicatorProps","previousId":388,"nextId":410},{"id":410,"name":"CornerIndicatorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the CornerIndicator component"}]},"sources":[{"fileName":"src/types.ts","line":203,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L203"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":411,"name":"CornerIndicatorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#CornerIndicatorComponent","previousId":389,"nextId":411},{"id":411,"name":"CornerIndicatorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet CornerIndicator component props"}]},"sources":[{"fileName":"src/types.ts","line":195,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L195"}],"type":{"type":"reflection","declaration":{"id":412,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":414,"name":"onSelect","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":199,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L199"}],"type":{"type":"reflection","declaration":{"id":415,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":199,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L199"}],"signatures":[{"id":416,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to select the entire table"}]},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":413,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the entire table is selected"}]},"sources":[{"fileName":"src/types.ts","line":197,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L197"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[414,413]}],"sources":[{"fileName":"src/types.ts","line":195,"character":35,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L195"}]}},"permalink":"/react-spreadsheet/api#CornerIndicatorProps","previousId":410,"nextId":386},{"id":386,"name":"DataEditorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataEditor component"}]},"sources":[{"fileName":"src/types.ts","line":134,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L134"}],"typeParameters":[{"id":387,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":376,"typeArguments":[{"type":"reference","id":387,"name":"Cell"}],"name":"DataEditorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#DataEditorComponent","previousId":411,"nextId":376},{"id":376,"name":"DataEditorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataEditor component props"}]},"sources":[{"fileName":"src/types.ts","line":125,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L125"}],"typeParameters":[{"id":385,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"intersection","types":[{"type":"reference","typeArguments":[{"type":"reference","id":385,"name":"Cell"}],"name":"DataComponentProps"},{"type":"reflection","declaration":{"id":377,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":382,"name":"exitEditMode","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":130,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L130"}],"type":{"type":"reflection","declaration":{"id":383,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":130,"character":18,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L130"}],"signatures":[{"id":384,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when edit mode should be exited"}]},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":378,"name":"onChange","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":128,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L128"}],"type":{"type":"reflection","declaration":{"id":379,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":128,"character":14,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L128"}],"signatures":[{"id":380,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when the cell\'s value is changed"}]},"parameters":[{"id":381,"name":"cell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":385,"name":"Cell"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[382,378]}],"sources":[{"fileName":"src/types.ts","line":126,"character":29,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L126"}]}}]},"permalink":"/react-spreadsheet/api#DataEditorProps","previousId":386,"nextId":374},{"id":374,"name":"DataViewerComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataViewer component"}]},"sources":[{"fileName":"src/types.ts","line":121,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L121"}],"typeParameters":[{"id":375,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":366,"typeArguments":[{"type":"reference","id":375,"name":"Cell"}],"name":"DataViewerProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#DataViewerComponent","previousId":376,"nextId":366},{"id":366,"name":"DataViewerProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataViewer component props"}]},"sources":[{"fileName":"src/types.ts","line":113,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L113"}],"typeParameters":[{"id":373,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"intersection","types":[{"type":"reference","typeArguments":[{"type":"reference","id":373,"name":"Cell"}],"name":"DataComponentProps"},{"type":"reflection","declaration":{"id":367,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":372,"name":"evaluatedCell","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":117,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L117"}],"type":{"type":"union","types":[{"type":"reference","id":373,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}},{"id":368,"name":"setCellData","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":116,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L116"}],"type":{"type":"reflection","declaration":{"id":369,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":116,"character":17,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L116"}],"signatures":[{"id":370,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Set data of the cell"}]},"parameters":[{"id":371,"name":"cell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":373,"name":"Cell"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[372,368]}],"sources":[{"fileName":"src/types.ts","line":114,"character":29,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L114"}]}}]},"permalink":"/react-spreadsheet/api#DataViewerProps","previousId":374,"nextId":323},{"id":323,"name":"Dimensions","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Dimensions of an element"}]},"sources":[{"fileName":"src/types.ts","line":37,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L37"}],"type":{"type":"reflection","declaration":{"id":324,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":326,"name":"height","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The element\'s height in pixels"}]},"sources":[{"fileName":"src/types.ts","line":41,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L41"}],"type":{"type":"intrinsic","name":"number"}},{"id":328,"name":"left","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The distance of the element from it\'s container left border in pixels"}]},"sources":[{"fileName":"src/types.ts","line":45,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"number"}},{"id":327,"name":"top","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The distance of the element from it\'s container top border in pixels"}]},"sources":[{"fileName":"src/types.ts","line":43,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"number"}},{"id":325,"name":"width","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The element\'s width in pixels"}]},"sources":[{"fileName":"src/types.ts","line":39,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L39"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[326,328,327,325]}],"sources":[{"fileName":"src/types.ts","line":37,"character":25,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L37"}]}},"permalink":"/react-spreadsheet/api#Dimensions","previousId":366,"nextId":428},{"id":428,"name":"HeaderRowComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the HeaderRow component"}]},"sources":[{"fileName":"src/types.ts","line":161,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L161"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":426,"name":"HeaderRowProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#HeaderRowComponent","previousId":323,"nextId":426},{"id":426,"name":"HeaderRowProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet HeaderRow component props"}]},"sources":[{"fileName":"src/types.ts","line":158,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L158"}],"type":{"type":"reference","typeArguments":[{"type":"reflection","declaration":{"id":427,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":158,"character":53,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L158"}]}}],"name":"React.PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"},"permalink":"/react-spreadsheet/api#HeaderRowProps","previousId":428,"nextId":69},{"id":69,"name":"Matrix","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"A two-dimensional array of given type T in rows and columns"}]},"sources":[{"fileName":"src/matrix.ts","line":4,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/matrix.ts#L4"}],"typeParameters":[{"id":70,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"type":{"type":"array","elementType":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","id":70,"name":"T"},{"type":"intrinsic","name":"undefined"}]}}},"permalink":"/react-spreadsheet/api#Matrix","previousId":426,"nextId":322},{"id":322,"name":"Mode","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The spreadsheet\'s write mode"}]},"sources":[{"fileName":"src/types.ts","line":34,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L34"}],"type":{"type":"union","types":[{"type":"literal","value":"view"},{"type":"literal","value":"edit"}]},"permalink":"/react-spreadsheet/api#Mode","previousId":69,"nextId":306},{"id":306,"name":"Point","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"A cell coordinates in the spreadsheet"}]},"sources":[{"fileName":"src/point.ts","line":2,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point.ts#L2"}],"type":{"type":"reflection","declaration":{"id":307,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":308,"name":"column","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The cell\'s column"}]},"sources":[{"fileName":"src/point.ts","line":4,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point.ts#L4"}],"type":{"type":"intrinsic","name":"number"}},{"id":309,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The cell\'s row"}]},"sources":[{"fileName":"src/point.ts","line":6,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point.ts#L6"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[308,309]}],"sources":[{"fileName":"src/point.ts","line":2,"character":20,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/point.ts#L2"}]}},"permalink":"/react-spreadsheet/api#Point","previousId":322,"nextId":14},{"id":14,"name":"Props","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet component props"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":43,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L43"}],"typeParameters":[{"id":63,"name":"CellType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"Types.CellBase"}}],"type":{"type":"reflection","declaration":{"id":15,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":31,"name":"Cell","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet\'s cell component."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":99,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L99"}],"type":{"type":"reference","id":364,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Types.CellComponent"}},{"id":25,"name":"ColumnIndicator","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered above each column."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":87,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L87"}],"type":{"type":"reference","id":388,"name":"Types.ColumnIndicatorComponent"}},{"id":26,"name":"CornerIndicator","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered in the corner of row and column indicators."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":89,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L89"}],"type":{"type":"reference","id":410,"name":"Types.CornerIndicatorComponent"}},{"id":33,"name":"DataEditor","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered for cells in edit mode."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":103,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L103"}],"type":{"type":"reference","id":386,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Types.DataEditorComponent"}},{"id":32,"name":"DataViewer","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered for cells in view mode."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":101,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L101"}],"type":{"type":"reference","id":374,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Types.DataViewerComponent"}},{"id":30,"name":"HeaderRow","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The spreadsheet\'s header row component"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":97,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L97"}],"type":{"type":"reference","id":428,"name":"Types.HeaderRowComponent"}},{"id":29,"name":"Row","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet\'s row component."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":95,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L95"}],"type":{"type":"reference","id":417,"name":"Types.RowComponent"}},{"id":27,"name":"RowIndicator","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered next to each row."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":91,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L91"}],"type":{"type":"reference","id":399,"name":"Types.RowIndicatorComponent"}},{"id":28,"name":"Table","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet\'s table component."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":93,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L93"}],"type":{"type":"reference","id":421,"name":"Types.TableComponent"}},{"id":17,"name":"className","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Class name to be added to the spreadsheet\'s root element"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":47,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L47"}],"type":{"type":"intrinsic","name":"string"}},{"id":20,"name":"columnLabels","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Labels to use in column indicators."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"text","text":"alphabetical labels."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":67,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L67"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":19,"name":"createFormulaParser","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function used to create the formula parser (instance of\\n\\"fast-formula-parser\\") used by the Spreadsheet by getting the spreadsheet\'s\\ndata."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"text","text":"function which creates a formula parser bound to the\\nSpreadsheet\'s data."}]},{"tag":"@see","content":[{"kind":"text","text":" - "},{"kind":"code","text":"`createFormulaParser`"},{"kind":"text","text":"\\n"},{"kind":"text","text":" - "},{"kind":"text","text":"https://www.npmjs.com/package/fast-formula-parser"},{"kind":"text","text":"\\n"}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":62,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L62"}],"type":{"type":"reference","name":"Types.CreateFormulaParser"}},{"id":18,"name":"darkMode","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Use dark colors that complement dark mode"}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`false`"}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":52,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L52"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":16,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The spreadsheet\'s data"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":45,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L45"}],"type":{"type":"reference","id":69,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Matrix.Matrix"}},{"id":23,"name":"hideColumnIndicators","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If set to true, hides the column indicators of the spreadsheet."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":82,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L82"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":22,"name":"hideRowIndicators","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If set to true, hides the row indicators of the spreadsheet."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":77,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L77"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":50,"name":"onActivate","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":114,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L114"}],"type":{"type":"reflection","declaration":{"id":51,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":114,"character":15,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L114"}],"signatures":[{"id":52,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when Spreadsheet\'s active cell changes."}]},"parameters":[{"id":53,"name":"active","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point.Point"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":54,"name":"onBlur","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":116,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L116"}],"type":{"type":"reflection","declaration":{"id":55,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":116,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L116"}],"signatures":[{"id":56,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet loses focus"}]},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":57,"name":"onCellCommit","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":117,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L117"}],"type":{"type":"reflection","declaration":{"id":58,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":117,"character":17,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L117"}],"signatures":[{"id":59,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":60,"name":"prevCell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":63,"name":"CellType"}]}},{"id":61,"name":"nextCell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":63,"name":"CellType"}]}},{"id":62,"name":"coords","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":306,"name":"Point.Point"}]}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":38,"name":"onChange","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":108,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L108"}],"type":{"type":"reflection","declaration":{"id":39,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":108,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L108"}],"signatures":[{"id":40,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet\'s data changes."}]},"parameters":[{"id":41,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Matrix.Matrix"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":34,"name":"onKeyDown","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":106,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L106"}],"type":{"type":"reflection","declaration":{"id":35,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":106,"character":14,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L106"}],"signatures":[{"id":36,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called on key down inside the spreadsheet."}]},"parameters":[{"id":37,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"React.KeyboardEvent","qualifiedName":"React.KeyboardEvent","package":"@types/react"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":42,"name":"onModeChange","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":110,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L110"}],"type":{"type":"reflection","declaration":{"id":43,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":110,"character":17,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L110"}],"signatures":[{"id":44,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet\'s edit mode changes."}]},"parameters":[{"id":45,"name":"mode","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":322,"name":"Types.Mode"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":46,"name":"onSelect","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":112,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L112"}],"type":{"type":"reflection","declaration":{"id":47,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":112,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L112"}],"signatures":[{"id":48,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet\'s selection changes."}]},"parameters":[{"id":49,"name":"selected","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":71,"name":"Selection"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":21,"name":"rowLabels","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Labels to use in row indicators."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"text","text":"row index labels."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":72,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L72"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":24,"name":"selected","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The selected cells in the worksheet."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":84,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L84"}],"type":{"type":"reference","id":71,"name":"Selection"}}],"groups":[{"title":"Properties","children":[31,25,26,33,32,30,29,27,28,17,20,19,18,16,23,22,50,54,57,38,34,42,46,21,24]}],"sources":[{"fileName":"src/Spreadsheet.tsx","line":43,"character":53,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L43"}]}},"permalink":"/react-spreadsheet/api#Props","previousId":306,"nextId":417},{"id":417,"name":"RowComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Row component"}]},"sources":[{"fileName":"src/types.ts","line":155,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L155"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":418,"name":"RowProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#RowComponent","previousId":14,"nextId":399},{"id":399,"name":"RowIndicatorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the RowIndicator component"}]},"sources":[{"fileName":"src/types.ts","line":176,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L176"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":400,"name":"RowIndicatorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#RowIndicatorComponent","previousId":417,"nextId":400},{"id":400,"name":"RowIndicatorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet RowIndicator component props"}]},"sources":[{"fileName":"src/types.ts","line":164,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L164"}],"type":{"type":"reflection","declaration":{"id":401,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":403,"name":"label","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom label for the indicator as provided in rowLabels"}]},"sources":[{"fileName":"src/types.ts","line":168,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L168"}],"type":{"type":"union","types":[{"type":"reference","name":"React.ReactNode","qualifiedName":"React.ReactNode","package":"@types/react"},{"type":"literal","value":null}]}},{"id":405,"name":"onSelect","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":172,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L172"}],"type":{"type":"reflection","declaration":{"id":406,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":172,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L172"}],"signatures":[{"id":407,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when the row is selected"}]},"parameters":[{"id":408,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":409,"name":"extend","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":402,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The row the indicator indicates"}]},"sources":[{"fileName":"src/types.ts","line":166,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L166"}],"type":{"type":"intrinsic","name":"number"}},{"id":404,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the entire row is selected"}]},"sources":[{"fileName":"src/types.ts","line":170,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L170"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[403,405,402,404]}],"sources":[{"fileName":"src/types.ts","line":164,"character":32,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L164"}]}},"permalink":"/react-spreadsheet/api#RowIndicatorProps","previousId":399,"nextId":418},{"id":418,"name":"RowProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Row component props"}]},"sources":[{"fileName":"src/types.ts","line":149,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L149"}],"type":{"type":"reference","typeArguments":[{"type":"reflection","declaration":{"id":419,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":420,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The row index of the table"}]},"sources":[{"fileName":"src/types.ts","line":151,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L151"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[420]}],"sources":[{"fileName":"src/types.ts","line":149,"character":47,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L149"}]}}],"name":"React.PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"},"permalink":"/react-spreadsheet/api#RowProps","previousId":400,"nextId":421},{"id":421,"name":"TableComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Table component"}]},"sources":[{"fileName":"src/types.ts","line":146,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L146"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":422,"name":"TableProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#TableComponent","previousId":418,"nextId":422},{"id":422,"name":"TableProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Table component props"}]},"sources":[{"fileName":"src/types.ts","line":138,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L138"}],"type":{"type":"reference","typeArguments":[{"type":"reflection","declaration":{"id":423,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":424,"name":"columns","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Numebr of columns the table should render"}]},"sources":[{"fileName":"src/types.ts","line":140,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L140"}],"type":{"type":"intrinsic","name":"number"}},{"id":425,"name":"hideColumnIndicators","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether column indicators are hidden"}]},"sources":[{"fileName":"src/types.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L142"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"literal","value":null}]}}],"groups":[{"title":"Properties","children":[424,425]}],"sources":[{"fileName":"src/types.ts","line":138,"character":49,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/types.ts#L138"}]}}],"name":"React.PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"},"permalink":"/react-spreadsheet/api#TableProps","previousId":421},{"id":5,"name":"DataEditor","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/DataEditor.tsx","line":6,"character":6,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/DataEditor.tsx#L6"}],"signatures":[{"id":6,"name":"DataEditor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The default Spreadsheet DataEditor component"}]},"parameters":[{"id":7,"name":"props","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","typeArguments":[{"type":"reference","id":376,"typeArguments":[{"type":"reference","id":310,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"CellBase"}],"name":"DataEditorProps"}],"name":"PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"}},{"id":8,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"ReactElement","qualifiedName":"React.ReactElement","package":"@types/react"}]}}],"permalink":"/react-spreadsheet/api/function/DataEditor","previousId":71,"nextId":9},{"id":9,"name":"DataViewer","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/DataViewer.tsx","line":10,"character":6,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/DataViewer.tsx#L10"}],"signatures":[{"id":10,"name":"DataViewer","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The default Spreadsheet DataViewer component"}]},"typeParameter":[{"id":11,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"typeArguments":[{"type":"reference","id":12,"name":"Value"}],"name":"CellBase"}},{"id":12,"name":"Value","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":13,"name":"__namedParameters","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":366,"typeArguments":[{"type":"reference","id":11,"name":"Cell"}],"name":"DataViewerProps"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","qualifiedName":"React.JSXElementConstructor","package":"@types/react"}]}],"name":"ReactElement","qualifiedName":"React.ReactElement","package":"@types/react"}}],"permalink":"/react-spreadsheet/api/function/DataViewer","previousId":5,"nextId":1},{"id":1,"name":"Spreadsheet","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":127,"character":6,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/Spreadsheet.tsx#L127"}],"signatures":[{"id":2,"name":"Spreadsheet","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet component"}]},"typeParameter":[{"id":3,"name":"CellType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"CellBase"}}],"parameters":[{"id":4,"name":"props","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":14,"typeArguments":[{"type":"reference","id":3,"name":"CellType"}],"name":"Props"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","qualifiedName":"React.JSXElementConstructor","package":"@types/react"}]}],"name":"ReactElement","qualifiedName":"React.ReactElement","package":"@types/react"}}],"permalink":"/react-spreadsheet/api/function/Spreadsheet","previousId":9,"nextId":64},{"id":64,"name":"createEmptyMatrix","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/matrix.ts","line":12,"character":16,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/matrix.ts#L12"}],"signatures":[{"id":65,"name":"createEmptyMatrix","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Creates an empty matrix with given rows and columns"}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"an empty matrix with given rows and columns"}]}]},"typeParameter":[{"id":66,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":67,"name":"rows","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"integer, the amount of rows the matrix should have"}]},"type":{"type":"intrinsic","name":"number"}},{"id":68,"name":"columns","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"integer, the amount of columns the matrix should have"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":69,"typeArguments":[{"type":"reference","id":66,"name":"T"}],"name":"Matrix"}}],"permalink":"/react-spreadsheet/api/function/createEmptyMatrix","previousId":1,"nextId":310}],"groups":[{"title":"Classes","children":[96,118,147,176,205,230,255,286,259,71]},{"title":"Functions","children":[5,9,1,64]},{"title":"Type Aliases","children":[310,364,334,318,388,389,410,411,386,376,374,366,323,428,426,69,322,306,14,417,399,400,418,421,422]}],"sources":[{"fileName":"src/index.ts","line":1,"character":0,"url":"https://github.com/iddan/react-spreadsheet/blob/e441ec1/src/index.ts#L1"}],"permalink":"/react-spreadsheet/api"},"urlSlug":"."}],"packageName":"react-spreadsheet","packageVersion":"0.9.3"}]')}}]); \ No newline at end of file +"use strict";(self.webpackChunkreact_spreadsheet=self.webpackChunkreact_spreadsheet||[]).push([[663],{457:function(e){e.exports=JSON.parse('[{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":0,"name":"react-spreadsheet","kind":1,"kindString":"Project","flags":{},"originalName":"","children":[{"id":96,"name":"EmptySelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of no cells"}]},"sources":[{"fileName":"src/selection.ts","line":30,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L30"}],"extendedTypes":[{"type":"reference","id":71,"name":"Selection"}],"permalink":"/react-spreadsheet/api/class/EmptySelection","nextId":118},{"id":118,"name":"EntireAxisSelection","kind":128,"kindString":"Class","flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Selection of an entire axis in the spreadsheet"}]},"children":[{"id":119,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/selection.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L142"}],"signatures":[{"id":120,"name":"new EntireAxisSelection","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@throws","content":[{"kind":"inline-tag","tag":"@link","text":"InvalidIndexError","target":255}]}]},"parameters":[{"id":121,"name":"start","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection starts, integer"}]},"type":{"type":"intrinsic","name":"number"}},{"id":122,"name":"end","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection ends, integer"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":118,"name":"EntireAxisSelection"},"overwrites":{"type":"reference","name":"EntireSelection.constructor"}}],"overwrites":{"type":"reference","name":"EntireSelection.constructor"}},{"id":124,"name":"end","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection end index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":135,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L135"}],"type":{"type":"intrinsic","name":"number"}},{"id":123,"name":"start","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection start index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":133,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L133"}],"type":{"type":"intrinsic","name":"number"}},{"id":143,"name":"has","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":23,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L23"}],"signatures":[{"id":144,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given point is within the selection"}]},"parameters":[{"id":145,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}},{"id":146,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":224,"name":"EntireSelection.has"}}],"inheritedFrom":{"type":"reference","id":223,"name":"EntireSelection.has"}},{"id":137,"name":"hasEntireColumn","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":17,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L17"}],"signatures":[{"id":138,"name":"hasEntireColumn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given column is entirely selected in given selection"}]},"parameters":[{"id":139,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":218,"name":"EntireSelection.hasEntireColumn"}}],"inheritedFrom":{"type":"reference","id":217,"name":"EntireSelection.hasEntireColumn"}},{"id":134,"name":"hasEntireRow","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":14,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L14"}],"signatures":[{"id":135,"name":"hasEntireRow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given row is entirely selected in given selection"}]},"parameters":[{"id":136,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":215,"name":"EntireSelection.hasEntireRow"}}],"inheritedFrom":{"type":"reference","id":214,"name":"EntireSelection.hasEntireRow"}},{"id":131,"name":"normalizeTo","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":11,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L11"}],"signatures":[{"id":132,"name":"normalizeTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize the selection according to the given data"}]},"parameters":[{"id":133,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"reference","id":118,"name":"EntireAxisSelection"},"inheritedFrom":{"type":"reference","id":212,"name":"EntireSelection.normalizeTo"}}],"inheritedFrom":{"type":"reference","id":211,"name":"EntireSelection.normalizeTo"}},{"id":140,"name":"size","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":20,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L20"}],"signatures":[{"id":141,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get the number of selected points according to given data"}]},"parameters":[{"id":142,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":221,"name":"EntireSelection.size"}}],"inheritedFrom":{"type":"reference","id":220,"name":"EntireSelection.size"}},{"id":128,"name":"toRange","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":8,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L8"}],"signatures":[{"id":129,"name":"toRange","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get concrete range of the selection in the given data"}]},"parameters":[{"id":130,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":286,"name":"PointRange"}]},"inheritedFrom":{"type":"reference","id":209,"name":"EntireSelection.toRange"}}],"inheritedFrom":{"type":"reference","id":208,"name":"EntireSelection.toRange"}}],"groups":[{"title":"Constructors","children":[119]},{"title":"Properties","children":[124,123]},{"title":"Methods","children":[143,137,134,131,140,128]}],"sources":[{"fileName":"src/selection.ts","line":131,"character":22,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L131"}],"extendedTypes":[{"type":"reference","id":205,"name":"EntireSelection"}],"extendedBy":[{"type":"reference","id":147,"name":"EntireColumnsSelection"},{"type":"reference","id":176,"name":"EntireRowsSelection"}],"permalink":"/react-spreadsheet/api/class/EntireAxisSelection","previousId":96,"nextId":147},{"id":147,"name":"EntireColumnsSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of entire columns in the spreadsheet"}]},"children":[{"id":148,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/selection.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L142"}],"signatures":[{"id":149,"name":"new EntireColumnsSelection","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@throws","content":[{"kind":"inline-tag","tag":"@link","text":"InvalidIndexError","target":255}]}]},"parameters":[{"id":150,"name":"start","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection starts, integer"}]},"type":{"type":"intrinsic","name":"number"}},{"id":151,"name":"end","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection ends, integer"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":147,"name":"EntireColumnsSelection"},"inheritedFrom":{"type":"reference","id":120,"name":"EntireAxisSelection.constructor"}}],"inheritedFrom":{"type":"reference","id":119,"name":"EntireAxisSelection.constructor"}},{"id":172,"name":"end","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection end index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":135,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L135"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":124,"name":"EntireAxisSelection.end"}},{"id":171,"name":"start","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection start index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":133,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L133"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":123,"name":"EntireAxisSelection.start"}}],"groups":[{"title":"Constructors","children":[148]},{"title":"Properties","children":[172,171]}],"sources":[{"fileName":"src/selection.ts","line":203,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L203"}],"extendedTypes":[{"type":"reference","id":118,"name":"EntireAxisSelection"}],"permalink":"/react-spreadsheet/api/class/EntireColumnsSelection","previousId":118,"nextId":176},{"id":176,"name":"EntireRowsSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of entire rows in the spreadsheet"}]},"children":[{"id":177,"name":"constructor","kind":512,"kindString":"Constructor","flags":{},"sources":[{"fileName":"src/selection.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L142"}],"signatures":[{"id":178,"name":"new EntireRowsSelection","kind":16384,"kindString":"Constructor signature","flags":{},"comment":{"summary":[],"blockTags":[{"tag":"@throws","content":[{"kind":"inline-tag","tag":"@link","text":"InvalidIndexError","target":255}]}]},"parameters":[{"id":179,"name":"start","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection starts, integer"}]},"type":{"type":"intrinsic","name":"number"}},{"id":180,"name":"end","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"row index where the selection ends, integer"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":176,"name":"EntireRowsSelection"},"inheritedFrom":{"type":"reference","id":120,"name":"EntireAxisSelection.constructor"}}],"inheritedFrom":{"type":"reference","id":119,"name":"EntireAxisSelection.constructor"}},{"id":201,"name":"end","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection end index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":135,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L135"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":124,"name":"EntireAxisSelection.end"}},{"id":200,"name":"start","kind":1024,"kindString":"Property","flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Selection start index, integer"}]},"sources":[{"fileName":"src/selection.ts","line":133,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L133"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":123,"name":"EntireAxisSelection.start"}}],"groups":[{"title":"Constructors","children":[177]},{"title":"Properties","children":[201,200]}],"sources":[{"fileName":"src/selection.ts","line":165,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L165"}],"extendedTypes":[{"type":"reference","id":118,"name":"EntireAxisSelection"}],"permalink":"/react-spreadsheet/api/class/EntireRowsSelection","previousId":147,"nextId":205},{"id":205,"name":"EntireSelection","kind":128,"kindString":"Class","flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Selection of an entire part of the spreadsheet"}]},"children":[{"id":227,"name":"equals","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":26,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L26"}],"signatures":[{"id":228,"name":"equals","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given selection is equal to this selection"}]},"parameters":[{"id":229,"name":"selection","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":71,"name":"Selection"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":94,"name":"Selection.equals"}}],"inheritedFrom":{"type":"reference","id":93,"name":"Selection.equals"}},{"id":223,"name":"has","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":23,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L23"}],"signatures":[{"id":224,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given point is within the selection"}]},"parameters":[{"id":225,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}},{"id":226,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":90,"name":"Selection.has"}}],"inheritedFrom":{"type":"reference","id":89,"name":"Selection.has"}},{"id":217,"name":"hasEntireColumn","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":17,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L17"}],"signatures":[{"id":218,"name":"hasEntireColumn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given column is entirely selected in given selection"}]},"parameters":[{"id":219,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":84,"name":"Selection.hasEntireColumn"}}],"inheritedFrom":{"type":"reference","id":83,"name":"Selection.hasEntireColumn"}},{"id":214,"name":"hasEntireRow","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":14,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L14"}],"signatures":[{"id":215,"name":"hasEntireRow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given row is entirely selected in given selection"}]},"parameters":[{"id":216,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","id":81,"name":"Selection.hasEntireRow"}}],"inheritedFrom":{"type":"reference","id":80,"name":"Selection.hasEntireRow"}},{"id":211,"name":"normalizeTo","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":11,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L11"}],"signatures":[{"id":212,"name":"normalizeTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize the selection according to the given data"}]},"parameters":[{"id":213,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"reference","id":205,"name":"EntireSelection"},"inheritedFrom":{"type":"reference","id":78,"name":"Selection.normalizeTo"}}],"inheritedFrom":{"type":"reference","id":77,"name":"Selection.normalizeTo"}},{"id":220,"name":"size","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":20,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L20"}],"signatures":[{"id":221,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get the number of selected points according to given data"}]},"parameters":[{"id":222,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","id":87,"name":"Selection.size"}}],"inheritedFrom":{"type":"reference","id":86,"name":"Selection.size"}},{"id":208,"name":"toRange","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":8,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L8"}],"signatures":[{"id":209,"name":"toRange","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get concrete range of the selection in the given data"}]},"parameters":[{"id":210,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":286,"name":"PointRange"}]},"inheritedFrom":{"type":"reference","id":75,"name":"Selection.toRange"}}],"inheritedFrom":{"type":"reference","id":74,"name":"Selection.toRange"}}],"groups":[{"title":"Methods","children":[227,223,217,214,211,220,208]}],"sources":[{"fileName":"src/selection.ts","line":97,"character":22,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L97"}],"extendedTypes":[{"type":"reference","id":71,"name":"Selection"}],"extendedBy":[{"type":"reference","id":118,"name":"EntireAxisSelection"},{"type":"reference","id":230,"name":"EntireWorksheetSelection"}],"permalink":"/react-spreadsheet/api/class/EntireSelection","previousId":176,"nextId":230},{"id":230,"name":"EntireWorksheetSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of the entire worksheet"}]},"sources":[{"fileName":"src/selection.ts","line":100,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L100"}],"extendedTypes":[{"type":"reference","id":205,"name":"EntireSelection"}],"permalink":"/react-spreadsheet/api/class/EntireWorksheetSelection","previousId":205,"nextId":255},{"id":255,"name":"InvalidIndexError","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Error thrown when passing a non-index value where an index value is expected"}]},"sources":[{"fileName":"src/selection.ts","line":252,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L252"}],"extendedTypes":[{"type":"reference","name":"Error","qualifiedName":"Error","package":"typescript"}],"permalink":"/react-spreadsheet/api/class/InvalidIndexError","previousId":230,"nextId":286},{"id":286,"name":"PointRange","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Range between two points. Creates a normalized range between two given points"}]},"children":[{"id":292,"name":"end","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The bottom-right point"}]},"sources":[{"fileName":"src/point-range.ts","line":12,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L12"}],"type":{"type":"reference","id":306,"name":"Point"}},{"id":291,"name":"start","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The top-left point"}]},"sources":[{"fileName":"src/point-range.ts","line":10,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L10"}],"type":{"type":"reference","id":306,"name":"Point"}},{"id":304,"name":"[iterator]","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":26,"character":3,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L26"}],"signatures":[{"id":305,"name":"[iterator]","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Iterates through all the existing points in given range"}]},"type":{"type":"reference","typeArguments":[{"type":"reference","id":306,"name":"Point"},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"undefined"}],"name":"Iterator","qualifiedName":"Iterator","package":"typescript"}}]},{"id":301,"name":"equals","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":74,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L74"}],"signatures":[{"id":302,"name":"equals","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Returns whether given range is equal to this range"}]},"parameters":[{"id":303,"name":"range","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":286,"name":"PointRange"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":295,"name":"has","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":46,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L46"}],"signatures":[{"id":296,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Returns whether given point exists in given range"}]},"parameters":[{"id":297,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":298,"name":"mask","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":56,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L56"}],"signatures":[{"id":299,"name":"mask","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Limits given masked range with given mask"}]},"parameters":[{"id":300,"name":"mask","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":286,"name":"PointRange"}}],"type":{"type":"reference","id":286,"name":"PointRange"}}]},{"id":293,"name":"size","kind":2048,"kindString":"Method","flags":{},"sources":[{"fileName":"src/point-range.ts","line":39,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L39"}],"signatures":[{"id":294,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Returns the size (rows x columns) of the given range"}]},"type":{"type":"intrinsic","name":"number"}}]}],"groups":[{"title":"Properties","children":[292,291]},{"title":"Methods","children":[304,301,295,298,293]}],"sources":[{"fileName":"src/point-range.ts","line":8,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point-range.ts#L8"}],"permalink":"/react-spreadsheet/api/class/PointRange","previousId":255,"nextId":259},{"id":259,"name":"RangeSelection","kind":128,"kindString":"Class","flags":{},"comment":{"summary":[{"kind":"text","text":"Selection of a range of cells"}]},"sources":[{"fileName":"src/selection.ts","line":55,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L55"}],"extendedTypes":[{"type":"reference","id":71,"name":"Selection"}],"permalink":"/react-spreadsheet/api/class/RangeSelection","previousId":286,"nextId":71},{"id":71,"name":"Selection","kind":128,"kindString":"Class","flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Selection from a spreadsheet"}]},"children":[{"id":93,"name":"equals","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":26,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L26"}],"signatures":[{"id":94,"name":"equals","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given selection is equal to this selection"}]},"parameters":[{"id":95,"name":"selection","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":71,"name":"Selection"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":89,"name":"has","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":23,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L23"}],"signatures":[{"id":90,"name":"has","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given point is within the selection"}]},"parameters":[{"id":91,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}},{"id":92,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":83,"name":"hasEntireColumn","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":17,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L17"}],"signatures":[{"id":84,"name":"hasEntireColumn","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given column is entirely selected in given selection"}]},"parameters":[{"id":85,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":80,"name":"hasEntireRow","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":14,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L14"}],"signatures":[{"id":81,"name":"hasEntireRow","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Determines whether the given row is entirely selected in given selection"}]},"parameters":[{"id":82,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":77,"name":"normalizeTo","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":11,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L11"}],"signatures":[{"id":78,"name":"normalizeTo","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize the selection according to the given data"}]},"parameters":[{"id":79,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"reference","id":71,"name":"Selection"}}]},{"id":86,"name":"size","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":20,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L20"}],"signatures":[{"id":87,"name":"size","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get the number of selected points according to given data"}]},"parameters":[{"id":88,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"intrinsic","name":"number"}}]},{"id":74,"name":"toRange","kind":2048,"kindString":"Method","flags":{"isAbstract":true},"sources":[{"fileName":"src/selection.ts","line":8,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L8"}],"signatures":[{"id":75,"name":"toRange","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Get concrete range of the selection in the given data"}]},"parameters":[{"id":76,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Matrix"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":286,"name":"PointRange"}]}}]}],"groups":[{"title":"Methods","children":[93,89,83,80,77,86,74]}],"sources":[{"fileName":"src/selection.ts","line":6,"character":22,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/selection.ts#L6"}],"extendedBy":[{"type":"reference","id":96,"name":"EmptySelection"},{"type":"reference","id":205,"name":"EntireSelection"},{"type":"reference","id":259,"name":"RangeSelection"}],"permalink":"/react-spreadsheet/api/class/Selection","previousId":259,"nextId":5},{"id":310,"name":"CellBase","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The base type of cell data in Spreadsheet"}]},"sources":[{"fileName":"src/types.ts","line":11,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L11"}],"typeParameters":[{"id":317,"name":"Value","kind":131072,"kindString":"Type parameter","flags":{},"default":{"type":"intrinsic","name":"any"}}],"type":{"type":"reflection","declaration":{"id":311,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":315,"name":"DataEditor","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom component to render when the cell is edited, if not defined would default to the component defined for the Spreadsheet"}]},"sources":[{"fileName":"src/types.ts","line":19,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L19"}],"type":{"type":"reference","id":386,"typeArguments":[{"type":"reference","id":310,"typeArguments":[{"type":"reference","id":317,"name":"Value"}],"name":"CellBase"}],"name":"DataEditorComponent"}},{"id":316,"name":"DataViewer","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom component to render when the cell is viewed, if not defined would default to the component defined for the Spreadsheet"}]},"sources":[{"fileName":"src/types.ts","line":21,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L21"}],"type":{"type":"reference","id":374,"typeArguments":[{"type":"reference","id":310,"typeArguments":[{"type":"reference","id":317,"name":"Value"}],"name":"CellBase"}],"name":"DataViewerComponent"}},{"id":313,"name":"className","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Class to be given for the cell element"}]},"sources":[{"fileName":"src/types.ts","line":15,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"}},{"id":312,"name":"readOnly","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the cell should not be editable"}]},"sources":[{"fileName":"src/types.ts","line":13,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L13"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":314,"name":"value","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The value of the cell"}]},"sources":[{"fileName":"src/types.ts","line":17,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L17"}],"type":{"type":"reference","id":317,"name":"Value"}}],"groups":[{"title":"Properties","children":[315,316,313,312,314]}],"sources":[{"fileName":"src/types.ts","line":11,"character":36,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L11"}]}},"permalink":"/react-spreadsheet/api#CellBase","previousId":64,"nextId":364},{"id":364,"name":"CellComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Cell component"}]},"sources":[{"fileName":"src/types.ts","line":104,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L104"}],"typeParameters":[{"id":365,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":334,"typeArguments":[{"type":"reference","id":365,"name":"Cell"}],"name":"CellComponentProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#CellComponent","previousId":310,"nextId":334},{"id":334,"name":"CellComponentProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of Spreadsheet Cell component props"}]},"sources":[{"fileName":"src/types.ts","line":72,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L72"}],"typeParameters":[{"id":363,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reflection","declaration":{"id":335,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":338,"name":"DataViewer","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The DataViewer component to be used by the cell"}]},"sources":[{"fileName":"src/types.ts","line":78,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L78"}],"type":{"type":"reference","id":374,"typeArguments":[{"type":"reference","id":363,"name":"Cell"}],"name":"DataViewerComponent"}},{"id":350,"name":"activate","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":96,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L96"}],"type":{"type":"reflection","declaration":{"id":351,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":96,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L96"}],"signatures":[{"id":352,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Activate the cell at the given point"}]},"parameters":[{"id":353,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":340,"name":"active","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the cell is active"}]},"sources":[{"fileName":"src/types.ts","line":82,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L82"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":337,"name":"column","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The column of the cell"}]},"sources":[{"fileName":"src/types.ts","line":76,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L76"}],"type":{"type":"intrinsic","name":"number"}},{"id":341,"name":"copied","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the cell is copied"}]},"sources":[{"fileName":"src/types.ts","line":84,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":344,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The data of the cell"}]},"sources":[{"fileName":"src/types.ts","line":90,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L90"}],"type":{"type":"union","types":[{"type":"reference","id":363,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}},{"id":342,"name":"dragging","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the user is dragging"}]},"sources":[{"fileName":"src/types.ts","line":86,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":345,"name":"evaluatedData","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The evaluated data of the cell"}]},"sources":[{"fileName":"src/types.ts","line":92,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L92"}],"type":{"type":"union","types":[{"type":"reference","id":363,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}},{"id":343,"name":"mode","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The mode of the cell"}]},"sources":[{"fileName":"src/types.ts","line":88,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L88"}],"type":{"type":"reference","id":322,"name":"Mode"}},{"id":336,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The row of the cell"}]},"sources":[{"fileName":"src/types.ts","line":74,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L74"}],"type":{"type":"intrinsic","name":"number"}},{"id":346,"name":"select","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":94,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L94"}],"type":{"type":"reflection","declaration":{"id":347,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":94,"character":10,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L94"}],"signatures":[{"id":348,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Select the cell at the given point"}]},"parameters":[{"id":349,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":339,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the cell is selected"}]},"sources":[{"fileName":"src/types.ts","line":80,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L80"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":359,"name":"setCellData","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":100,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L100"}],"type":{"type":"reflection","declaration":{"id":360,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":100,"character":15,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L100"}],"signatures":[{"id":361,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Set data of the cell"}]},"parameters":[{"id":362,"name":"cell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":363,"name":"Cell"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":354,"name":"setCellDimensions","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":98,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L98"}],"type":{"type":"reflection","declaration":{"id":355,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":98,"character":21,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L98"}],"signatures":[{"id":356,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Set the dimensions of the cell at the given point with the given dimensions"}]},"parameters":[{"id":357,"name":"point","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point"}},{"id":358,"name":"dimensions","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":323,"name":"Dimensions"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[338,350,340,337,341,344,342,345,343,336,346,339,359,354]}],"sources":[{"fileName":"src/types.ts","line":72,"character":67,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L72"}]}},"permalink":"/react-spreadsheet/api#CellComponentProps","previousId":364,"nextId":318},{"id":318,"name":"CellDescriptor","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"A cell with it\'s coordinates"}],"blockTags":[{"tag":"@deprecated","content":[{"kind":"text","text":"the component does not use cell descriptors anymore. Instead it passes cell point and cell value explicitly."}]}]},"sources":[{"fileName":"src/types.ts","line":28,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L28"}],"typeParameters":[{"id":321,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{}}],"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":319,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":320,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The cell\'s data"}]},"sources":[{"fileName":"src/types.ts","line":30,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L30"}],"type":{"type":"union","types":[{"type":"reference","id":321,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}}],"groups":[{"title":"Properties","children":[320]}],"sources":[{"fileName":"src/types.ts","line":28,"character":35,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L28"}]}},{"type":"reference","id":306,"name":"Point"}]},"permalink":"/react-spreadsheet/api#CellDescriptor","previousId":334,"nextId":388},{"id":388,"name":"ColumnIndicatorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the ColumnIndicator component"}]},"sources":[{"fileName":"src/types.ts","line":191,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L191"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":389,"name":"ColumnIndicatorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#ColumnIndicatorComponent","previousId":318,"nextId":389},{"id":389,"name":"ColumnIndicatorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet ColumnIndicator component props"}]},"sources":[{"fileName":"src/types.ts","line":179,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L179"}],"type":{"type":"reflection","declaration":{"id":390,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":391,"name":"column","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The column the indicator indicates"}]},"sources":[{"fileName":"src/types.ts","line":181,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L181"}],"type":{"type":"intrinsic","name":"number"}},{"id":392,"name":"label","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom label for the indicator as provided in columnLabels"}]},"sources":[{"fileName":"src/types.ts","line":183,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L183"}],"type":{"type":"union","types":[{"type":"reference","name":"React.ReactNode","qualifiedName":"React.ReactNode","package":"@types/react"},{"type":"literal","value":null}]}},{"id":394,"name":"onSelect","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":187,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L187"}],"type":{"type":"reflection","declaration":{"id":395,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":187,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L187"}],"signatures":[{"id":396,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when the column is selected"}]},"parameters":[{"id":397,"name":"column","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":398,"name":"extend","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":393,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the entire column in selected"}]},"sources":[{"fileName":"src/types.ts","line":185,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L185"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[391,392,394,393]}],"sources":[{"fileName":"src/types.ts","line":179,"character":35,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L179"}]}},"permalink":"/react-spreadsheet/api#ColumnIndicatorProps","previousId":388,"nextId":410},{"id":410,"name":"CornerIndicatorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the CornerIndicator component"}]},"sources":[{"fileName":"src/types.ts","line":203,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L203"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":411,"name":"CornerIndicatorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#CornerIndicatorComponent","previousId":389,"nextId":411},{"id":411,"name":"CornerIndicatorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet CornerIndicator component props"}]},"sources":[{"fileName":"src/types.ts","line":195,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L195"}],"type":{"type":"reflection","declaration":{"id":412,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":414,"name":"onSelect","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":199,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L199"}],"type":{"type":"reflection","declaration":{"id":415,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":199,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L199"}],"signatures":[{"id":416,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to select the entire table"}]},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":413,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the entire table is selected"}]},"sources":[{"fileName":"src/types.ts","line":197,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L197"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[414,413]}],"sources":[{"fileName":"src/types.ts","line":195,"character":35,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L195"}]}},"permalink":"/react-spreadsheet/api#CornerIndicatorProps","previousId":410,"nextId":386},{"id":386,"name":"DataEditorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataEditor component"}]},"sources":[{"fileName":"src/types.ts","line":134,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L134"}],"typeParameters":[{"id":387,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":376,"typeArguments":[{"type":"reference","id":387,"name":"Cell"}],"name":"DataEditorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#DataEditorComponent","previousId":411,"nextId":376},{"id":376,"name":"DataEditorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataEditor component props"}]},"sources":[{"fileName":"src/types.ts","line":125,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L125"}],"typeParameters":[{"id":385,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"intersection","types":[{"type":"reference","typeArguments":[{"type":"reference","id":385,"name":"Cell"}],"name":"DataComponentProps"},{"type":"reflection","declaration":{"id":377,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":382,"name":"exitEditMode","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":130,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L130"}],"type":{"type":"reflection","declaration":{"id":383,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":130,"character":18,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L130"}],"signatures":[{"id":384,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when edit mode should be exited"}]},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":378,"name":"onChange","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":128,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L128"}],"type":{"type":"reflection","declaration":{"id":379,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":128,"character":14,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L128"}],"signatures":[{"id":380,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when the cell\'s value is changed"}]},"parameters":[{"id":381,"name":"cell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":385,"name":"Cell"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[382,378]}],"sources":[{"fileName":"src/types.ts","line":126,"character":29,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L126"}]}}]},"permalink":"/react-spreadsheet/api#DataEditorProps","previousId":386,"nextId":374},{"id":374,"name":"DataViewerComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataViewer component"}]},"sources":[{"fileName":"src/types.ts","line":121,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L121"}],"typeParameters":[{"id":375,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":366,"typeArguments":[{"type":"reference","id":375,"name":"Cell"}],"name":"DataViewerProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#DataViewerComponent","previousId":376,"nextId":366},{"id":366,"name":"DataViewerProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet DataViewer component props"}]},"sources":[{"fileName":"src/types.ts","line":113,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L113"}],"typeParameters":[{"id":373,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"CellBase"},"default":{"type":"reference","id":310,"name":"CellBase"}}],"type":{"type":"intersection","types":[{"type":"reference","typeArguments":[{"type":"reference","id":373,"name":"Cell"}],"name":"DataComponentProps"},{"type":"reflection","declaration":{"id":367,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":372,"name":"evaluatedCell","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":117,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L117"}],"type":{"type":"union","types":[{"type":"reference","id":373,"name":"Cell"},{"type":"intrinsic","name":"undefined"}]}},{"id":368,"name":"setCellData","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":116,"character":4,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L116"}],"type":{"type":"reflection","declaration":{"id":369,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":116,"character":17,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L116"}],"signatures":[{"id":370,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Set data of the cell"}]},"parameters":[{"id":371,"name":"cell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":373,"name":"Cell"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[372,368]}],"sources":[{"fileName":"src/types.ts","line":114,"character":29,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L114"}]}}]},"permalink":"/react-spreadsheet/api#DataViewerProps","previousId":374,"nextId":323},{"id":323,"name":"Dimensions","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Dimensions of an element"}]},"sources":[{"fileName":"src/types.ts","line":37,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L37"}],"type":{"type":"reflection","declaration":{"id":324,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":326,"name":"height","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The element\'s height in pixels"}]},"sources":[{"fileName":"src/types.ts","line":41,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L41"}],"type":{"type":"intrinsic","name":"number"}},{"id":328,"name":"left","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The distance of the element from it\'s container left border in pixels"}]},"sources":[{"fileName":"src/types.ts","line":45,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"number"}},{"id":327,"name":"top","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The distance of the element from it\'s container top border in pixels"}]},"sources":[{"fileName":"src/types.ts","line":43,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"number"}},{"id":325,"name":"width","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The element\'s width in pixels"}]},"sources":[{"fileName":"src/types.ts","line":39,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L39"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[326,328,327,325]}],"sources":[{"fileName":"src/types.ts","line":37,"character":25,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L37"}]}},"permalink":"/react-spreadsheet/api#Dimensions","previousId":366,"nextId":428},{"id":428,"name":"HeaderRowComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the HeaderRow component"}]},"sources":[{"fileName":"src/types.ts","line":161,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L161"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":426,"name":"HeaderRowProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#HeaderRowComponent","previousId":323,"nextId":426},{"id":426,"name":"HeaderRowProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet HeaderRow component props"}]},"sources":[{"fileName":"src/types.ts","line":158,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L158"}],"type":{"type":"reference","typeArguments":[{"type":"reflection","declaration":{"id":427,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":158,"character":53,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L158"}]}}],"name":"React.PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"},"permalink":"/react-spreadsheet/api#HeaderRowProps","previousId":428,"nextId":69},{"id":69,"name":"Matrix","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"A two-dimensional array of given type T in rows and columns"}]},"sources":[{"fileName":"src/matrix.ts","line":4,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/matrix.ts#L4"}],"typeParameters":[{"id":70,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"type":{"type":"array","elementType":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","id":70,"name":"T"},{"type":"intrinsic","name":"undefined"}]}}},"permalink":"/react-spreadsheet/api#Matrix","previousId":426,"nextId":322},{"id":322,"name":"Mode","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The spreadsheet\'s write mode"}]},"sources":[{"fileName":"src/types.ts","line":34,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L34"}],"type":{"type":"union","types":[{"type":"literal","value":"view"},{"type":"literal","value":"edit"}]},"permalink":"/react-spreadsheet/api#Mode","previousId":69,"nextId":306},{"id":306,"name":"Point","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"A cell coordinates in the spreadsheet"}]},"sources":[{"fileName":"src/point.ts","line":2,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point.ts#L2"}],"type":{"type":"reflection","declaration":{"id":307,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":308,"name":"column","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The cell\'s column"}]},"sources":[{"fileName":"src/point.ts","line":4,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point.ts#L4"}],"type":{"type":"intrinsic","name":"number"}},{"id":309,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The cell\'s row"}]},"sources":[{"fileName":"src/point.ts","line":6,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point.ts#L6"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[308,309]}],"sources":[{"fileName":"src/point.ts","line":2,"character":20,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/point.ts#L2"}]}},"permalink":"/react-spreadsheet/api#Point","previousId":322,"nextId":14},{"id":14,"name":"Props","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet component props"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":43,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L43"}],"typeParameters":[{"id":63,"name":"CellType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"name":"Types.CellBase"}}],"type":{"type":"reflection","declaration":{"id":15,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":31,"name":"Cell","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet\'s cell component."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":99,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L99"}],"type":{"type":"reference","id":364,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Types.CellComponent"}},{"id":25,"name":"ColumnIndicator","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered above each column."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":87,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L87"}],"type":{"type":"reference","id":388,"name":"Types.ColumnIndicatorComponent"}},{"id":26,"name":"CornerIndicator","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered in the corner of row and column indicators."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":89,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L89"}],"type":{"type":"reference","id":410,"name":"Types.CornerIndicatorComponent"}},{"id":33,"name":"DataEditor","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered for cells in edit mode."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":103,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L103"}],"type":{"type":"reference","id":386,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Types.DataEditorComponent"}},{"id":32,"name":"DataViewer","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered for cells in view mode."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":101,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L101"}],"type":{"type":"reference","id":374,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Types.DataViewerComponent"}},{"id":30,"name":"HeaderRow","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The spreadsheet\'s header row component"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":97,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L97"}],"type":{"type":"reference","id":428,"name":"Types.HeaderRowComponent"}},{"id":29,"name":"Row","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet\'s row component."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":95,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L95"}],"type":{"type":"reference","id":417,"name":"Types.RowComponent"}},{"id":27,"name":"RowIndicator","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Component rendered next to each row."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":91,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L91"}],"type":{"type":"reference","id":399,"name":"Types.RowIndicatorComponent"}},{"id":28,"name":"Table","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet\'s table component."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":93,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L93"}],"type":{"type":"reference","id":421,"name":"Types.TableComponent"}},{"id":17,"name":"className","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Class name to be added to the spreadsheet\'s root element"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":47,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L47"}],"type":{"type":"intrinsic","name":"string"}},{"id":20,"name":"columnLabels","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Labels to use in column indicators."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"text","text":"alphabetical labels."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":67,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L67"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":19,"name":"createFormulaParser","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function used to create the formula parser (instance of\\n\\"fast-formula-parser\\") used by the Spreadsheet by getting the spreadsheet\'s\\ndata."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"text","text":"function which creates a formula parser bound to the\\nSpreadsheet\'s data."}]},{"tag":"@see","content":[{"kind":"text","text":" - "},{"kind":"code","text":"`createFormulaParser`"},{"kind":"text","text":"\\n"},{"kind":"text","text":" - "},{"kind":"text","text":"https://www.npmjs.com/package/fast-formula-parser"},{"kind":"text","text":"\\n"}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":62,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L62"}],"type":{"type":"reference","name":"Types.CreateFormulaParser"}},{"id":18,"name":"darkMode","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Use dark colors that complement dark mode"}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`false`"}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":52,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L52"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":16,"name":"data","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The spreadsheet\'s data"}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":45,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L45"}],"type":{"type":"reference","id":69,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Matrix.Matrix"}},{"id":23,"name":"hideColumnIndicators","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If set to true, hides the column indicators of the spreadsheet."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":82,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L82"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":22,"name":"hideRowIndicators","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"If set to true, hides the row indicators of the spreadsheet."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":77,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L77"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":50,"name":"onActivate","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":114,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L114"}],"type":{"type":"reflection","declaration":{"id":51,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":114,"character":15,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L114"}],"signatures":[{"id":52,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when Spreadsheet\'s active cell changes."}]},"parameters":[{"id":53,"name":"active","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":306,"name":"Point.Point"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":54,"name":"onBlur","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":116,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L116"}],"type":{"type":"reflection","declaration":{"id":55,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":116,"character":11,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L116"}],"signatures":[{"id":56,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet loses focus"}]},"type":{"type":"intrinsic","name":"void"}}]}}},{"id":57,"name":"onCellCommit","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":117,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L117"}],"type":{"type":"reflection","declaration":{"id":58,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":117,"character":17,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L117"}],"signatures":[{"id":59,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"parameters":[{"id":60,"name":"prevCell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":63,"name":"CellType"}]}},{"id":61,"name":"nextCell","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":63,"name":"CellType"}]}},{"id":62,"name":"coords","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","id":306,"name":"Point.Point"}]}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":38,"name":"onChange","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":108,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L108"}],"type":{"type":"reflection","declaration":{"id":39,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":108,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L108"}],"signatures":[{"id":40,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet\'s data changes."}]},"parameters":[{"id":41,"name":"data","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":69,"typeArguments":[{"type":"reference","id":63,"name":"CellType"}],"name":"Matrix.Matrix"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":34,"name":"onKeyDown","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":106,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L106"}],"type":{"type":"reflection","declaration":{"id":35,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":106,"character":14,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L106"}],"signatures":[{"id":36,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called on key down inside the spreadsheet."}]},"parameters":[{"id":37,"name":"event","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","name":"React.KeyboardEvent","qualifiedName":"React.KeyboardEvent","package":"@types/react"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":42,"name":"onModeChange","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":110,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L110"}],"type":{"type":"reflection","declaration":{"id":43,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":110,"character":17,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L110"}],"signatures":[{"id":44,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet\'s edit mode changes."}]},"parameters":[{"id":45,"name":"mode","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":322,"name":"Types.Mode"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":46,"name":"onSelect","kind":1024,"kindString":"Property","flags":{"isOptional":true},"sources":[{"fileName":"src/Spreadsheet.tsx","line":112,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L112"}],"type":{"type":"reflection","declaration":{"id":47,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":112,"character":13,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L112"}],"signatures":[{"id":48,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback called when the Spreadsheet\'s selection changes."}]},"parameters":[{"id":49,"name":"selected","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":71,"name":"Selection"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":21,"name":"rowLabels","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Labels to use in row indicators."}],"blockTags":[{"tag":"@defaultValue","content":[{"kind":"text","text":"row index labels."}]}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":72,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L72"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":24,"name":"selected","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The selected cells in the worksheet."}]},"sources":[{"fileName":"src/Spreadsheet.tsx","line":84,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L84"}],"type":{"type":"reference","id":71,"name":"Selection"}}],"groups":[{"title":"Properties","children":[31,25,26,33,32,30,29,27,28,17,20,19,18,16,23,22,50,54,57,38,34,42,46,21,24]}],"sources":[{"fileName":"src/Spreadsheet.tsx","line":43,"character":53,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L43"}]}},"permalink":"/react-spreadsheet/api#Props","previousId":306,"nextId":417},{"id":417,"name":"RowComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Row component"}]},"sources":[{"fileName":"src/types.ts","line":155,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L155"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":418,"name":"RowProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#RowComponent","previousId":14,"nextId":399},{"id":399,"name":"RowIndicatorComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the RowIndicator component"}]},"sources":[{"fileName":"src/types.ts","line":176,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L176"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":400,"name":"RowIndicatorProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#RowIndicatorComponent","previousId":417,"nextId":400},{"id":400,"name":"RowIndicatorProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet RowIndicator component props"}]},"sources":[{"fileName":"src/types.ts","line":164,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L164"}],"type":{"type":"reflection","declaration":{"id":401,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":403,"name":"label","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom label for the indicator as provided in rowLabels"}]},"sources":[{"fileName":"src/types.ts","line":168,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L168"}],"type":{"type":"union","types":[{"type":"reference","name":"React.ReactNode","qualifiedName":"React.ReactNode","package":"@types/react"},{"type":"literal","value":null}]}},{"id":405,"name":"onSelect","kind":1024,"kindString":"Property","flags":{},"sources":[{"fileName":"src/types.ts","line":172,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L172"}],"type":{"type":"reflection","declaration":{"id":406,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"sources":[{"fileName":"src/types.ts","line":172,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L172"}],"signatures":[{"id":407,"name":"__type","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Callback to be called when the row is selected"}]},"parameters":[{"id":408,"name":"row","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":409,"name":"extend","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":402,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The row the indicator indicates"}]},"sources":[{"fileName":"src/types.ts","line":166,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L166"}],"type":{"type":"intrinsic","name":"number"}},{"id":404,"name":"selected","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the entire row is selected"}]},"sources":[{"fileName":"src/types.ts","line":170,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L170"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[403,405,402,404]}],"sources":[{"fileName":"src/types.ts","line":164,"character":32,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L164"}]}},"permalink":"/react-spreadsheet/api#RowIndicatorProps","previousId":399,"nextId":418},{"id":418,"name":"RowProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Row component props"}]},"sources":[{"fileName":"src/types.ts","line":149,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L149"}],"type":{"type":"reference","typeArguments":[{"type":"reflection","declaration":{"id":419,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":420,"name":"row","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"The row index of the table"}]},"sources":[{"fileName":"src/types.ts","line":151,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L151"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[420]}],"sources":[{"fileName":"src/types.ts","line":149,"character":47,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L149"}]}}],"name":"React.PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"},"permalink":"/react-spreadsheet/api#RowProps","previousId":400,"nextId":421},{"id":421,"name":"TableComponent","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Table component"}]},"sources":[{"fileName":"src/types.ts","line":146,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L146"}],"type":{"type":"reference","typeArguments":[{"type":"reference","id":422,"name":"TableProps"}],"name":"React.ComponentType","qualifiedName":"React.ComponentType","package":"@types/react"},"permalink":"/react-spreadsheet/api#TableComponent","previousId":418,"nextId":422},{"id":422,"name":"TableProps","kind":4194304,"kindString":"Type alias","flags":{},"comment":{"summary":[{"kind":"text","text":"Type of the Spreadsheet Table component props"}]},"sources":[{"fileName":"src/types.ts","line":138,"character":12,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L138"}],"type":{"type":"reference","typeArguments":[{"type":"reflection","declaration":{"id":423,"name":"__type","kind":65536,"kindString":"Type literal","flags":{},"children":[{"id":424,"name":"columns","kind":1024,"kindString":"Property","flags":{},"comment":{"summary":[{"kind":"text","text":"Numebr of columns the table should render"}]},"sources":[{"fileName":"src/types.ts","line":140,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L140"}],"type":{"type":"intrinsic","name":"number"}},{"id":425,"name":"hideColumnIndicators","kind":1024,"kindString":"Property","flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether column indicators are hidden"}]},"sources":[{"fileName":"src/types.ts","line":142,"character":2,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L142"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"literal","value":null}]}}],"groups":[{"title":"Properties","children":[424,425]}],"sources":[{"fileName":"src/types.ts","line":138,"character":49,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/types.ts#L138"}]}}],"name":"React.PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"},"permalink":"/react-spreadsheet/api#TableProps","previousId":421},{"id":5,"name":"DataEditor","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/DataEditor.tsx","line":6,"character":6,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/DataEditor.tsx#L6"}],"signatures":[{"id":6,"name":"DataEditor","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The default Spreadsheet DataEditor component"}]},"parameters":[{"id":7,"name":"props","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","typeArguments":[{"type":"reference","id":376,"typeArguments":[{"type":"reference","id":310,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"CellBase"}],"name":"DataEditorProps"}],"name":"PropsWithChildren","qualifiedName":"React.PropsWithChildren","package":"@types/react"}},{"id":8,"name":"context","kind":32768,"kindString":"Parameter","flags":{"isOptional":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"ReactElement","qualifiedName":"React.ReactElement","package":"@types/react"}]}}],"permalink":"/react-spreadsheet/api/function/DataEditor","previousId":71,"nextId":9},{"id":9,"name":"DataViewer","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/DataViewer.tsx","line":10,"character":6,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/DataViewer.tsx#L10"}],"signatures":[{"id":10,"name":"DataViewer","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The default Spreadsheet DataViewer component"}]},"typeParameter":[{"id":11,"name":"Cell","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"typeArguments":[{"type":"reference","id":12,"name":"Value"}],"name":"CellBase"}},{"id":12,"name":"Value","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":13,"name":"__namedParameters","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":366,"typeArguments":[{"type":"reference","id":11,"name":"Cell"}],"name":"DataViewerProps"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","qualifiedName":"React.JSXElementConstructor","package":"@types/react"}]}],"name":"ReactElement","qualifiedName":"React.ReactElement","package":"@types/react"}}],"permalink":"/react-spreadsheet/api/function/DataViewer","previousId":5,"nextId":1},{"id":1,"name":"Spreadsheet","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/Spreadsheet.tsx","line":127,"character":6,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/Spreadsheet.tsx#L127"}],"signatures":[{"id":2,"name":"Spreadsheet","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"The Spreadsheet component"}]},"typeParameter":[{"id":3,"name":"CellType","kind":131072,"kindString":"Type parameter","flags":{},"type":{"type":"reference","id":310,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"CellBase"}}],"parameters":[{"id":4,"name":"props","kind":32768,"kindString":"Parameter","flags":{},"type":{"type":"reference","id":14,"typeArguments":[{"type":"reference","id":3,"name":"CellType"}],"name":"Props"}}],"type":{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","qualifiedName":"React.JSXElementConstructor","package":"@types/react"}]}],"name":"ReactElement","qualifiedName":"React.ReactElement","package":"@types/react"}}],"permalink":"/react-spreadsheet/api/function/Spreadsheet","previousId":9,"nextId":64},{"id":64,"name":"createEmptyMatrix","kind":64,"kindString":"Function","flags":{},"sources":[{"fileName":"src/matrix.ts","line":12,"character":16,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/matrix.ts#L12"}],"signatures":[{"id":65,"name":"createEmptyMatrix","kind":4096,"kindString":"Call signature","flags":{},"comment":{"summary":[{"kind":"text","text":"Creates an empty matrix with given rows and columns"}],"blockTags":[{"tag":"@returns","content":[{"kind":"text","text":"an empty matrix with given rows and columns"}]}]},"typeParameter":[{"id":66,"name":"T","kind":131072,"kindString":"Type parameter","flags":{}}],"parameters":[{"id":67,"name":"rows","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"integer, the amount of rows the matrix should have"}]},"type":{"type":"intrinsic","name":"number"}},{"id":68,"name":"columns","kind":32768,"kindString":"Parameter","flags":{},"comment":{"summary":[{"kind":"text","text":"integer, the amount of columns the matrix should have"}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","id":69,"typeArguments":[{"type":"reference","id":66,"name":"T"}],"name":"Matrix"}}],"permalink":"/react-spreadsheet/api/function/createEmptyMatrix","previousId":1,"nextId":310}],"groups":[{"title":"Classes","children":[96,118,147,176,205,230,255,286,259,71]},{"title":"Functions","children":[5,9,1,64]},{"title":"Type Aliases","children":[310,364,334,318,388,389,410,411,386,376,374,366,323,428,426,69,322,306,14,417,399,400,418,421,422]}],"sources":[{"fileName":"src/index.ts","line":1,"character":0,"url":"https://github.com/iddan/react-spreadsheet/blob/5751105/src/index.ts#L1"}],"permalink":"/react-spreadsheet/api"},"urlSlug":"."}],"packageName":"react-spreadsheet","packageVersion":"0.9.3"}]')}}]); \ No newline at end of file diff --git a/assets/js/e37efcac.7eeb8dba.js b/assets/js/e37efcac.7eeb8dba.js deleted file mode 100644 index 73e51fee..00000000 --- a/assets/js/e37efcac.7eeb8dba.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkreact_spreadsheet=self.webpackChunkreact_spreadsheet||[]).push([[805],{4396:function(e,t,a){a.r(t),a.d(t,{assets:function(){return i},contentTitle:function(){return l},default:function(){return u},frontMatter:function(){return o},metadata:function(){return s},toc:function(){return p}});var n=a(3117),r=(a(7294),a(3905));const o={id:"usage",title:"Usage"},l="Usage",s={unversionedId:"usage",id:"usage",title:"Usage",description:"Simple",source:"@site/docs/02-usage.md",sourceDirName:".",slug:"/usage",permalink:"/react-spreadsheet/docs/usage",draft:!1,editUrl:"https://github.com/iddan/react-spreadsheet/tree/master/website/docs/02-usage.md",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"usage",title:"Usage"},sidebar:"sidebar",previous:{title:"Get Started",permalink:"/react-spreadsheet/docs/"},next:{title:"Formula Parser",permalink:"/react-spreadsheet/docs/formula-parser"}},i={},p=[{value:"Simple",id:"simple",level:2},{value:"Custom Columns and Rows",id:"custom-columns-and-rows",level:2},{value:"Readonly Cells",id:"readonly-cells",level:2},{value:"Controlled",id:"controlled",level:2}],c={toc:p};function u(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},c,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"usage"},"Usage"),(0,r.kt)("h2",{id:"simple"},"Simple"),(0,r.kt)("p",null,"The Spreadsheet component requires the ",(0,r.kt)("inlineCode",{parentName:"p"},"data")," property: an array of arrays with objects that have the ",(0,r.kt)("inlineCode",{parentName:"p"},"value")," key. Changes made in the Spreadsheet will not affect the passed data array as in React props values should not be mutated."),(0,r.kt)("admonition",{type:"caution"},(0,r.kt)("p",{parentName:"admonition"},"If the ",(0,r.kt)("inlineCode",{parentName:"p"},"data")," prop value is changed the component will discard any changes made by the user. If you want to make changes to ",(0,r.kt)("inlineCode",{parentName:"p"},"data")," and incorporate the user's changes see ",(0,r.kt)("a",{parentName:"p",href:"#Controlled"},"Controlled"),".")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import Spreadsheet from "react-spreadsheet";\n\nconst App = () => {\n const data = [\n [{ value: "Vanilla" }, { value: "Chocolate" }],\n [{ value: "Strawberry" }, { value: "Cookies" }],\n ];\n return ;\n};\n')),(0,r.kt)("h2",{id:"custom-columns-and-rows"},"Custom Columns and Rows"),(0,r.kt)("p",null,"The Spreadsheet component accepts the ",(0,r.kt)("inlineCode",{parentName:"p"},"columnLabels")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"rowLabels")," props, both of which accept arrays. If no ",(0,r.kt)("inlineCode",{parentName:"p"},"columnLabels")," are supplied, alphabetical labels are used, and row index labels are used if no ",(0,r.kt)("inlineCode",{parentName:"p"},"rowLabels")," are passed."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import Spreadsheet from "react-spreadsheet";\n\nconst App = () => {\n const columnLabels = ["Flavour", "Food"];\n const rowLabels = ["Item 1", "Item 2"];\n const data = [\n [{ value: "Vanilla" }, { value: "Chocolate" }],\n [{ value: "Strawberry" }, { value: "Cookies" }],\n ];\n return ;\n};\n')),(0,r.kt)("h2",{id:"readonly-cells"},"Readonly Cells"),(0,r.kt)("p",null,"Any particular Spreadsheet cell can be set to read-only by just specifying ",(0,r.kt)("inlineCode",{parentName:"p"},"readOnly: true")," in the cell along with the value."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import Spreadsheet from "react-spreadsheet";\n\nconst App = () => {\n const data = [\n [{ value: "Vanilla" }, { value: "Chocolate", readOnly: true }],\n [{ value: "Strawberry" }, { value: "Cookies", readOnly: true }],\n ];\n return ;\n};\n')),(0,r.kt)("h2",{id:"controlled"},"Controlled"),(0,r.kt)("p",null,"The Spreadsheet component accepts the ",(0,r.kt)("inlineCode",{parentName:"p"},"onChange")," prop that is called every time one of the Spreadsheet's cells is changed by the user. You can use it to save the modified data and to react to changes (e.g. validating the modified data, further modifying it, persisting it)."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import {useState} from "react";\nimport Spreadsheet from "react-spreadsheet";\n\nconst App = () => {\n const [data, setData] = useState([\n [{ value: "Vanilla" }, { value: "Chocolate" }, { value: "" }],\n [{ value: "Strawberry" }, { value: "Cookies" }, { value: "" }],\n ]);\n return ;\n};\n')))}u.isMDXComponent=!0},3905:function(e,t,a){a.d(t,{Zo:function(){return c},kt:function(){return m}});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var i=n.createContext({}),p=function(e){var t=n.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=p(e.components);return n.createElement(i.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(a),m=r,h=d["".concat(i,".").concat(m)]||d[m]||u[m]||o;return a?n.createElement(h,l(l({ref:t},c),{},{components:a})):n.createElement(h,l({ref:t},c))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=d;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var p=2;p {\n const data = [\n [{ value: "Vanilla" }, { value: "Chocolate" }],\n [{ value: "Strawberry" }, { value: "Cookies" }],\n ];\n return ;\n};\n')),(0,r.kt)("h2",{id:"custom-columns-and-rows"},"Custom Columns and Rows"),(0,r.kt)("p",null,"The Spreadsheet component accepts the ",(0,r.kt)("inlineCode",{parentName:"p"},"columnLabels")," or ",(0,r.kt)("inlineCode",{parentName:"p"},"rowLabels")," props, both of which accept arrays. If no ",(0,r.kt)("inlineCode",{parentName:"p"},"columnLabels")," are supplied, alphabetical labels are used, and row index labels are used if no ",(0,r.kt)("inlineCode",{parentName:"p"},"rowLabels")," are passed."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import Spreadsheet from "react-spreadsheet";\n\nconst App = () => {\n const columnLabels = ["Flavour", "Food"];\n const rowLabels = ["Item 1", "Item 2"];\n const data = [\n [{ value: "Vanilla" }, { value: "Chocolate" }],\n [{ value: "Strawberry" }, { value: "Cookies" }],\n ];\n return (\n \n );\n};\n')),(0,r.kt)("h2",{id:"readonly-cells"},"Readonly Cells"),(0,r.kt)("p",null,"Any particular Spreadsheet cell can be set to read-only by just specifying ",(0,r.kt)("inlineCode",{parentName:"p"},"readOnly: true")," in the cell along with the value."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import Spreadsheet from "react-spreadsheet";\n\nconst App = () => {\n const data = [\n [{ value: "Vanilla" }, { value: "Chocolate", readOnly: true }],\n [{ value: "Strawberry" }, { value: "Cookies", readOnly: true }],\n ];\n return ;\n};\n')),(0,r.kt)("h2",{id:"controlled"},"Controlled"),(0,r.kt)("p",null,"The Spreadsheet component accepts the ",(0,r.kt)("inlineCode",{parentName:"p"},"onChange")," prop that is called every time one of the Spreadsheet's cells is changed by the user. You can use it to save the modified data and to react to changes (e.g. validating the modified data, further modifying it, persisting it)."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-javascript"},'import { useState } from "react";\nimport Spreadsheet from "react-spreadsheet";\n\nconst App = () => {\n const [data, setData] = useState([\n [{ value: "Vanilla" }, { value: "Chocolate" }, { value: "" }],\n [{ value: "Strawberry" }, { value: "Cookies" }, { value: "" }],\n ]);\n return ;\n};\n')))}u.isMDXComponent=!0},3905:function(e,t,a){a.d(t,{Zo:function(){return c},kt:function(){return m}});var n=a(7294);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function l(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var i=n.createContext({}),p=function(e){var t=n.useContext(i),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},c=function(e){var t=p(e.components);return n.createElement(i.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var a=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),d=p(a),m=r,h=d["".concat(i,".").concat(m)]||d[m]||u[m]||o;return a?n.createElement(h,l(l({ref:t},c),{},{components:a})):n.createElement(h,l({ref:t},c))}));function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=a.length,l=new Array(o);l[0]=d;var s={};for(var i in t)hasOwnProperty.call(t,i)&&(s[i]=t[i]);s.originalType=e,s.mdxType="string"==typeof e?e:r,l[1]=s;for(var p=2;p=o)&&Object.keys(u.O).every((function(e){return u.O[e](r[c])}))?r.splice(c--,1):(f=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[r,n,o]},u.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return u.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},u.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var o=Object.create(null);u.r(o);var a={};t=t||[null,r({}),r([]),r(r)];for(var f=2&n&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((function(t){a[t]=function(){return e[t]}}));return a.default=function(){return e},u.d(o,a),o},u.d=function(e,t){for(var r in t)u.o(t,r)&&!u.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},u.f={},u.e=function(e){return Promise.all(Object.keys(u.f).reduce((function(t,r){return u.f[r](e,t),t}),[]))},u.u=function(e){return"assets/js/"+({26:"d0929213",34:"b82ebaa3",53:"935f2afb",101:"51acad9b",189:"fb8a53b6",195:"c4f5d8e4",298:"6aee17c2",303:"6c09791d",378:"85e06c3c",514:"1be78505",547:"9e6ab697",559:"a025f20f",663:"6325140b",676:"16dfd63b",805:"e37efcac",918:"17896441"}[e]||e)+"."+{26:"c510bc7c",34:"87944348",53:"1dbff3d6",101:"1dae4b45",189:"4e21fc32",195:"f6eabf8a",298:"2306aa85",303:"ebe2f014",346:"d9bd7ff7",378:"01e7c20f",514:"976816c9",547:"afc126e3",559:"65983175",609:"7a4f9195",663:"75280456",676:"e7f46882",713:"857806c5",805:"7eeb8dba",918:"0fac4e5a"}[e]+".js"},u.miniCssF=function(e){},u.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),u.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},o="react-spreadsheet:",u.l=function(e,t,r,a){if(n[e])n[e].push(t);else{var f,c;if(void 0!==r)for(var i=document.getElementsByTagName("script"),d=0;d=o)&&Object.keys(u.O).every((function(e){return u.O[e](r[f])}))?r.splice(f--,1):(c=!1,o0&&e[d-1][2]>o;d--)e[d]=e[d-1];e[d]=[r,n,o]},u.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return u.d(t,{a:t}),t},r=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},u.t=function(e,n){if(1&n&&(e=this(e)),8&n)return e;if("object"==typeof e&&e){if(4&n&&e.__esModule)return e;if(16&n&&"function"==typeof e.then)return e}var o=Object.create(null);u.r(o);var a={};t=t||[null,r({}),r([]),r(r)];for(var c=2&n&&e;"object"==typeof c&&!~t.indexOf(c);c=r(c))Object.getOwnPropertyNames(c).forEach((function(t){a[t]=function(){return e[t]}}));return a.default=function(){return e},u.d(o,a),o},u.d=function(e,t){for(var r in t)u.o(t,r)&&!u.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},u.f={},u.e=function(e){return Promise.all(Object.keys(u.f).reduce((function(t,r){return u.f[r](e,t),t}),[]))},u.u=function(e){return"assets/js/"+({26:"d0929213",34:"b82ebaa3",53:"935f2afb",101:"51acad9b",189:"fb8a53b6",195:"c4f5d8e4",298:"6aee17c2",303:"6c09791d",378:"85e06c3c",514:"1be78505",547:"9e6ab697",559:"a025f20f",663:"6325140b",676:"16dfd63b",805:"e37efcac",918:"17896441"}[e]||e)+"."+{26:"c510bc7c",34:"87944348",53:"1dbff3d6",101:"1dae4b45",189:"4e21fc32",195:"f6eabf8a",298:"2306aa85",303:"ebe2f014",346:"d9bd7ff7",378:"01e7c20f",514:"976816c9",547:"afc126e3",559:"65983175",609:"7a4f9195",663:"51f1b10a",676:"e7f46882",713:"857806c5",805:"bc76881f",918:"0fac4e5a"}[e]+".js"},u.miniCssF=function(e){},u.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),u.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n={},o="react-spreadsheet:",u.l=function(e,t,r,a){if(n[e])n[e].push(t);else{var c,f;if(void 0!==r)for(var i=document.getElementsByTagName("script"),d=0;d Contributing | React Spreadsheet - +

Contributing

Perquisites​

Make sure you are familiar with the following technologies:

Installation​

Make sure you have the following installed:

Then run:

git clone https://github.com/iddan/react-spreadsheet.git;
cd react-spreadsheet;
yarn install;

Project Structure​

  • src/index.ts - The entry point for the library, exports all the public API.
  • src/Spreadsheet.tsx - The main component for the library.
  • src/engine- The spreadsheet formula evaluation engine for the library.

State management​

The component's state is managed in a single reducer defined in src/reducer.ts and the actions are defined in src/actions.ts. The state is passed to the other components using context (defined in src/context.ts), specifically using use-context-selector to select the required state from the context and avoid unnecessary re-renders.

Main data structures​

  • Matrix - Represents a 2D matrix of cells, used for the spreadsheet data.
  • PointRange - Represents a range in the spreadsheet.
  • Selection - Represents a rectangular selection of cells.
  • CellBase - Represents a single cell in the spreadsheet.
  • Model - Represents the spreadsheet data and the evaluated formulae cells.
  • PointSet - Represents a set of points in the spreadsheet. Used for formulae evaluation only.

Stories​

The component is interactively tested with Storybook. The stories are defined in src/stories/.

Components​

As the Spreadsheet component allows customizing all the components used in the spreadsheet. For instance src/Table.tsx can be overridden with a component from the outside. That's why the props for the components are imported for src/types.ts, so their API will be stable and well defined.

Website​

The website is built with Docusaurus and it's code is available in website/. The docs are in website/docs/ and the main configuration is in website/docusaurus.config.js.

Built with Docusaurus.
- + \ No newline at end of file diff --git a/docs/formula-parser/index.html b/docs/formula-parser/index.html index cd60a3ce..a52d44cd 100644 --- a/docs/formula-parser/index.html +++ b/docs/formula-parser/index.html @@ -4,7 +4,7 @@ Formula Parser | React Spreadsheet - + @@ -12,7 +12,7 @@

Formula Parser

Default​

By default, a regular formula parser (based on Fast Formula Parser) is created. With this come all the formulas and implementations from the Fast Formula Parser.

Custom formula parser​

It is possible to pass a construction function for a formula parser to the <Spreadsheet /> component by assigning it to the createFormulaParser prop. This should be an implementation of the FormulaParser as defined in the Fast Formula Parser library, hence this library should be added as dependency. Thereact-spreadsheet library also exposes a function createFormulaParser to quickly create the implementation as used by default.

Overriding formulas​

The Fast Formula Parser library allows overriding of the formulas as implemented. To leverage this, one could for example disable the SUM function as follows.

import Spreadsheet, {
  createFormulaParser,
  Matrix,
  CellBase,
} from "react-spreadsheet";

const customCreateFormulaParser = (data: Matrix<CellBase>) =>
  createFormulaParser(data, { SUM: undefined });

const MyComponent = () => {
  return (
    <Spreadsheet data={[]} createFormulaParser={customCreateFormulaParser} />
  );
};
Built with Docusaurus.
- + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 50a2506d..ac436b75 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,13 +4,13 @@ Get Started | React Spreadsheet - +

Get Started

Installation​

npm install scheduler react-spreadsheet

or

yarn add scheduler react-spreadsheet
Built with Docusaurus.
- + \ No newline at end of file diff --git a/docs/usage/index.html b/docs/usage/index.html index 19e99079..ef2908e8 100644 --- a/docs/usage/index.html +++ b/docs/usage/index.html @@ -4,13 +4,13 @@ Usage | React Spreadsheet - +
-

Usage

Simple​

The Spreadsheet component requires the data property: an array of arrays with objects that have the value key. Changes made in the Spreadsheet will not affect the passed data array as in React props values should not be mutated.

caution

If the data prop value is changed the component will discard any changes made by the user. If you want to make changes to data and incorporate the user's changes see Controlled.

import Spreadsheet from "react-spreadsheet";

const App = () => {
  const data = [
    [{ value: "Vanilla" }, { value: "Chocolate" }],
    [{ value: "Strawberry" }, { value: "Cookies" }],
  ];
  return <Spreadsheet data={data} />;
};

Custom Columns and Rows​

The Spreadsheet component accepts the columnLabels or rowLabels props, both of which accept arrays. If no columnLabels are supplied, alphabetical labels are used, and row index labels are used if no rowLabels are passed.

import Spreadsheet from "react-spreadsheet";

const App = () => {
  const columnLabels = ["Flavour", "Food"];
  const rowLabels = ["Item 1", "Item 2"];
  const data = [
    [{ value: "Vanilla" }, { value: "Chocolate" }],
    [{ value: "Strawberry" }, { value: "Cookies" }],
  ];
  return <Spreadsheet data={data} columnLabels={columnLabels} rowLabels={rowLabels} />;
};

Readonly Cells​

Any particular Spreadsheet cell can be set to read-only by just specifying readOnly: true in the cell along with the value.

import Spreadsheet from "react-spreadsheet";

const App = () => {
  const data = [
    [{ value: "Vanilla" }, { value: "Chocolate", readOnly: true }],
    [{ value: "Strawberry" }, { value: "Cookies", readOnly: true }],
  ];
  return <Spreadsheet data={data} />;
};

Controlled​

The Spreadsheet component accepts the onChange prop that is called every time one of the Spreadsheet's cells is changed by the user. You can use it to save the modified data and to react to changes (e.g. validating the modified data, further modifying it, persisting it).

import {useState} from "react";
import Spreadsheet from "react-spreadsheet";

const App = () => {
  const [data, setData] = useState([
    [{ value: "Vanilla" }, { value: "Chocolate" }, { value: "" }],
    [{ value: "Strawberry" }, { value: "Cookies" }, { value: "" }],
  ]);
  return <Spreadsheet data={data} onChange={setData} />;
};
Built with Docusaurus.
- +

Usage

Simple​

The Spreadsheet component requires the data property: an array of arrays with objects that have the value key. Changes made in the Spreadsheet will not affect the passed data array as in React props values should not be mutated.

caution

If the data prop value is changed the component will discard any changes made by the user. If you want to make changes to data and incorporate the user's changes see Controlled.

import Spreadsheet from "react-spreadsheet";

const App = () => {
  const data = [
    [{ value: "Vanilla" }, { value: "Chocolate" }],
    [{ value: "Strawberry" }, { value: "Cookies" }],
  ];
  return <Spreadsheet data={data} />;
};

Custom Columns and Rows​

The Spreadsheet component accepts the columnLabels or rowLabels props, both of which accept arrays. If no columnLabels are supplied, alphabetical labels are used, and row index labels are used if no rowLabels are passed.

import Spreadsheet from "react-spreadsheet";

const App = () => {
  const columnLabels = ["Flavour", "Food"];
  const rowLabels = ["Item 1", "Item 2"];
  const data = [
    [{ value: "Vanilla" }, { value: "Chocolate" }],
    [{ value: "Strawberry" }, { value: "Cookies" }],
  ];
  return (
    <Spreadsheet
      data={data}
      columnLabels={columnLabels}
      rowLabels={rowLabels}
    />
  );
};

Readonly Cells​

Any particular Spreadsheet cell can be set to read-only by just specifying readOnly: true in the cell along with the value.

import Spreadsheet from "react-spreadsheet";

const App = () => {
  const data = [
    [{ value: "Vanilla" }, { value: "Chocolate", readOnly: true }],
    [{ value: "Strawberry" }, { value: "Cookies", readOnly: true }],
  ];
  return <Spreadsheet data={data} />;
};

Controlled​

The Spreadsheet component accepts the onChange prop that is called every time one of the Spreadsheet's cells is changed by the user. You can use it to save the modified data and to react to changes (e.g. validating the modified data, further modifying it, persisting it).

import { useState } from "react";
import Spreadsheet from "react-spreadsheet";

const App = () => {
  const [data, setData] = useState([
    [{ value: "Vanilla" }, { value: "Chocolate" }, { value: "" }],
    [{ value: "Strawberry" }, { value: "Cookies" }, { value: "" }],
  ]);
  return <Spreadsheet data={data} onChange={setData} />;
};
Built with Docusaurus.
+ \ No newline at end of file diff --git a/index.html b/index.html index e9aea978..86afb39c 100644 --- a/index.html +++ b/index.html @@ -4,13 +4,13 @@ React Spreadsheet | React Spreadsheet - +

React Spreadsheet

Simple, customizable yet performant spreadsheet for React

Get StartedStorybook
ABCDE
1
2
3
4

Simple

Straightforward API focusing on common use cases while keeping flexibility

Performant

Draw and update tables with many columns and rows without virtualization

Just Components™

The Spreadsheet is just a component, compose it easily with other components and data

Built with Docusaurus.
- + \ No newline at end of file diff --git a/storybook/project.json b/storybook/project.json index 6601fcf6..7d56d695 100644 --- a/storybook/project.json +++ b/storybook/project.json @@ -1 +1 @@ -{"generatedAt":1704421010621,"hasCustomBabel":false,"hasCustomWebpack":false,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"yarn","version":"1.22.21"},"preview":{"usesGlobals":false},"framework":{"name":"@storybook/react-webpack5","options":{}},"builder":"@storybook/builder-webpack5","renderer":"@storybook/react","storybookVersion":"7.4.5","storybookVersionSpecifier":"^7.4.5","language":"typescript","storybookPackages":{"@storybook/blocks":{"version":"7.4.5"},"@storybook/react":{"version":"7.4.5"},"@storybook/react-webpack5":{"version":"7.4.5"},"@storybook/testing-library":{"version":"0.2.1"},"storybook":{"version":"7.4.5"}},"addons":{"@storybook/addon-links":{"version":"7.4.5"},"@storybook/addon-essentials":{"version":"7.4.5"},"@storybook/addon-interactions":{"version":"7.4.5"}}} +{"generatedAt":1704421230449,"hasCustomBabel":false,"hasCustomWebpack":false,"hasStaticDirs":false,"hasStorybookEslint":false,"refCount":0,"packageManager":{"type":"yarn","version":"1.22.21"},"preview":{"usesGlobals":false},"framework":{"name":"@storybook/react-webpack5","options":{}},"builder":"@storybook/builder-webpack5","renderer":"@storybook/react","storybookVersion":"7.4.5","storybookVersionSpecifier":"^7.4.5","language":"typescript","storybookPackages":{"@storybook/blocks":{"version":"7.4.5"},"@storybook/react":{"version":"7.4.5"},"@storybook/react-webpack5":{"version":"7.4.5"},"@storybook/testing-library":{"version":"0.2.1"},"storybook":{"version":"7.4.5"}},"addons":{"@storybook/addon-links":{"version":"7.4.5"},"@storybook/addon-essentials":{"version":"7.4.5"},"@storybook/addon-interactions":{"version":"7.4.5"}}}