Formulon

English

日本語

English

日本語

Appearance

Platform and Mac UI ​

The spreadsheet platform is selected with ui.platform. It is independent of ui.profile: the profile chooses the feature surface, while the platform chooses platform-specific interaction details and ribbon layout.

ValueBehavior
defaultUse the default spreadsheet surface. This is the default when platform is omitted.
macOpt in explicitly to the Mac ribbon and Mac interaction surface.
autoResolve from the browser platform. iPad and iPhone user agents, including touch-enabled MacIntel, fall back to default.

Use the resolver when the host needs the result before mounting:

ts
import {
  resolveSpreadsheetPlatform,
  Spreadsheet,
  type SpreadsheetPlatform,
} from '@libraz/formulon-cell'

const requested: SpreadsheetPlatform = 'auto'
const resolved = resolveSpreadsheetPlatform(requested)
const instance = await Spreadsheet.mount(host, {
  ui: { profile: 'excel365', platform: requested },
})

console.log(resolved) // 'mac' or 'default'

ui.platform does not change the selected ui.profile. For example, { profile: 'embedded', platform: 'mac' } keeps an embedded surface while opting into the Mac platform behavior. A host can change both values after mount:

ts
instance.setUi({ profile: 'excel365', platform: 'mac', theme: 'paper' })

setUi() keeps the current workbook and re-resolves the profile, platform, and theme. Pass the complete desired UI configuration: omitted fields return to their defaults. It also reapplies the top-level features, theme, and toolbar overrides supplied at mount. Changing away from Mac closes an open formula palette and discards its suspended draft; the workbook itself is not replaced. Use setFeatures(), setTheme(), or setToolbar() when only one top-level setting should change. See Options for precedence rules.

Mac ribbon ​

The Mac platform supplies its own ribbon tabs, shortcuts, and dialog routes. A host that builds a separate toolbar can select the published ribbon model explicitly:

ts
import { buildRibbonModel, type RibbonProfile } from '@libraz/formulon-cell'

const profile: RibbonProfile = 'excel365Mac'
const tabs = buildRibbonModel('en', { profile })

The built-in Mac ribbon is available through ui.platform: 'mac'. Its Draw tab exposes black and red pens, a pencil, a highlighter, an eraser, and trackpad controls. Ink is stored in the mounted session illustration layer, with at most 2,000 points per stroke; it is not written to workbook data or persisted in an .xlsx file. The active policy still authorizes the affected cells before a stroke is committed.

With the shortcuts feature enabled, the grid supports these Mac bindings:

ShortcutAction
Control+UEdit the active cell using its existing content.
Command+Control+VOpen Paste Special when that feature is enabled.
Option+Left / Option+RightMove to the previous or next sheet.

Function Arguments palette ​

The Mac Function Arguments palette is nonmodal. Opening it suspends an inline or formula-bar draft. Cancel restores the draft text, focus, and caret or selection, including when the caret is inside a function call in a compound formula. Editing a function argument changes that call while preserving the surrounding formula. The picker reads the live workbook catalog and groups functions into families. Recent records successfully inserted functions for the mounted spreadsheet store.

Use openFunctionArguments(seedName?, { category }) to open it from host UI. category is ignored when seedName names a function; supported categories include all, recent, logical, lookup, text, datetime, math, financial, dynamicArray, statistical, engineering, information, database, compatibility, cube, and web.

getFunctionArgumentHelp receives the canonical function name, a zero-based argument index, and the active locale. An omitted label uses the catalog argument label. Descriptions and reference links come from the host provider. The palette reads the help link from the result for argument index 0; object property order has no effect.

ts
import { Spreadsheet, type FunctionArgumentHelpProvider } from '@libraz/formulon-cell'

const getFunctionArgumentHelp: FunctionArgumentHelpProvider = (
  functionName,
  argumentIndex,
  locale,
) => {
  if (functionName.toUpperCase() !== 'SUM' || argumentIndex !== 0) return null
  const japanese = locale.toLowerCase().startsWith('ja')
  return {
    url: japanese ? '/ja/workbook/formula-engine' : '/workbook/formula-engine',
    label: japanese ? '数値' : 'numbers',
    description: japanese ? '加算する値または範囲です。' : 'The values or range to add.',
  }
}

const instance = await Spreadsheet.mount(host, {
  ui: { profile: 'excel365', platform: 'mac' },
  getFunctionArgumentHelp,
})

The React and Vue adapters export FunctionArgumentHelp and FunctionArgumentHelpProvider and pass the callback through to the core mount. The Vue example receives the callback as a component prop:

tsx
import { Spreadsheet } from '@libraz/formulon-cell-react'

<Spreadsheet
  ui={{ profile: 'excel365', platform: 'mac' }}
  getFunctionArgumentHelp={getFunctionArgumentHelp}
/>
vue
<script setup lang="ts">
import { Spreadsheet } from '@libraz/formulon-cell-vue'
import type { FunctionArgumentHelpProvider } from '@libraz/formulon-cell-vue'

defineProps<{ getFunctionArgumentHelp: FunctionArgumentHelpProvider }>()
</script>

<template>
  <Spreadsheet
    :ui="{ profile: 'excel365', platform: 'mac' }"
    :get-function-argument-help="getFunctionArgumentHelp"
  />
</template>

Mac ribbon dialogs ​

The Mac ribbon opens these dialogs. A host-owned toolbar can dispatch the listed command through ToolbarInstance.applyCommand(id); framework adapters expose the toolbar instance through onToolbarReady. The boolean return value reports whether a handler matched. Goal Seek, Consolidate, and Subtotal check the instance policy before changing workbook data.

Ribbon routeCommand IDSupported behavior and limits
Data → What-If Analysis → Goal Seekmac.data.goalSeekIterative solve with at most 100 iterations.
Data → Consolidatemac.data.consolidatesum, average, count, min, or max; the combined source area is limited to 100,000 cells.
Data → Subtotalmac.data.subtotalActive sheet only; up to 100,000 input rows, 100,000 output cells, and 1,000 groups. The engine must support SUBTOTAL, objects that the operation cannot process are rejected, and the output needs room.
Insert → Sparklinemac.insert.sparklineRectangular source range, one-cell destination, and line, column, or win-loss kinds.
Insert → Slicermac.insert.slicerRequires an existing workbook table and one of its columns.
Review → Workbook Statisticsmac.review.statsCounts sheets, populated cells, formulas, numbers, text, booleans, errors, tables, comments, hyperlinks, used rows, and used columns; it recounts when opened.

Subtotal and other Mac data changes remain policy-controlled and undoable. See Options, API surface, Modals and dialogs, and Embedding for host policy, overlay, and helper details.