API reference
@searsuite/sear-plugin-sort
Sheet range sorting commands and stable sparse row permutation helpers.
10 exportsderived from source
- enumSheetSortDirectionsource ↗
-
enum SheetSortDirectionenum memberAscending Ascending: "ascending"enum memberDescending Descending: "descending" - classSheetSortErrorsource ↗
-
class SheetSortError extends SearErrorBase class for errors intentionally exposed by SearSuite packages.
Packages may throw this generic form while they do not need a more specific public error type. Domain-specific subclasses override
code.constructorconstructor SheetSortError(message: string, details: Record<string, unknown>): SheetSortErrormessage: stringdetails: Record<string, unknown>
propertycode readonly code: "SHEET_SORT_INVALID_INPUT"Stable machine-readable identifier for this error category.
Inherited members 9
Inherited from SearError.
- classSheetSortPluginsource ↗
-
class SheetSortPlugin extends Plugin<unknown, CellProperties, Record<string, never>>Stateless command owner for stable range sorting.
constructorconstructor SheetSortPlugin(dependencies: SheetSortDependencies): SheetSortPlugindependencies: SheetSortDependencies
propertywarnOnDuplicateDepth readonly warnOnDuplicateDepth: falseWhether PluginManager should warn when another ordered plugin shares this depth.
propertypluginKeystatic readonly pluginKey: PluginKeypropertysymbolstatic readonly symbol: typeof symbolmethodapply apply(state: Record<string, never>, _transaction: Transaction): Record<string, never>Applies a transaction to plugin-owned state and returns the next state.
state: Record<string, never>_transaction: Transaction
methodgetPluginConfig getPluginConfig(): nullReturns this plugin's runtime configuration view for the current core.
methodregisterCommands registerCommands(commands: SheetCommandBus): voidcommands: SheetCommandBus
methodregisterState registerState(): { dataEngine: { enabled: boolean }; key: PluginKey; state: Record<string, never> }Registers one or more plugin-owned state records with the host manager.
methodrender render(): []Produces scene nodes owned by this plugin for the current core state.
Inherited members 29
Inherited from Plugin.
- depth
- documentState
- interestedIn
- pluginKey
- transactionHistory
- transactionOT
- key
- dirtyRect
- enforceRuntimeWriteBoundary
- enforceStateWriteBoundary
- getState
- hasStateWriteBoundary
- lockCommittedState
- onClick
- onDblClick
- onInitialDataCell
- onInitialDataComplete
- onMouseDown
- onMouseMove
- onMouseUp
- onResize
- onScroll
- onTransactionCommitted
- projectTransaction
- registerConfig
- sealRuntimeMetadata
- sealRuntimeMethods
- sealRuntimeWrites
- setState
- interfaceSheetSortDependenciessource ↗
-
interface SheetSortDependenciespropertycompareText readonly compareText: (left: string, right: string): numberpropertyplatform readonly platform: Pick<Platform, "toLowerCase">propertyreadMatrix readonly readMatrix: (): CSRMatrix<CellMatrixElement>propertyreadValue readonly readValue: (row: number, column: number): SheetSortValuepropertyreorders readonly reorders: SheetRangeReorderRegistry - interfaceSheetSortKeysource ↗
-
interface SheetSortKey - interfaceSheetSortPermutationsource ↗
-
interface SheetSortPermutationpropertychanged readonly changed: booleanpropertydestinationOf readonly destinationOf: (row: number): numberpropertyrange readonly range: SheetMoveRange - interfaceSheetSortRangeInputsource ↗
-
interface SheetSortRangeInputpropertyfirstRowIsHeader readonly firstRowIsHeader?: booleanpropertykeys readonly keys: readonly SheetSortKey[]propertyrange readonly range: SheetMoveRange - typeSheetSortValuesource ↗
-
type SheetSortValue = number | string | boolean | null - variableSortSheetRangeCommandsource ↗
-
SortSheetRangeCommand: SheetCommandDefinition<SheetSortRangeInput, SheetCommandResult> - functioncreateSheetSortPermutationsource ↗
-
createSheetSortPermutation(input: SheetSortRangeInput, matrix: CSRMatrix<CellMatrixElement>, readValue: (row: number, column: number): SheetSortValue, platform: Pick<Platform, "toLowerCase">, compareText: (left: string, right: string): number): SheetSortPermutationSorts occupied key rows; rows with empty keys remain stable at the end without being materialized.
input: SheetSortRangeInputmatrix: CSRMatrix<CellMatrixElement>readValue: (row: number, column: number): SheetSortValueplatform: Pick<Platform, "toLowerCase">compareText: (left: string, right: string): number
No public exports match that search.