open-grid 1.6.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +62 -0
- package/dist/ExportProgressView-9Kt1SQxv.js +48 -0
- package/dist/ExportProgressView-B59uHIwt.cjs +48 -0
- package/dist/LcpMergeOrderer-BdUtV67j.js +114 -0
- package/dist/LcpMergeOrderer-C_ANVkGk.cjs +113 -0
- package/dist/OpenGrid-BUYQs1_w.cjs +9806 -0
- package/dist/OpenGrid-BmagF0yo.js +9819 -0
- package/dist/XlsxChannel-DOeHeP7h.cjs +95 -0
- package/dist/XlsxChannel-DdaiytFR.js +95 -0
- package/dist/XlsxWorkbookWriter-BTNtZ80J.js +199 -0
- package/dist/XlsxWorkbookWriter-_u5stfg4.cjs +198 -0
- package/dist/{index-Brnev66-.js → index-B9_g5Eg3.js} +2 -2
- package/dist/{index-B_e5BXnW.cjs → index-CnyumyPV.cjs} +2 -2
- package/dist/open-grid-a11y.cjs +216 -0
- package/dist/open-grid-a11y.js +219 -0
- package/dist/open-grid-base.css +9 -0
- package/dist/open-grid-header.css +6 -15
- package/dist/open-grid-react.cjs +1 -1
- package/dist/open-grid-react.js +1 -1
- package/dist/open-grid-vue.cjs +1 -1
- package/dist/open-grid-vue.js +1 -1
- package/dist/open-grid.cjs +5 -2
- package/dist/open-grid.js +6 -3
- package/dist/sinks-BWkWQexV.js +149 -0
- package/dist/sinks-DPK0VxYG.cjs +143 -0
- package/dist/types/a11y/index.d.ts +37 -0
- package/dist/types/core/CFRenderBridge.d.ts +5 -1
- package/dist/types/core/CellEditManager.d.ts +26 -2
- package/dist/types/core/CellEventHandler.d.ts +6 -2
- package/dist/types/core/ColumnLayout.d.ts +11 -3
- package/dist/types/core/DataLayer.d.ts +48 -1
- package/dist/types/core/DetailManager.d.ts +43 -2
- package/dist/types/core/ExportManager.d.ts +26 -6
- package/dist/types/core/FindBarManager.d.ts +6 -2
- package/dist/types/core/FlatRowModel.d.ts +69 -3
- package/dist/types/core/FooterManager.d.ts +43 -1
- package/dist/types/core/FormulaController.d.ts +4 -4
- package/dist/types/core/GridComposer.d.ts +11 -1
- package/dist/types/core/GridRenderer.d.ts +84 -19
- package/dist/types/core/GroupTreeManager.d.ts +6 -4
- package/dist/types/core/KeyboardManager.d.ts +3 -2
- package/dist/types/core/MergeEngine.d.ts +45 -5
- package/dist/types/core/MutationService.d.ts +14 -17
- package/dist/types/core/OpenGrid.d.ts +350 -12
- package/dist/types/core/OrgChart.d.ts +24 -0
- package/dist/types/core/RangeSelectionManager.d.ts +23 -2
- package/dist/types/core/RenderController.d.ts +126 -8
- package/dist/types/core/RowDragDrop.d.ts +2 -0
- package/dist/types/core/SortFilterManager.d.ts +18 -2
- package/dist/types/core/VirtualScroll.d.ts +12 -0
- package/dist/types/core/WorksheetManager.d.ts +2 -2
- package/dist/types/core/a11y/KeyboardInteractionModel.d.ts +321 -20
- package/dist/types/core/a11y/LiveRegionController.d.ts +229 -27
- package/dist/types/core/a11y/VisualEquivRegistry.d.ts +199 -14
- package/dist/types/core/appearance/TextureRegistry.d.ts +10 -0
- package/dist/types/core/cf/CFRule.d.ts +145 -22
- package/dist/types/core/coordinate/CellTextPolicy.d.ts +58 -0
- package/dist/types/core/coordinate/ColumnGeometry.d.ts +60 -0
- package/dist/types/core/coordinate/ColumnWindow.d.ts +40 -0
- package/dist/types/core/coordinate/ColumnWindowPolicy.d.ts +89 -0
- package/dist/types/core/coordinate/ExtraColumns.d.ts +39 -0
- package/dist/types/core/coordinate/RangeRectCalculator.d.ts +35 -0
- package/dist/types/core/coordinate/ViewportHeightJudge.d.ts +28 -0
- package/dist/types/core/coordinate/geometryPorts.d.ts +250 -0
- package/dist/types/core/coordinate/ports.d.ts +5 -0
- package/dist/types/core/domain/footer/FooterValues.d.ts +50 -0
- package/dist/types/core/domain/footer/ports.d.ts +31 -0
- package/dist/types/core/domain/render/RenderPlanner.d.ts +17 -0
- package/dist/types/core/domain/render/RenderRequest.d.ts +91 -0
- package/dist/types/core/domain/render/ports.d.ts +169 -0
- package/dist/types/core/domain/resize/ResizeGesture.d.ts +25 -0
- package/dist/types/core/domain/resize/ResizeHitZone.d.ts +23 -0
- package/dist/types/core/domain/resize/ports.d.ts +64 -0
- package/dist/types/core/domain/sort/ComparisonOrderer.d.ts +11 -0
- package/dist/types/core/domain/sort/LcpMergeOrderer.d.ts +15 -0
- package/dist/types/core/domain/sort/RankIndex.d.ts +74 -0
- package/dist/types/core/domain/sort/SortCostEstimate.d.ts +36 -0
- package/dist/types/core/domain/sort/SortKeyColumn.d.ts +89 -0
- package/dist/types/core/domain/sort/SortKeyStore.d.ts +34 -0
- package/dist/types/core/domain/sort/Sorter.d.ts +54 -0
- package/dist/types/core/domain/sort/SyncSortRunner.d.ts +9 -0
- package/dist/types/core/domain/sort/commonPrefix.d.ts +5 -0
- package/dist/types/core/domain/sort/ports.d.ts +140 -0
- package/dist/types/core/export/ExportProgressView.d.ts +28 -0
- package/dist/types/core/export/channels/XlsxChannel.d.ts +29 -0
- package/dist/types/core/export/channels/XlsxWorkbookWriter.d.ts +17 -0
- package/dist/types/core/export/index.d.ts +2 -0
- package/dist/types/core/export/sinks.d.ts +81 -0
- package/dist/types/core/host/archCheck.d.ts +16 -1
- package/dist/types/core/i18n/locales/en.d.ts +6 -0
- package/dist/types/core/i18n/locales/ko.d.ts +6 -0
- package/dist/types/core/i18n/types.d.ts +8 -0
- package/dist/types/core/render/FooterView.d.ts +121 -0
- package/dist/types/core/render/GeometryApplier.d.ts +55 -0
- package/dist/types/core/render/HorizontalReveal.d.ts +26 -0
- package/dist/types/core/render/RangeOverlayAdapter.d.ts +10 -0
- package/dist/types/core/render/RenderScheduler.d.ts +225 -0
- package/dist/types/core/render/ResizeSinkAdapter.d.ts +35 -0
- package/dist/types/core/render/ScrollFollower.d.ts +34 -0
- package/dist/types/core/render/ScrollObserver.d.ts +47 -0
- package/dist/types/core/render/ScrollbarGutter.d.ts +19 -0
- package/dist/types/core/render/body/BodyEventRouter.d.ts +58 -0
- package/dist/types/core/render/body/BodyRowSet.d.ts +28 -0
- package/dist/types/core/render/body/BodyView.d.ts +185 -0
- package/dist/types/core/render/body/CellLocator.d.ts +36 -0
- package/dist/types/core/render/body/CellRegistry.d.ts +24 -0
- package/dist/types/core/render/body/ColumnPaintPlan.d.ts +19 -0
- package/dist/types/core/render/body/ExtraCellPainters.d.ts +20 -0
- package/dist/types/core/render/body/rows/BodyRowContext.d.ts +138 -0
- package/dist/types/core/render/body/rows/DataRowPainter.d.ts +58 -0
- package/dist/types/core/render/body/rows/DetailRowPainter.d.ts +24 -0
- package/dist/types/core/render/body/rows/GroupRowPainter.d.ts +32 -0
- package/dist/types/core/render/body/rows/RowPainterTable.d.ts +24 -0
- package/dist/types/core/render/body/rows/WindowLayout.d.ts +38 -0
- package/dist/types/core/render/dom.d.ts +10 -0
- package/dist/types/core/render/header/HeaderSortIndicator.d.ts +39 -0
- package/dist/types/core/render/header/HeaderView.d.ts +84 -0
- package/dist/types/core/render/header/ResizeHandleBinder.d.ts +110 -0
- package/dist/types/core/render/ports.d.ts +218 -0
- package/dist/types/core/renderers/CellRenderer.d.ts +7 -0
- package/dist/types/core/types.d.ts +572 -22
- package/dist/types/index.d.ts +31 -1
- package/dist/types/vue/OpenGrid.vue.d.ts +2 -2
- package/package.json +8 -9
- package/dist/OpenGrid-DgZtbVD0.cjs +0 -7390
- package/dist/OpenGrid-E11B7Xa7.js +0 -7403
|
@@ -140,6 +140,16 @@ export type Position = 'first' | 'last' | 'before' | 'after' | number;
|
|
|
140
140
|
* 内置单元格渲染器的类型名。
|
|
141
141
|
*/
|
|
142
142
|
export type RendererType = 'text' | 'number' | 'date' | 'checkbox' | 'button' | 'link' | 'image' | 'icon' | 'switch' | 'sparkline' | 'template' | 'custom' | 'badge' | 'progress' | 'rating' | 'radio' | 'img' | 'html' | 'barcode';
|
|
143
|
+
/**
|
|
144
|
+
* 컬럼 `renderer` 에 쓸 수 있는 이름 — 내장 렌더러 이름 또는 `OpenGrid.registerRenderer` 로 등록한 이름.
|
|
145
|
+
*
|
|
146
|
+
* A name usable as a column `renderer` — a built-in renderer name or one registered with `OpenGrid.registerRenderer`.
|
|
147
|
+
*
|
|
148
|
+
* 列の `renderer` に使える名前 — 組み込みレンダラーの名前、または `OpenGrid.registerRenderer` で登録した名前。
|
|
149
|
+
*
|
|
150
|
+
* 可用作列 `renderer` 的名称 — 内置渲染器名称,或用 `OpenGrid.registerRenderer` 注册的名称。
|
|
151
|
+
*/
|
|
152
|
+
export type RendererName = RendererType | (string & {});
|
|
143
153
|
/**
|
|
144
154
|
* 내장 셀 에디터 타입 이름.
|
|
145
155
|
*
|
|
@@ -612,17 +622,41 @@ export interface CellKeyEvent<T = any> {
|
|
|
612
622
|
originalEvent: KeyboardEvent;
|
|
613
623
|
}
|
|
614
624
|
/**
|
|
615
|
-
* 정렬 변경 이벤트(sortChange).
|
|
625
|
+
* 정렬 변경 이벤트(sortChange). 머리글 클릭·`orderBy()`·`resetOrder()` 어느 길이든 같은 모양으로 온다.
|
|
626
|
+
*
|
|
627
|
+
* Sort change event (sortChange). It has the same shape whether it comes from a header click, `orderBy()` or `resetOrder()`.
|
|
616
628
|
*
|
|
617
|
-
*
|
|
629
|
+
* ソート変更イベント(sortChange)。見出しのクリック・`orderBy()`・`resetOrder()` のどの経路でも同じ形で届きます。
|
|
618
630
|
*
|
|
619
|
-
*
|
|
631
|
+
* 排序变更事件(sortChange)。无论来自表头点击、`orderBy()` 还是 `resetOrder()`,形状都相同。
|
|
620
632
|
*
|
|
621
|
-
*
|
|
633
|
+
* @example
|
|
634
|
+
* grid.on('sortChange', (e: SortEvent) => {
|
|
635
|
+
* if (!e.field) say('정렬 해제');
|
|
636
|
+
* else say(`${e.field} ${e.dir ?? '해제'}`);
|
|
637
|
+
* });
|
|
622
638
|
*/
|
|
623
639
|
export interface SortEvent {
|
|
624
|
-
|
|
625
|
-
|
|
640
|
+
/**
|
|
641
|
+
* 방금 정렬이 바뀐 컬럼. 정렬을 모두 풀었으면(`resetOrder()`) 없다.
|
|
642
|
+
*
|
|
643
|
+
* The column whose sort just changed. Absent when all sorting was cleared (`resetOrder()`).
|
|
644
|
+
*
|
|
645
|
+
* いまソートが変わった列。ソートをすべて解除したとき(`resetOrder()`)はありません。
|
|
646
|
+
*
|
|
647
|
+
* 刚刚改变排序的列。全部解除排序(`resetOrder()`)时不存在。
|
|
648
|
+
*/
|
|
649
|
+
field?: string;
|
|
650
|
+
/**
|
|
651
|
+
* 그 컬럼의 새 방향. 그 컬럼의 정렬이 풀렸으면 없다.
|
|
652
|
+
*
|
|
653
|
+
* That column's new direction. Absent when that column's sort was cleared.
|
|
654
|
+
*
|
|
655
|
+
* その列の新しい向き。その列のソートが解除されたときはありません。
|
|
656
|
+
*
|
|
657
|
+
* 该列的新方向。该列的排序被解除时不存在。
|
|
658
|
+
*/
|
|
659
|
+
dir?: SortDir;
|
|
626
660
|
/**
|
|
627
661
|
* 멀티정렬 전체 상태.
|
|
628
662
|
*
|
|
@@ -658,18 +692,54 @@ export interface FilterEvent {
|
|
|
658
692
|
allFilters: Record<string, FilterItem[]>;
|
|
659
693
|
}
|
|
660
694
|
/**
|
|
661
|
-
* 스크롤 이벤트(scroll).
|
|
695
|
+
* 본문 스크롤 이벤트(scroll). 스크롤하는 동안 화면이 그려질 때마다 한 번(초당 60회 안팎)까지 온다. 서버 요청처럼 무거운 일은 직접 모아서(throttle) 한다.
|
|
662
696
|
*
|
|
663
|
-
*
|
|
697
|
+
* Body scroll event (scroll). Arrives at most once per rendered frame while scrolling (around 60 times a second). Batch heavy work such as server requests yourself (throttle).
|
|
664
698
|
*
|
|
665
|
-
*
|
|
699
|
+
* 本文のスクロールイベント(scroll)。スクロール中、画面が描かれるたびに最大 1 回(毎秒 60 回前後)届きます。サーバー要求のような重い処理は自分でまとめて(throttle)行います。
|
|
666
700
|
*
|
|
667
|
-
*
|
|
701
|
+
* 正文滚动事件(scroll)。滚动期间每次画面绘制最多触发一次(每秒约 60 次)。服务器请求这类繁重的工作请自行合并(throttle)后再做。
|
|
668
702
|
*/
|
|
669
703
|
export interface ScrollEvent {
|
|
704
|
+
/**
|
|
705
|
+
* 가로 스크롤 위치(px).
|
|
706
|
+
*
|
|
707
|
+
* Horizontal scroll position (px).
|
|
708
|
+
*
|
|
709
|
+
* 横スクロールの位置(px)。
|
|
710
|
+
*
|
|
711
|
+
* 横向滚动位置(px)。
|
|
712
|
+
*/
|
|
670
713
|
scrollLeft: number;
|
|
714
|
+
/**
|
|
715
|
+
* 세로 스크롤 위치(px). 0 이 맨 위.
|
|
716
|
+
*
|
|
717
|
+
* Vertical scroll position (px); 0 is the top.
|
|
718
|
+
*
|
|
719
|
+
* 縦スクロールの位置(px)。0 がいちばん上。
|
|
720
|
+
*
|
|
721
|
+
* 纵向滚动位置(px)。0 为最顶部。
|
|
722
|
+
*/
|
|
671
723
|
scrollTop: number;
|
|
724
|
+
/**
|
|
725
|
+
* 맨 위에 있으면 `true`.
|
|
726
|
+
*
|
|
727
|
+
* `true` at the very top.
|
|
728
|
+
*
|
|
729
|
+
* いちばん上にあれば `true`。
|
|
730
|
+
*
|
|
731
|
+
* 位于最顶部时为 `true`。
|
|
732
|
+
*/
|
|
672
733
|
isAtTop: boolean;
|
|
734
|
+
/**
|
|
735
|
+
* 맨 아래에 닿았으면 `true`(1px 여유를 둔다 — 소수점 스크롤 값 때문). 끝까지 내리면 다음 쪽을 불러오는 데 쓴다.
|
|
736
|
+
*
|
|
737
|
+
* `true` once the bottom is reached (with 1px of slack for fractional scroll values). Use it to load the next page when the user reaches the end.
|
|
738
|
+
*
|
|
739
|
+
* いちばん下に届いたら `true`(小数のスクロール値のため 1px の余裕を持たせます)。最後まで下げたら次のページを読み込むのに使います。
|
|
740
|
+
*
|
|
741
|
+
* 到达最底部时为 `true`(因滚动值可能带小数,留 1px 余量)。可用于滚到底时加载下一页。
|
|
742
|
+
*/
|
|
673
743
|
isAtBottom: boolean;
|
|
674
744
|
}
|
|
675
745
|
/**
|
|
@@ -1513,7 +1583,7 @@ export interface RendererDef {
|
|
|
1513
1583
|
*
|
|
1514
1584
|
* 使用哪个内置渲染器。
|
|
1515
1585
|
*/
|
|
1516
|
-
type:
|
|
1586
|
+
type: RendererName;
|
|
1517
1587
|
/**
|
|
1518
1588
|
* 렌더러별 추가 옵션(자유 키).
|
|
1519
1589
|
*
|
|
@@ -1778,7 +1848,7 @@ export interface ColumnDef<T = any> {
|
|
|
1778
1848
|
*
|
|
1779
1849
|
* 单元格的绘制方式。用一行传内置渲染器名称,需要附加选项时传 RendererDef 对象。
|
|
1780
1850
|
*/
|
|
1781
|
-
renderer?:
|
|
1851
|
+
renderer?: RendererName | RendererDef;
|
|
1782
1852
|
/**
|
|
1783
1853
|
* 이 컬럼을 편집할 수 있는지. true 면 항상 편집 가능, 함수로 주면 행마다 다르게 결정합니다
|
|
1784
1854
|
* (예: 상태가 '확정'인 행만 잠그기). GridOptions.editable 과 둘 다 참일 때만 실제로 열립니다.
|
|
@@ -1950,7 +2020,7 @@ export interface ColumnDef<T = any> {
|
|
|
1950
2020
|
*
|
|
1951
2021
|
* 多级表头用的子列。
|
|
1952
2022
|
*/
|
|
1953
|
-
children?:
|
|
2023
|
+
children?: ColumnOrGroup<T>[];
|
|
1954
2024
|
/**
|
|
1955
2025
|
* 셀 title 툴팁(정적 또는 값·행 함수).
|
|
1956
2026
|
*
|
|
@@ -1961,6 +2031,23 @@ export interface ColumnDef<T = any> {
|
|
|
1961
2031
|
* 单元格的 title 提示(静态,或按值、行的函数)。
|
|
1962
2032
|
*/
|
|
1963
2033
|
tooltip?: string | ((value: any, row: T) => string);
|
|
2034
|
+
/**
|
|
2035
|
+
* 셀을 화면 낭독기가 읽을 글(`aria-label`). 주지 않으면 「머리글: 값」을 읽는다. 스파크라인·데이터바처럼 그림으로 그린 셀에 「무엇을 뜻하는지」를 말로 달아 줄 때 쓴다(문자열 또는 값·행 함수).
|
|
2036
|
+
* 수식 셀은 수식 안내(오류 설명 포함)가 이 값보다 먼저다.
|
|
2037
|
+
*
|
|
2038
|
+
* The text screen readers read for the cell (`aria-label`). Without it they read "header: value". Use it to put into words what a drawn cell (sparkline, data bar, …) means (a string, or a value/row function).
|
|
2039
|
+
* For formula cells the formula description (including error explanations) takes precedence.
|
|
2040
|
+
*
|
|
2041
|
+
* スクリーンリーダーがセルを読むときの文(`aria-label`)。渡さなければ「見出し: 値」を読みます。スパークラインやデータバーのように絵で描いたセルに「何を意味するか」を言葉で付けるときに使います(文字列、または値・行の関数)。
|
|
2042
|
+
* 数式セルでは数式の案内(エラーの説明を含む)がこの値より優先されます。
|
|
2043
|
+
*
|
|
2044
|
+
* 屏幕阅读器朗读该单元格时的文字(`aria-label`)。不传则朗读「表头: 值」。用于给迷你折线、数据条这类以图形绘制的单元格用文字说明「表示什么」(字符串,或按值、行的函数)。
|
|
2045
|
+
* 公式单元格中,公式说明(包括错误说明)优先于此值。
|
|
2046
|
+
*
|
|
2047
|
+
* @example
|
|
2048
|
+
* { field: 'trend', header: '추세', renderer: 'sparkline', ariaLabel: (v: number[]) => `최근 값 ${v[v.length - 1]}, 처음보다 ${v[v.length - 1] >= v[0] ? '올랐다' : '내렸다'}` }
|
|
2049
|
+
*/
|
|
2050
|
+
ariaLabel?: string | ((value: any, row: T) => string);
|
|
1964
2051
|
/**
|
|
1965
2052
|
* select 정적 옵션.
|
|
1966
2053
|
*
|
|
@@ -2102,6 +2189,58 @@ export interface ColumnDef<T = any> {
|
|
|
2102
2189
|
*/
|
|
2103
2190
|
_maskRevealedRows?: Set<number>;
|
|
2104
2191
|
}
|
|
2192
|
+
/**
|
|
2193
|
+
* `columns` 에 넣을 수 있는 한 항목 — 값을 보여 주는 컬럼(`ColumnDef`) 또는 묶음 머리글(`ColumnGroupDef`).
|
|
2194
|
+
*
|
|
2195
|
+
* One entry of `columns` — a value column (`ColumnDef`) or a group header (`ColumnGroupDef`).
|
|
2196
|
+
*
|
|
2197
|
+
* `columns` に入れられる一項目 — 値を表示する列(`ColumnDef`)、またはまとめ見出し(`ColumnGroupDef`)。
|
|
2198
|
+
*
|
|
2199
|
+
* `columns` 中的一项 — 显示值的列(`ColumnDef`)或分组表头(`ColumnGroupDef`)。
|
|
2200
|
+
*/
|
|
2201
|
+
export type ColumnOrGroup<T = any> = ColumnDef<T> | ColumnGroupDef<T>;
|
|
2202
|
+
/**
|
|
2203
|
+
* 묶음 머리글 컬럼 — 여러 컬럼 위에 한 줄 머리글을 얹는다(다단 헤더). `header` 가 묶음 머리글 글자이고
|
|
2204
|
+
* 실제 값을 보여 주는 컬럼은 `children` 에 둔다. 묶음 자체는 값을 보여 주지 않으므로 `field` 는 적지 않아도 된다.
|
|
2205
|
+
*
|
|
2206
|
+
* A group-header column — puts one header row over several columns (multi-level header). `header` is
|
|
2207
|
+
* the group's caption and the columns that show values go in `children`. The group itself shows no
|
|
2208
|
+
* value, so `field` is optional.
|
|
2209
|
+
*
|
|
2210
|
+
* まとめ見出しの列 — 複数の列の上に一段の見出しを載せます(多段ヘッダー)。`header` がまとめ見出しの文字で、
|
|
2211
|
+
* 実際に値を表示する列は `children` に置きます。まとめ自体は値を表示しないので `field` は書かなくてもかまいません。
|
|
2212
|
+
*
|
|
2213
|
+
* 分组表头列 — 在多个列上方加一行表头(多级表头)。`header` 是分组表头的文字,真正显示值的列放在
|
|
2214
|
+
* `children` 里。分组本身不显示值,因此可以不写 `field`。
|
|
2215
|
+
*
|
|
2216
|
+
* @example
|
|
2217
|
+
* columns: [
|
|
2218
|
+
* { field: 'name', header: '이름' },
|
|
2219
|
+
* { header: '매출(만원)', children: [{ field: 'q1', header: '1분기' }, { field: 'q2', header: '2분기' }] },
|
|
2220
|
+
* ]
|
|
2221
|
+
*/
|
|
2222
|
+
export interface ColumnGroupDef<T = any> extends Omit<ColumnDef<T>, 'field' | 'children'> {
|
|
2223
|
+
/**
|
|
2224
|
+
* 묶음에는 값이 없으므로 선택 항목이다.
|
|
2225
|
+
*
|
|
2226
|
+
* Optional, since a group has no value of its own.
|
|
2227
|
+
*
|
|
2228
|
+
* まとめには値がないので任意項目です。
|
|
2229
|
+
*
|
|
2230
|
+
* 分组没有自己的值,因此为可选项。
|
|
2231
|
+
*/
|
|
2232
|
+
field?: string;
|
|
2233
|
+
/**
|
|
2234
|
+
* 묶음 아래에 놓일 컬럼들(잎 컬럼 또는 다시 묶음).
|
|
2235
|
+
*
|
|
2236
|
+
* Columns under the group (leaf columns or nested groups).
|
|
2237
|
+
*
|
|
2238
|
+
* まとめの下に置く列(末端の列、またはさらにまとめ)。
|
|
2239
|
+
*
|
|
2240
|
+
* 分组下面的列(叶子列或再嵌套的分组)。
|
|
2241
|
+
*/
|
|
2242
|
+
children: ColumnOrGroup<T>[];
|
|
2243
|
+
}
|
|
2105
2244
|
/**
|
|
2106
2245
|
* 트리 노드 아이콘 정의.
|
|
2107
2246
|
*
|
|
@@ -2228,6 +2367,16 @@ export interface FilterItem {
|
|
|
2228
2367
|
* 聚合运算符。
|
|
2229
2368
|
*/
|
|
2230
2369
|
export type SummaryOp = 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'COUNT';
|
|
2370
|
+
/**
|
|
2371
|
+
* 집계 op 이름 — 내장 op(`SummaryOp`) 또는 `summaryOp` 전략 슬롯으로 새로 만든 이름(예: 'MEDIAN').
|
|
2372
|
+
*
|
|
2373
|
+
* An aggregate op name — a built-in op (`SummaryOp`) or a name you added through the `summaryOp` strategy slot (e.g. 'MEDIAN').
|
|
2374
|
+
*
|
|
2375
|
+
* 集計 op の名前 — 組み込みの op(`SummaryOp`)、または `summaryOp` 戦略スロットで新しく作った名前(例: 'MEDIAN')。
|
|
2376
|
+
*
|
|
2377
|
+
* 聚合 op 名称 — 内置 op(`SummaryOp`),或通过 `summaryOp` 策略槽新增的名称(例如 'MEDIAN')。
|
|
2378
|
+
*/
|
|
2379
|
+
export type SummaryOpName = SummaryOp | (string & {});
|
|
2231
2380
|
/**
|
|
2232
2381
|
* 필드별 집계 정의.
|
|
2233
2382
|
*
|
|
@@ -2239,7 +2388,7 @@ export type SummaryOp = 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'COUNT';
|
|
|
2239
2388
|
*/
|
|
2240
2389
|
export interface SummaryFieldDef {
|
|
2241
2390
|
field: string;
|
|
2242
|
-
op:
|
|
2391
|
+
op: SummaryOpName;
|
|
2243
2392
|
label?: string;
|
|
2244
2393
|
}
|
|
2245
2394
|
/**
|
|
@@ -2296,7 +2445,7 @@ export interface SummaryOptions {
|
|
|
2296
2445
|
* 在一个组内生成多行汇总时(例如合计行 + 平均行)。也可用 customFn 自行聚合。
|
|
2297
2446
|
*/
|
|
2298
2447
|
rows?: Array<{
|
|
2299
|
-
op:
|
|
2448
|
+
op: SummaryOpName;
|
|
2300
2449
|
label?: string;
|
|
2301
2450
|
customFn?: (items: any[]) => number;
|
|
2302
2451
|
}>;
|
|
@@ -2334,7 +2483,7 @@ export interface FooterDef {
|
|
|
2334
2483
|
*
|
|
2335
2484
|
* 计算哪种聚合(SUM/AVG/…)。
|
|
2336
2485
|
*/
|
|
2337
|
-
op?:
|
|
2486
|
+
op?: SummaryOpName;
|
|
2338
2487
|
/**
|
|
2339
2488
|
* 집계 대신 그대로 보여줄 고정 문구(예: '합계').
|
|
2340
2489
|
*
|
|
@@ -2394,6 +2543,16 @@ export interface PrintOptions {
|
|
|
2394
2543
|
title?: string;
|
|
2395
2544
|
excludeFields?: string[];
|
|
2396
2545
|
showFooter?: boolean;
|
|
2546
|
+
/**
|
|
2547
|
+
* 인쇄 쪽 맨 아래에 넣을 글(예: 출력 일시·담당 부서). 비우면 넣지 않는다. HTML 로 해석되므로 사용자 입력을 그대로 넣지 않는다.
|
|
2548
|
+
*
|
|
2549
|
+
* Text placed at the bottom of the printed page (e.g. print time, department). Omitted when empty. It is parsed as HTML, so do not pass raw user input.
|
|
2550
|
+
*
|
|
2551
|
+
* 印刷ページのいちばん下に入れる文(例: 出力日時・担当部署)。空なら入れません。HTML として解釈されるので、利用者の入力をそのまま渡さないでください。
|
|
2552
|
+
*
|
|
2553
|
+
* 放在打印页最下方的文字(例如打印时间、负责部门)。为空则不放。它会被当作 HTML 解析,因此不要直接传入用户输入。
|
|
2554
|
+
*/
|
|
2555
|
+
footerText?: string;
|
|
2397
2556
|
}
|
|
2398
2557
|
/**
|
|
2399
2558
|
* 내보내기 스타일 모드.
|
|
@@ -2521,6 +2680,46 @@ export interface ExportOptions {
|
|
|
2521
2680
|
* 导出完成后调用的钩子。接收生成的文件 blob。
|
|
2522
2681
|
*/
|
|
2523
2682
|
onAfter?: (blob: Blob) => void;
|
|
2683
|
+
/**
|
|
2684
|
+
* 대량 엑셀 내보내기 진척 콜백(done 행 / total 행).
|
|
2685
|
+
*
|
|
2686
|
+
* Progress callback for large Excel exports (done rows / total rows).
|
|
2687
|
+
*
|
|
2688
|
+
* 大量の Excel エクスポートの進捗コールバック(done 行 / total 行)。
|
|
2689
|
+
*
|
|
2690
|
+
* 大批量 Excel 导出的进度回调(done 行 / total 行)。
|
|
2691
|
+
*/
|
|
2692
|
+
onProgress?: (done: number, total: number) => void;
|
|
2693
|
+
/**
|
|
2694
|
+
* 대량 엑셀 내보내기를 취소하는 신호.
|
|
2695
|
+
*
|
|
2696
|
+
* Signal to cancel a large Excel export.
|
|
2697
|
+
*
|
|
2698
|
+
* 大量の Excel エクスポートを取り消すシグナル。
|
|
2699
|
+
*
|
|
2700
|
+
* 取消大批量 Excel 导出的信号。
|
|
2701
|
+
*/
|
|
2702
|
+
signal?: AbortSignal;
|
|
2703
|
+
/**
|
|
2704
|
+
* 엑셀 스트리밍 사용 방식. 기본 'auto'(5만 행 이상이면 스트리밍), 'force' 항상, 'off' 기존 방식.
|
|
2705
|
+
*
|
|
2706
|
+
* Excel streaming mode. Default 'auto' (stream from 50k rows), 'force' always, 'off' legacy path.
|
|
2707
|
+
*
|
|
2708
|
+
* Excel ストリーミングの方式。既定 'auto'(5万行以上でストリーミング)、'force' 常に、'off' 従来方式。
|
|
2709
|
+
*
|
|
2710
|
+
* Excel 流式导出方式。默认 'auto'(5 万行起流式),'force' 始终,'off' 旧方式。
|
|
2711
|
+
*/
|
|
2712
|
+
stream?: 'auto' | 'force' | 'off';
|
|
2713
|
+
/**
|
|
2714
|
+
* 스트리밍 내보내기 중 오류가 났을 때 부를 훅.
|
|
2715
|
+
*
|
|
2716
|
+
* Hook called when a streaming export fails.
|
|
2717
|
+
*
|
|
2718
|
+
* ストリーミングのエクスポート中にエラーが起きたときに呼ぶフック。
|
|
2719
|
+
*
|
|
2720
|
+
* 流式导出出错时调用的钩子。
|
|
2721
|
+
*/
|
|
2722
|
+
onError?: (error: unknown) => void;
|
|
2524
2723
|
}
|
|
2525
2724
|
/**
|
|
2526
2725
|
* 내보내기 제목/푸터 행.
|
|
@@ -2584,7 +2783,7 @@ export interface GridOptions<T = any> {
|
|
|
2584
2783
|
*
|
|
2585
2784
|
* 列定义数组(必填)。
|
|
2586
2785
|
*/
|
|
2587
|
-
columns:
|
|
2786
|
+
columns: ColumnOrGroup<T>[];
|
|
2588
2787
|
/**
|
|
2589
2788
|
* 그리드의 세로 크기. 숫자면 px, 문자열이면 CSS 값('60vh' 등)입니다. 가상 스크롤이 제대로 돌려면
|
|
2590
2789
|
* 확정된 높이가 필요하므로, 큰 데이터에서는 이 값(또는 조상 요소의 높이)을 꼭 주는 걸 권합니다.
|
|
@@ -2655,6 +2854,36 @@ export interface GridOptions<T = any> {
|
|
|
2655
2854
|
* 单元格内容过长而换行时,让行高随内容自动增高。与列的 wrap 配合使用。
|
|
2656
2855
|
*/
|
|
2657
2856
|
autoHeight?: boolean;
|
|
2857
|
+
/**
|
|
2858
|
+
* 가로로 보이는 컬럼(과 앞뒤 여유)만 칸을 만듭니다(기본 켬). 컬럼이 많고 칸 글자가 길 때 가로 스크롤·너비 조절이 가벼워집니다.
|
|
2859
|
+
* 화면 밖 컬럼은 칸 요소 대신 폭만 차지하는 빈 자리로 둡니다 — 칸 DOM 을 직접 찾는 바깥 코드가 화면 밖 칸을 꼭 찾아야 하면 끕니다.
|
|
2860
|
+
* 켜 두어도 자동 높이(autoHeight)·셀 병합이 있거나 그리드 폭을 모를 때(숨은 컨테이너 등)는 저절로 전 컬럼을 그립니다.
|
|
2861
|
+
* 끄면 지금까지처럼 보이는 행의 모든 컬럼 칸을 만듭니다.
|
|
2862
|
+
* 주의: 행 안 자식 순서에 기대는 바깥 CSS(`.og-row > :nth-child(n)`)는 빈 자리 요소와 창 때문에 어긋납니다. 사용자 렌더러가 칸 안에 만든 임시 상태(입력 중 글자·열린 목록·포커스)는 그 컬럼이 창에서 나가면 사라집니다(들어올 때 다시 그림).
|
|
2863
|
+
* 화면 밖 컬럼으로 가려면 `grid.jumpToCol(field)` 를 씁니다.
|
|
2864
|
+
*
|
|
2865
|
+
* Create cells only for horizontally visible columns (plus a margin on each side); on by default. Lighter horizontal scrolling
|
|
2866
|
+
* and width resizing with many columns and long cell text. Off-screen columns become width-only gaps instead of cell elements —
|
|
2867
|
+
* turn it off if outside code must find off-screen cell DOM. Even when on, all columns are painted automatically with autoHeight,
|
|
2868
|
+
* cell merges, or an unknown grid width (e.g. a hidden container). When off, every column's cell is created for visible rows, as before.
|
|
2869
|
+
* Caution: outside CSS that relies on child order inside a row (`.og-row > :nth-child(n)`) drifts because of gap elements and the window. Temporary state a custom renderer keeps inside a cell (typed text, an open list, focus) is lost when that column leaves the window (it is re-rendered on return).
|
|
2870
|
+
* To bring an off-screen column into view use `grid.jumpToCol(field)`.
|
|
2871
|
+
*
|
|
2872
|
+
* 横に見えている列(と前後の余裕)だけセルを作ります(既定で有効)。列が多くセルの文字が長いとき、横スクロールや幅の調整が軽くなります。
|
|
2873
|
+
* 画面外の列はセル要素の代わりに幅だけを占める空きにします — 画面外のセル DOM を外部コードが直接探す必要があるときは無効にします。
|
|
2874
|
+
* 有効でも、autoHeight・セル結合があるとき、グリッドの幅が分からないとき(非表示のコンテナなど)は自動的に全列を描きます。
|
|
2875
|
+
* 無効にすると、これまでどおり見えている行のすべての列のセルを作ります。
|
|
2876
|
+
* 注意: 行内の子の順番に頼る外部 CSS(`.og-row > :nth-child(n)`)は空き要素と表示範囲のためずれます。カスタムレンダラーがセル内に持つ一時的な状態(入力中の文字・開いたリスト・フォーカス)は、その列が表示範囲から出ると消えます(戻ると描き直します)。
|
|
2877
|
+
* 画面外の列へ移るには `grid.jumpToCol(field)` を使います。
|
|
2878
|
+
*
|
|
2879
|
+
* 只为横向可见的列(及前后余量)创建单元格(默认开启)。列多且单元格文字长时,横向滚动和调整列宽更轻快。
|
|
2880
|
+
* 屏幕外的列不创建单元格元素,只留占宽度的空位 — 若外部代码必须直接查找屏幕外的单元格 DOM,请关闭。
|
|
2881
|
+
* 即使开启,在 autoHeight、存在单元格合并、或不知道表格宽度时(如隐藏的容器)也会自动绘制全部列。
|
|
2882
|
+
* 关闭时与以前一样,为可见行的所有列创建单元格。
|
|
2883
|
+
* 注意:依赖行内子元素顺序的外部 CSS(`.og-row > :nth-child(n)`)会因空位元素和可见窗口而错位。自定义渲染器在单元格内保留的临时状态(输入中的文字、打开的列表、焦点)在该列离开窗口时会丢失(回来时重新绘制)。
|
|
2884
|
+
* 要转到屏幕外的列,请用 `grid.jumpToCol(field)`。
|
|
2885
|
+
*/
|
|
2886
|
+
virtualColumns?: boolean;
|
|
2658
2887
|
/**
|
|
2659
2888
|
* 컬럼 폭의 합이 컨테이너를 꽉 채우도록 늘립니다. 오른쪽에 빈 공간을 남기고 싶지 않을 때.
|
|
2660
2889
|
*
|
|
@@ -2959,7 +3188,7 @@ export interface GridOptions<T = any> {
|
|
|
2959
3188
|
* - 'interactive': 源/目标结构不同时弹出映射对话框,由开发者匹配并输出转换脚本
|
|
2960
3189
|
* - 函数: 以 (srcRow) => targetRow 直接转换(不弹对话框,直接 baking)
|
|
2961
3190
|
*/
|
|
2962
|
-
crossGridMapping?: 'auto' | 'interactive' | ((srcRow: T) =>
|
|
3191
|
+
crossGridMapping?: 'auto' | 'interactive' | ((srcRow: T) => Record<string, any>);
|
|
2963
3192
|
/**
|
|
2964
3193
|
* 셀 병합 기능 사용.
|
|
2965
3194
|
*
|
|
@@ -3239,6 +3468,32 @@ export interface GridOptions<T = any> {
|
|
|
3239
3468
|
* 首次渲染完成的回调。
|
|
3240
3469
|
*/
|
|
3241
3470
|
onReady?: (grid: OpenGridInstance<T>) => void;
|
|
3471
|
+
/**
|
|
3472
|
+
* 셀 클릭 콜백.
|
|
3473
|
+
*
|
|
3474
|
+
* 이 옵션을 비롯한 이벤트 옵션 `onX` 는 `grid.on('x', …)` 과 같은 구독이다. 한 번의 일에 한 번 불리고,
|
|
3475
|
+
* `grid.on` 으로 단 리스너보다 먼저 불린다. `grid.off('x')` 로 그 이벤트의 리스너를 전부 해제하면 옵션 콜백도 멈춘다.
|
|
3476
|
+
* `setOptions` 로 바꾼 콜백은 곧바로 쓰인다.
|
|
3477
|
+
*
|
|
3478
|
+
* Cell-click callback.
|
|
3479
|
+
*
|
|
3480
|
+
* This and the other event options `onX` are the same subscription as `grid.on('x', …)`. They fire
|
|
3481
|
+
* once per occurrence, before listeners added with `grid.on`. Removing every listener of the event
|
|
3482
|
+
* with `grid.off('x')` stops the option callback too. A callback replaced through `setOptions` takes
|
|
3483
|
+
* effect immediately.
|
|
3484
|
+
*
|
|
3485
|
+
* セルクリックのコールバック。
|
|
3486
|
+
*
|
|
3487
|
+
* このオプションをはじめとするイベントオプション `onX` は `grid.on('x', …)` と同じ購読です。1 回の出来事につき 1 回呼ばれ、
|
|
3488
|
+
* `grid.on` で付けたリスナーより先に呼ばれます。`grid.off('x')` でそのイベントのリスナーをすべて解除するとオプションのコールバックも止まります。
|
|
3489
|
+
* `setOptions` で差し替えたコールバックはすぐに使われます。
|
|
3490
|
+
*
|
|
3491
|
+
* 单元格点击回调。
|
|
3492
|
+
*
|
|
3493
|
+
* 这个选项以及其他事件选项 `onX` 与 `grid.on('x', …)` 是同一种订阅。每发生一次只调用一次,
|
|
3494
|
+
* 并且先于用 `grid.on` 添加的监听器调用。用 `grid.off('x')` 解除该事件的全部监听器时,选项回调也会停止。
|
|
3495
|
+
* 通过 `setOptions` 替换的回调会立即生效。
|
|
3496
|
+
*/
|
|
3242
3497
|
onCellClick?: (e: CellEvent<T>) => void;
|
|
3243
3498
|
onCellDblClick?: (e: CellEvent<T>) => void;
|
|
3244
3499
|
onEditStart?: (e: EditEvent<T>) => void;
|
|
@@ -3298,6 +3553,15 @@ export interface GridOptions<T = any> {
|
|
|
3298
3553
|
onRowCollapse?: (e: RowExpandEvent<T>) => void;
|
|
3299
3554
|
onSortChange?: (e: SortEvent) => void;
|
|
3300
3555
|
onFilterChange?: (e: FilterEvent) => void;
|
|
3556
|
+
/**
|
|
3557
|
+
* 본문을 스크롤할 때 호출. 스크롤하는 동안 화면이 그려질 때마다 한 번(초당 60회 안팎)까지 온다. 서버 요청처럼 무거운 일은 직접 모아서(throttle) 한다.
|
|
3558
|
+
*
|
|
3559
|
+
* Called while the body scrolls. Arrives at most once per rendered frame while scrolling (around 60 times a second). Batch heavy work such as server requests yourself (throttle).
|
|
3560
|
+
*
|
|
3561
|
+
* 本文をスクロールするときに呼び出し。スクロール中、画面が描かれるたびに最大 1 回(毎秒 60 回前後)届きます。サーバー要求のような重い処理は自分でまとめて(throttle)行います。
|
|
3562
|
+
*
|
|
3563
|
+
* 正文滚动时调用。滚动期间每次画面绘制最多触发一次(每秒约 60 次)。服务器请求这类繁重的工作请自行合并(throttle)后再做。
|
|
3564
|
+
*/
|
|
3301
3565
|
onScroll?: (e: ScrollEvent) => void;
|
|
3302
3566
|
onDrop?: (e: DragDropEvent<T>) => void;
|
|
3303
3567
|
onRowDrop?: (e: {
|
|
@@ -3365,6 +3629,235 @@ export interface GridOptions<T = any> {
|
|
|
3365
3629
|
onCellKeyUp?: (e: CellKeyEvent<T>) => void;
|
|
3366
3630
|
onCellKeyPress?: (e: CellKeyEvent<T>) => void;
|
|
3367
3631
|
}
|
|
3632
|
+
/**
|
|
3633
|
+
* 행 체크 상자를 켜거나 끈 이벤트(rowCheck).
|
|
3634
|
+
*
|
|
3635
|
+
* Event fired when a row checkbox is toggled (rowCheck).
|
|
3636
|
+
*
|
|
3637
|
+
* 行のチェックボックスをオン・オフしたイベント(rowCheck)。
|
|
3638
|
+
*
|
|
3639
|
+
* 勾选或取消某行复选框的事件(rowCheck)。
|
|
3640
|
+
*/
|
|
3641
|
+
export interface RowCheckEvent<T = any> {
|
|
3642
|
+
/**
|
|
3643
|
+
* 바뀐 행의 표시 순서 인덱스.
|
|
3644
|
+
*
|
|
3645
|
+
* Display-order index of the row.
|
|
3646
|
+
*
|
|
3647
|
+
* 変わった行の表示順インデックス。
|
|
3648
|
+
*
|
|
3649
|
+
* 发生变化的行的显示顺序索引。
|
|
3650
|
+
*/
|
|
3651
|
+
rowIndex: number;
|
|
3652
|
+
/**
|
|
3653
|
+
* 새 체크 상태.
|
|
3654
|
+
*
|
|
3655
|
+
* The new checked state.
|
|
3656
|
+
*
|
|
3657
|
+
* 新しいチェック状態。
|
|
3658
|
+
*
|
|
3659
|
+
* 新的勾选状态。
|
|
3660
|
+
*/
|
|
3661
|
+
checked: boolean;
|
|
3662
|
+
/**
|
|
3663
|
+
* 그 행의 데이터.
|
|
3664
|
+
*
|
|
3665
|
+
* The row's data.
|
|
3666
|
+
*
|
|
3667
|
+
* その行のデータ。
|
|
3668
|
+
*
|
|
3669
|
+
* 该行的数据。
|
|
3670
|
+
*/
|
|
3671
|
+
row: T | undefined;
|
|
3672
|
+
}
|
|
3673
|
+
/**
|
|
3674
|
+
* 머리글의 「모두 선택」 체크 상자를 켜거나 끈 이벤트(allCheck).
|
|
3675
|
+
*
|
|
3676
|
+
* Event fired when the header's select-all checkbox is toggled (allCheck).
|
|
3677
|
+
*
|
|
3678
|
+
* 見出しの「すべて選択」チェックボックスをオン・オフしたイベント(allCheck)。
|
|
3679
|
+
*
|
|
3680
|
+
* 切换表头「全选」复选框的事件(allCheck)。
|
|
3681
|
+
*/
|
|
3682
|
+
export interface AllCheckEvent {
|
|
3683
|
+
/**
|
|
3684
|
+
* 새 체크 상태.
|
|
3685
|
+
*
|
|
3686
|
+
* The new checked state.
|
|
3687
|
+
*
|
|
3688
|
+
* 新しいチェック状態。
|
|
3689
|
+
*
|
|
3690
|
+
* 新的勾选状态。
|
|
3691
|
+
*/
|
|
3692
|
+
checked: boolean;
|
|
3693
|
+
}
|
|
3694
|
+
/**
|
|
3695
|
+
* 행을 끌어 같은 그리드 안에서 옮긴 이벤트(rowDrop).
|
|
3696
|
+
*
|
|
3697
|
+
* Event fired when a row is dragged to a new place in the same grid (rowDrop).
|
|
3698
|
+
*
|
|
3699
|
+
* 行をドラッグして同じグリッド内で移動したイベント(rowDrop)。
|
|
3700
|
+
*
|
|
3701
|
+
* 在同一表格内拖动行到新位置的事件(rowDrop)。
|
|
3702
|
+
*/
|
|
3703
|
+
export interface RowDropEvent {
|
|
3704
|
+
/**
|
|
3705
|
+
* 옮기기 전 위치.
|
|
3706
|
+
*
|
|
3707
|
+
* Position before the move.
|
|
3708
|
+
*
|
|
3709
|
+
* 移動前の位置。
|
|
3710
|
+
*
|
|
3711
|
+
* 移动前的位置。
|
|
3712
|
+
*/
|
|
3713
|
+
fromIndex: number;
|
|
3714
|
+
/**
|
|
3715
|
+
* 옮긴 뒤 위치.
|
|
3716
|
+
*
|
|
3717
|
+
* Position after the move.
|
|
3718
|
+
*
|
|
3719
|
+
* 移動後の位置。
|
|
3720
|
+
*
|
|
3721
|
+
* 移动后的位置。
|
|
3722
|
+
*/
|
|
3723
|
+
toIndex: number;
|
|
3724
|
+
}
|
|
3725
|
+
/**
|
|
3726
|
+
* 화면 언어를 바꾼 이벤트(localeChange).
|
|
3727
|
+
*
|
|
3728
|
+
* Event fired when the display locale changes (localeChange).
|
|
3729
|
+
*
|
|
3730
|
+
* 表示言語を変えたイベント(localeChange)。
|
|
3731
|
+
*
|
|
3732
|
+
* 切换显示语言的事件(localeChange)。
|
|
3733
|
+
*/
|
|
3734
|
+
export interface LocaleChangeEvent {
|
|
3735
|
+
/**
|
|
3736
|
+
* 새 언어 id.
|
|
3737
|
+
*
|
|
3738
|
+
* The new locale id.
|
|
3739
|
+
*
|
|
3740
|
+
* 新しい言語 id。
|
|
3741
|
+
*
|
|
3742
|
+
* 新的语言 id。
|
|
3743
|
+
*/
|
|
3744
|
+
locale: string;
|
|
3745
|
+
/**
|
|
3746
|
+
* 바뀌기 전 언어 id.
|
|
3747
|
+
*
|
|
3748
|
+
* The previous locale id.
|
|
3749
|
+
*
|
|
3750
|
+
* 変わる前の言語 id。
|
|
3751
|
+
*
|
|
3752
|
+
* 切换前的语言 id。
|
|
3753
|
+
*/
|
|
3754
|
+
prev: string;
|
|
3755
|
+
}
|
|
3756
|
+
/**
|
|
3757
|
+
* `writeCells` 가 일부 칸을 건너뛰었다는 알림(writeCellsSkip) — 수식 칸 등 쓸 수 없는 칸.
|
|
3758
|
+
*
|
|
3759
|
+
* Notice that `writeCells` skipped some cells (writeCellsSkip) — cells that cannot be written, such as formula cells.
|
|
3760
|
+
*
|
|
3761
|
+
* `writeCells` が一部のセルを飛ばしたという知らせ(writeCellsSkip) — 数式セルなど書き込めないセル。
|
|
3762
|
+
*
|
|
3763
|
+
* `writeCells` 跳过了部分单元格的通知(writeCellsSkip)— 例如公式单元格等无法写入的单元格。
|
|
3764
|
+
*/
|
|
3765
|
+
export interface WriteCellsSkipEvent {
|
|
3766
|
+
/**
|
|
3767
|
+
* 건너뛴 칸 수.
|
|
3768
|
+
*
|
|
3769
|
+
* Number of cells skipped.
|
|
3770
|
+
*
|
|
3771
|
+
* 飛ばしたセルの数。
|
|
3772
|
+
*
|
|
3773
|
+
* 跳过的单元格数。
|
|
3774
|
+
*/
|
|
3775
|
+
skipped: number;
|
|
3776
|
+
/**
|
|
3777
|
+
* 쓰려던 칸 수.
|
|
3778
|
+
*
|
|
3779
|
+
* Number of cells requested.
|
|
3780
|
+
*
|
|
3781
|
+
* 書こうとしたセルの数。
|
|
3782
|
+
*
|
|
3783
|
+
* 请求写入的单元格数。
|
|
3784
|
+
*/
|
|
3785
|
+
total: number;
|
|
3786
|
+
}
|
|
3787
|
+
/**
|
|
3788
|
+
* `grid.on()` 이 받는 이벤트 이름과 그 인자 형의 표. 이름을 적으면 인자 형이 정해져 따로 형을 달지 않아도 된다.
|
|
3789
|
+
* 표에 없는 이름(직접 `emit` 하는 사용자 이벤트 등)도 그대로 쓸 수 있다 — 그때 인자 형은 정해지지 않는다.
|
|
3790
|
+
*
|
|
3791
|
+
* The table of event names `grid.on()` accepts and their argument types. Naming the event fixes the argument type, so no manual annotation is needed.
|
|
3792
|
+
* Names not in the table (such as your own events raised with `emit`) still work; their argument type is simply not fixed.
|
|
3793
|
+
*
|
|
3794
|
+
* `grid.on()` が受け取るイベント名とその引数の型の表。名前を書けば引数の型が決まるので、別に型を付けなくて済みます。
|
|
3795
|
+
* 表にない名前(自分で `emit` する利用者イベントなど)もそのまま使えます — その場合、引数の型は決まりません。
|
|
3796
|
+
*
|
|
3797
|
+
* `grid.on()` 接受的事件名及其参数类型的对照表。写出事件名即可确定参数类型,无需另外标注。
|
|
3798
|
+
* 表中没有的名称(例如自己 `emit` 的用户事件)也可以照常使用 — 此时参数类型不固定。
|
|
3799
|
+
*
|
|
3800
|
+
* @example
|
|
3801
|
+
* grid.on('rowCheck', (e) => console.log(e.rowIndex, e.checked)); // e: RowCheckEvent<Row>
|
|
3802
|
+
* grid.on('formulaRecalc', (e) => console.log(e.cycles, e.ms)); // e: FormulaRecalcEvent
|
|
3803
|
+
*/
|
|
3804
|
+
export interface GridEventMap<T = any> {
|
|
3805
|
+
cellClick: CellEvent<T>;
|
|
3806
|
+
cellDblClick: CellEvent<T>;
|
|
3807
|
+
cellMouseOver: CellEvent<T>;
|
|
3808
|
+
cellMouseOut: CellEvent<T>;
|
|
3809
|
+
cellMouseDown: CellEvent<T>;
|
|
3810
|
+
cellMouseUp: CellEvent<T>;
|
|
3811
|
+
cellMouseMove: CellEvent<T>;
|
|
3812
|
+
cellKeyDown: CellKeyEvent<T>;
|
|
3813
|
+
cellKeyUp: CellKeyEvent<T>;
|
|
3814
|
+
cellKeyPress: CellKeyEvent<T>;
|
|
3815
|
+
rowClick: RowEvent<T>;
|
|
3816
|
+
rowDblClick: RowEvent<T>;
|
|
3817
|
+
rowMouseOver: RowEvent<T>;
|
|
3818
|
+
rowMouseOut: RowEvent<T>;
|
|
3819
|
+
rowMouseDown: RowEvent<T>;
|
|
3820
|
+
rowMouseUp: RowEvent<T>;
|
|
3821
|
+
rowMouseMove: RowEvent<T>;
|
|
3822
|
+
editStart: EditEvent<T>;
|
|
3823
|
+
editEnd: EditEvent<T>;
|
|
3824
|
+
dataChange: T[];
|
|
3825
|
+
selectionChange: SelectionEvent<T>;
|
|
3826
|
+
sortChange: SortEvent;
|
|
3827
|
+
filterChange: FilterEvent;
|
|
3828
|
+
scroll: ScrollEvent;
|
|
3829
|
+
rowExpand: RowExpandEvent<T>;
|
|
3830
|
+
rowCollapse: RowExpandEvent<T>;
|
|
3831
|
+
rowCheck: RowCheckEvent<T>;
|
|
3832
|
+
allCheck: AllCheckEvent;
|
|
3833
|
+
rowDrop: RowDropEvent;
|
|
3834
|
+
pageChange: import('./Pagination.js').PageChangeEvent;
|
|
3835
|
+
rangeChange: RangeChangeEvent;
|
|
3836
|
+
rangeCopy: RangeCopyEvent;
|
|
3837
|
+
rangeFill: RangeFillEvent;
|
|
3838
|
+
formulaChange: FormulaChangeEvent;
|
|
3839
|
+
formulaRecalc: FormulaRecalcEvent;
|
|
3840
|
+
formulaError: FormulaErrorEvent;
|
|
3841
|
+
gridDropBefore: GridDropEvent<T>;
|
|
3842
|
+
gridDropAfter: GridDropEvent<T>;
|
|
3843
|
+
gridDropComplete: GridDropEvent<T>;
|
|
3844
|
+
gridDropMapping: GridMappingEvent<T>;
|
|
3845
|
+
chartCreate: import('./chart/types.js').ChartInstance;
|
|
3846
|
+
chartRender: {
|
|
3847
|
+
id: string;
|
|
3848
|
+
model: import('./chart/types.js').ChartDataModel;
|
|
3849
|
+
};
|
|
3850
|
+
chartPointClick: {
|
|
3851
|
+
id: string;
|
|
3852
|
+
point: import('./chart/types.js').ChartPoint;
|
|
3853
|
+
};
|
|
3854
|
+
chartDestroy: {
|
|
3855
|
+
id: string;
|
|
3856
|
+
};
|
|
3857
|
+
localeChange: LocaleChangeEvent;
|
|
3858
|
+
writeCellsSkip: WriteCellsSkipEvent;
|
|
3859
|
+
ready: OpenGridInstance<T>;
|
|
3860
|
+
}
|
|
3368
3861
|
/**
|
|
3369
3862
|
* override 레이어 함수: 첫 인자는 안쪽(원본 근접) 함수. orig(...) 호출이 super 처럼 동작.
|
|
3370
3863
|
*
|
|
@@ -3781,6 +4274,9 @@ export interface OpenGridInstance<T = any> {
|
|
|
3781
4274
|
insertRow(item: Partial<T>, position?: Position): void;
|
|
3782
4275
|
pushRow(items: Partial<T> | Partial<T>[]): void;
|
|
3783
4276
|
unshiftRow(items: Partial<T> | Partial<T>[]): void;
|
|
4277
|
+
appendRows(items: Partial<T> | Partial<T>[]): void;
|
|
4278
|
+
prependRows(items: Partial<T> | Partial<T>[]): void;
|
|
4279
|
+
reorderRow(fromIndex: number, toIndex: number): void;
|
|
3784
4280
|
deleteRow(rowIndex: number | number[]): void;
|
|
3785
4281
|
deleteById(ids: string[]): void;
|
|
3786
4282
|
readCell<K extends keyof T>(rowIndex: number, field: K): T[K];
|
|
@@ -3788,6 +4284,40 @@ export interface OpenGridInstance<T = any> {
|
|
|
3788
4284
|
getDisplayValue(rowIndex: number, field: string): string;
|
|
3789
4285
|
writeCell(rowIndex: number, field: string, value: any): void;
|
|
3790
4286
|
getRowAt(rowIndex: number): T;
|
|
4287
|
+
/**
|
|
4288
|
+
* 화면 순서로 늘어놓은 **전체** 목록(그룹 머리·트리·상세 칸 포함)에서 `flatIndex` 번째 줄의 데이터 행을 돌려준다. 이 번호는 스크롤 위치와 무관하다 — 지금 창에 보이는 줄 가운데 몇 번째가 아니다. 그룹 머리·상세 칸이면 `null`, 트리 줄이면 그 노드의 데이터 행.
|
|
4289
|
+
* `getRowAt(rowIndex)` 는 데이터의 표시 순서라 그룹·트리·상세가 켜지면 둘이 다른 줄을 가리킨다.
|
|
4290
|
+
*
|
|
4291
|
+
* Returns the data row on the `flatIndex`-th line of the **whole** list laid out in on-screen order (group heads, tree rows and detail slots included). The number does not depend on the scroll position — it is not a position among the lines currently visible in the viewport. `null` for group heads and detail slots; for tree lines, that node's data row.
|
|
4292
|
+
* `getRowAt(rowIndex)` uses the data's display order, so with grouping, tree or detail on the two point at different lines.
|
|
4293
|
+
*
|
|
4294
|
+
* 画面順に並べた**全体**の一覧(グループ見出し・ツリー・詳細欄を含む)で `flatIndex` 番目の行のデータ行を返します。この番号はスクロール位置と関係ありません — いま窓に見えている行の中での何番目かではありません。グループ見出し・詳細欄なら `null`、ツリーの行ならそのノードのデータ行。
|
|
4295
|
+
* `getRowAt(rowIndex)` はデータの表示順なので、グループ・ツリー・詳細が有効だと両者は別の行を指します。
|
|
4296
|
+
*
|
|
4297
|
+
* 在按画面顺序排列的**完整**列表(包括分组标题、树、详情栏)中,返回第 `flatIndex` 行的数据行。这个编号与滚动位置无关 — 不是当前窗口中可见行里的第几行。分组标题、详情栏返回 `null`;树的行返回该节点的数据行。
|
|
4298
|
+
* `getRowAt(rowIndex)` 使用数据的显示顺序,启用分组、树、详情时两者指向不同的行。
|
|
4299
|
+
*
|
|
4300
|
+
* @param flatIndex - 화면 순서 전체 목록에서의 줄 번호(0부터, 스크롤과 무관)
|
|
4301
|
+
*
|
|
4302
|
+
* Line number in the whole on-screen-order list (0-based, independent of scrolling)
|
|
4303
|
+
*
|
|
4304
|
+
* 画面順の全体一覧での行番号(0 始まり、スクロールと無関係)
|
|
4305
|
+
*
|
|
4306
|
+
* 在画面顺序完整列表中的行号(从 0 开始,与滚动无关)
|
|
4307
|
+
*
|
|
4308
|
+
* @returns 데이터 행, 없으면 `null`
|
|
4309
|
+
*
|
|
4310
|
+
* The data row, or `null`
|
|
4311
|
+
*
|
|
4312
|
+
* データ行、なければ `null`
|
|
4313
|
+
*
|
|
4314
|
+
* 数据行,没有则为 `null`
|
|
4315
|
+
*
|
|
4316
|
+
* @example
|
|
4317
|
+
* const row = grid.getFlatRow(3); // 전체 목록의 넷째 줄(스크롤해도 같은 줄)
|
|
4318
|
+
* if (row) console.log(row.name);
|
|
4319
|
+
*/
|
|
4320
|
+
getFlatRow(flatIndex: number): T | null;
|
|
3791
4321
|
/**
|
|
3792
4322
|
* 화면에 보이는 행 순서와 실제 데이터를 이어 주는 내부 모델을 돌려줍니다(고급 배선용).
|
|
3793
4323
|
*
|
|
@@ -3864,7 +4394,7 @@ export interface OpenGridInstance<T = any> {
|
|
|
3864
4394
|
getColumnDefs(): ColumnDef<T>[];
|
|
3865
4395
|
getAllColumnDefs(): ColumnDef<T>[];
|
|
3866
4396
|
getColumnCount(): number;
|
|
3867
|
-
applyColumns(columns:
|
|
4397
|
+
applyColumns(columns: ColumnOrGroup<T>[]): void;
|
|
3868
4398
|
insertColumn(colDef: ColumnDef<T>, position?: Position): void;
|
|
3869
4399
|
deleteColumn(field: string): void;
|
|
3870
4400
|
hideColumn(field: string | string[]): void;
|
|
@@ -4210,17 +4740,28 @@ export interface OpenGridInstance<T = any> {
|
|
|
4210
4740
|
moveCheckedTo(target: OpenGridInstance<T>): Promise<boolean>;
|
|
4211
4741
|
freeze(columnCount: number): void;
|
|
4212
4742
|
freezeRows(rowCount: number): void;
|
|
4743
|
+
mergeCells(cells: import('./MergeEngine.js').MergeCell[]): void;
|
|
4744
|
+
autoMerge(fields: string[]): void;
|
|
4745
|
+
clearMerge(): void;
|
|
4213
4746
|
groupBy(fields: string[]): void;
|
|
4214
4747
|
clearGroup(): void;
|
|
4215
4748
|
addTreeRow(item: Partial<T>, parentId: string, position?: Position): void;
|
|
4216
4749
|
expandAll(): void;
|
|
4217
4750
|
collapseAll(): void;
|
|
4218
4751
|
expandNodes(ids: string | string[], open?: boolean): void;
|
|
4752
|
+
enableTree(): void;
|
|
4753
|
+
disableTree(): void;
|
|
4754
|
+
expandAllNodes(): void;
|
|
4755
|
+
collapseAllNodes(): void;
|
|
4219
4756
|
exportExcel(options?: ExportOptions | string): void;
|
|
4220
4757
|
exportCsv(options?: ExportOptions | string): void;
|
|
4221
4758
|
exportJson(options?: ExportOptions | string): void;
|
|
4222
4759
|
toArray(keyValue?: boolean): any[];
|
|
4223
4760
|
print(options?: PrintOptions): void;
|
|
4761
|
+
setPageSize(size: number): void;
|
|
4762
|
+
setRowHeight(px: number): void;
|
|
4763
|
+
openFindBar(): void;
|
|
4764
|
+
closeFindBar(): void;
|
|
4224
4765
|
jumpToRow(rowIndex: number): void;
|
|
4225
4766
|
jumpToCol(field: string): void;
|
|
4226
4767
|
getScrollPos(): {
|
|
@@ -4233,6 +4774,12 @@ export interface OpenGridInstance<T = any> {
|
|
|
4233
4774
|
resize(width?: number, height?: number): void;
|
|
4234
4775
|
setTheme(theme: string): void;
|
|
4235
4776
|
setThemeVar(varName: string, value: string): void;
|
|
4777
|
+
setIcon(role: string, svgOrKey: string): OpenGridInstance<T>;
|
|
4778
|
+
renderIcon(role: string, opts?: {
|
|
4779
|
+
size?: number;
|
|
4780
|
+
title?: string;
|
|
4781
|
+
el?: boolean;
|
|
4782
|
+
}): string | SVGElement;
|
|
4236
4783
|
/**
|
|
4237
4784
|
* 스킨(형태 축)을 바꿉니다 — 모서리·테두리·여백 같은 "생김새"만 갈아 끼우고, 색 테마는 그대로 둡니다.
|
|
4238
4785
|
*
|
|
@@ -4351,15 +4898,18 @@ export interface OpenGridInstance<T = any> {
|
|
|
4351
4898
|
openContextMenu(e: MouseEvent, items?: ContextMenuItem[]): void;
|
|
4352
4899
|
closeContextMenu(): void;
|
|
4353
4900
|
setFilterSelect(config: import('./FilterSelect.js').FilterSelectConfig | null): void;
|
|
4354
|
-
addWorksheet(name: string, columns?:
|
|
4901
|
+
addWorksheet(name: string, columns?: ColumnOrGroup<T>[], data?: T[]): void;
|
|
4355
4902
|
removeWorksheet(name: string): void;
|
|
4356
4903
|
switchWorksheet(name: string): void;
|
|
4357
4904
|
renameWorksheet(oldName: string, newName: string): void;
|
|
4358
4905
|
getWorksheet(name: string): WorksheetState<T> | undefined;
|
|
4359
4906
|
getWorksheetNames(): string[];
|
|
4360
4907
|
exportSheetsExcel(filename?: string): void;
|
|
4908
|
+
on<K extends keyof GridEventMap<T>>(event: K, handler: (e: GridEventMap<T>[K]) => void): OpenGridInstance<T>;
|
|
4361
4909
|
on(event: string, handler: Function): OpenGridInstance<T>;
|
|
4910
|
+
once<K extends keyof GridEventMap<T>>(event: K, handler: (e: GridEventMap<T>[K]) => void): OpenGridInstance<T>;
|
|
4362
4911
|
once(event: string, handler: Function): OpenGridInstance<T>;
|
|
4912
|
+
off<K extends keyof GridEventMap<T>>(event: K, handler?: (e: GridEventMap<T>[K]) => void): OpenGridInstance<T>;
|
|
4363
4913
|
off(event: string, handler?: Function): OpenGridInstance<T>;
|
|
4364
4914
|
emit(event: string, data?: any): void;
|
|
4365
4915
|
/**
|
|
@@ -4443,7 +4993,7 @@ export interface WorksheetDef<T = any> {
|
|
|
4443
4993
|
*
|
|
4444
4994
|
* 工作表专用的列(未指定时共用表格的 columns)。
|
|
4445
4995
|
*/
|
|
4446
|
-
columns?:
|
|
4996
|
+
columns?: ColumnOrGroup<T>[];
|
|
4447
4997
|
data?: T[];
|
|
4448
4998
|
}
|
|
4449
4999
|
/**
|
|
@@ -4457,7 +5007,7 @@ export interface WorksheetDef<T = any> {
|
|
|
4457
5007
|
*/
|
|
4458
5008
|
export interface WorksheetState<T = any> {
|
|
4459
5009
|
name: string;
|
|
4460
|
-
columns:
|
|
5010
|
+
columns: ColumnOrGroup<T>[];
|
|
4461
5011
|
data: T[];
|
|
4462
5012
|
}
|
|
4463
5013
|
/**
|