@sheetxl/sdk 0.6.15 → 0.6.17
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/browser/cjs/{DEezdLdn55kGultJ.cjs → B0ZRkYe5vXS8AXl5.cjs} +1 -1
- package/browser/cjs/{C_JGndrOOobXdWM9.cjs → B8C0qJCXRmSK9w8i.cjs} +1 -1
- package/browser/cjs/{DwsD11UtBZVBKXDj.cjs → BiZu_UkuyEYl_49H.cjs} +1 -1
- package/browser/cjs/{DoYc2FzwQCh04_iU.cjs → BjkUWCp2ObvYeP19.cjs} +1 -1
- package/browser/cjs/{B8Z20ZHnVdKPe_wg.cjs → BrPDVJeOA7eotIdQ.cjs} +1 -1
- package/browser/cjs/{BMlsgnEKkvuJ_zCU.cjs → Bt0KH5ry8A-H2XJc.cjs} +1 -1
- package/browser/cjs/{DPW1fNYgmA7pYuD4.cjs → ByU95-ZXPn3w3tPi.cjs} +1 -1
- package/browser/cjs/{CpEBLzivH9arChhd.cjs → BynzHHQPUmhMyHYX.cjs} +3 -3
- package/browser/cjs/{drmp51GNkc-_dEhU.cjs → C2z-2oeFQXCC2sdF.cjs} +1 -1
- package/browser/cjs/{Dx5kop28TgYNjLWg.cjs → CNU-5-cLXkZdlc_I.cjs} +1 -1
- package/browser/cjs/{B1FSysGLiMuBWWG7.cjs → C_7BUvmtSDknJjxh.cjs} +1 -1
- package/browser/cjs/{BmAuZ-x329wWwez-.cjs → Ck6yfrJGBKcCAnfo.cjs} +2 -2
- package/browser/cjs/{DD47hmAQlYVCONFG.cjs → DAVtwWgUmRbYKaUI.cjs} +1 -1
- package/browser/cjs/{C1Z-iNMVmlFh0-9a.cjs → DS7I31gDrgGx-Kjc.cjs} +1 -1
- package/browser/cjs/{Dy7TA5w_6b7NZ9L5.cjs → DSBHJBPea75XkjbG.cjs} +1 -1
- package/browser/cjs/D_KL_f2CIY390LrK.cjs +54 -0
- package/browser/cjs/{DANE2K4uLXH2h6L_.cjs → DbJg_p3YrWqNiONk.cjs} +1 -1
- package/browser/cjs/{EYh0tqpDATD-VWjH.cjs → Dudo2JNx8nSohuJ9.cjs} +1 -1
- package/browser/cjs/{CVgEYzGdf73vqt1t.cjs → DwpsSlAaY2T3Rh0z.cjs} +1 -1
- package/browser/cjs/{tVPyTuFILZF8dLSx.cjs → MxGT1owu3LK7lzv4.cjs} +1 -1
- package/browser/cjs/{BE6JxE7oSWBEp-mN.cjs → OlJ4WvknCU0tx9zr.cjs} +2 -2
- package/browser/cjs/{BqL47R-5d3W6dAVu.cjs → PYxlwwf8LymgB6KF.cjs} +1 -1
- package/browser/cjs/{DnxziYwOHzv72aCD.cjs → QSfpWHpM3ExP8C31.cjs} +1 -1
- package/browser/cjs/{C62iavaEh4cKs8ra.cjs → SDe43jbsWmUivkUh.cjs} +1 -1
- package/browser/cjs/{DV0GzxQXzduRewRU.cjs → g-p1ZhI1XIJx-vvq.cjs} +1 -1
- package/browser/cjs/{b7ZrNvJyGPgBRWxt.cjs → g44jkX22Kjpaujd8.cjs} +1 -1
- package/browser/cjs/index.cjs +2 -2
- package/browser/cjs/{CCTKLml0jGdTAZmx.cjs → vytrRYuoufF5SUFz.cjs} +1 -1
- package/browser/esm/{T3E730OGyqLICaG4.mjs → 1H4OcVpECNdo2leo.mjs} +1 -1
- package/browser/esm/BCR-QupOzqFjIQ26.mjs +23328 -0
- package/browser/esm/{BcWVEl_OmB71TLif.mjs → BSkaqwyDqSBFahkS.mjs} +1 -1
- package/browser/esm/{uQly1tDDOJIVS3ry.mjs → BbRFZyuCl2YcHE_O.mjs} +1 -1
- package/browser/esm/{CIpcOv2dF1XO5m1x.mjs → BcSMUT4Sx-YNny4I.mjs} +1 -1
- package/browser/esm/{nS59IDXNCyy1-vgD.mjs → Bj5dWxpiNTkchR1Y.mjs} +1 -1
- package/{node/esm/BzevSgN_GJWMD5yy.mjs → browser/esm/Bo9TMq-qqBydQB-d.mjs} +1 -1
- package/browser/esm/{sqBXERj3-thNudHO.mjs → Bu-rq4yH8T1EwN2P.mjs} +1 -1
- package/browser/esm/{2hhwCP61Sa3v1NjZ.mjs → CF9WRmqFK1b5FwUY.mjs} +1 -1
- package/browser/esm/{CTejJJENMp_FS_6U.mjs → CiDTEYF3f2Ays6hs.mjs} +1 -1
- package/browser/esm/{Dm_128Lljhtv6Jn3.mjs → CijgE8Xdf4U-p_n_.mjs} +1 -1
- package/{node/esm/B0g5pJy-yw8fGJdl.mjs → browser/esm/Cjbrqj_RTTjDFoIZ.mjs} +1 -1
- package/browser/esm/{C9G6mh11Yamc32zo.mjs → D1kVfIYxJreinijW.mjs} +1 -1
- package/{node/esm/BphXbjjrr-xRvn_v.mjs → browser/esm/D3Dm6W1dzveetEon.mjs} +1 -1
- package/browser/esm/{BjhhLrmxn09ZN2F4.mjs → DGvCi12sa7ZIIyrU.mjs} +1 -1
- package/{node/esm/Cz0W8hPCLvXlkbQo.mjs → browser/esm/DKVh-BpPSxRKNBg0.mjs} +1 -1
- package/browser/esm/{icvBR7LJkMU_-6XY.mjs → D_RGE3EZfJC5ZZWR.mjs} +2 -2
- package/{node/esm/PPPix-VNwJDk_TOK.mjs → browser/esm/DbfaEgmktGZoVmR9.mjs} +1 -1
- package/{node/esm/B97kvVdQfa3Exl2N.mjs → browser/esm/Dh0gG6If4az9wdA_.mjs} +1 -1
- package/browser/esm/{gWGzpjWJcRXCmFpy.mjs → Ls1ZSIs4_Dizy6M2.mjs} +1 -1
- package/browser/esm/{QAWVi4qmFpATjne0.mjs → PC-0s4BlfmcUuM2n.mjs} +2 -2
- package/browser/esm/{BoFx5mWOQ9kDmxAd.mjs → VABCB8JWd3GRuJSJ.mjs} +1 -1
- package/browser/esm/{6vhfFZ6TcuKo4lbQ.mjs → W2jVr33Yj6xCsoBI.mjs} +3 -3
- package/browser/esm/index.mjs +2 -2
- package/browser/esm/{DJkuQy_knvUrhvPq.mjs → sblqA0GEw7u_7uUc.mjs} +1 -1
- package/browser/esm/{CNF1rtJTtfg0sPAm.mjs → v18e8vKmxVrtktOm.mjs} +1 -1
- package/browser/esm/{DKa84yD16Xrsh-v9.mjs → vbJIfJnzIQ7BWeaz.mjs} +1 -1
- package/browser/esm/{ZH5jyv9nq8TH5fJm.mjs → xQmntmz9bIJQGGk5.mjs} +1 -1
- package/node/esm/{B6qtasB4ksqh4JoN.mjs → 60NBbrQpc9hm9XDF.mjs} +1 -1
- package/node/esm/{CKBYykISy-lvkNyD.mjs → B-VscQXhRPYYzMBg.mjs} +1 -1
- package/node/esm/{BcWVEl_OmB71TLif.mjs → BSkaqwyDqSBFahkS.mjs} +1 -1
- package/node/esm/{uQly1tDDOJIVS3ry.mjs → BbRFZyuCl2YcHE_O.mjs} +1 -1
- package/node/esm/{CIpcOv2dF1XO5m1x.mjs → BcSMUT4Sx-YNny4I.mjs} +1 -1
- package/node/esm/{nS59IDXNCyy1-vgD.mjs → Bj5dWxpiNTkchR1Y.mjs} +1 -1
- package/{browser/esm/BzevSgN_GJWMD5yy.mjs → node/esm/Bo9TMq-qqBydQB-d.mjs} +1 -1
- package/node/esm/{CAlsCjZ5AvJtJ3Pm.mjs → BpnjD3v17ME5wsuw.mjs} +1 -1
- package/node/esm/{sqBXERj3-thNudHO.mjs → Bu-rq4yH8T1EwN2P.mjs} +1 -1
- package/node/esm/{CW-N7xXW32EPyr3n.mjs → C4eGsdqRlRQklHCI.mjs} +1 -1
- package/node/esm/{DHSx9xekAnH8zZVV.mjs → CV4lgmXng9GwC7Jc.mjs} +2 -2
- package/node/esm/{B5SmfILHrn_jXyuk.mjs → CduvvHyonYr0CJdM.mjs} +1 -1
- package/node/esm/{Cfn8RWH90XePIyI4.mjs → Ch4EonmIhss9y_h3.mjs} +1 -1
- package/{browser/esm/B0g5pJy-yw8fGJdl.mjs → node/esm/Cjbrqj_RTTjDFoIZ.mjs} +1 -1
- package/node/esm/{C9G6mh11Yamc32zo.mjs → D1kVfIYxJreinijW.mjs} +1 -1
- package/{browser/esm/BphXbjjrr-xRvn_v.mjs → node/esm/D3Dm6W1dzveetEon.mjs} +1 -1
- package/{browser/esm/Cz0W8hPCLvXlkbQo.mjs → node/esm/DKVh-BpPSxRKNBg0.mjs} +1 -1
- package/{browser/esm/PPPix-VNwJDk_TOK.mjs → node/esm/DbfaEgmktGZoVmR9.mjs} +1 -1
- package/{browser/esm/B97kvVdQfa3Exl2N.mjs → node/esm/Dh0gG6If4az9wdA_.mjs} +1 -1
- package/node/esm/{B4b_hQqKGPRL1siC.mjs → DkQjw7yUaMjLtVhs.mjs} +1 -1
- package/node/esm/{pD_Jl_6CMYcVAUPV.mjs → DrAv_iWPmonAJ9-3.mjs} +1 -1
- package/node/esm/{gWGzpjWJcRXCmFpy.mjs → Ls1ZSIs4_Dizy6M2.mjs} +1 -1
- package/node/esm/{BoFx5mWOQ9kDmxAd.mjs → VABCB8JWd3GRuJSJ.mjs} +1 -1
- package/node/esm/index.mjs +2196 -1980
- package/node/esm/{DJkuQy_knvUrhvPq.mjs → sblqA0GEw7u_7uUc.mjs} +1 -1
- package/node/esm/{CNF1rtJTtfg0sPAm.mjs → v18e8vKmxVrtktOm.mjs} +1 -1
- package/package.json +4 -4
- package/types/index.d.ts +312 -147
- package/types/scripting.d.ts +484 -174
- package/browser/cjs/BxD8HnRMYSdquKAd.cjs +0 -54
- package/browser/esm/DLiq84aEiY21Fyro.mjs +0 -23110
package/types/index.d.ts
CHANGED
|
@@ -776,6 +776,10 @@ declare namespace CellState {
|
|
|
776
776
|
/* Excluded from this release type: IteratorOptions */
|
|
777
777
|
}
|
|
778
778
|
|
|
779
|
+
declare interface CellStyleUpdater {
|
|
780
|
+
(update: IStyle.Update, options?: IStyle.UpdateOptions, range?: IRange.Coords): IStyle;
|
|
781
|
+
}
|
|
782
|
+
|
|
779
783
|
declare type CellToString<C extends IRange.CellCoords = IRange.CellCoords> = (cell: C) => string;
|
|
780
784
|
|
|
781
785
|
/**
|
|
@@ -2151,7 +2155,19 @@ export declare namespace IBorder {
|
|
|
2151
2155
|
}
|
|
2152
2156
|
export interface IStroke {
|
|
2153
2157
|
getStyle(): StrokeStyle;
|
|
2158
|
+
/**
|
|
2159
|
+
* Sets the stroke style.
|
|
2160
|
+
*
|
|
2161
|
+
* @param style The stroke style.
|
|
2162
|
+
*/
|
|
2163
|
+
setStyle(style: IBorder.StrokeStyle | string | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
|
|
2154
2164
|
getColor(): IColor;
|
|
2165
|
+
/**
|
|
2166
|
+
* Sets the stroke color.
|
|
2167
|
+
*
|
|
2168
|
+
* @param color The stroke color.
|
|
2169
|
+
*/
|
|
2170
|
+
setColor(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IBorder.IStroke;
|
|
2155
2171
|
/**
|
|
2156
2172
|
* Returns all the set properties and their values for the border.
|
|
2157
2173
|
*/
|
|
@@ -2200,26 +2216,62 @@ export declare interface IBorder {
|
|
|
2200
2216
|
* @returns The left border.
|
|
2201
2217
|
*/
|
|
2202
2218
|
getLeft(): IBorder.IStroke;
|
|
2219
|
+
/**
|
|
2220
|
+
* Sets the left border.
|
|
2221
|
+
*
|
|
2222
|
+
* @param edge The border edge.
|
|
2223
|
+
*/
|
|
2224
|
+
setLeft(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
|
|
2203
2225
|
/**
|
|
2204
2226
|
* @returns The top border.
|
|
2205
2227
|
*/
|
|
2206
2228
|
getTop(): IBorder.IStroke;
|
|
2229
|
+
/**
|
|
2230
|
+
* Sets the top border.
|
|
2231
|
+
*
|
|
2232
|
+
* @param edge The border edge.
|
|
2233
|
+
*/
|
|
2234
|
+
setTop(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
|
|
2207
2235
|
/**
|
|
2208
2236
|
* @returns The right border.
|
|
2209
2237
|
*/
|
|
2210
2238
|
getRight(): IBorder.IStroke;
|
|
2239
|
+
/**
|
|
2240
|
+
* Sets the right border.
|
|
2241
|
+
*
|
|
2242
|
+
* @param edge The border edge.
|
|
2243
|
+
*/
|
|
2244
|
+
setRight(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
|
|
2211
2245
|
/**
|
|
2212
2246
|
* @returns The bottom border.
|
|
2213
2247
|
*/
|
|
2214
2248
|
getBottom(): IBorder.IStroke;
|
|
2249
|
+
/**
|
|
2250
|
+
* Sets the bottom border.
|
|
2251
|
+
*
|
|
2252
|
+
* @param edge The border edge.
|
|
2253
|
+
*/
|
|
2254
|
+
setBottom(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
|
|
2215
2255
|
/**
|
|
2216
2256
|
* @returns The diagonalUp border.
|
|
2217
2257
|
*/
|
|
2218
2258
|
getDiagonalUp(): IBorder.IStroke;
|
|
2259
|
+
/**
|
|
2260
|
+
* Sets the diagonalUp border.
|
|
2261
|
+
*
|
|
2262
|
+
* @param edge The border edge.
|
|
2263
|
+
*/
|
|
2264
|
+
setDiagonalUp(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
|
|
2219
2265
|
/**
|
|
2220
2266
|
* @returns The diagonalDown border.
|
|
2221
2267
|
*/
|
|
2222
2268
|
getDiagonalDown(): IBorder.IStroke;
|
|
2269
|
+
/**
|
|
2270
|
+
* Sets the diagonalDown border.
|
|
2271
|
+
*
|
|
2272
|
+
* @param edge The border edge.
|
|
2273
|
+
*/
|
|
2274
|
+
setDiagonalDown(edge: IBorder.IStroke | IProperties.ResolvableProperties<IBorder.StrokeProperties> | string | null, options?: IStyle.UpdateOptions): IBorder;
|
|
2223
2275
|
/**
|
|
2224
2276
|
* If there are any borders that are not none.
|
|
2225
2277
|
*/
|
|
@@ -4271,30 +4323,6 @@ export declare namespace ICellProtection {
|
|
|
4271
4323
|
* - Methods that transform the range's data into a different type use a `to` prefix (e.g., `toArray()`).
|
|
4272
4324
|
*/
|
|
4273
4325
|
export declare interface ICellRange {
|
|
4274
|
-
/**
|
|
4275
|
-
* Retrieves an {@link IStyle.Updater} object for updating the styles of the range.
|
|
4276
|
-
*
|
|
4277
|
-
* Unlike {@link ICell.getStyle}, which provides a read-only view of a cell's style,
|
|
4278
|
-
* this method returns an updater object that allows modifications to the styles
|
|
4279
|
-
* of all cells in the range.
|
|
4280
|
-
*
|
|
4281
|
-
* @example
|
|
4282
|
-
* ```typescript
|
|
4283
|
-
* const updater = range.getStyleUpdater();
|
|
4284
|
-
* updater.setColor("blue").setFont("Arial");
|
|
4285
|
-
* ```
|
|
4286
|
-
* @returns {IStyle.Updater} A style updater for the range.
|
|
4287
|
-
*
|
|
4288
|
-
* @remarks
|
|
4289
|
-
* - **Deterministic Behavior**: All updates via the `IStyle.Updater` are applied
|
|
4290
|
-
* to the entire range, overriding any mixed styles with the specified values.
|
|
4291
|
-
* - **Read-Only Alternatives**: To inspect styles across all cells in the range
|
|
4292
|
-
* without modifying them, use {@link ICellRange.entries} or {@link ICellRange.forEach} to iterate over immutable
|
|
4293
|
-
* {@link ICell}s.
|
|
4294
|
-
* - **Immutable Philosophy**: This API aligns with the principle that `ICell`
|
|
4295
|
-
* objects are immutable, while `ICellRange` is the interface for mutable operations.
|
|
4296
|
-
*/
|
|
4297
|
-
getStyleUpdater(): IStyle.Updater;
|
|
4298
4326
|
/**
|
|
4299
4327
|
* Return an array of coords for all merges.
|
|
4300
4328
|
*
|
|
@@ -4331,6 +4359,13 @@ export declare interface ICellRange {
|
|
|
4331
4359
|
* {@link ICellRange.getValues}
|
|
4332
4360
|
*/
|
|
4333
4361
|
getValue(options?: ICellRange.GetValuesOptions): Scalar | JSScalar;
|
|
4362
|
+
/**
|
|
4363
|
+
* Returns the style for the ranges.
|
|
4364
|
+
*
|
|
4365
|
+
* @see
|
|
4366
|
+
* {@link ICellRange.getStyle}
|
|
4367
|
+
*/
|
|
4368
|
+
getStyle(): IStyle;
|
|
4334
4369
|
/**
|
|
4335
4370
|
* Returns the intersection of the current range and the specified range.
|
|
4336
4371
|
*
|
|
@@ -4652,14 +4687,6 @@ export declare interface ICellRange {
|
|
|
4652
4687
|
* @returns Current `ICellRange`.
|
|
4653
4688
|
*/
|
|
4654
4689
|
unmerge(options?: ITransaction.OperationOptions): this;
|
|
4655
|
-
/**
|
|
4656
|
-
* Update the style for the range(s).
|
|
4657
|
-
*
|
|
4658
|
-
* @param style {@link IStyle.Update}
|
|
4659
|
-
* @param options {@link IStyle.UpdateOptions}
|
|
4660
|
-
* @returns Current `ICellRange`.
|
|
4661
|
-
*/
|
|
4662
|
-
updateStyle(style: IStyle.Update, options?: IStyle.UpdateOptions): this;
|
|
4663
4690
|
/**
|
|
4664
4691
|
* Returns an iterator of ICells that match the results.
|
|
4665
4692
|
*
|
|
@@ -5825,13 +5852,13 @@ export declare interface ICellRanges {
|
|
|
5825
5852
|
*/
|
|
5826
5853
|
getSheet(): ISheet;
|
|
5827
5854
|
/**
|
|
5828
|
-
*
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
|
|
5832
|
-
*
|
|
5855
|
+
* Returns the style for the range.
|
|
5856
|
+
*
|
|
5857
|
+
* @remarks
|
|
5858
|
+
* When querying the style the values will always be for the top left. However the
|
|
5859
|
+
* set values work for the entire range.
|
|
5833
5860
|
*/
|
|
5834
|
-
|
|
5861
|
+
getStyle(): IStyle;
|
|
5835
5862
|
/**
|
|
5836
5863
|
* {@inheritDoc ICellRange.find}
|
|
5837
5864
|
*/
|
|
@@ -7906,7 +7933,14 @@ export declare interface IFill {
|
|
|
7906
7933
|
* (for example color, backgroundColor)
|
|
7907
7934
|
*/
|
|
7908
7935
|
toCSS(darkMode?: boolean, bounds?: Bounds): Properties;
|
|
7936
|
+
/**
|
|
7937
|
+
* Returns the fill as a JSON object.
|
|
7938
|
+
*/
|
|
7909
7939
|
toJSON(): IFill.JSON;
|
|
7940
|
+
/**
|
|
7941
|
+
* For type checking.
|
|
7942
|
+
*/
|
|
7943
|
+
readonly isIFill: true;
|
|
7910
7944
|
}
|
|
7911
7945
|
|
|
7912
7946
|
/**
|
|
@@ -8159,6 +8193,12 @@ export declare namespace IFill {
|
|
|
8159
8193
|
* Returns the color of the fill.
|
|
8160
8194
|
*/
|
|
8161
8195
|
getColor(): IColor;
|
|
8196
|
+
/**
|
|
8197
|
+
* Sets the stroke color.
|
|
8198
|
+
*
|
|
8199
|
+
* @param color The stroke color.
|
|
8200
|
+
*/
|
|
8201
|
+
setColor(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IFill.ISolid;
|
|
8162
8202
|
}
|
|
8163
8203
|
export interface SolidProperties<C = IColor.Serializable> extends IFill.Properties {
|
|
8164
8204
|
/**
|
|
@@ -8252,7 +8292,7 @@ export declare namespace IFill {
|
|
|
8252
8292
|
* @see
|
|
8253
8293
|
* {@link IFill.IGradient.getStops}
|
|
8254
8294
|
*/
|
|
8255
|
-
stops?: GradientStopProperties<C>[];
|
|
8295
|
+
stops?: (GradientStopProperties<C> | C)[];
|
|
8256
8296
|
/**
|
|
8257
8297
|
* @see
|
|
8258
8298
|
* {@link IFill.IGradient.getGradientType}
|
|
@@ -8284,19 +8324,46 @@ export declare namespace IFill {
|
|
|
8284
8324
|
* * This must be at least two stops.
|
|
8285
8325
|
*/
|
|
8286
8326
|
getStops(): IGradientStop[];
|
|
8327
|
+
/**
|
|
8328
|
+
* Sets the gradient stops.
|
|
8329
|
+
*
|
|
8330
|
+
* @param stops The gradient stops.
|
|
8331
|
+
*/
|
|
8332
|
+
setStops(stops: (IGradientStop | IColor.Serializable | null)[], options?: IStyle.UpdateOptions): IFill.IGradient;
|
|
8287
8333
|
/**
|
|
8288
8334
|
* The type of gradient.
|
|
8289
8335
|
* @defaultValue GradientType.Linear
|
|
8290
8336
|
*/
|
|
8291
8337
|
getGradientType(): IFill.GradientType;
|
|
8338
|
+
/**
|
|
8339
|
+
* Sets the gradient type.
|
|
8340
|
+
*
|
|
8341
|
+
* @param type The gradient type.
|
|
8342
|
+
*/
|
|
8343
|
+
setGradientType(type: IFill.GradientType | null, options?: IStyle.UpdateOptions): IFill.IGradient;
|
|
8292
8344
|
/**
|
|
8293
8345
|
* The angle of the gradient in degrees if gradient type is linear.
|
|
8294
8346
|
*/
|
|
8295
8347
|
getAngle(): number;
|
|
8348
|
+
/**
|
|
8349
|
+
* Sets the rotation
|
|
8350
|
+
*
|
|
8351
|
+
* @param angle The angle
|
|
8352
|
+
*/
|
|
8353
|
+
setAngle(angle: number | null, options?: IStyle.UpdateOptions): IFill.IGradient;
|
|
8296
8354
|
/**
|
|
8297
8355
|
* Used for path and circular gradients.
|
|
8298
8356
|
*/
|
|
8299
8357
|
getFillTo(): Rectangle;
|
|
8358
|
+
/**
|
|
8359
|
+
* Sets the fill area for the gradient.
|
|
8360
|
+
*
|
|
8361
|
+
* @param fillTo The fill area.
|
|
8362
|
+
*/
|
|
8363
|
+
setFillTo(fillTo: Rectangle | null, options?: IStyle.UpdateOptions): IFill.IGradient;
|
|
8364
|
+
/**
|
|
8365
|
+
* Converts the gradient fill to a JSON representation.
|
|
8366
|
+
*/
|
|
8300
8367
|
toJSON(): GradientJSON;
|
|
8301
8368
|
}
|
|
8302
8369
|
export interface GradientJSON extends GradientProperties<string> {
|
|
@@ -8313,14 +8380,35 @@ export declare namespace IFill {
|
|
|
8313
8380
|
* The foreground color for the pattern.
|
|
8314
8381
|
*/
|
|
8315
8382
|
getForeground(): IColor;
|
|
8383
|
+
/**
|
|
8384
|
+
* Sets the foreground color.
|
|
8385
|
+
*
|
|
8386
|
+
* @param color The foreground color.
|
|
8387
|
+
*/
|
|
8388
|
+
setForeground(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IFill.IPattern;
|
|
8316
8389
|
/**
|
|
8317
8390
|
* The background color for the pattern.
|
|
8318
8391
|
*/
|
|
8319
8392
|
getBackground(): IColor;
|
|
8393
|
+
/**
|
|
8394
|
+
* Sets the background color.
|
|
8395
|
+
*
|
|
8396
|
+
* @param color The background color.
|
|
8397
|
+
*/
|
|
8398
|
+
setBackground(color: IColor.Serializable | null, options?: IStyle.UpdateOptions): IFill.IPattern;
|
|
8320
8399
|
/**
|
|
8321
8400
|
* The type of pattern used.
|
|
8322
8401
|
*/
|
|
8323
8402
|
getPatternType(): IFill.BuiltInSheetPattern;
|
|
8403
|
+
/**
|
|
8404
|
+
* Sets the pattern type.
|
|
8405
|
+
*
|
|
8406
|
+
* @param type The pattern type.
|
|
8407
|
+
*/
|
|
8408
|
+
setPatternType(type: IFill.BuiltInSheetPattern | null, options?: IStyle.UpdateOptions): IFill.IPattern;
|
|
8409
|
+
/**
|
|
8410
|
+
* Converts the pattern fill to a JSON representation.
|
|
8411
|
+
*/
|
|
8324
8412
|
toJSON(): PatternJSON;
|
|
8325
8413
|
}
|
|
8326
8414
|
export interface PatternProperties<C = IColor.Serializable> extends IFill.Properties {
|
|
@@ -13930,30 +14018,96 @@ export declare interface IStyle {
|
|
|
13930
14018
|
*
|
|
13931
14019
|
* @remarks
|
|
13932
14020
|
* * If a number provided the builtIn numFmtId as defined in OOXML will be used.
|
|
13933
|
-
*
|
|
14021
|
+
* * {@link NumberFormat.Type}
|
|
13934
14022
|
*/
|
|
13935
14023
|
getNumberFormat(): string;
|
|
14024
|
+
/**
|
|
14025
|
+
* @see {@link IStyle.getNumberFormat}
|
|
14026
|
+
*/
|
|
14027
|
+
setNumberFormat(numFmt: string | null, options?: IStyle.UpdateOptions): IStyle;
|
|
13936
14028
|
/**
|
|
13937
14029
|
* A boolean value indicating whether the text string in a cell should be prefixed by a single quote mark (e.g., 'text).
|
|
13938
14030
|
* In these cases, the quote is not stored in the Shared Strings Part.
|
|
13939
14031
|
*/
|
|
13940
14032
|
getQuotePrefix(): boolean;
|
|
13941
14033
|
/**
|
|
13942
|
-
*
|
|
14034
|
+
* @see {@link IStyle.getQuotePrefix}
|
|
13943
14035
|
*/
|
|
13944
|
-
|
|
14036
|
+
setQuotePrefix(quotePrefix: boolean | null, options?: IStyle.UpdateOptions): IStyle;
|
|
13945
14037
|
/**
|
|
13946
14038
|
* Returns the border style.
|
|
13947
14039
|
*/
|
|
13948
14040
|
getBorder(): IBorder;
|
|
14041
|
+
/**
|
|
14042
|
+
* Sets the border style.
|
|
14043
|
+
*
|
|
14044
|
+
* This method allows updating borders using an {@link IBorder} or a shorthand property object.
|
|
14045
|
+
*
|
|
14046
|
+
* @param border The border object or a shorthand property object to apply. Pass `null` to clear.
|
|
14047
|
+
* @param options Optional configuration for the update.
|
|
14048
|
+
* @returns The `IBorder` object for further modifications.
|
|
14049
|
+
*/
|
|
14050
|
+
setBorder(border: IBorder | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IStyle;
|
|
13949
14051
|
/**
|
|
13950
14052
|
* Fill properties for the background.
|
|
13951
14053
|
*/
|
|
13952
14054
|
getFill(): IFill.ISolid | IFill.IGradient | IFill.IPattern | IFill.INone;
|
|
14055
|
+
/**
|
|
14056
|
+
* Sets the fill style.
|
|
14057
|
+
*
|
|
14058
|
+
* This method allows updating fill using an {@link IFill} or a shorthand property object.
|
|
14059
|
+
*
|
|
14060
|
+
* @param fill The fill object or a shorthand property object to apply. Pass `null` to clear.
|
|
14061
|
+
* @param options Optional configuration for the update.
|
|
14062
|
+
* @returns The `IFill` object for further modifications.
|
|
14063
|
+
*/
|
|
14064
|
+
setFill(fill: IFill | IProperties.ResolvableProperties<IFill.Properties> | string | null, options?: IStyle.UpdateOptions): IStyle;
|
|
14065
|
+
/**
|
|
14066
|
+
* Returns the alignment for the style.
|
|
14067
|
+
*/
|
|
14068
|
+
getAlignment(): ITextFrame.IAlignment;
|
|
14069
|
+
/**
|
|
14070
|
+
* Sets the alignment style.
|
|
14071
|
+
*
|
|
14072
|
+
* This method allows updating alignments using an {@link ITextFrame.IAlignment} or a shorthand property object.
|
|
14073
|
+
*
|
|
14074
|
+
* @param alignment The alignment object or a shorthand property object to apply. Pass `null` to clear.
|
|
14075
|
+
* @param options Optional configuration for the update.
|
|
14076
|
+
* @returns The `ITextFrame.IAlignment` object for further modifications.
|
|
14077
|
+
*/
|
|
14078
|
+
setAlignment(alignment: ITextFrame.IAlignment | IProperties.ResolvableProperties<ITextFrame.IAlignment.Properties> | string | null, options?: IStyle.UpdateOptions): IStyle;
|
|
13953
14079
|
/**
|
|
13954
14080
|
* Returns the font for the style.
|
|
13955
14081
|
*/
|
|
13956
14082
|
getFont(): IStyledFont;
|
|
14083
|
+
/**
|
|
14084
|
+
* Sets the font style.
|
|
14085
|
+
*
|
|
14086
|
+
* This method allows updating fill using an {@link IStyledFont} or a shorthand property object.
|
|
14087
|
+
*
|
|
14088
|
+
* @param font The font object or a shorthand property object to apply. Pass `null` to clear.
|
|
14089
|
+
* @param options Optional configuration for the update.
|
|
14090
|
+
* @returns The `IStyledFont` object for further modifications.
|
|
14091
|
+
*/
|
|
14092
|
+
setFont(font: IStyledFont | IProperties.ResolvableProperties<IStyledFont.Properties> | string | null, options?: IStyle.UpdateOptions): IStyle;
|
|
14093
|
+
/**
|
|
14094
|
+
* Returns an instance of the named style that this is derived from.
|
|
14095
|
+
*/
|
|
14096
|
+
getNamed(): IStyle.INamed;
|
|
14097
|
+
/**
|
|
14098
|
+
* Sets the named style that this is derived from.
|
|
14099
|
+
*
|
|
14100
|
+
* @param named The named style to set.
|
|
14101
|
+
*/
|
|
14102
|
+
setNamed(named: string | IStyle.INamed | null, options?: IStyle.UpdateOptions): IStyle;
|
|
14103
|
+
/**
|
|
14104
|
+
* Update many style properties at once.
|
|
14105
|
+
*
|
|
14106
|
+
* @param update {@link IStyle.Update}
|
|
14107
|
+
* @param options {@link IStyle.UpdateOptions}
|
|
14108
|
+
* @returns The `IStyle` for further modifications.
|
|
14109
|
+
*/
|
|
14110
|
+
update(update: IStyle.Update, options?: IStyle.UpdateOptions): IStyle;
|
|
13957
14111
|
/**
|
|
13958
14112
|
* Measure the text using the styling properties
|
|
13959
14113
|
*
|
|
@@ -13990,14 +14144,14 @@ export declare interface IStyle {
|
|
|
13990
14144
|
* @param update Adjustments to the style.
|
|
13991
14145
|
*/
|
|
13992
14146
|
createTemporaryStyle(update: IStyle.Update): IStyle;
|
|
13993
|
-
/**
|
|
13994
|
-
* Returns an instance of the named style that this is derived from.
|
|
13995
|
-
*/
|
|
13996
|
-
getNamed(): IStyle.INamed;
|
|
13997
14147
|
/**
|
|
13998
14148
|
* Returns `true` if the CellStyle is the normal style
|
|
13999
14149
|
*/
|
|
14000
14150
|
isNormal(): boolean;
|
|
14151
|
+
/**
|
|
14152
|
+
* Returns a JSON representation of the style.
|
|
14153
|
+
*/
|
|
14154
|
+
toJSON(): IStyle.JSON | null;
|
|
14001
14155
|
/**
|
|
14002
14156
|
* For runtime type checking.
|
|
14003
14157
|
*/
|
|
@@ -14101,106 +14255,6 @@ export declare namespace IStyle {
|
|
|
14101
14255
|
*/
|
|
14102
14256
|
autoFit?: boolean | ICellRange.AutoFitOptions;
|
|
14103
14257
|
}
|
|
14104
|
-
/**
|
|
14105
|
-
* Provides an API for updating styles.
|
|
14106
|
-
*/
|
|
14107
|
-
export interface Updater {
|
|
14108
|
-
/**
|
|
14109
|
-
* @see {@link IStyle.getNumberFormat}
|
|
14110
|
-
*/
|
|
14111
|
-
setNumberFormat(numFmt: string | null, options?: IStyle.UpdateOptions): this;
|
|
14112
|
-
/**
|
|
14113
|
-
* Sets or removes the quote prefix for the range.
|
|
14114
|
-
*
|
|
14115
|
-
* The quote prefix ensures that values in cells are treated as text.
|
|
14116
|
-
*
|
|
14117
|
-
* @see {@link IStyle.getQuotePrefix}
|
|
14118
|
-
*/
|
|
14119
|
-
setQuotePrefix(quotePrefix: boolean | null, options?: IStyle.UpdateOptions): this;
|
|
14120
|
-
/**
|
|
14121
|
-
* Sets the alignment style.
|
|
14122
|
-
*
|
|
14123
|
-
* This method allows updating alignments using an {@link ITextFrame.IAlignment} or a shorthand property object.
|
|
14124
|
-
*
|
|
14125
|
-
* @param alignment The alignment object or a shorthand property object to apply. Pass `null` to clear.
|
|
14126
|
-
* @param options Optional configuration for the update.
|
|
14127
|
-
* @returns The `ITextFrame.IAlignment.Updater` object for further modifications.
|
|
14128
|
-
*/
|
|
14129
|
-
setAlignment(alignment: ITextFrame.IAlignment | IProperties.ResolvableProperties<ITextFrame.IAlignment.Properties> | string | null, options?: IStyle.UpdateOptions): ITextFrame.IAlignment;
|
|
14130
|
-
/**
|
|
14131
|
-
* Retrieves the alignment updater.
|
|
14132
|
-
*
|
|
14133
|
-
* @returns An `ITextFrame.IAlignment.Updater` object.
|
|
14134
|
-
*/
|
|
14135
|
-
getAlignment(): ITextFrame.IAlignment;
|
|
14136
|
-
/**
|
|
14137
|
-
* Sets the border style.
|
|
14138
|
-
*
|
|
14139
|
-
* This method allows updating borders using an {@link IBorder} or a shorthand property object.
|
|
14140
|
-
*
|
|
14141
|
-
* @param border The border object or a shorthand property object to apply. Pass `null` to clear.
|
|
14142
|
-
* @param options Optional configuration for the update.
|
|
14143
|
-
* @returns The `IBorder.Updater` object for further modifications.
|
|
14144
|
-
*/
|
|
14145
|
-
setBorder(border: IBorder | IProperties.ResolvableProperties<IBorder.Properties> | string | null, options?: IStyle.UpdateOptions): IBorder;
|
|
14146
|
-
/**
|
|
14147
|
-
* Retrieves the border updater.
|
|
14148
|
-
*
|
|
14149
|
-
* @returns An `IBorder.Updater` object.
|
|
14150
|
-
*/
|
|
14151
|
-
getBorder(): IBorder;
|
|
14152
|
-
/**
|
|
14153
|
-
* Sets the fill style.
|
|
14154
|
-
*
|
|
14155
|
-
* This method allows updating fill using an {@link IFill} or a shorthand property object.
|
|
14156
|
-
*
|
|
14157
|
-
* @param fill The fill object or a shorthand property object to apply. Pass `null` to clear.
|
|
14158
|
-
* @param options Optional configuration for the update.
|
|
14159
|
-
* @returns The `IFill.Updater` object for further modifications.
|
|
14160
|
-
*/
|
|
14161
|
-
setFill(fill: IFill | IProperties.ResolvableProperties<IFill.Properties> | string | null, options?: IStyle.UpdateOptions): IFill;
|
|
14162
|
-
/**
|
|
14163
|
-
* Retrieves the fill updater.
|
|
14164
|
-
*
|
|
14165
|
-
* @returns An `IFIll.Updater` object.
|
|
14166
|
-
*/
|
|
14167
|
-
getFill(): IFill;
|
|
14168
|
-
/**
|
|
14169
|
-
* Sets the font style.
|
|
14170
|
-
*
|
|
14171
|
-
* This method allows updating fill using an {@link IStyledFont} or a shorthand property object.
|
|
14172
|
-
*
|
|
14173
|
-
* @param font The font object or a shorthand property object to apply. Pass `null` to clear.
|
|
14174
|
-
* @param options Optional configuration for the update.
|
|
14175
|
-
* @returns The `IStyledFont.Updater` object for further modifications.
|
|
14176
|
-
*/
|
|
14177
|
-
setFont(font: IFill | IProperties.ResolvableProperties<IFill.Properties> | string | null, options?: IStyle.UpdateOptions): IFill;
|
|
14178
|
-
/**
|
|
14179
|
-
* Retrieves the IStyledFont updater.
|
|
14180
|
-
*
|
|
14181
|
-
* @returns An `IStyledFont.Updater` object.
|
|
14182
|
-
*/
|
|
14183
|
-
getFont(): IStyledFont;
|
|
14184
|
-
/**
|
|
14185
|
-
* Updates multiple style properties at once.
|
|
14186
|
-
*
|
|
14187
|
-
* This method is the most versatile way to update styles, allowing bulk updates with nested properties,
|
|
14188
|
-
* shorthand strings, or function callbacks.
|
|
14189
|
-
*
|
|
14190
|
-
* @example
|
|
14191
|
-
* ```typescript
|
|
14192
|
-
* updater.update({
|
|
14193
|
-
* font: { bold: true, color: "blue" },
|
|
14194
|
-
* fill: { pattern: "solid", color: "yellow" }
|
|
14195
|
-
* });
|
|
14196
|
-
* ```
|
|
14197
|
-
*
|
|
14198
|
-
* @param style An object describing the style updates.
|
|
14199
|
-
* @param options Optional configuration for the update.
|
|
14200
|
-
* @returns The current `Updater` instance for chaining.
|
|
14201
|
-
*/
|
|
14202
|
-
update(style: IStyle.Update, options?: IStyle.UpdateOptions): this;
|
|
14203
|
-
}
|
|
14204
14258
|
export interface JSON extends Properties<string> {
|
|
14205
14259
|
}
|
|
14206
14260
|
/**
|
|
@@ -14664,23 +14718,43 @@ export declare interface IStyledFont {
|
|
|
14664
14718
|
* marshalled into their correct property.
|
|
14665
14719
|
*/
|
|
14666
14720
|
getFamily(): string;
|
|
14721
|
+
/**
|
|
14722
|
+
* @see {@link IStyledFont.getFamily}
|
|
14723
|
+
*/
|
|
14724
|
+
setFamily(family: string | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14667
14725
|
/**
|
|
14668
14726
|
* A list of fonts and their fallbacks. These can also be provided in the fontFamily attribute but will
|
|
14669
14727
|
* be normalized to here.
|
|
14670
14728
|
*/
|
|
14671
14729
|
getFallbacks(): string[];
|
|
14730
|
+
/**
|
|
14731
|
+
* @see {@link IStyledFont.setFallbacks}
|
|
14732
|
+
*/
|
|
14733
|
+
setFallbacks(fallbacks: string[] | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14672
14734
|
/**
|
|
14673
14735
|
* Font size is either a number in points or a string that can be converted such as '14px', '1.5em'.
|
|
14674
14736
|
*/
|
|
14675
14737
|
getSize(): number;
|
|
14738
|
+
/**
|
|
14739
|
+
* @see {@link IStyledFont.setSize}
|
|
14740
|
+
*/
|
|
14741
|
+
setSize(size: number | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14676
14742
|
/**
|
|
14677
14743
|
* The weight of the characters.
|
|
14678
14744
|
*/
|
|
14679
14745
|
getWeight(): number;
|
|
14746
|
+
/**
|
|
14747
|
+
* @see {@link IStyledFont.setWeight}
|
|
14748
|
+
*/
|
|
14749
|
+
setWeight(weight: number | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14680
14750
|
/**
|
|
14681
14751
|
* @default `IFont.Style.Normal`
|
|
14682
14752
|
*/
|
|
14683
14753
|
getStyle(): IFont.Style;
|
|
14754
|
+
/**
|
|
14755
|
+
* @see {@link IStyledFont.setStyle}
|
|
14756
|
+
*/
|
|
14757
|
+
setStyle(style: IFont.Style | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14684
14758
|
/**
|
|
14685
14759
|
* The text color.
|
|
14686
14760
|
*
|
|
@@ -14688,25 +14762,45 @@ export declare interface IStyledFont {
|
|
|
14688
14762
|
* Currently only solid fill is supported but this will be expanded to allow all fill types similar to DrawML.
|
|
14689
14763
|
*/
|
|
14690
14764
|
getFill(): IColor;
|
|
14765
|
+
/**
|
|
14766
|
+
* @see {@link IStyledFont.setFill}
|
|
14767
|
+
*/
|
|
14768
|
+
setFill(fill: IColor | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14691
14769
|
/**
|
|
14692
14770
|
* Adds or removes additional spacing between the characters.
|
|
14693
14771
|
*/
|
|
14694
14772
|
getLetterSpacing(): number;
|
|
14773
|
+
/**
|
|
14774
|
+
* @see {@link IStyledFont.setLetterSpacing}
|
|
14775
|
+
*/
|
|
14776
|
+
setLetterSpacing(letterSpacing: number | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14695
14777
|
/**
|
|
14696
14778
|
* Sets the underline style. If true defaults to single. If false or null defaults to none.
|
|
14697
14779
|
*
|
|
14698
14780
|
* @default `IFont.UnderlineStyle.None`
|
|
14699
14781
|
*/
|
|
14700
14782
|
getUnderline(): IFont.UnderlineStyle;
|
|
14783
|
+
/**
|
|
14784
|
+
* @see {@link IStyledFont.setUnderline}
|
|
14785
|
+
*/
|
|
14786
|
+
setUnderline(underline: IFont.UnderlineStyle | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14701
14787
|
/**
|
|
14702
14788
|
* The effect draws the text with a line through it.
|
|
14703
14789
|
*/
|
|
14704
14790
|
getStrike(): boolean;
|
|
14791
|
+
/**
|
|
14792
|
+
* @see {@link IStyledFont.setStrike}
|
|
14793
|
+
*/
|
|
14794
|
+
setStrike(strike: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14705
14795
|
/**
|
|
14706
14796
|
* Defines the font scheme to use.
|
|
14707
14797
|
* @default `IFont.Scheme.Minor`
|
|
14708
14798
|
*/
|
|
14709
14799
|
getScheme(): IFont.Scheme;
|
|
14800
|
+
/**
|
|
14801
|
+
* @see {@link IStyledFont.setScheme}
|
|
14802
|
+
*/
|
|
14803
|
+
setScheme(scheme: IFont.Scheme | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14710
14804
|
/**
|
|
14711
14805
|
* Returns the vertical alignment of the text within a text line.
|
|
14712
14806
|
*
|
|
@@ -14714,6 +14808,10 @@ export declare interface IStyledFont {
|
|
|
14714
14808
|
* If the IFont.VerticalAlignment is superscript or subscript then the font size should also render smaller.
|
|
14715
14809
|
*/
|
|
14716
14810
|
getVerticalAlignment(): IFont.VerticalAlignment;
|
|
14811
|
+
/**
|
|
14812
|
+
* @see {@link IStyledFont.setVerticalAlignment}
|
|
14813
|
+
*/
|
|
14814
|
+
setVerticalAlignment(verticalAlignment: IFont.VerticalAlignment | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14717
14815
|
/**
|
|
14718
14816
|
* The effect draws a shadow around the text.
|
|
14719
14817
|
*
|
|
@@ -14721,6 +14819,10 @@ export declare interface IStyledFont {
|
|
|
14721
14819
|
* Not rendered by Excel or SheetXL.
|
|
14722
14820
|
*/
|
|
14723
14821
|
getShadow(): boolean;
|
|
14822
|
+
/**
|
|
14823
|
+
* @see {@link IStyledFont.setShadow}
|
|
14824
|
+
*/
|
|
14825
|
+
setShadow(shadow: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14724
14826
|
/**
|
|
14725
14827
|
* The effect draws the text as an outline.
|
|
14726
14828
|
*
|
|
@@ -14728,6 +14830,10 @@ export declare interface IStyledFont {
|
|
|
14728
14830
|
* Not rendered by Excel or SheetXL.
|
|
14729
14831
|
*/
|
|
14730
14832
|
getOutline(): boolean;
|
|
14833
|
+
/**
|
|
14834
|
+
* @see {@link IStyledFont.setOutline}
|
|
14835
|
+
*/
|
|
14836
|
+
setOutline(outline: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14731
14837
|
/**
|
|
14732
14838
|
* The effect extends or stretches out the text.
|
|
14733
14839
|
*
|
|
@@ -14735,6 +14841,10 @@ export declare interface IStyledFont {
|
|
|
14735
14841
|
* Not rendered by Excel or SheetXL.
|
|
14736
14842
|
*/
|
|
14737
14843
|
getExtend(): boolean;
|
|
14844
|
+
/**
|
|
14845
|
+
* @see {@link IStyledFont.setExtend}
|
|
14846
|
+
*/
|
|
14847
|
+
setExtend(extend: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
|
|
14738
14848
|
/**
|
|
14739
14849
|
* Returns `true` if the font is either a superscript or a subscript.
|
|
14740
14850
|
*/
|
|
@@ -15669,10 +15779,22 @@ export declare interface ITextBoxAlignment {
|
|
|
15669
15779
|
* Types of horizontal alignment.
|
|
15670
15780
|
*/
|
|
15671
15781
|
getHorizontal(): ITextFrame.HorizontalAlignment;
|
|
15782
|
+
/**
|
|
15783
|
+
* Sets the horizontal alignment
|
|
15784
|
+
*
|
|
15785
|
+
* @param horizontal The horizontal alignment
|
|
15786
|
+
*/
|
|
15787
|
+
setHorizontal(horizontal: ITextFrame.HorizontalAlignment | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15672
15788
|
/**
|
|
15673
15789
|
* Types of horizontal alignment.
|
|
15674
15790
|
*/
|
|
15675
15791
|
getVertical(): ITextFrame.VerticalAlignment;
|
|
15792
|
+
/**
|
|
15793
|
+
* Sets the vertical alignment
|
|
15794
|
+
*
|
|
15795
|
+
* @param vertical The vertical alignment
|
|
15796
|
+
*/
|
|
15797
|
+
setVertical(vertical: ITextFrame.VerticalAlignment | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15676
15798
|
/**
|
|
15677
15799
|
* An integer value, where an increment of 1 represents 3 spaces.
|
|
15678
15800
|
* Indicates the number of spaces (of the normal style font) of indentation for text in a cell.
|
|
@@ -15681,34 +15803,76 @@ export declare interface ITextBoxAlignment {
|
|
|
15681
15803
|
* This is only applied for alignments: left, right, and distributed.
|
|
15682
15804
|
*/
|
|
15683
15805
|
getIndent(): number;
|
|
15806
|
+
/**
|
|
15807
|
+
* Sets the indentation
|
|
15808
|
+
*
|
|
15809
|
+
* @param indent The indentation
|
|
15810
|
+
*/
|
|
15811
|
+
setIndent(indent: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15684
15812
|
/**
|
|
15685
15813
|
* Indicates additional number of spaces of indentation to adjust for text in a cell.
|
|
15686
15814
|
*/
|
|
15687
15815
|
getRelativeIndent(): number;
|
|
15816
|
+
/**
|
|
15817
|
+
* Sets the relative indentation
|
|
15818
|
+
*
|
|
15819
|
+
* @param relativeIndent The relative indentation
|
|
15820
|
+
*/
|
|
15821
|
+
setRelativeIndent(relativeIndent: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15688
15822
|
/**
|
|
15689
15823
|
* The behavior for text that does not fit with the cell bounds.
|
|
15690
15824
|
* @see
|
|
15691
15825
|
* {@link ITextFrame.Overflow}
|
|
15692
15826
|
*/
|
|
15693
15827
|
getOverflow(): ITextFrame.Overflow;
|
|
15828
|
+
/**
|
|
15829
|
+
* Sets the overflow behavior
|
|
15830
|
+
*
|
|
15831
|
+
* @param overflow The overflow behavior
|
|
15832
|
+
*/
|
|
15833
|
+
setOverflow(overflow: ITextFrame.Overflow | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15694
15834
|
/**
|
|
15695
15835
|
* Rotation of the text.
|
|
15696
15836
|
* @defaultValue 0
|
|
15697
15837
|
*/
|
|
15698
15838
|
getRotation(): number;
|
|
15839
|
+
/**
|
|
15840
|
+
* Sets the rotation
|
|
15841
|
+
*
|
|
15842
|
+
* @param rotation The rotation
|
|
15843
|
+
*/
|
|
15844
|
+
setRotation(rotation: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15699
15845
|
/**
|
|
15700
15846
|
* If the text should stack vertically instead of horizontally.
|
|
15701
15847
|
*/
|
|
15702
15848
|
getStacked(): boolean;
|
|
15849
|
+
/**
|
|
15850
|
+
* Sets the stacked
|
|
15851
|
+
*
|
|
15852
|
+
* @param stacked The stacked
|
|
15853
|
+
*/
|
|
15854
|
+
setStacked(stacked: boolean | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15703
15855
|
/**
|
|
15704
15856
|
* If the cells justified or distributed alignment should be used on the last line of text.
|
|
15705
15857
|
* (This is typical for East Asian alignments but not typical in other contexts.)
|
|
15706
15858
|
*/
|
|
15707
15859
|
getJustifyLastLine(): boolean;
|
|
15860
|
+
/**
|
|
15861
|
+
* Sets the justified last line
|
|
15862
|
+
*
|
|
15863
|
+
* @param justifyLastLine The justified last line
|
|
15864
|
+
*/
|
|
15865
|
+
setJustifyLastLine(justifyLastLine: boolean | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15708
15866
|
/**
|
|
15709
15867
|
* The direction the cell is being read.
|
|
15710
15868
|
*/
|
|
15711
15869
|
getReadingDirection(): ITextFrame.ReadingDirection;
|
|
15870
|
+
/**
|
|
15871
|
+
* Sets the reading direction
|
|
15872
|
+
*
|
|
15873
|
+
* @param readingDirection The reading direction
|
|
15874
|
+
*/
|
|
15875
|
+
setReadingDirection(readingDirection: ITextFrame.ReadingDirection | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
|
|
15712
15876
|
toJSON(): ITextBoxAlignment.JSON;
|
|
15713
15877
|
/**
|
|
15714
15878
|
* For runtime type checking.
|
|
@@ -18627,7 +18791,7 @@ export declare class Sheet implements ISheet {
|
|
|
18627
18791
|
/* Excluded from this release type: _updateState */
|
|
18628
18792
|
/* Excluded from this release type: _addEvent */
|
|
18629
18793
|
/* Excluded from this release type: _getScalar */
|
|
18630
|
-
/* Excluded from this release type:
|
|
18794
|
+
/* Excluded from this release type: _getStyle */
|
|
18631
18795
|
/* Excluded from this release type: _initState */
|
|
18632
18796
|
/* Excluded from this release type: _clearState */
|
|
18633
18797
|
/* Excluded from this release type: _createTableEntry */
|
|
@@ -18673,6 +18837,7 @@ declare interface SheetCellOptions {
|
|
|
18673
18837
|
calcGraph(): ICalcGraph;
|
|
18674
18838
|
colHeaders: ISheetHeader;
|
|
18675
18839
|
getRange(coords: IRange.Coords): ICellRange;
|
|
18840
|
+
styleUpdater: CellStyleUpdater;
|
|
18676
18841
|
opener(url: string, options: ICellRange.SelectOptions, target?: string, features?: string): Promise<boolean>;
|
|
18677
18842
|
}
|
|
18678
18843
|
|