sheetnext 0.2.3 → 0.2.4

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.
Files changed (14) hide show
  1. package/README.md +164 -164
  2. package/README_CN.md +163 -163
  3. package/dist/sheetnext.css +1 -1
  4. package/dist/sheetnext.es.js +3 -3
  5. package/dist/sheetnext.locale.zh-CN.es.js +3 -3
  6. package/dist/sheetnext.locale.zh-CN.umd.js +3 -3
  7. package/dist/sheetnext.umd.js +3 -3
  8. package/docs/ai-relay.md +284 -284
  9. package/docs/core-api.md +3008 -2980
  10. package/docs/enums.md +171 -171
  11. package/docs/events.md +331 -331
  12. package/docs/image_en.png +0 -0
  13. package/docs/json-format.md +426 -426
  14. package/package.json +1 -1
package/docs/enums.md CHANGED
@@ -1,171 +1,171 @@
1
- # Enum API
2
-
3
- > Generated: 2026-03-17
4
-
5
- ## Enum Types
6
-
7
- > Access via `SN.Enum.XXX`, or import from `sheetnext/enum`.
8
-
9
- ### EventPriority
10
- - Event priority. Lower values run earlier.
11
-
12
- | Key | Value | Description |
13
- | --- | --- | --- |
14
- | SYSTEM | -2000 | Internal system |
15
- | PROTECTION | -1000 | Protection checks |
16
- | PLUGIN | -500 | Plugin |
17
- | NORMAL | 0 | Default |
18
- | LATE | 500 | Post-processing |
19
- | AUDIT | 1000 | Audit log |
20
-
21
- ### PasteMode
22
- - Paste mode.
23
-
24
- | Key | Value | Description |
25
- | --- | --- | --- |
26
- | ALL | all | All (default) |
27
- | VALUE | value | Values only |
28
- | FORMULA | formula | Formulas only |
29
- | FORMAT | format | Formats only |
30
- | NO_BORDER | noBorder | Without borders |
31
- | COLUMN_WIDTH | colWidth | Column widths |
32
- | COMMENT | comment | Comment |
33
- | VALIDATION | validation | Data validation |
34
- | TRANSPOSE | transpose | Transpose |
35
- | VALUE_NUMBER_FORMAT | valueNumberFormat | Values and number formats |
36
- | ALL_MERGE_CONDITIONAL | allMergeConditional | All with source theme |
37
- | FORMULA_NUMBER_FORMAT | formulaNumberFormat | Formulas and number formats |
38
-
39
- ### PasteOperation
40
- - Paste operation mode.
41
-
42
- | Key | Value | Description |
43
- | --- | --- | --- |
44
- | NONE | none | None |
45
- | ADD | add | Add |
46
- | SUBTRACT | sub | Subtract |
47
- | MULTIPLY | mul | Multiply |
48
- | DIVIDE | div | Divide |
49
-
50
- ### AnchorType
51
- - Drawing anchor type.
52
-
53
- | Key | Value | Description |
54
- | --- | --- | --- |
55
- | TWO_CELL | twoCell | Move and resize with cells |
56
- | ONE_CELL | oneCell | Move with cells only |
57
- | ABSOLUTE | absolute | Fixed position |
58
-
59
- ### DrawingType
60
- - Drawing type.
61
-
62
- | Key | Value | Description |
63
- | --- | --- | --- |
64
- | CHART | chart | - |
65
- | IMAGE | image | - |
66
- | SHAPE | shape | - |
67
- | SLICER | slicer | - |
68
-
69
- ### ValidationType
70
- - Data validation type.
71
-
72
- | Key | Value | Description |
73
- | --- | --- | --- |
74
- | LIST | list | Dropdown list |
75
- | WHOLE | whole | Integer |
76
- | DECIMAL | decimal | Decimal |
77
- | DATE | date | Date |
78
- | TIME | time | Time |
79
- | TEXT_LENGTH | textLength | Text length |
80
- | CUSTOM | custom | Custom formula |
81
-
82
- ### ValidationOperator
83
- - Data validation operator.
84
-
85
- | Key | Value | Description |
86
- | --- | --- | --- |
87
- | BETWEEN | between | Between |
88
- | NOT_BETWEEN | notBetween | Not between |
89
- | EQUAL | equal | Equal |
90
- | NOT_EQUAL | notEqual | Not equal |
91
- | GREATER_THAN | greaterThan | Greater than |
92
- | GREATER_THAN_OR_EQUAL | greaterThanOrEqual | Greater than or equal |
93
- | LESS_THAN | lessThan | Less than |
94
- | LESS_THAN_OR_EQUAL | lessThanOrEqual | Less than or equal |
95
-
96
- ### FilterOperator
97
- - Filter condition operator.
98
-
99
- | Key | Value | Description |
100
- | --- | --- | --- |
101
- | EQUAL | equal | Equal |
102
- | NOT_EQUAL | notEqual | Not equal |
103
- | GREATER_THAN | greaterThan | Greater than |
104
- | GREATER_THAN_OR_EQUAL | greaterThanOrEqual | Greater than or equal |
105
- | LESS_THAN | lessThan | Less than |
106
- | LESS_THAN_OR_EQUAL | lessThanOrEqual | Less than or equal |
107
- | BEGINS_WITH | beginsWith | Begins with |
108
- | ENDS_WITH | endsWith | Ends with |
109
- | CONTAINS | contains | Contains |
110
- | NOT_CONTAINS | notContains | Does not contain |
111
-
112
- ### CFType
113
- - Conditional formatting type.
114
-
115
- | Key | Value | Description |
116
- | --- | --- | --- |
117
- | CELL_VALUE | cellIs | Cell Value |
118
- | TEXT_CONTAINS | containsText | Text contains |
119
- | DATE_OCCURRING | timePeriod | Date occurring |
120
- | TOP_BOTTOM | top10 | Top/bottom N |
121
- | ABOVE_AVERAGE | aboveAverage | Above/below average |
122
- | DUPLICATE | duplicateValues | Duplicate values |
123
- | UNIQUE | uniqueValues | Unique values |
124
- | DATA_BAR | dataBar | DATA BAR |
125
- | COLOR_SCALE | colorScale | COLOUR STEP |
126
- | ICON_SET | iconSet | ICON SET |
127
- | EXPRESSION | expression | FORMULA |
128
-
129
- ### SortOrder
130
- - Sort direction.
131
-
132
- | Key | Value | Description |
133
- | --- | --- | --- |
134
- | ASC | asc | Ascending |
135
- | DESC | desc | Descending |
136
-
137
- ### HorizontalAlign
138
- - Horizontal alignment.
139
-
140
- | Key | Value | Description |
141
- | --- | --- | --- |
142
- | LEFT | left | - |
143
- | CENTER | center | - |
144
- | RIGHT | right | - |
145
- | JUSTIFY | justify | Justify |
146
- | FILL | fill | Fill |
147
- | DISTRIBUTED | distributed | Distributed |
148
-
149
- ### VerticalAlign
150
- - Vertical alignment.
151
-
152
- | Key | Value | Description |
153
- | --- | --- | --- |
154
- | TOP | top | - |
155
- | CENTER | center | - |
156
- | BOTTOM | bottom | - |
157
- | JUSTIFY | justify | - |
158
- | DISTRIBUTED | distributed | - |
159
-
160
- ### BorderStyle
161
- - Border Style
162
-
163
- | Key | Value | Description |
164
- | --- | --- | --- |
165
- | NONE | none | - |
166
- | THIN | thin | - |
167
- | MEDIUM | medium | - |
168
- | THICK | thick | - |
169
- | DASHED | dashed | - |
170
- | DOTTED | dotted | - |
171
- | DOUBLE | double | - |
1
+ # Enum API
2
+
3
+ > Generated: 2026-03-27
4
+
5
+ ## Enum Types
6
+
7
+ > Access via `SN.Enum.XXX`, or import from `sheetnext/enum`.
8
+
9
+ ### EventPriority
10
+ - Event priority. Lower values run earlier.
11
+
12
+ | Key | Value | Description |
13
+ | --- | --- | --- |
14
+ | SYSTEM | -2000 | Internal system |
15
+ | PROTECTION | -1000 | Protection checks |
16
+ | PLUGIN | -500 | Plugin |
17
+ | NORMAL | 0 | Default |
18
+ | LATE | 500 | Post-processing |
19
+ | AUDIT | 1000 | Audit log |
20
+
21
+ ### PasteMode
22
+ - Paste mode.
23
+
24
+ | Key | Value | Description |
25
+ | --- | --- | --- |
26
+ | ALL | all | All (default) |
27
+ | VALUE | value | Values only |
28
+ | FORMULA | formula | Formulas only |
29
+ | FORMAT | format | Formats only |
30
+ | NO_BORDER | noBorder | Without borders |
31
+ | COLUMN_WIDTH | colWidth | Column widths |
32
+ | COMMENT | comment | Comment |
33
+ | VALIDATION | validation | Data validation |
34
+ | TRANSPOSE | transpose | Transpose |
35
+ | VALUE_NUMBER_FORMAT | valueNumberFormat | Values and number formats |
36
+ | ALL_MERGE_CONDITIONAL | allMergeConditional | All with source theme |
37
+ | FORMULA_NUMBER_FORMAT | formulaNumberFormat | Formulas and number formats |
38
+
39
+ ### PasteOperation
40
+ - Paste operation mode.
41
+
42
+ | Key | Value | Description |
43
+ | --- | --- | --- |
44
+ | NONE | none | None |
45
+ | ADD | add | Add |
46
+ | SUBTRACT | sub | Subtract |
47
+ | MULTIPLY | mul | Multiply |
48
+ | DIVIDE | div | Divide |
49
+
50
+ ### AnchorType
51
+ - Drawing anchor type.
52
+
53
+ | Key | Value | Description |
54
+ | --- | --- | --- |
55
+ | TWO_CELL | twoCell | Move and resize with cells |
56
+ | ONE_CELL | oneCell | Move with cells only |
57
+ | ABSOLUTE | absolute | Fixed position |
58
+
59
+ ### DrawingType
60
+ - Drawing type.
61
+
62
+ | Key | Value | Description |
63
+ | --- | --- | --- |
64
+ | CHART | chart | - |
65
+ | IMAGE | image | - |
66
+ | SHAPE | shape | - |
67
+ | SLICER | slicer | - |
68
+
69
+ ### ValidationType
70
+ - Data validation type.
71
+
72
+ | Key | Value | Description |
73
+ | --- | --- | --- |
74
+ | LIST | list | Dropdown list |
75
+ | WHOLE | whole | Integer |
76
+ | DECIMAL | decimal | Decimal |
77
+ | DATE | date | Date |
78
+ | TIME | time | Time |
79
+ | TEXT_LENGTH | textLength | Text length |
80
+ | CUSTOM | custom | Custom formula |
81
+
82
+ ### ValidationOperator
83
+ - Data validation operator.
84
+
85
+ | Key | Value | Description |
86
+ | --- | --- | --- |
87
+ | BETWEEN | between | Between |
88
+ | NOT_BETWEEN | notBetween | Not between |
89
+ | EQUAL | equal | Equal |
90
+ | NOT_EQUAL | notEqual | Not equal |
91
+ | GREATER_THAN | greaterThan | Greater than |
92
+ | GREATER_THAN_OR_EQUAL | greaterThanOrEqual | Greater than or equal |
93
+ | LESS_THAN | lessThan | Less than |
94
+ | LESS_THAN_OR_EQUAL | lessThanOrEqual | Less than or equal |
95
+
96
+ ### FilterOperator
97
+ - Filter condition operator.
98
+
99
+ | Key | Value | Description |
100
+ | --- | --- | --- |
101
+ | EQUAL | equal | Equal |
102
+ | NOT_EQUAL | notEqual | Not equal |
103
+ | GREATER_THAN | greaterThan | Greater than |
104
+ | GREATER_THAN_OR_EQUAL | greaterThanOrEqual | Greater than or equal |
105
+ | LESS_THAN | lessThan | Less than |
106
+ | LESS_THAN_OR_EQUAL | lessThanOrEqual | Less than or equal |
107
+ | BEGINS_WITH | beginsWith | Begins with |
108
+ | ENDS_WITH | endsWith | Ends with |
109
+ | CONTAINS | contains | Contains |
110
+ | NOT_CONTAINS | notContains | Does not contain |
111
+
112
+ ### CFType
113
+ - Conditional formatting type.
114
+
115
+ | Key | Value | Description |
116
+ | --- | --- | --- |
117
+ | CELL_VALUE | cellIs | Cell Value |
118
+ | TEXT_CONTAINS | containsText | Text contains |
119
+ | DATE_OCCURRING | timePeriod | Date occurring |
120
+ | TOP_BOTTOM | top10 | Top/bottom N |
121
+ | ABOVE_AVERAGE | aboveAverage | Above/below average |
122
+ | DUPLICATE | duplicateValues | Duplicate values |
123
+ | UNIQUE | uniqueValues | Unique values |
124
+ | DATA_BAR | dataBar | DATA BAR |
125
+ | COLOR_SCALE | colorScale | COLOUR STEP |
126
+ | ICON_SET | iconSet | ICON SET |
127
+ | EXPRESSION | expression | FORMULA |
128
+
129
+ ### SortOrder
130
+ - Sort direction.
131
+
132
+ | Key | Value | Description |
133
+ | --- | --- | --- |
134
+ | ASC | asc | Ascending |
135
+ | DESC | desc | Descending |
136
+
137
+ ### HorizontalAlign
138
+ - Horizontal alignment.
139
+
140
+ | Key | Value | Description |
141
+ | --- | --- | --- |
142
+ | LEFT | left | - |
143
+ | CENTER | center | - |
144
+ | RIGHT | right | - |
145
+ | JUSTIFY | justify | Justify |
146
+ | FILL | fill | Fill |
147
+ | DISTRIBUTED | distributed | Distributed |
148
+
149
+ ### VerticalAlign
150
+ - Vertical alignment.
151
+
152
+ | Key | Value | Description |
153
+ | --- | --- | --- |
154
+ | TOP | top | - |
155
+ | CENTER | center | - |
156
+ | BOTTOM | bottom | - |
157
+ | JUSTIFY | justify | - |
158
+ | DISTRIBUTED | distributed | - |
159
+
160
+ ### BorderStyle
161
+ - Border Style
162
+
163
+ | Key | Value | Description |
164
+ | --- | --- | --- |
165
+ | NONE | none | - |
166
+ | THIN | thin | - |
167
+ | MEDIUM | medium | - |
168
+ | THICK | thick | - |
169
+ | DASHED | dashed | - |
170
+ | DOTTED | dotted | - |
171
+ | DOUBLE | double | - |