Interface VirtualSpreadsheetProps

Props for VirtualSpreadsheet

interface VirtualSpreadsheetProps {
    className?: string;
    columnHeaderHeight?: number;
    data: ReactSpreadsheetData<unknown>;
    height: number;
    inputBarHeight?: number;
    maxColumnCount?: number;
    maxCssSize?: number;
    maxRowCount?: number;
    minColumnCount?: number;
    minNumPages?: number;
    minRowCount?: number;
    readOnly?: boolean;
    rowHeaderWidth?: number;
    theme?: VirtualSpreadsheetTheme | Record<string, string>;
    width: number;
}

Hierarchy (View Summary)

Properties

className? columnHeaderHeight? data height inputBarHeight? maxColumnCount? maxCssSize? maxRowCount? minColumnCount? minNumPages? minRowCount? readOnly? rowHeaderWidth? theme? width

Properties

OptionalclassName

className?: string

The className applied to the spreadsheet as a whole

OptionalcolumnHeaderHeight

columnHeaderHeight?: number

Height of column header

Default Value

50

data

data: ReactSpreadsheetData<unknown>

Data to display and edit

height

height: number

Component height

OptionalinputBarHeight

inputBarHeight?: number

Height of input bar

Default Value

30

OptionalmaxColumnCount

maxColumnCount?: number

Maximum umber of columns in the grid

Default Value

1000000000000

OptionalmaxCssSize

maxCssSize?: number

Maximum size for CSS element beyond which layout breaks. You should never normally need to change this. The default value is compatible with all major browsers.

Default Value

6000000

OptionalmaxRowCount

maxRowCount?: number

Maximum number of rows in the spreadsheet

Default Value

1000000000000

OptionalminColumnCount

minColumnCount?: number

Minimum number of columns in the grid

Default Value

26

OptionalminNumPages

minNumPages?: number

The minimum number of virtual pages to use when inner container would otherwise be more than VirtualSpreadsheetProps.maxCssSize big. You should never normally need to change this.

Default Value

100

OptionalminRowCount

minRowCount?: number

Minimum number of rows in the spreadsheet

Default Value

100

OptionalreadOnly

readOnly?: boolean

Disables edit mode if true

Default Value

false

OptionalrowHeaderWidth

rowHeaderWidth?: number

Width of row header

Default Value

100

Optionaltheme

theme?: VirtualSpreadsheetTheme | Record<string, string>

Spreadsheet theme which defines the CSS classes to apply

Defined as a union so that it supports both hand written themes defined as implementations of VirtualSpreadsheetTheme and themes implicitly defined by importing a CSS module.

width

width: number

Component width

Settings

Member Visibility

On This Page

Properties