Last updated

API / geotoolkit / widgets / datasheet / DataSheet / DataSheet

Namespace: DataSheet

datasheet.DataSheet.DataSheet

Table of contents

Type Aliases

Contents

Type Aliases

EventMap

Ƭ EventMap: EventMap & EventMap


Options

Ƭ Options: Options & WidgetOptions & { data?: string[][] | number[][] | DataTable }

Options for datasheet


Tools

Ƭ Tools: { DataSheetSelection: DataSheetSelection ; Highlight: Highlight ; TableViewColumnHandler: ColumnHandler ; TableViewCompositeTool: CompositeTool ; TableViewHeaderHandler: HeaderHandler ; TableViewHighlight: Highlight ; TableViewPanning: Panning ; TableViewRowHandler: RowHandler ; TableViewSelection: Selection ; TableViewSplitter: Splitter } & Tools


WidgetOptions

Ƭ WidgetOptions: Object

Type declaration

NameTypeDescription
autotablesize?booleanTrue to let DataSheet decides table size if the actual size is smaller than the spcified size, the size will be decided base on supplied data (if defined) or number of rows and columns (if data is not supplied)
cols?numberNumber of columns, will be ignored if autotablesize is True
content?{ activecelllinestyle?: Type ; activerowfillstyle?: Type ; editable?: boolean ; evenfillstyle?: Type ; evenfillstylecolumn?: Type ; gridstyle?: Type ; highlightcolumnfillstyle?: Type ; oddfillstyle?: Type ; oddfillstylecolumn?: Type ; textsizemode?: string | WrapMode ; textstyle?: Type ; validator?: ValidatorPredicate | ValidationPreset }Settings for content of DataSheet
content.activecelllinestyle?TypeLine style of cell when it is set to active
content.activerowfillstyle?TypeFill style of a row in DataSheet content when it is set to active
content.editable?booleanTrue to set cell content to be editable, false otherwise
content.evenfillstyle?TypeFill style of even row in DataSheet content
content.evenfillstylecolumn?TypeFill style for even column in DataSheet content
content.gridstyle?TypeGrid line style of table content
content.highlightcolumnfillstyle?TypeFill style of a column in DataSheet content when it is set to active
content.oddfillstyle?TypeFill style of odd row in DataSheet content
content.oddfillstylecolumn?TypeFill style for odd column in DataSheet content
content.textsizemode?string | WrapModeWrap mode for DataSheet cell
content.textstyle?TypeText style for cell text
content.validator?ValidatorPredicate | ValidationPresetValidation function to validate cell content, validator must be in the form of function (cellContent) and must return a boolean, return true means cell text content is valid, false otherwise, cellContent parameter is cell content to be validated of type string
header?{ evenfillstyle?: Type ; gridstyle?: Type ; headerdata?: string[] ; highlightcolumnfillstyle?: Type ; oddfillstyle?: Type ; textstyle?: Type }Settings for header or column titles row
header.evenfillstyle?TypeFill style of even column in header row
header.gridstyle?TypeGrid line style
header.headerdata?string[]Array of column titles
header.highlightcolumnfillstyle?TypeFill style of a column in header row when it is set to active
header.oddfillstyle?TypeFill style of odd column in header row
header.textstyle?TypeText style for header row
headerheight?numberHeader or column titles height
headervisible?booleanvalue to set header row visibility
highlightrowonhover?booleanTrue to highlight row when hover, false otherwise
horizontalscroll?boolean | "floating"horizontal scroll bar visible or scrollbar floating mode
index?{ activerowfillstyle?: Type ; evenfillstyle?: Type ; gridstyle?: Type ; indexdata?: string[] ; oddfillstyle?: Type ; textstyle?: Type }Settings for index or row titles column
index.activerowfillstyle?TypeFill style of a row in index column when it is set to active
index.evenfillstyle?TypeFill style of even row in index column
index.gridstyle?TypeGrid line style
index.indexdata?string[]Array of row titles
index.oddfillstyle?TypeFill style of odd row in index column
index.textstyle?TypeText style for index column
indextitle?stringTitle of index column or row titles column
indextitlefillstyle?Type-
indexvisible?booleanvalue to set index column visibility
indexwidth?numberIndex or row titles column
mincolumnwidth?numberMinimum column width
minrowheight?numberMinimum row height
model?GroupModel limits for DataSheet
rows?numberNumber of rows, will be ignored if autotablesize is True
verticalscroll?boolean | "floating"vertical scroll bar visible or scrollbar floating mode