IronCalc Wasm
    Preparing search index...

    Class Model

    Index
    [dispose] addConditionalFormatting applyExternalDiffs autoFillColumns autoFillRows canRedo canUndo copyToClipboard createNamedStyle cycleReference deleteColumns deleteConditionalFormatting deleteDefinedName deleteNamedStyle deleteRows deleteSheet duplicateSheet evaluate flushSendQueue free getBuiltinNamedStyles getCellArrayStructure getCellContent getCellStyle getCellType getColumnsWithData getColumnWidth getConditionalFormattingList getDefinedNameList getDxfForConditionalFormatting getFirstNonEmptyInRowAfterColumn getFmtSettings getFormattedCellValue getFormulaCompletion getFrozenColumnsCount getFrozenRowsCount getLanguage getLastNonEmptyInRowBeforeColumn getLocale getName getNamedStyle getNamedStyleIncludes getNamedStyleList getRowHeight getRowsWithData getScrollX getScrollY getSelectedCell getSelectedSheet getSelectedView getShowGridLines getTheme getTimezone getWorksheetsProperties hideSheet insertColumns insertRows isValidDefinedName lowerConditionalFormattingPriority moveColumns moveRows moveSheet newDefinedName newSheet onApplyNamedStyle onAreaSelecting onArrowDown onArrowLeft onArrowRight onArrowUp onExpandSelectedRange onNavigateToEdgeInDirection onPageDown onPageUp onPasteStyles pasteCsvText pasteFromClipboard pauseEvaluation raiseConditionalFormattingPriority rangeClearAll rangeClearContents rangeClearFormatting redo renameSheet resolveColor resumeEvaluation setAreaWithBorder setColumnsHidden setColumnsWidth setFrozenColumnsCount setFrozenRowsCount setLanguage setLocale setName setRowsHeight setRowsHidden setSelectedCell setSelectedRange setSelectedSheet setSheetColor setShowGridLines setTheme setTimezone setTopLeftVisibleCell setUserArrayFormula setUserInput setWindowHeight setWindowWidth toBytes undo unhideSheet updateConditionalFormatting updateDefinedName updateNamedStyle updateRangeStyle from_bytes
    • Parameters

      • name: string
      • locale: string
      • timezone: string
      • language_id: string

      Returns Model

    • Returns void

    • Parameters

      Returns void

    • Parameters

      • diffs: Uint8Array

      Returns void

    • Parameters

      • source_area: Area
      • to_column: number

      Returns void

    • Parameters

      • source_area: Area
      • to_row: number

      Returns void

    • Returns boolean

    • Returns boolean

    • Creates a new named style. includes selects which formatting categories the style carries.

      Parameters

      Returns void

    • Cycles the references touched by the cursor through the four absolute/relative states, Excel F4 style: A1 -> $A$1 -> A$1 -> $A1 -> A1. Returns the new text together with the new cursor start and end. start and end are char offsets into value.

      Parameters

      • value: string
      • start: number
      • end: number

      Returns [string, number, number]

    • Parameters

      • sheet: number
      • column: number
      • column_count: number

      Returns void

    • Parameters

      • sheet: number
      • index: number

      Returns void

    • Parameters

      • name: string
      • Optionalscope: number | null

      Returns void

    • Parameters

      • name: string

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • row_count: number

      Returns void

    • Parameters

      • sheet: number

      Returns void

    • Parameters

      • sheet: number

      Returns void

    • Returns void

    • Returns Uint8Array

    • Returns void

    • Returns all Excel built-in named styles as a NamedStyle[]. These are always available regardless of whether the workbook uses them.

      Returns NamedStyle[]

    • Parameters

      • sheet: number
      • row: number
      • column: number

      Returns CellArrayStructure

    • Parameters

      • sheet: number
      • row: number
      • column: number

      Returns string

    • Parameters

      • sheet: number
      • row: number
      • column: number

      Returns ExtendedCellStyle

    • Parameters

      • sheet: number
      • row: number
      • column: number

      Returns number

    • Parameters

      • sheet: number
      • row: number

      Returns Int32Array

    • Parameters

      • sheet: number
      • column: number

      Returns number

    • Parameters

      • sheet: number
      • index: number

      Returns Dxf | null

    • Parameters

      • sheet: number
      • row: number
      • column: number

      Returns number | undefined

    • Parameters

      • sheet: number
      • row: number
      • column: number

      Returns string

    • Returns completion information for a formula being edited in a cell. formula is the raw cell input (it may start with =) and cursor is a char offset into it.

      Parameters

      • sheet: number
      • row: number
      • column: number
      • formula: string
      • cursor: number

      Returns CompletionContext

    • Parameters

      • sheet: number

      Returns number

    • Parameters

      • sheet: number

      Returns number

    • Gets the language of the model

      Returns string

    • Parameters

      • sheet: number
      • row: number
      • column: number

      Returns number | undefined

    • Gets the locale of the model

      Returns string

    • Returns string

    • Parameters

      • name: string

      Returns CellStyle

    • Returns which formatting categories the named style includes.

      Parameters

      • name: string

      Returns StyleIncludes

    • Returns string[]

    • Parameters

      • sheet: number
      • row: number

      Returns number

    • Parameters

      • sheet: number
      • column: number

      Returns Int32Array

    • Returns number

    • Returns number

    • Returns Int32Array

    • Returns number

    • Parameters

      • sheet: number

      Returns boolean

    • Gets the timezone of the model

      Returns string

    • Parameters

      • sheet: number

      Returns void

    • Parameters

      • sheet: number
      • column: number
      • column_count: number

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • row_count: number

      Returns void

    • Parameters

      • name: string
      • scope: number | null | undefined
      • formula: string

      Returns void

    • Parameters

      • sheet: number
      • index: number

      Returns void

    • Parameters

      • sheet: number
      • column: number
      • column_count: number
      • delta: number

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • row_count: number
      • delta: number

      Returns void

    • Parameters

      • sheet: number
      • new_index: number

      Returns void

    • Parameters

      • name: string
      • scope: number | null | undefined
      • formula: string

      Returns void

    • Returns void

    • Applies a named style to the current selection. If the style is a built-in not yet in the workbook, it is added first.

      Parameters

      • name: string

      Returns void

    • Parameters

      • target_row: number
      • target_column: number

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • key: string

      Returns void

    • Parameters

      • direction: string

      Returns void

    • Returns void

    • Returns void

    • Parameters

      Returns void

    • Parameters

      • area: Area
      • csv: string

      Returns void

    • Parameters

      • source_sheet: number
      • source_range: [number, number, number, number]
      • clipboard: ClipboardData
      • is_cut: boolean

      Returns void

    • Returns void

    • Parameters

      • sheet: number
      • index: number

      Returns void

    • Parameters

      • sheet: number
      • start_row: number
      • start_column: number
      • end_row: number
      • end_column: number

      Returns void

    • Parameters

      • sheet: number
      • start_row: number
      • start_column: number
      • end_row: number
      • end_column: number

      Returns void

    • Parameters

      • sheet: number
      • start_row: number
      • start_column: number
      • end_row: number
      • end_column: number

      Returns void

    • Returns void

    • Parameters

      • sheet: number
      • name: string

      Returns void

    • Resolves a Color value to a CSS hex string using the current workbook theme. Accepts Color; returns "" for absent/None colors.

      Parameters

      Returns string

    • Returns void

    • Parameters

      Returns void

    • Parameters

      • sheet: number
      • column_start: number
      • column_end: number
      • hidden: boolean

      Returns void

    • Parameters

      • sheet: number
      • column_start: number
      • column_end: number
      • width: number

      Returns void

    • Parameters

      • sheet: number
      • count: number

      Returns void

    • Parameters

      • sheet: number
      • count: number

      Returns void

    • Sets the language of the model

      Parameters

      • language: string

      Returns void

    • Parameters

      • locale: string

      Returns void

    • Parameters

      • name: string

      Returns void

    • Parameters

      • sheet: number
      • row_start: number
      • row_end: number
      • height: number

      Returns void

    • Parameters

      • sheet: number
      • row_start: number
      • row_end: number
      • hidden: boolean

      Returns void

    • Parameters

      • row: number
      • column: number

      Returns void

    • Parameters

      • start_row: number
      • start_column: number
      • end_row: number
      • end_column: number

      Returns void

    • Parameters

      • sheet: number

      Returns void

    • Parameters

      • sheet: number
      • color: Color

      Returns void

    • Parameters

      • sheet: number
      • show_grid_lines: boolean

      Returns void

    • Sets the workbook theme.

      Parameters

      Returns void

    • Parameters

      • timezone: string

      Returns void

    • Parameters

      • top_row: number
      • top_column: number

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • column: number
      • width: number
      • height: number
      • formula: string

      Returns void

    • Parameters

      • sheet: number
      • row: number
      • column: number
      • input: string

      Returns void

    • Parameters

      • window_height: number

      Returns void

    • Parameters

      • window_width: number

      Returns void

    • Returns Uint8Array

    • Returns void

    • Parameters

      • sheet: number

      Returns void

    • Parameters

      • sheet: number
      • index: number
      • new_range: string
      • new_rule: CfRuleInput

      Returns void

    • Parameters

      • name: string
      • scope: number | null | undefined
      • new_name: string
      • new_scope: number | null | undefined
      • new_formula: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      • range: Area
      • style_path: string
      • value: string

      Returns void

    • Parameters

      • bytes: Uint8Array
      • language_id: string

      Returns Model