OPEN_GRID API - v1.5.2
    Preparing search index...

    Interface OpenGridInstance<T>

    new OpenGrid(...) 로 만든 그리드가 밖에 내어 주는 조작 창구(메서드 모음)입니다. 데이터 넣기·읽기, 행·컬럼 편집, 정렬·필터, 선택, 내보내기, 테마 전환 등 그리드에게 시킬 수 있는 모든 일이 여기 모여 있습니다. 각 메서드의 자세한 설명은 이 계약을 구현하는 OpenGrid 클래스 쪽에 있습니다.

    The set of methods a grid built with new OpenGrid(...) exposes — everything you can ask the grid to do: load/read data, edit rows & columns, sort/filter, select, export, switch themes, and more. Per-method detail lives on the OpenGrid class that implements this contract.

    new OpenGrid(...) で作ったグリッドが外に差し出す操作の窓口（メソッド群）です。データの投入・読み取り、 行・列の編集、並べ替え・フィルター、選択、エクスポート、テーマ切り替えなど、グリッドに頼めるすべてのことが ここに集まっています。各メソッドの詳しい説明は、この契約を実装する OpenGrid クラス側にあります。

    用 new OpenGrid(...) 创建的表格对外提供的操作窗口（方法集合）。载入／读取数据、编辑行与列、 排序／过滤、选择、导出、切换主题等一切能让表格做的事都汇集在这里。各方法的详细说明在实现本契约的 OpenGrid 类那一侧。

    interface OpenGridInstance<T = any> {
        override: OverrideApi<T>;
        activate(index: number): void;
        addCheckById(ids: string[]): void;
        addTreeRow(item: Partial<T>, parentId: string, position?: Position): void;
        addTrigger(event: string, handler: TriggerHandler): this;
        addWorksheet(name: string, columns?: ColumnDef<T>[], data?: T[]): void;
        applyColumns(columns: ColumnDef<T>[]): void;
        beginBatch(): void;
        calcColWidths(fitToGrid?: boolean): number[];
        checkById(ids: string[]): void;
        checkByValue(field: string, values: any[]): void;
        clearCellFormula(rowIndex: number, field: string): void;
        clearData(): void;
        clearGroup(): void;
        clearHistory(): void;
        clearRangeSelection(): void;
        clearTriggers(event?: string): this;
        closeContextMenu(): void;
        collapseAll(): void;
        collapseAllDetails(): void;
        collapseRow(rowRef: number | { id: string }): void;
        createChart(config: ChartConfig): ChartInstance;
        deleteById(ids: string[]): void;
        deleteColumn(field: string): void;
        deleteRow(rowIndex: number | number[]): void;
        deselect(): void;
        destroy(): void;
        destroyCharts(): void;
        emit(event: string, data?: any): void;
        endBatch(): void;
        expandAll(): void;
        expandNodes(ids: string | string[], open?: boolean): void;
        expandRow(rowRef: number | { id: string }): void;
        exportCsv(options?: string | ExportOptions): void;
        exportExcel(options?: string | ExportOptions): void;
        exportJson(options?: string | ExportOptions): void;
        exportSheetsExcel(filename?: string): void;
        fillRange(
            source: CellRange,
            target: CellRange,
            mode?: "copy" | "series",
        ): void;
        freeze(columnCount: number): void;
        freezeRows(rowCount: number): void;
        getActiveRange(): CellRange | null;
        getActiveRow(): number;
        getAddedRows(): T[];
        getAllChecked(): T[];
        getAllColumnDefs(): ColumnDef<T>[];
        getCellError(rowIndex: number, field: string): FormulaErrorCode | null;
        getCellFormula(rowIndex: number, field: string): string | null;
        getChangedColumns(): {
            diff: { field: string; newValue: any; oldValue: any }[];
            fields: string[];
            row: T;
        }[];
        getChangedRows(): T[];
        getChanges(): { added: T[]; edited: T[]; removed: T[] };
        getCharts(): ChartInstance[];
        getChecked(): { row: T; rowIndex: number }[];
        getColumnCount(): number;
        getColumnDefs(): ColumnDef<T>[];
        getColumnIndex(field: string): number;
        getColValues(field: string, all?: boolean): any[];
        getData(): T[];
        getDependents(
            rowIndex: number,
            field: string,
        ): { field: string; rowIndex: number }[];
        getDetailInstance<D = any>(rowRef: number | { id: string }): D | undefined;
        getDisplayValue(rowIndex: number, field: string): string;
        getEditedRows(): T[];
        getFieldAt(index: number): string;
        getFilterState(): Record<string, FilterItem[]>;
        getFlatRowModel(): FlatRowModel;
        getFooterData(): any[];
        getFooterValue(field: string): any;
        getLocale(): string;
        getMaskEnabled(field: string): boolean;
        getOriginalRow(rowIndex: number): T | undefined;
        getOverrideNames(): string[];
        getPrecedents(
            rowIndex: number,
            field: string,
        ): { field: string; rowIndex: number }[];
        getRangeSelection(): CellRange[];
        getRangeStats(): RangeStats | null;
        getRangeValues(): any[][];
        getRemovedRows(): T[];
        getRowAt(rowIndex: number): T;
        getRowsWithState(stateField: string): T[];
        getScrollPos(): { x: number; y: number };
        getSelections(): T[];
        getSkin(): string;
        getSourceRows(): T[];
        getStrategy<F extends Function>(slot: string, fallback: F): F;
        getUniqueValues(field: string, all?: boolean): any[];
        getWorksheet(name: string): WorksheetState<T> | undefined;
        getWorksheetNames(): string[];
        groupBy(fields: string[]): void;
        hasCellFormula(rowIndex: number, field: string): boolean;
        hasOverride(name: string): boolean;
        hideColumn(field: string | string[]): void;
        insertColumn(colDef: ColumnDef<T>, position?: Position): void;
        insertRow(item: Partial<T>, position?: Position): void;
        isRowExpanded(rowRef: number | { id: string }): boolean;
        jumpToCol(field: string): void;
        jumpToRow(rowIndex: number): void;
        moveCheckedTo(target: OpenGridInstance<T>): Promise<boolean>;
        moveRowsTo(
            target: OpenGridInstance<T>,
            sourceIndexes: number[],
            targetIndex?: number,
        ): Promise<boolean>;
        off(event: string, handler?: Function): OpenGridInstance<T>;
        offsetFormula(
            srcRowId: string,
            srcField: string,
            dRow: number,
            dCol: number,
        ): string;
        on(event: string, handler: Function): OpenGridInstance<T>;
        once(event: string, handler: Function): OpenGridInstance<T>;
        openContextMenu(e: MouseEvent, items?: ContextMenuItem[]): void;
        orderBy(field: string, dir?: SortDir): void;
        orderBy(sortList: SortItem[]): void;
        prefixData(data: T[]): void;
        print(options?: PrintOptions): void;
        pushData(data: T[]): void;
        pushRow(items: Partial<T> | Partial<T>[]): void;
        readCell<K extends string | number | symbol>(
            rowIndex: number,
            field: K,
        ): T[K];
        readCell(rowIndex: number, field: string): any;
        recalculate(): void;
        recalculateCell(rowIndex: number, field: string): void;
        redo(): void;
        removeTrigger(event: string, handler: TriggerHandler): this;
        removeWorksheet(name: string): void;
        renameWorksheet(oldName: string, newName: string): void;
        resetFilter(field?: string): void;
        resetOrder(): void;
        resize(width?: number, height?: number): void;
        restore(name: string): OpenGridInstance<T>;
        restoreAll(): OpenGridInstance<T>;
        restoreFilter(state: Record<string, FilterItem[]>): void;
        resyncPanelWidths(): void;
        setCellFormula(rowIndex: number, field: string, formula: string): void;
        setColWidths(widths: number[]): void;
        setConditionalFormat(rules: CFRule[]): Promise<void>;
        setData(data: T[]): void;
        setDensity(name: string): void;
        setFilter(field: string, filterItems: FilterItem[]): void;
        setFilterSelect(config: FilterSelectConfig | null): void;
        setFooter(footerDef: FooterDef[]): void;
        setLocale(locale: string): void;
        setMaskEnabled(field: string, enabled: boolean): void;
        setMessage(key: string, value: MessageValue): OpenGridInstance<T>;
        setOptions(opts: Partial<GridOptions<T>>): void;
        setRangeSelection(range: CellRange | CellRange[]): void;
        setSkin(skin: string): void;
        setSkinVar(varName: string, value: string): void;
        setTexture(name: string): void;
        setTheme(theme: string): void;
        setThemeVar(varName: string, value: string): void;
        showColumn(field: string | string[]): void;
        switchWorksheet(name: string): void;
        t(key: string, params?: Record<string, string | number>): string;
        toArray(keyValue?: boolean): any[];
        toggleRow(rowRef: number | { id: string }): void;
        uncheckAll(): void;
        uncheckById(ids: string[]): void;
        undo(): void;
        unshiftRow(items: Partial<T> | Partial<T>[]): void;
        writeCell(rowIndex: number, field: string, value: any): void;
        writeCells(
            patches: { field: string; rowIndex: number; value: any }[],
        ): number;
    }

    Type Parameters

    • T = any

      행 데이터 타입

      Row data type

      行データの型

      行数据类型

    Implemented by

    Index

    Properties

    override

    Methods

    activate addCheckById addTreeRow addTrigger addWorksheet applyColumns beginBatch calcColWidths checkById checkByValue clearCellFormula clearData clearGroup clearHistory clearRangeSelection clearTriggers closeContextMenu collapseAll collapseAllDetails collapseRow createChart deleteById deleteColumn deleteRow deselect destroy destroyCharts emit endBatch expandAll expandNodes expandRow exportCsv exportExcel exportJson exportSheetsExcel fillRange freeze freezeRows getActiveRange getActiveRow getAddedRows getAllChecked getAllColumnDefs getCellError getCellFormula getChangedColumns getChangedRows getChanges getCharts getChecked getColumnCount getColumnDefs getColumnIndex getColValues getData getDependents getDetailInstance getDisplayValue getEditedRows getFieldAt getFilterState getFlatRowModel getFooterData getFooterValue getLocale getMaskEnabled getOriginalRow getOverrideNames getPrecedents getRangeSelection getRangeStats getRangeValues getRemovedRows getRowAt getRowsWithState getScrollPos getSelections getSkin getSourceRows getStrategy getUniqueValues getWorksheet getWorksheetNames groupBy hasCellFormula hasOverride hideColumn insertColumn insertRow isRowExpanded jumpToCol jumpToRow moveCheckedTo moveRowsTo off offsetFormula on once openContextMenu orderBy prefixData print pushData pushRow readCell recalculate recalculateCell redo removeTrigger removeWorksheet renameWorksheet resetFilter resetOrder resize restore restoreAll restoreFilter resyncPanelWidths setCellFormula setColWidths setConditionalFormat setData setDensity setFilter setFilterSelect setFooter setLocale setMaskEnabled setMessage setOptions setRangeSelection setSkin setSkinVar setTexture setTheme setThemeVar showColumn switchWorksheet t toArray toggleRow uncheckAll uncheckById undo unshiftRow writeCell writeCells

    Properties

    override: OverrideApi<T>

    공개 메서드를 런타임에 감싸 동작을 바꾸거나(.override), 정렬·포맷 같은 알고리즘 슬롯을 갈아 끼웁니다(.strategy).

    Wrap a public method at runtime to change its behavior (.override), or swap an algorithm slot like sorting/formatting (.strategy).

    公開メソッドをランタイムで包んで動作を変えたり（.override）、並べ替え・フォーマットのような アルゴリズムスロットを差し替えたりします（.strategy）。

    在运行时包裹公开方法以改变其行为（.override），或替换排序、格式化这类算法插槽（.strategy）。

    Methods

    • Parameters

      • index: number

      Returns void

    • Parameters

      • ids: string[]

      Returns void

    • Parameters

      • item: Partial<T>
      • parentId: string
      • Optionalposition: Position

      Returns void

    • 트리거 등록.

      • 'before:{op}' : 작업 실행 전 호출. ctx.cancel() 시 해당 작업 중단.
      • 'after:{op}' : 작업 완료 후 호출. ctx.result에 결과 포함.
      • 'complete' : 모든 작업 완료 후 공통 핸들러.

      トリガーの登録。

      • 'before:{op}' : 作業の実行前に呼び出し。ctx.cancel() で該当作業を中断。
      • 'after:{op}' : 作業の完了後に呼び出し。ctx.result に結果を含む。
      • 'complete' : すべての作業の完了後の共通ハンドラー。

      触发器的注册。

      • 'before:{op}' : 在操作执行前调用。ctx.cancel() 可中断该操作。
      • 'after:{op}' : 在操作完成后调用。ctx.result 中包含结果。
      • 'complete' : 所有操作完成后的公共处理器。

      Parameters

      Returns this

      grid.addTrigger('before:insertRow', ctx => {
        if (!ctx.args[0]?.name) ctx.cancel(); // 이름 없으면 삽입 중단
      });
      grid.addTrigger('after:setData', ctx => {
        console.log('로드 완료:', ctx.result, '건');
      });

    • Parameters

      • name: string
      • Optionalcolumns: ColumnDef<T>[]
      • Optionaldata: T[]

      Returns void

    • Parameters

      Returns void

    • 여러 셀을 한꺼번에 쓸 때, 이 호출 이후의 writeCell 들이 즉시 다시 그리지 않도록 렌더를 잠시 미룹니다.

      Start a batch — subsequent writeCell calls defer their render/change events instead of firing each time.

      複数のセルをまとめて書くとき、この呼び出し以降の writeCell が即座に再描画しないようにレンダリングを しばらく先送りします。

      批量写入多个单元格时，让此调用之后的各次 writeCell 不立即重绘，而是暂缓渲染。

      Returns void

    • Parameters

      • OptionalfitToGrid: boolean

      Returns number[]

    • Parameters

      • ids: string[]

      Returns void

    • Parameters

      • field: string
      • values: any[]

      Returns void

    • 셀의 수식만 지웁니다(마지막 계산 값은 남습니다).

      Remove the cell's formula (keeps the last computed value).

      セルの数式だけを消します（最後に計算した値は残ります）。

      只清除单元格的公式（最后一次计算的值保留）。

      Parameters

      • rowIndex: number
      • field: string

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • 현재 범위 선택을 모두 해제합니다.

      Clear the current range selection.

      現在の範囲選択をすべて解除します。

      清除当前全部区域选择。

      Returns void

    • 트리거 전체 또는 특정 이벤트 클리어

      トリガー全体または特定イベントのクリア

      清除全部触发器或特定事件的触发器

      Parameters

      • Optionalevent: string

      Returns this

    • Returns void

    • Returns void

    • 열려 있는 모든 상세 패널을 한 번에 접습니다.

      Collapse every open detail panel at once.

      開いているすべての詳細パネルを一度に折りたたみます。

      一次折叠所有已打开的详情面板。

      Returns void

    • 열려 있는 상세 패널을 접습니다.

      Collapse an open detail panel.

      開いている詳細パネルを折りたたみます。

      折叠已打开的详情面板。

      Parameters

      • rowRef: number | { id: string }

      Returns void

    • 그리드 데이터로 차트를 만들어 인스턴스를 돌려줍니다.

      Create a chart from grid data and return its instance.

      グリッドのデータでチャートを作ってインスタンスを返します。

      用表格数据创建图表并返回其实例。

      Parameters

      Returns ChartInstance

    • Parameters

      • ids: string[]

      Returns void

    • Parameters

      • field: string

      Returns void

    • Parameters

      • rowIndex: number | number[]

      Returns void

    • Returns void

    • Returns void

    • 이 그리드의 차트를 모두 정리(해제)합니다.

      Dispose all charts on this grid.

      このグリッドのチャートをすべて片付け（解放）します。

      清理（释放）此表格的所有图表。

      Returns void

    • Parameters

      • event: string
      • Optionaldata: any

      Returns void

    • 배치를 끝내고, 그 사이 변경이 있었으면 단 한 번만 다시 그리고 변경 이벤트도 한 번만 냅니다.

      End the batch — if anything changed, render once and emit one coalesced change event.

      バッチを終えて、その間に変更があれば一度だけ再描画し、変更イベントも一度だけ出します。

      结束批处理；期间若有变更，只重绘一次，变更事件也只发出一次。

      Returns void

    • Returns void

    • Parameters

      • ids: string | string[]
      • Optionalopen: boolean

      Returns void

    • 행을 펼쳐 상세 패널을 엽니다. rowRef 는 화면 순서 인덱스 또는 안정적 id. 허용 겹수를 넘으면 거부됩니다.

      Expand a row's detail panel. rowRef is a screen-order index or a stable id; rejected past the nesting limit.

      行を展開して詳細パネルを開きます。rowRef は画面順のインデックスまたは安定した id。許容する 重なりの数を超えると拒否されます。

      展开行以打开详情面板。rowRef 是画面顺序的索引或稳定 id。超过允许的嵌套层数会被拒绝。

      Parameters

      • rowRef: number | { id: string }

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • Optionalfilename: string

      Returns void

    • 원본 범위의 값을 대상 범위로 채웁니다. 'copy'=그대로 복사, 'series'=규칙 감지해 이어 채우기.

      Fill the target range from the source — 'copy' duplicates, 'series' detects a pattern and extends.

      元の範囲の値を対象の範囲に入力します。'copy'=そのままコピー、'series'=規則を検知して連続入力。

      把源区域的值填入目标区域。'copy'=原样复制，'series'=识别规律后序列填充。

      Parameters

      Returns void

    • Parameters

      • columnCount: number

      Returns void

    • Parameters

      • rowCount: number

      Returns void

    • 지금 활성인 범위 하나(없으면 null). 차트가 이 값을 읽어 씁니다.

      The single active range (null if none). The chart reads this.

      今アクティブな範囲一つ（なければ null）。チャートがこの値を読んで使います。

      当前活动的那一个区域（没有则为 null）。图表会读取此值使用。

      Returns CellRange | null

    • Returns number

    • Returns T[]

    • Returns T[]

    • 그 셀의 수식 오류 코드(오류가 없으면 null).

      The cell's formula error code (null if none).

      そのセルの数式エラーコード（エラーがなければ null）。

      该单元格的公式错误码（没有错误时为 null）。

      Parameters

      • rowIndex: number
      • field: string

      Returns FormulaErrorCode | null

    • 그 셀의 수식 원문(없으면 null).

      The cell's formula text (null if none).

      そのセルの数式の原文（なければ null）。

      该单元格的公式原文（没有则为 null）。

      Parameters

      • rowIndex: number
      • field: string

      Returns string | null

    • Returns {
          diff: { field: string; newValue: any; oldValue: any }[];
          fields: string[];
          row: T;
      }[]

    • Returns T[]

    • Returns { added: T[]; edited: T[]; removed: T[] }

    • 이 그리드에 붙어 있는 차트 인스턴스들.

      The chart instances attached to this grid.

      このグリッドに付いているチャートインスタンス。

      附着在此表格上的图表实例。

      Returns ChartInstance[]

    • Returns { row: T; rowIndex: number }[]

    • Returns number

    • Parameters

      • field: string

      Returns number

    • Parameters

      • field: string
      • Optionalall: boolean

      Returns any[]

    • Returns T[]

    • 디버깅용 — 이 셀을 참조하는(이 셀이 바뀌면 다시 계산되는) 셀들.

      Debug — cells that reference this one (recomputed when it changes).

      デバッグ用 — このセルを参照する（このセルが変わると再計算される）セル。

      调试用 — 引用该单元格的（该单元格变化时会重算的）单元格。

      Parameters

      • rowIndex: number
      • field: string

      Returns { field: string; rowIndex: number }[]

    • 그 행의 상세 패널 내용물(직접 그린 결과 또는 자동 생성된 자식 그리드). 한 번도 펼치지 않았으면 undefined.

      The row's detail content (your rendered result or the auto-created child grid); undefined if never expanded.

      その行の詳細パネルの中身（自分で描画した結果、または自動生成された子グリッド）。一度も展開して いなければ undefined。

      该行详情面板的内容（自行绘制的结果，或自动生成的子表格）。从未展开过时为 undefined。

      Type Parameters

      • D = any

      Parameters

      • rowRef: number | { id: string }

      Returns D | undefined

    • Parameters

      • rowIndex: number
      • field: string

      Returns string

    • Returns T[]

    • Parameters

      • index: number

      Returns string

    • Returns Record<string, FilterItem[]>

    • 화면에 보이는 행 순서와 실제 데이터를 이어 주는 내부 모델을 돌려줍니다(고급 배선용).

      Return the internal model mapping on-screen row order to actual data (for advanced wiring).

      画面に見える行の順序と実際のデータをつないでくれる内部モデルを返します（高度な配線用）。

      返回把屏幕上可见的行顺序与实际数据连接起来的内部模型（供高级接线使用）。

      Returns FlatRowModel

    • Returns any[]

    • Parameters

      • field: string

      Returns any

    • 이 그리드에 지금 적용된 로케일 id.

      The locale id currently applied to this grid.

      このグリッドに今適用されているロケールの id。

      该表格当前应用的区域 id。

      Returns string

    • 현재 마스킹 활성 여부 반환 (true=마스킹 중)

      現在マスキングが有効かどうかを返す（true=マスキング中）

      返回当前掩码是否启用（true=正在掩码）

      Parameters

      • field: string

      Returns boolean

    • Parameters

      • rowIndex: number

      Returns T | undefined

    • override 로 감싼 메서드 이름들의 목록을 돌려줍니다.

      Return the list of overridden method names.

      override で包んだメソッド名の一覧を返します。

      返回被 override 包裹的方法名列表。

      Returns string[]

    • 디버깅용 — 이 셀의 수식이 참조하는(이 셀보다 먼저 계산돼야 하는) 셀들.

      Debug — cells this one's formula references (computed before it).

      デバッグ用 — このセルの数式が参照する（このセルより先に計算されなければならない）セル。

      调试用 — 该单元格的公式所引用的（必须先于该单元格计算的）单元格。

      Parameters

      • rowIndex: number
      • field: string

      Returns { field: string; rowIndex: number }[]

    • 현재 선택된 셀 범위들(없으면 빈 배열). 지금은 한 번에 하나까지 담깁니다.

      Currently selected cell ranges (empty if none). At most one for now.

      現在選択されているセル範囲（なければ空の配列）。今は一度に一つまで入ります。

      当前选中的单元格区域（没有则为空数组）。目前一次最多容纳一个。

      Returns CellRange[]

    • 현재 활성 범위의 숫자 셀 통계(합·평균·최소·최대 등, 고정밀 계산). 숫자가 없으면 null.

      High-precision stats (sum/avg/min/max …) over the active range's numeric cells; null if none.

      現在アクティブな範囲の数値セルの統計（合計・平均・最小・最大など、高精度計算）。数値がなければ null。

      当前活动区域内数值单元格的统计（合计、平均、最小、最大等，高精度计算）。没有数值则为 null。

      Returns RangeStats | null

    • 현재 활성 범위 안 셀 값들을 행×열 2차원 배열로 돌려줍니다(차트가 소비).

      Return the active range's cell values as a 2-D (rows×cols) array (consumed by the chart).

      現在アクティブな範囲内のセルの値を行×列の 2 次元配列で返します（チャートが消費）。

      把当前活动区域内的单元格值以行×列的二维数组返回（供图表消费）。

      Returns any[][]

    • Returns T[]

    • Parameters

      • rowIndex: number

      Returns T

    • Parameters

      • stateField: string

      Returns T[]

    • Returns { x: number; y: number }

    • Returns T[]

    • 지금 적용된 스킨 id('default' = 기본 생김새).

      The currently applied skin id ('default' = stock look).

      今適用されているスキンの id（'default' = 既定の見た目）。

      当前应用的皮肤 id（'default' = 默认外形）。

      Returns string

    • Returns T[]

    • 등록된 알고리즘 슬롯 함수를 가져옵니다(없으면 넘긴 fallback 을 그대로 반환).

      Fetch a registered algorithm-slot function (returns the given fallback if none).

      登録されたアルゴリズムスロット関数を取得します（なければ渡した fallback をそのまま返します）。

      取得已注册的算法插槽函数（没有则原样返回传入的 fallback）。

      Type Parameters

      • F extends Function

      Parameters

      • slot: string
      • fallback: F

      Returns F

    • Parameters

      • field: string
      • Optionalall: boolean

      Returns any[]

    • Parameters

      • name: string

      Returns WorksheetState<T> | undefined

    • Returns string[]

    • Parameters

      • fields: string[]

      Returns void

    • 그 셀에 수식이 들어 있는지.

      Whether that cell holds a formula.

      そのセルに数式が入っているか。

      该单元格中是否含有公式。

      Parameters

      • rowIndex: number
      • field: string

      Returns boolean

    • 그 메서드가 지금 override 로 감싸져 있는지 확인합니다.

      Check whether that method is currently overridden.

      そのメソッドが今 override で包まれているかを確認します。

      确认该方法当前是否被 override 包裹。

      Parameters

      • name: string

      Returns boolean

    • Parameters

      • field: string | string[]

      Returns void

    • Parameters

      Returns void

    • 그 행의 상세 패널이 지금 펼쳐져 있는지.

      Whether that row's detail panel is currently expanded.

      その行の詳細パネルが今展開されているか。

      该行的详情面板当前是否展开。

      Parameters

      • rowRef: number | { id: string }

      Returns boolean

    • Parameters

      • field: string

      Returns void

    • Parameters

      • rowIndex: number

      Returns void

    • 체크박스로 고른 행들을 다른 그리드로 옮깁니다(화살표 셔틀 버튼용).

      Move the checkbox-selected rows into another grid (for the arrow-shuttle buttons).

      チェックボックスで選んだ行を別のグリッドに移します（矢印シャトルボタン用）。

      把用复选框选中的行移到另一个表格（用于箭头穿梭按钮）。

      Parameters

      Returns Promise<boolean>

    • 지정한 행들을 다른 그리드로 옮깁니다(드래그·셔틀과 같은 경로). 옮기는 전·후·완료 3단계 이벤트가 나고 필드 매핑 규칙이 적용됩니다.

      Move the given rows into another grid (same path as drag/shuttle). Fires the three-phase events and applies the field-mapping rule.

      指定した行を別のグリッドに移します（ドラッグ・シャトルと同じ経路）。移す前・後・完了の 3 段階の イベントが出て、フィールドマッピングのルールが適用されます。

      把指定的行移到另一个表格（与拖动、穿梭同一路径）。会触发移动前、移动后、完成三个阶段的事件， 并应用字段映射规则。

      Parameters

      Returns Promise<boolean>

    • 채우기 기능 전용 — 어떤 셀의 수식을 dRow/dCol 만큼 이동한 자리에 맞게 참조를 옮긴 새 수식 원문을 돌려줍니다.

      Fill-only — return a copy of a cell's formula with its relative refs shifted by dRow/dCol.

      入力機能専用 — あるセルの数式を dRow/dCol だけ移動した位置に合わせて参照を移した新しい数式の原文を 返します。

      填充功能专用 — 返回某单元格公式的新原文，其中的引用按 dRow/dCol 移动后的位置作相应偏移。

      Parameters

      • srcRowId: string
      • srcField: string
      • dRow: number
      • dCol: number

      Returns string

    • Parameters

      • e: MouseEvent
      • Optionalitems: ContextMenuItem[]

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      • data: T[]

      Returns void

    • Parameters

      • Optionaloptions: PrintOptions

      Returns void

    • Parameters

      • data: T[]

      Returns void

    • Parameters

      • items: Partial<T> | Partial<T>[]

      Returns void

    • Type Parameters

      • K extends string | number | symbol

      Parameters

      • rowIndex: number
      • field: K

      Returns T[K]

    • Parameters

      • rowIndex: number
      • field: string

      Returns any

    • 모든 수식을 처음부터 다시 계산합니다(데이터 교체·컬럼 변경 후 등).

      Recompute every formula from scratch (after replacing data, changing columns, …).

      すべての数式を最初から計算し直します（データの入れ替え・列の変更の後など）。

      从头重算所有公式（替换数据、变更列之后等）。

      Returns void

    • 이 셀과, 이 셀에 딸린(종속) 셀들만 다시 계산합니다.

      Recompute only this cell and the cells depending on it.

      このセルと、このセルにぶら下がる（従属）セルだけを計算し直します。

      只重算该单元格和依赖它的单元格。

      Parameters

      • rowIndex: number
      • field: string

      Returns void

    • Returns void

    • 트리거 제거

      トリガーの削除

      移除触发器

      Parameters

      Returns this

    • Parameters

      • name: string

      Returns void

    • Parameters

      • oldName: string
      • newName: string

      Returns void

    • Parameters

      • Optionalfield: string

      Returns void

    • Returns void

    • Parameters

      • Optionalwidth: number
      • Optionalheight: number

      Returns void

    • 이름을 지정한 메서드 하나를 원래 동작으로 되돌립니다.

      Restore one named method to its original behavior.

      名前を指定したメソッド一つを元の動作に戻します。

      把指定名称的一个方法恢复为原本的行为。

      Parameters

      • name: string

      Returns OpenGridInstance<T>

    • 걸어 둔 모든 override 와 strategy 를 한 번에 되돌립니다(그리드 파기 시 자동 호출).

      Undo all overrides and strategies at once (called automatically on destroy).

      掛けておいたすべての override と strategy を一度に戻します（グリッド破棄時に自動で呼び出し）。

      一次性还原所有已挂上的 override 与 strategy（表格销毁时自动调用）。

      Returns OpenGridInstance<T>

    • Parameters

      Returns void

    • 컬럼·컨테이너 크기를 바꾼 뒤 열린 패널의 폭을 다시 맞춥니다(보통은 재렌더가 알아서 처리).

      Re-sync open panel widths after a column/container resize (usually the re-render handles it).

      列・コンテナーのサイズを変えた後、開いているパネルの幅を合わせ直します（通常は再レンダリングが 自動で処理）。

      改变列或容器尺寸后，重新对齐已打开面板的宽度（通常重新渲染会自动处理）。

      Returns void

    • 셀에 수식을 넣습니다(예: "=A1+B2"). rowIndex 는 화면 순서로 주면 내부에서 안정적 참조로 바꿉니다.

      Set a cell's formula (e.g. "=A1+B2"). Pass rowIndex in screen order; it's normalized to a stable ref inside.

      セルに数式を入れます（例: "=A1+B2"）。rowIndex は画面の順序で渡せば内部で安定した参照に変えます。

      给单元格设置公式（例: "=A1+B2"）。rowIndex 按屏幕顺序传入即可，内部会转换为稳定引用。

      Parameters

      • rowIndex: number
      • field: string
      • formula: string

      Returns void

    • Parameters

      • widths: number[]

      Returns void

    • 조건부 서식 규칙을 지정합니다 — 값에 따라 셀에 데이터바·색조(히트맵)·아이콘셋을 입혀 강조합니다. 규칙이 걸린 컬럼의 통계(최소·최대 등)를 미리 계산해 두고 다시 그립니다. 빈 배열을 주면 조건부 서식을 모두 해제합니다.

      Set conditional-format rules — highlight cells by value with data-bars, color scales (heatmaps), or icon sets. It precomputes the rule-bearing columns' stats (min/max …) and re-renders. Pass an empty array to clear all conditional formatting.

      条件付き書式のルールを指定します — 値に応じてセルにデータバー・カラースケール（ヒートマップ）・ アイコンセットを付けて強調します。ルールが掛かった列の統計（最小・最大など）をあらかじめ計算しておき、 再描画します。空の配列を渡すと条件付き書式をすべて解除します。

      指定条件格式规则 — 按值给单元格加上数据条、色阶（热力图）或图标集以示强调。它会预先算好带规则的列的 统计（最小、最大等）并重新渲染。传入空数组即清除全部条件格式。

      Parameters

      • rules: CFRule[]

      Returns Promise<void>

    • Parameters

      • data: T[]

      Returns void

    • 밀도(행 간격)를 바꿉니다 — 촘촘/보통/여유처럼 행 높이와 여백을 통째로 조절합니다. 색·스킨과 따로 노는 별개 축이며, 없는 이름을 줘도 오류를 내지 않습니다.

      Switch the density (row spacing) — compact/normal/roomy row heights and paddings. An independent axis from color/skin; never throws on an unknown name.

      密度（行間隔）を変えます — 詰め／普通／ゆとりのように行の高さと余白をまとめて調節します。 色・スキンとは別に動く独立した軸であり、ない名前を渡してもエラーになりません。

      更改密度（行间距）— 像紧凑／普通／宽松那样，整体调节行高和留白。它是与色彩、皮肤各自独立的轴， 传入不存在的名称也不会报错。

      Parameters

      • name: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • UI 문구의 언어(로케일)를 바꾸고 화면을 다시 그립니다. 등록되지 않은 로케일을 줘도 오류를 내지 않습니다.

      Switch the UI language (locale) and re-render. Never throws on an unregistered locale.

      UI 文言の言語（ロケール）を変えて画面を再描画します。登録されていないロケールを渡しても エラーになりません。

      更改 UI 文字的语言（区域），并重绘画面。传入未注册的区域也不会报错。

      Parameters

      • locale: string

      Returns void

    • 컬럼 마스킹 ON/OFF. enabled=true → 마스킹 적용, enabled=false → 전체 해제

      列マスキングの ON/OFF。enabled=true → マスキング適用、enabled=false → 全解除

      列掩码的开关。enabled=true → 应用掩码，enabled=false → 全部解除

      Parameters

      • field: string
      • enabled: boolean

      Returns void

    • 이 그리드에서만 특정 문구 하나를 다른 말로 바꿉니다.

      Override a single UI message for this grid only.

      このグリッドでだけ特定の文言一つを別の言葉に変えます。

      只在该表格内把某一条文字换成别的说法。

      Parameters

      Returns OpenGridInstance<T>

    • Parameters

      Returns void

    • 셀 범위를 프로그램에서 직접 선택합니다.

      Select a cell range programmatically.

      セル範囲をプログラムから直接選択します。

      由程序直接选择单元格区域。

      Parameters

      Returns void

    • 스킨(형태 축)을 바꿉니다 — 모서리·테두리·여백 같은 "생김새"만 갈아 끼우고, 색 테마는 그대로 둡니다.

      Switch the skin (form axis) — swaps the "shape" (corners, borders, spacing …) only, leaving the color theme untouched.

      スキン（形の軸）を変えます — 角・枠線・余白のような「見た目」だけを差し替え、色テーマはそのままに します。

      更换皮肤（形态轴）— 只替换圆角、边框、间距这类「外形」，色彩主题保持不变。

      Parameters

      • skin: string

      Returns void

    • 형태 축의 CSS 변수 하나만 즉석에서 바꿉니다(setThemeVar 의 형태 버전). 색 값을 넣으면 거부됩니다.

      Override a single form-axis CSS variable at runtime (the form-axis sibling of setThemeVar). Color values are rejected.

      形の軸の CSS 変数一つだけをその場で変えます（setThemeVar の形バージョン）。色の値を入れると 拒否されます。

      即时更改形态轴的单个 CSS 变量（setThemeVar 的形态版本）。传入色彩值会被拒绝。

      Parameters

      • varName: string
      • value: string

      Returns void

    • 질감(배경 패턴)을 바꿉니다 — 배경 페인트만 입히고 크기 재계산은 하지 않습니다. 없는 이름을 줘도 오류를 내지 않습니다.

      Switch the texture (background pattern) — paints the background only, no relayout. Never throws on an unknown name.

      質感（背景パターン）を変えます — 背景のペイントだけを付け、サイズの再計算はしません。 ない名前を渡してもエラーになりません。

      更改质感（背景图案）— 只上背景漆，不重算尺寸。传入不存在的名称也不会报错。

      Parameters

      • name: string

      Returns void

    • Parameters

      • theme: string

      Returns void

    • Parameters

      • varName: string
      • value: string

      Returns void

    • Parameters

      • field: string | string[]

      Returns void

    • Parameters

      • name: string

      Returns void

    • 키에 해당하는 문구를 찾아 돌려줍니다(개별 오버라이드 → 활성 로케일 → 한국어 → 키 순). 오류를 내지 않습니다.

      Resolve a message by key (per-message override → active locale → Korean → the key itself). Never throws.

      キーに当たる文言を探して返します（個別オーバーライド → 有効ロケール → 韓国語 → キーの順）。 エラーになりません。

      按键查找并返回对应文字（单条覆盖 → 生效区域 → 韩语 → 键本身，依此顺序）。不会报错。

      Parameters

      • key: string
      • Optionalparams: Record<string, string | number>

      Returns string

    • Parameters

      • OptionalkeyValue: boolean

      Returns any[]

    • 상세 패널을 펼쳐져 있으면 접고, 접혀 있으면 폅니다.

      Toggle a detail panel open/closed.

      詳細パネルを、開いていれば折りたたみ、折りたたまれていれば開きます。

      详情面板已展开则折叠，已折叠则展开。

      Parameters

      • rowRef: number | { id: string }

      Returns void

    • Returns void

    • Parameters

      • ids: string[]

      Returns void

    • Returns void

    • Parameters

      • items: Partial<T> | Partial<T>[]

      Returns void

    • Parameters

      • rowIndex: number
      • field: string
      • value: any

      Returns void

    • 여러 셀 쓰기를 한 번에 처리하는 간편 래퍼(beginBatch → 반복 쓰기 → endBatch). rowIndex 는 화면 표시 순서이며, 그룹·트리·상세 같은 실제 데이터가 아닌 가상 행은 안전하게 건너뜁니다. 반환값은 건너뛴 셀 수입니다.

      A convenience wrapper that writes many cells at once (beginBatch → loop → endBatch). rowIndex is screen-order; non-data pseudo-rows (group/tree/detail) are safely skipped. Returns how many were skipped.

      複数のセル書き込みを一度に処理する簡便ラッパー（beginBatch → 繰り返し書き込み → endBatch）。 rowIndex は画面の表示順であり、グループ・ツリー・詳細のような実データではない仮想行は安全に スキップします。戻り値はスキップしたセル数です。

      一次处理多个单元格写入的简便包装（beginBatch → 循环写入 → endBatch）。rowIndex 为屏幕显示顺序， 分组、树、详情这类并非实际数据的虚拟行会被安全跳过。返回值是被跳过的单元格数。

      Parameters

      • patches: { field: string; rowIndex: number; value: any }[]

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    activateaddCheckByIdaddTreeRowaddTriggeraddWorksheetapplyColumnsbeginBatchcalcColWidthscheckByIdcheckByValueclearCellFormulaclearDataclearGroupclearHistoryclearRangeSelectionclearTriggerscloseContextMenucollapseAllcollapseAllDetailscollapseRowcreateChartdeleteByIddeleteColumndeleteRowdeselectdestroydestroyChartsemitendBatchexpandAllexpandNodesexpandRowexportCsvexportExcelexportJsonexportSheetsExcelfillRangefreezefreezeRowsgetActiveRangegetActiveRowgetAddedRowsgetAllCheckedgetAllColumnDefsgetCellErrorgetCellFormulagetChangedColumnsgetChangedRowsgetChangesgetChartsgetCheckedgetColumnCountgetColumnDefsgetColumnIndexgetColValuesgetDatagetDependentsgetDetailInstancegetDisplayValuegetEditedRowsgetFieldAtgetFilterStategetFlatRowModelgetFooterDatagetFooterValuegetLocalegetMaskEnabledgetOriginalRowgetOverrideNamesgetPrecedentsgetRangeSelectiongetRangeStatsgetRangeValuesgetRemovedRowsgetRowAtgetRowsWithStategetScrollPosgetSelectionsgetSkingetSourceRowsgetStrategygetUniqueValuesgetWorksheetgetWorksheetNamesgroupByhasCellFormulahasOverridehideColumninsertColumninsertRowisRowExpandedjumpToColjumpToRowmoveCheckedTomoveRowsTooffoffsetFormulaononceopenContextMenuorderByprefixDataprintpushDatapushRowreadCellrecalculaterecalculateCellredoremoveTriggerremoveWorksheetrenameWorksheetresetFilterresetOrderresizerestorerestoreAllrestoreFilterresyncPanelWidthssetCellFormulasetColWidthssetConditionalFormatsetDatasetDensitysetFiltersetFilterSelectsetFootersetLocalesetMaskEnabledsetMessagesetOptionssetRangeSelectionsetSkinsetSkinVarsetTexturesetThemesetThemeVarshowColumnswitchWorksheetttoArraytoggleRowuncheckAlluncheckByIdundounshiftRowwriteCellwriteCells