SpreadsheetViewSpreadsheet
Note: this document is automatically generated from mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info
Source file
plugins/spreadsheet-view/src/SpreadsheetView/models/Spreadsheet.ts
SpreadsheetViewSpreadsheet - Properties
property: rowSet
// type signature
IOptionalIType<IModelType<{ isLoaded: ISimpleType<true>; rows: IArrayType<IModelType<{ id: ISimpleType<string>; cells: IArrayType<IModelType<{ text: ISimpleType<string>; extendedData: IMaybe<IType<any, any, any>>; }, {}, _NotCustomized, _NotCustomized>>; extendedData: IMaybe<...>; isSelected: IType<...>; }, { ...; }...
// code
rowSet: types.optional(StaticRowSetModel, () => StaticRowSetModel.create())
property: columns
// type signature
IArrayType<IModelType<{ name: IMaybe<ISimpleType<string>>; dataType: IOptionalIType<IAnyType, [undefined]>; isDerived: IType<boolean, boolean, boolean>; derivationFunctionText: IMaybe<...>; }, { ...; }, _NotCustomized, _NotCustomized>>
// code
columns: types.array(ColumnDefinition)
property: columnDisplayOrder
// type signature
IArrayType<ISimpleType<number>>
// code
columnDisplayOrder: types.array(types.number)
property: hasColumnNames
// type signature
false
// code
hasColumnNames: false
property: sortColumns
// type signature
IArrayType<IModelType<{ columnNumber: ISimpleType<number>; descending: IType<boolean, boolean, boolean>; }, { switchDirection(): void; }, _NotCustomized, _NotCustomized>>
// code
sortColumns: types.array(
types
.model('SortColumns', {
columnNumber: types.number,
descending: false,
})
.actions(self => ({
switchDirection() {
self.descending = !self.descending
},
})),
)
SpreadsheetViewSpreadsheet - Getters
getter: initialized
// type
boolean
getter: hideRowSelection
// type
any
getter: dataTypeChoices
list of data type names to be made available in the column dropdown menu
// type
{
typeName: 'Text' | 'LocRef' | 'Number' | 'LocStart' | 'LocEnd' | 'LocString'
displayName: string
categoryName: string
}
;[]
SpreadsheetViewSpreadsheet - Methods
method: rowSortingComparisonFunction
// type signature
rowSortingComparisonFunction: (rowA: { id: string; cells: IMSTArray<IModelType<{ text: ISimpleType<string>; extendedData: IMaybe<IType<any, any, any>>; }, {}, _NotCustomized, _NotCustomized>> & IStateTreeNode<...>; extendedData: any; isSelected: boolean; } & NonEmptyObject & { ...; } & { ...; } & IStateTreeNode<...>, rowB: { ...; } & ... 3 more ...
SpreadsheetViewSpreadsheet - Actions
action: setLoaded
// type signature
setLoaded: (flag: boolean) => void
action: setRowMenuPosition
// type signature
setRowMenuPosition: (newPosition: { anchorEl: Element; rowNumber: string; }) => void
action: setSortColumns
// type signature
setSortColumns: (newSort: readonly ModelCreationType<ExtractCFromProps<{ columnNumber: ISimpleType<number>; descending: IType<boolean, boolean, boolean>; }>>[]) => void
action: setColumnType
// type signature
setColumnType: (columnNumber: number, newTypeName: string) => void
action: unselectAll
// type signature
unselectAll: () => void