@alineco/docx 9.5.1 → 9.6.1-fork.2
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/README.md +1 -1
- package/dist/index.cjs +32602 -21818
- package/dist/index.d.cts +322 -247
- package/dist/index.d.ts +322 -247
- package/dist/index.iife.js +32937 -22153
- package/dist/index.mjs +32558 -22080
- package/dist/index.umd.cjs +32937 -22153
- package/package.json +17 -19
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
|
-
|
|
3
1
|
import { default as default_2 } from 'jszip';
|
|
4
2
|
import { Element as Element_2 } from 'xml-js';
|
|
5
3
|
import { Stream } from 'stream';
|
|
@@ -11,18 +9,6 @@ export declare class AbstractNumbering extends XmlComponent {
|
|
|
11
9
|
|
|
12
10
|
export declare const abstractNumUniqueNumericIdGen: () => UniqueNumericIdCreator;
|
|
13
11
|
|
|
14
|
-
export declare class Alignment extends XmlComponent {
|
|
15
|
-
constructor(type: (typeof AlignmentType)[keyof typeof AlignmentType]);
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
export declare class AlignmentAttributes extends XmlAttributeComponent<{
|
|
19
|
-
readonly val: (typeof AlignmentType)[keyof typeof AlignmentType];
|
|
20
|
-
}> {
|
|
21
|
-
protected readonly xmlKeys: {
|
|
22
|
-
val: string;
|
|
23
|
-
};
|
|
24
|
-
}
|
|
25
|
-
|
|
26
12
|
export declare const AlignmentType: {
|
|
27
13
|
readonly START: "start";
|
|
28
14
|
readonly CENTER: "center";
|
|
@@ -104,20 +90,12 @@ export declare class Attributes extends XmlAttributeComponent<{
|
|
|
104
90
|
};
|
|
105
91
|
}
|
|
106
92
|
|
|
107
|
-
export declare abstract class BaseEmphasisMark extends XmlComponent {
|
|
108
|
-
protected constructor(emphasisMarkType: (typeof EmphasisMarkType)[keyof typeof EmphasisMarkType]);
|
|
109
|
-
}
|
|
110
|
-
|
|
111
93
|
export declare abstract class BaseXmlComponent {
|
|
112
94
|
protected readonly rootKey: string;
|
|
113
95
|
constructor(rootKey: string);
|
|
114
96
|
abstract prepForXml(context: IContext): IXmlableObject | undefined;
|
|
115
97
|
}
|
|
116
98
|
|
|
117
|
-
declare class Begin extends XmlComponent {
|
|
118
|
-
constructor(dirty?: boolean);
|
|
119
|
-
}
|
|
120
|
-
|
|
121
99
|
declare class Body_2 extends XmlComponent {
|
|
122
100
|
private readonly sections;
|
|
123
101
|
constructor();
|
|
@@ -133,10 +111,7 @@ export declare class Bookmark {
|
|
|
133
111
|
readonly start: BookmarkStart;
|
|
134
112
|
readonly children: readonly ParagraphChild[];
|
|
135
113
|
readonly end: BookmarkEnd;
|
|
136
|
-
constructor(options:
|
|
137
|
-
readonly id: string;
|
|
138
|
-
readonly children: readonly ParagraphChild[];
|
|
139
|
-
});
|
|
114
|
+
constructor(options: IBookmarkOptions);
|
|
140
115
|
}
|
|
141
116
|
|
|
142
117
|
export declare class BookmarkEnd extends XmlComponent {
|
|
@@ -153,10 +128,6 @@ export declare class Border extends IgnoreIfEmptyXmlComponent {
|
|
|
153
128
|
constructor(options: IBordersOptions);
|
|
154
129
|
}
|
|
155
130
|
|
|
156
|
-
export declare class BorderElement extends XmlComponent {
|
|
157
|
-
constructor(elementName: string, { color, size, space, style }: IBorderOptions);
|
|
158
|
-
}
|
|
159
|
-
|
|
160
131
|
export declare const BorderStyle: {
|
|
161
132
|
readonly SINGLE: "single";
|
|
162
133
|
readonly DASH_DOT_STROKED: "dashDotStroked";
|
|
@@ -187,10 +158,6 @@ export declare const BorderStyle: {
|
|
|
187
158
|
readonly WAVE: "wave";
|
|
188
159
|
};
|
|
189
160
|
|
|
190
|
-
declare class Break extends XmlComponent {
|
|
191
|
-
constructor();
|
|
192
|
-
}
|
|
193
|
-
|
|
194
161
|
export declare class BuilderElement<T extends AttributeData = {}> extends XmlComponent {
|
|
195
162
|
constructor({ name, attributes, children, }: {
|
|
196
163
|
readonly name: string;
|
|
@@ -263,22 +230,24 @@ export declare class CheckBoxUtil extends XmlComponent {
|
|
|
263
230
|
}
|
|
264
231
|
|
|
265
232
|
export declare class Column extends XmlComponent {
|
|
266
|
-
constructor(
|
|
233
|
+
constructor(options: IColumnAttributes);
|
|
267
234
|
}
|
|
268
235
|
|
|
269
236
|
export declare class ColumnBreak extends Run {
|
|
270
237
|
constructor();
|
|
271
238
|
}
|
|
272
239
|
|
|
273
|
-
export declare class Columns extends XmlComponent {
|
|
274
|
-
constructor({ space, count, separate, equalWidth, children }: IColumnsAttributes);
|
|
275
|
-
}
|
|
276
|
-
|
|
277
240
|
declare class Comment_2 extends XmlComponent {
|
|
278
|
-
|
|
241
|
+
private readonly paraId?;
|
|
242
|
+
constructor({ id, initials, author, date, children }: ICommentOptions, paraId?: string);
|
|
243
|
+
prepForXml(context: IContext): IXmlableObject | undefined;
|
|
279
244
|
}
|
|
280
245
|
export { Comment_2 as Comment }
|
|
281
246
|
|
|
247
|
+
export declare const commentIdToDurableId: (id: number) => string;
|
|
248
|
+
|
|
249
|
+
export declare const commentIdToParaId: (id: number) => string;
|
|
250
|
+
|
|
282
251
|
export declare class CommentRangeEnd extends XmlComponent {
|
|
283
252
|
constructor(id: number);
|
|
284
253
|
}
|
|
@@ -293,8 +262,26 @@ export declare class CommentReference extends XmlComponent {
|
|
|
293
262
|
|
|
294
263
|
export declare class Comments extends XmlComponent {
|
|
295
264
|
private readonly relationships;
|
|
265
|
+
private readonly threadData?;
|
|
266
|
+
private readonly commentIdData?;
|
|
267
|
+
private readonly commentExtensibleData?;
|
|
296
268
|
constructor({ children }: ICommentsOptions);
|
|
297
269
|
get Relationships(): Relationships;
|
|
270
|
+
get ThreadData(): readonly ICommentThreadData[] | undefined;
|
|
271
|
+
get CommentIdData(): readonly ICommentIdData[] | undefined;
|
|
272
|
+
get CommentExtensibleData(): readonly ICommentExtensibleData[] | undefined;
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
export declare class CommentsExtended extends XmlComponent {
|
|
276
|
+
constructor(threadData: readonly ICommentThreadData[]);
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
export declare class CommentsExtensible extends XmlComponent {
|
|
280
|
+
constructor(commentExtensibleData: readonly ICommentExtensibleData[]);
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
export declare class CommentsIds extends XmlComponent {
|
|
284
|
+
constructor(commentIdData: readonly ICommentIdData[]);
|
|
298
285
|
}
|
|
299
286
|
|
|
300
287
|
declare const CompoundLine: {
|
|
@@ -321,6 +308,9 @@ export declare const concreteNumUniqueNumericIdGen: () => UniqueNumericIdCreator
|
|
|
321
308
|
|
|
322
309
|
declare class ContentTypes extends XmlComponent {
|
|
323
310
|
constructor();
|
|
311
|
+
addCommentsExtended(): void;
|
|
312
|
+
addCommentsIds(): void;
|
|
313
|
+
addCommentsExtensible(): void;
|
|
324
314
|
addFooter(index: number): void;
|
|
325
315
|
addHeader(index: number): void;
|
|
326
316
|
}
|
|
@@ -335,11 +325,19 @@ export declare const convertMillimetersToTwip: (millimeters: number) => number;
|
|
|
335
325
|
|
|
336
326
|
export declare const convertToXmlComponent: (element: Element_2) => ImportedXmlComponent | string | undefined;
|
|
337
327
|
|
|
328
|
+
declare type CoreGroupOptions = {
|
|
329
|
+
readonly children: readonly IGroupChildMediaData[];
|
|
330
|
+
readonly transformation: IMediaTransformation;
|
|
331
|
+
readonly floating?: IFloating;
|
|
332
|
+
readonly altText?: DocPropertiesOptions;
|
|
333
|
+
};
|
|
334
|
+
|
|
338
335
|
declare type CoreImageOptions = {
|
|
339
336
|
readonly transformation: IMediaTransformation;
|
|
340
337
|
readonly floating?: IFloating;
|
|
341
338
|
readonly altText?: DocPropertiesOptions;
|
|
342
339
|
readonly outline?: OutlineOptions;
|
|
340
|
+
readonly solidFill?: SolidFillOptions;
|
|
343
341
|
};
|
|
344
342
|
|
|
345
343
|
declare type CoreMediaData = {
|
|
@@ -352,12 +350,36 @@ declare class CoreProperties extends XmlComponent {
|
|
|
352
350
|
constructor(options: Omit<IPropertiesOptions, "sections">);
|
|
353
351
|
}
|
|
354
352
|
|
|
353
|
+
declare type CoreShapeOptions = {
|
|
354
|
+
readonly transformation: IMediaTransformation;
|
|
355
|
+
readonly floating?: IFloating;
|
|
356
|
+
readonly altText?: DocPropertiesOptions;
|
|
357
|
+
readonly outline?: OutlineOptions;
|
|
358
|
+
readonly solidFill?: SolidFillOptions;
|
|
359
|
+
};
|
|
360
|
+
|
|
361
|
+
export declare const createAlignment: (type: (typeof AlignmentType)[keyof typeof AlignmentType]) => XmlComponent;
|
|
362
|
+
|
|
363
|
+
export declare const createBodyProperties: (options?: IBodyPropertiesOptions) => XmlComponent;
|
|
364
|
+
|
|
365
|
+
export declare const createBorderElement: (elementName: string, { color, size, space, style }: IBorderOptions) => XmlComponent;
|
|
366
|
+
|
|
367
|
+
export declare const createColumns: ({ space, count, separate, equalWidth, children }: IColumnsAttributes) => XmlComponent;
|
|
368
|
+
|
|
355
369
|
export declare const createDocumentGrid: ({ type, linePitch, charSpace }: IDocGridAttributesProperties) => XmlComponent;
|
|
356
370
|
|
|
371
|
+
export declare const createDotEmphasisMark: () => XmlComponent;
|
|
372
|
+
|
|
373
|
+
export declare const createEmphasisMark: (emphasisMarkType?: (typeof EmphasisMarkType)[keyof typeof EmphasisMarkType]) => XmlComponent;
|
|
374
|
+
|
|
357
375
|
export declare const createFrameProperties: (options: IFrameOptions) => XmlComponent;
|
|
358
376
|
|
|
377
|
+
export declare const createHeaderFooterReference: (type: (typeof HeaderFooterType)[keyof typeof HeaderFooterType], options: IHeaderFooterOptions) => XmlComponent;
|
|
378
|
+
|
|
359
379
|
export declare const createHorizontalPosition: ({ relative, align, offset }: IHorizontalPositionOptions) => XmlComponent;
|
|
360
380
|
|
|
381
|
+
export declare const createIndent: ({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties) => XmlComponent;
|
|
382
|
+
|
|
361
383
|
export declare const createLineNumberType: ({ countBy, start, restart, distance }: ILineNumberAttributes) => XmlComponent;
|
|
362
384
|
|
|
363
385
|
export declare const createMathAccentCharacter: ({ accent }: MathAccentCharacterOptions) => XmlComponent;
|
|
@@ -380,14 +402,58 @@ export declare const createMathSuperScriptElement: ({ children }: MathSuperScrip
|
|
|
380
402
|
|
|
381
403
|
export declare const createMathSuperScriptProperties: () => XmlComponent;
|
|
382
404
|
|
|
405
|
+
export declare const createOutlineLevel: (level: number) => XmlComponent;
|
|
406
|
+
|
|
407
|
+
export declare const createPageMargin: (top: number | UniversalMeasure, right: number | PositiveUniversalMeasure, bottom: number | UniversalMeasure, left: number | PositiveUniversalMeasure, header: number | PositiveUniversalMeasure, footer: number | PositiveUniversalMeasure, gutter: number | PositiveUniversalMeasure) => XmlComponent;
|
|
408
|
+
|
|
409
|
+
export declare const createPageNumberType: ({ start, formatType, separator }: IPageNumberTypeAttributes) => XmlComponent;
|
|
410
|
+
|
|
383
411
|
export declare const createPageSize: ({ width, height, orientation, code }: IPageSizeAttributes) => XmlComponent;
|
|
384
412
|
|
|
413
|
+
export declare const createParagraphStyle: (styleId: string) => XmlComponent;
|
|
414
|
+
|
|
415
|
+
export declare const createRunFonts: (nameOrAttrs: string | IFontAttributesProperties, hint?: string) => XmlComponent;
|
|
416
|
+
|
|
417
|
+
export declare const createSectionType: (value: (typeof SectionType)[keyof typeof SectionType]) => XmlComponent;
|
|
418
|
+
|
|
419
|
+
export declare const createShading: ({ fill, color, type }: IShadingAttributesProperties) => XmlComponent;
|
|
420
|
+
|
|
385
421
|
export declare const createSimplePos: () => XmlComponent;
|
|
386
422
|
|
|
423
|
+
export declare const createSpacing: ({ after, before, line, lineRule, beforeAutoSpacing, afterAutoSpacing }: ISpacingProperties) => XmlComponent;
|
|
424
|
+
|
|
387
425
|
export declare const createStringElement: (name: string, value: string) => XmlComponent;
|
|
388
426
|
|
|
427
|
+
export declare const createTableFloatProperties: ({ horizontalAnchor, verticalAnchor, absoluteHorizontalPosition, relativeHorizontalPosition, absoluteVerticalPosition, relativeVerticalPosition, bottomFromText, topFromText, leftFromText, rightFromText, overlap, }: ITableFloatOptions) => XmlComponent;
|
|
428
|
+
|
|
429
|
+
export declare const createTableLayout: (type: (typeof TableLayoutType)[keyof typeof TableLayoutType]) => XmlComponent;
|
|
430
|
+
|
|
431
|
+
export declare const createTableLook: ({ firstRow, lastRow, firstColumn, lastColumn, noHBand, noVBand }: ITableLookOptions) => XmlComponent;
|
|
432
|
+
|
|
433
|
+
export declare const createTableRowHeight: (value: number | PositiveUniversalMeasure, rule: (typeof HeightRule)[keyof typeof HeightRule]) => XmlComponent;
|
|
434
|
+
|
|
435
|
+
export declare const createTableWidthElement: (name: string, { type, size }: ITableWidthProperties) => XmlComponent;
|
|
436
|
+
|
|
437
|
+
export declare const createTabStop: (tabDefinitions: readonly TabStopDefinition[]) => XmlComponent;
|
|
438
|
+
|
|
439
|
+
export declare const createTabStopItem: ({ type, position, leader }: TabStopDefinition) => XmlComponent;
|
|
440
|
+
|
|
441
|
+
export declare const createTransformation: (options: IMediaTransformation) => IMediaDataTransformation;
|
|
442
|
+
|
|
443
|
+
export declare const createUnderline: (underlineType?: (typeof UnderlineType)[keyof typeof UnderlineType], color?: string) => XmlComponent;
|
|
444
|
+
|
|
445
|
+
export declare const createVerticalAlign: (value: (typeof VerticalAlign)[keyof typeof VerticalAlign]) => XmlComponent;
|
|
446
|
+
|
|
389
447
|
export declare const createVerticalPosition: ({ relative, align, offset }: IVerticalPositionOptions) => XmlComponent;
|
|
390
448
|
|
|
449
|
+
export declare const createWrapNone: () => XmlComponent;
|
|
450
|
+
|
|
451
|
+
export declare const createWrapSquare: (textWrapping: ITextWrapping, margins?: IMargins) => XmlComponent;
|
|
452
|
+
|
|
453
|
+
export declare const createWrapTight: (margins?: IMargins) => XmlComponent;
|
|
454
|
+
|
|
455
|
+
export declare const createWrapTopAndBottom: (margins?: IMargins) => XmlComponent;
|
|
456
|
+
|
|
391
457
|
declare class CustomProperties extends XmlComponent {
|
|
392
458
|
private nextId;
|
|
393
459
|
private readonly properties;
|
|
@@ -429,6 +495,7 @@ declare type DocPropertiesOptions = {
|
|
|
429
495
|
readonly name: string;
|
|
430
496
|
readonly description?: string;
|
|
431
497
|
readonly title?: string;
|
|
498
|
+
readonly id?: string;
|
|
432
499
|
};
|
|
433
500
|
|
|
434
501
|
export declare const docPropertiesUniqueNumericIdGen: () => UniqueNumericIdCreator;
|
|
@@ -526,12 +593,8 @@ declare class DocumentWrapper implements IViewWrapper {
|
|
|
526
593
|
get Relationships(): Relationships;
|
|
527
594
|
}
|
|
528
595
|
|
|
529
|
-
export declare class DotEmphasisMark extends BaseEmphasisMark {
|
|
530
|
-
constructor();
|
|
531
|
-
}
|
|
532
|
-
|
|
533
596
|
export declare class Drawing extends XmlComponent {
|
|
534
|
-
constructor(imageData:
|
|
597
|
+
constructor(imageData: IExtendedMediaData, drawingOptions?: IDrawingOptions);
|
|
535
598
|
}
|
|
536
599
|
|
|
537
600
|
export declare const DropCapType: {
|
|
@@ -542,10 +605,6 @@ export declare const DropCapType: {
|
|
|
542
605
|
|
|
543
606
|
export declare const eighthPointMeasureValue: (val: number) => number;
|
|
544
607
|
|
|
545
|
-
export declare class EmphasisMark extends BaseEmphasisMark {
|
|
546
|
-
constructor(emphasisMarkType?: (typeof EmphasisMarkType)[keyof typeof EmphasisMarkType]);
|
|
547
|
-
}
|
|
548
|
-
|
|
549
608
|
export declare const EmphasisMarkType: {
|
|
550
609
|
readonly DOT: "dot";
|
|
551
610
|
};
|
|
@@ -555,23 +614,44 @@ export declare const EMPTY_OBJECT: {};
|
|
|
555
614
|
export declare class EmptyElement extends XmlComponent {
|
|
556
615
|
}
|
|
557
616
|
|
|
558
|
-
declare
|
|
559
|
-
|
|
617
|
+
export declare const encodeUtf8: (str: string) => Uint8Array;
|
|
618
|
+
|
|
619
|
+
export declare class EndnoteIdReference extends XmlComponent {
|
|
620
|
+
constructor(id: number);
|
|
560
621
|
}
|
|
561
622
|
|
|
562
623
|
export declare class EndnoteReference extends EmptyElement {
|
|
563
624
|
constructor();
|
|
564
625
|
}
|
|
565
626
|
|
|
566
|
-
export declare class
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
627
|
+
export declare class EndnoteReferenceRun extends Run {
|
|
628
|
+
constructor(id: number);
|
|
629
|
+
}
|
|
630
|
+
|
|
631
|
+
export declare class EndnoteReferenceRunAttributes extends XmlAttributeComponent<{
|
|
632
|
+
readonly id: number;
|
|
633
|
+
}> {
|
|
634
|
+
protected readonly xmlKeys: {
|
|
635
|
+
id: string;
|
|
570
636
|
};
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
637
|
+
}
|
|
638
|
+
|
|
639
|
+
export declare class Endnotes extends XmlComponent {
|
|
640
|
+
constructor();
|
|
641
|
+
createEndnote(id: number, paragraph: readonly Paragraph[]): void;
|
|
642
|
+
}
|
|
643
|
+
|
|
644
|
+
declare class EndnotesWrapper implements IViewWrapper {
|
|
645
|
+
private readonly endnotes;
|
|
646
|
+
private readonly relationships;
|
|
647
|
+
constructor();
|
|
648
|
+
get View(): Endnotes;
|
|
649
|
+
get Relationships(): Relationships;
|
|
650
|
+
}
|
|
651
|
+
|
|
652
|
+
export declare class ExternalHyperlink extends XmlComponent {
|
|
653
|
+
readonly options: IExternalHyperlinkOptions;
|
|
654
|
+
constructor(options: IExternalHyperlinkOptions);
|
|
575
655
|
}
|
|
576
656
|
|
|
577
657
|
declare class FieldInstruction extends XmlComponent {
|
|
@@ -589,12 +669,16 @@ declare class File_2 {
|
|
|
589
669
|
private readonly media;
|
|
590
670
|
private readonly fileRelationships;
|
|
591
671
|
private readonly footnotesWrapper;
|
|
672
|
+
private readonly endnotesWrapper;
|
|
592
673
|
private readonly settings;
|
|
593
674
|
private readonly contentTypes;
|
|
594
675
|
private readonly customProperties;
|
|
595
676
|
private readonly appProperties;
|
|
596
677
|
private readonly styles;
|
|
597
678
|
private readonly comments;
|
|
679
|
+
private readonly commentsExtended?;
|
|
680
|
+
private readonly commentsIds?;
|
|
681
|
+
private readonly commentsExtensible?;
|
|
598
682
|
private readonly fontWrapper;
|
|
599
683
|
constructor(options: IPropertiesOptions);
|
|
600
684
|
private addSection;
|
|
@@ -615,8 +699,12 @@ declare class File_2 {
|
|
|
615
699
|
get CustomProperties(): CustomProperties;
|
|
616
700
|
get AppProperties(): AppProperties;
|
|
617
701
|
get FootNotes(): FootnotesWrapper;
|
|
702
|
+
get Endnotes(): EndnotesWrapper;
|
|
618
703
|
get Settings(): Settings;
|
|
619
704
|
get Comments(): Comments;
|
|
705
|
+
get CommentsExtended(): CommentsExtended | undefined;
|
|
706
|
+
get CommentsIds(): CommentsIds | undefined;
|
|
707
|
+
get CommentsExtensible(): CommentsExtensible | undefined;
|
|
620
708
|
get FontTable(): FontWrapper;
|
|
621
709
|
}
|
|
622
710
|
export { File_2 as Document }
|
|
@@ -741,10 +829,6 @@ declare class Header_2 extends InitializableXmlComponent {
|
|
|
741
829
|
add(item: Paragraph | Table): void;
|
|
742
830
|
}
|
|
743
831
|
|
|
744
|
-
export declare class HeaderFooterReference extends XmlComponent {
|
|
745
|
-
constructor(type: (typeof HeaderFooterType)[keyof typeof HeaderFooterType], options: IHeaderFooterOptions);
|
|
746
|
-
}
|
|
747
|
-
|
|
748
832
|
export declare const HeaderFooterReferenceType: {
|
|
749
833
|
readonly DEFAULT: "default";
|
|
750
834
|
readonly FIRST: "first";
|
|
@@ -871,6 +955,23 @@ export declare type IBaseParagraphStyleOptions = {
|
|
|
871
955
|
readonly run?: IRunStylePropertiesOptions;
|
|
872
956
|
} & IStyleOptions;
|
|
873
957
|
|
|
958
|
+
export declare type IBodyPropertiesOptions = {
|
|
959
|
+
readonly wrap?: (typeof TextWrappingType)[keyof typeof TextWrappingType];
|
|
960
|
+
readonly verticalAnchor?: VerticalAnchor;
|
|
961
|
+
readonly margins?: {
|
|
962
|
+
readonly top?: number;
|
|
963
|
+
readonly bottom?: number;
|
|
964
|
+
readonly left?: number;
|
|
965
|
+
readonly right?: number;
|
|
966
|
+
};
|
|
967
|
+
readonly noAutoFit?: boolean;
|
|
968
|
+
};
|
|
969
|
+
|
|
970
|
+
export declare type IBookmarkOptions = {
|
|
971
|
+
readonly id: string;
|
|
972
|
+
readonly children: readonly ParagraphChild[];
|
|
973
|
+
};
|
|
974
|
+
|
|
874
975
|
export declare type IBorderOptions = {
|
|
875
976
|
readonly style: (typeof BorderStyle)[keyof typeof BorderStyle];
|
|
876
977
|
readonly color?: string;
|
|
@@ -886,10 +987,7 @@ export declare type IBordersOptions = {
|
|
|
886
987
|
readonly between?: IBorderOptions;
|
|
887
988
|
};
|
|
888
989
|
|
|
889
|
-
export declare type ICellMergeAttributes = {
|
|
890
|
-
readonly id: number;
|
|
891
|
-
readonly author: string;
|
|
892
|
-
readonly date: string;
|
|
990
|
+
export declare type ICellMergeAttributes = IChangedAttributesProperties & {
|
|
893
991
|
readonly verticalMerge?: (typeof VerticalMergeRevisionType)[keyof typeof VerticalMergeRevisionType];
|
|
894
992
|
readonly verticalMergeOriginal?: (typeof VerticalMergeRevisionType)[keyof typeof VerticalMergeRevisionType];
|
|
895
993
|
};
|
|
@@ -916,7 +1014,7 @@ export declare type ICheckboxSymbolProperties = {
|
|
|
916
1014
|
readonly font?: string;
|
|
917
1015
|
};
|
|
918
1016
|
|
|
919
|
-
declare type IColumnAttributes = {
|
|
1017
|
+
export declare type IColumnAttributes = {
|
|
920
1018
|
readonly width: number | PositiveUniversalMeasure;
|
|
921
1019
|
readonly space?: number | PositiveUniversalMeasure;
|
|
922
1020
|
};
|
|
@@ -929,18 +1027,36 @@ export declare type IColumnsAttributes = {
|
|
|
929
1027
|
readonly children?: readonly Column[];
|
|
930
1028
|
};
|
|
931
1029
|
|
|
1030
|
+
export declare type ICommentExtensibleData = {
|
|
1031
|
+
readonly durableId: string;
|
|
1032
|
+
readonly dateUtc?: string;
|
|
1033
|
+
};
|
|
1034
|
+
|
|
1035
|
+
export declare type ICommentIdData = {
|
|
1036
|
+
readonly paraId: string;
|
|
1037
|
+
readonly durableId: string;
|
|
1038
|
+
};
|
|
1039
|
+
|
|
932
1040
|
export declare type ICommentOptions = {
|
|
933
1041
|
readonly id: number;
|
|
934
1042
|
readonly children: readonly FileChild[];
|
|
935
1043
|
readonly initials?: string;
|
|
936
1044
|
readonly author?: string;
|
|
937
1045
|
readonly date?: Date;
|
|
1046
|
+
readonly parentId?: number;
|
|
1047
|
+
readonly resolved?: boolean;
|
|
938
1048
|
};
|
|
939
1049
|
|
|
940
1050
|
export declare type ICommentsOptions = {
|
|
941
1051
|
readonly children: readonly ICommentOptions[];
|
|
942
1052
|
};
|
|
943
1053
|
|
|
1054
|
+
export declare type ICommentThreadData = {
|
|
1055
|
+
readonly paraId: string;
|
|
1056
|
+
readonly parentParaId?: string;
|
|
1057
|
+
readonly done?: boolean;
|
|
1058
|
+
};
|
|
1059
|
+
|
|
944
1060
|
declare type ICompatibilityOptions = {
|
|
945
1061
|
readonly version?: number;
|
|
946
1062
|
readonly useSingleBorderforContiguousCells?: boolean;
|
|
@@ -1044,6 +1160,9 @@ declare type IDefaultStylesOptions = {
|
|
|
1044
1160
|
readonly footnoteReference?: IBaseCharacterStyleOptions;
|
|
1045
1161
|
readonly footnoteText?: IBaseParagraphStyleOptions;
|
|
1046
1162
|
readonly footnoteTextChar?: IBaseCharacterStyleOptions;
|
|
1163
|
+
readonly endnoteReference?: IBaseCharacterStyleOptions;
|
|
1164
|
+
readonly endnoteText?: IBaseParagraphStyleOptions;
|
|
1165
|
+
readonly endnoteTextChar?: IBaseCharacterStyleOptions;
|
|
1047
1166
|
};
|
|
1048
1167
|
|
|
1049
1168
|
declare type IDeletedRunOptions = IRunOptions & IChangedAttributesProperties;
|
|
@@ -1095,6 +1214,14 @@ export declare type IDrawingOptions = {
|
|
|
1095
1214
|
readonly floating?: IFloating;
|
|
1096
1215
|
readonly docProperties?: DocPropertiesOptions;
|
|
1097
1216
|
readonly outline?: OutlineOptions;
|
|
1217
|
+
readonly solidFill?: SolidFillOptions;
|
|
1218
|
+
};
|
|
1219
|
+
|
|
1220
|
+
export declare type IExtendedMediaData = IMediaData | WpsMediaData | WpgMediaData;
|
|
1221
|
+
|
|
1222
|
+
export declare type IExternalHyperlinkOptions = {
|
|
1223
|
+
readonly children: readonly ParagraphChild[];
|
|
1224
|
+
readonly link: string;
|
|
1098
1225
|
};
|
|
1099
1226
|
|
|
1100
1227
|
export declare type IFloating = {
|
|
@@ -1130,6 +1257,8 @@ export declare abstract class IgnoreIfEmptyXmlComponent extends XmlComponent {
|
|
|
1130
1257
|
prepForXml(context: IContext): IXmlableObject | undefined;
|
|
1131
1258
|
}
|
|
1132
1259
|
|
|
1260
|
+
export declare type IGroupChildMediaData = (WpsMediaData | IMediaData) & WpgCommonMediaData;
|
|
1261
|
+
|
|
1133
1262
|
export declare type IHeaderFooterGroup<T> = {
|
|
1134
1263
|
readonly default?: T;
|
|
1135
1264
|
readonly first?: T;
|
|
@@ -1169,8 +1298,18 @@ export declare type IIndentAttributesProperties = {
|
|
|
1169
1298
|
readonly firstLine?: number | PositiveUniversalMeasure;
|
|
1170
1299
|
};
|
|
1171
1300
|
|
|
1301
|
+
export declare type IInsertedDeletedTextRunOptions = IRunOptions & {
|
|
1302
|
+
readonly insertion: IChangedAttributesProperties;
|
|
1303
|
+
readonly deletion: IChangedAttributesProperties;
|
|
1304
|
+
};
|
|
1305
|
+
|
|
1172
1306
|
declare type IInsertedRunOptions = IChangedAttributesProperties & IRunOptions;
|
|
1173
1307
|
|
|
1308
|
+
export declare type IInternalHyperlinkOptions = {
|
|
1309
|
+
readonly children: readonly ParagraphChild[];
|
|
1310
|
+
readonly anchor: string;
|
|
1311
|
+
};
|
|
1312
|
+
|
|
1174
1313
|
declare type ILanguageOptions = {
|
|
1175
1314
|
readonly value?: string;
|
|
1176
1315
|
readonly eastAsia?: string;
|
|
@@ -1290,6 +1429,16 @@ export declare type IMathSuperScriptOptions = {
|
|
|
1290
1429
|
export declare type IMediaData = (RegularMediaData | SvgMediaData) & CoreMediaData;
|
|
1291
1430
|
|
|
1292
1431
|
export declare type IMediaDataTransformation = {
|
|
1432
|
+
readonly offset?: {
|
|
1433
|
+
readonly pixels: {
|
|
1434
|
+
readonly x: number;
|
|
1435
|
+
readonly y: number;
|
|
1436
|
+
};
|
|
1437
|
+
readonly emus?: {
|
|
1438
|
+
readonly x: number;
|
|
1439
|
+
readonly y: number;
|
|
1440
|
+
};
|
|
1441
|
+
};
|
|
1293
1442
|
readonly pixels: {
|
|
1294
1443
|
readonly x: number;
|
|
1295
1444
|
readonly y: number;
|
|
@@ -1306,6 +1455,10 @@ export declare type IMediaDataTransformation = {
|
|
|
1306
1455
|
};
|
|
1307
1456
|
|
|
1308
1457
|
export declare type IMediaTransformation = {
|
|
1458
|
+
readonly offset?: {
|
|
1459
|
+
readonly top?: number;
|
|
1460
|
+
readonly left?: number;
|
|
1461
|
+
};
|
|
1309
1462
|
readonly width: number;
|
|
1310
1463
|
readonly height: number;
|
|
1311
1464
|
readonly flip?: {
|
|
@@ -1327,16 +1480,20 @@ export declare class ImportedXmlComponent extends XmlComponent {
|
|
|
1327
1480
|
push(xmlComponent: XmlComponent | string): void;
|
|
1328
1481
|
}
|
|
1329
1482
|
|
|
1330
|
-
export declare class Indent extends XmlComponent {
|
|
1331
|
-
constructor({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties);
|
|
1332
|
-
}
|
|
1333
|
-
|
|
1334
1483
|
export declare abstract class InitializableXmlComponent extends XmlComponent {
|
|
1335
1484
|
constructor(rootKey: string, initComponent?: InitializableXmlComponent);
|
|
1336
1485
|
}
|
|
1337
1486
|
|
|
1487
|
+
declare type INonVisualShapePropertiesOptions = {
|
|
1488
|
+
readonly txBox: string;
|
|
1489
|
+
};
|
|
1490
|
+
|
|
1338
1491
|
export declare type InputDataType = Buffer | string | number[] | Uint8Array | ArrayBuffer | Blob | NodeJS.ReadableStream | default_2;
|
|
1339
1492
|
|
|
1493
|
+
export declare class InsertedDeletedTextRun extends XmlComponent {
|
|
1494
|
+
constructor(options: IInsertedDeletedTextRunOptions);
|
|
1495
|
+
}
|
|
1496
|
+
|
|
1340
1497
|
export declare class InsertedTableCell extends XmlComponent {
|
|
1341
1498
|
constructor(options: IChangedAttributesProperties);
|
|
1342
1499
|
}
|
|
@@ -1350,10 +1507,7 @@ export declare class InsertedTextRun extends XmlComponent {
|
|
|
1350
1507
|
}
|
|
1351
1508
|
|
|
1352
1509
|
export declare class InternalHyperlink extends ConcreteHyperlink {
|
|
1353
|
-
constructor(options:
|
|
1354
|
-
readonly children: readonly ParagraphChild[];
|
|
1355
|
-
readonly anchor: string;
|
|
1356
|
-
});
|
|
1510
|
+
constructor(options: IInternalHyperlinkOptions);
|
|
1357
1511
|
}
|
|
1358
1512
|
|
|
1359
1513
|
export declare type INumberedItemReferenceOptions = {
|
|
@@ -1486,6 +1640,9 @@ export declare type IPropertiesOptions = {
|
|
|
1486
1640
|
readonly footnotes?: Readonly<Record<string, {
|
|
1487
1641
|
readonly children: readonly Paragraph[];
|
|
1488
1642
|
}>>;
|
|
1643
|
+
readonly endnotes?: Readonly<Record<string, {
|
|
1644
|
+
readonly children: readonly Paragraph[];
|
|
1645
|
+
}>>;
|
|
1489
1646
|
readonly background?: IDocumentBackgroundOptions;
|
|
1490
1647
|
readonly features?: {
|
|
1491
1648
|
readonly trackRevisions?: boolean;
|
|
@@ -1503,7 +1660,7 @@ export declare type IPropertiesOptions = {
|
|
|
1503
1660
|
export declare type IRunOptions = IRunOptionsBase & IRunPropertiesOptions;
|
|
1504
1661
|
|
|
1505
1662
|
declare type IRunOptionsBase = {
|
|
1506
|
-
readonly children?: readonly (
|
|
1663
|
+
readonly children?: readonly (FieldInstruction | (typeof PageNumber)[keyof typeof PageNumber] | FootnoteReferenceRun | AnnotationReference | CarriageReturn | ContinuationSeparator | DayLong | DayShort | EndnoteReference | FootnoteReferenceElement | LastRenderedPageBreak | MonthLong | MonthShort | NoBreakHyphen | PageNumberElement | Separator | SoftHyphen | Tab | YearLong | YearShort | XmlComponent | string)[];
|
|
1507
1664
|
readonly break?: number;
|
|
1508
1665
|
readonly text?: string;
|
|
1509
1666
|
};
|
|
@@ -1728,6 +1885,15 @@ declare type ITableGridChangeOptions = {
|
|
|
1728
1885
|
readonly columnWidths: readonly number[] | readonly PositiveUniversalMeasure[];
|
|
1729
1886
|
};
|
|
1730
1887
|
|
|
1888
|
+
export declare type ITableLookOptions = {
|
|
1889
|
+
readonly firstRow?: boolean;
|
|
1890
|
+
readonly lastRow?: boolean;
|
|
1891
|
+
readonly firstColumn?: boolean;
|
|
1892
|
+
readonly lastColumn?: boolean;
|
|
1893
|
+
readonly noHBand?: boolean;
|
|
1894
|
+
readonly noVBand?: boolean;
|
|
1895
|
+
};
|
|
1896
|
+
|
|
1731
1897
|
export declare type ITableOfContentsOptions = {
|
|
1732
1898
|
readonly captionLabel?: string;
|
|
1733
1899
|
readonly entriesFromBookmark?: string;
|
|
@@ -1760,6 +1926,7 @@ export declare type ITableOptions = {
|
|
|
1760
1926
|
readonly borders?: ITableBordersOptions;
|
|
1761
1927
|
readonly alignment?: (typeof AlignmentType)[keyof typeof AlignmentType];
|
|
1762
1928
|
readonly visuallyRightToLeft?: boolean;
|
|
1929
|
+
readonly tableLook?: ITableLookOptions;
|
|
1763
1930
|
readonly cellSpacing?: ITableCellSpacingProperties;
|
|
1764
1931
|
readonly revision?: ITablePropertiesChangeOptions;
|
|
1765
1932
|
};
|
|
@@ -1782,6 +1949,7 @@ export declare type ITablePropertiesOptionsBase = {
|
|
|
1782
1949
|
readonly alignment?: (typeof AlignmentType)[keyof typeof AlignmentType];
|
|
1783
1950
|
readonly cellMargin?: ITableCellMarginOptions;
|
|
1784
1951
|
readonly visuallyRightToLeft?: boolean;
|
|
1952
|
+
readonly tableLook?: ITableLookOptions;
|
|
1785
1953
|
readonly cellSpacing?: ITableCellSpacingProperties;
|
|
1786
1954
|
};
|
|
1787
1955
|
|
|
@@ -1830,10 +1998,18 @@ export declare type IVerticalPositionOptions = {
|
|
|
1830
1998
|
};
|
|
1831
1999
|
|
|
1832
2000
|
declare type IViewWrapper = {
|
|
1833
|
-
readonly View: Document_2 | Footer_2 | Header_2 | FootNotes | XmlComponent;
|
|
2001
|
+
readonly View: Document_2 | Footer_2 | Header_2 | FootNotes | Endnotes | XmlComponent;
|
|
1834
2002
|
readonly Relationships: Relationships;
|
|
1835
2003
|
};
|
|
1836
2004
|
|
|
2005
|
+
export declare type IWpgGroupOptions = {
|
|
2006
|
+
readonly type: "wpg";
|
|
2007
|
+
} & CoreGroupOptions;
|
|
2008
|
+
|
|
2009
|
+
export declare type IWpsShapeOptions = WpsShapeCoreOptions & {
|
|
2010
|
+
readonly type: "wps";
|
|
2011
|
+
} & CoreShapeOptions;
|
|
2012
|
+
|
|
1837
2013
|
export declare interface IXmlableObject extends Record<string, unknown> {
|
|
1838
2014
|
readonly [key: string]: any;
|
|
1839
2015
|
}
|
|
@@ -2249,11 +2425,6 @@ declare type OutlineAttributes = {
|
|
|
2249
2425
|
|
|
2250
2426
|
declare type OutlineFillProperties = OutlineNoFill | OutlineSolidFill;
|
|
2251
2427
|
|
|
2252
|
-
export declare class OutlineLevel extends XmlComponent {
|
|
2253
|
-
readonly level: number;
|
|
2254
|
-
constructor(level: number);
|
|
2255
|
-
}
|
|
2256
|
-
|
|
2257
2428
|
declare type OutlineNoFill = {
|
|
2258
2429
|
readonly type: "noFill";
|
|
2259
2430
|
};
|
|
@@ -2332,10 +2503,6 @@ export declare class PageBreakBefore extends XmlComponent {
|
|
|
2332
2503
|
constructor();
|
|
2333
2504
|
}
|
|
2334
2505
|
|
|
2335
|
-
export declare class PageMargin extends XmlComponent {
|
|
2336
|
-
constructor(top: number | UniversalMeasure, right: number | PositiveUniversalMeasure, bottom: number | UniversalMeasure, left: number | PositiveUniversalMeasure, header: number | PositiveUniversalMeasure, footer: number | PositiveUniversalMeasure, gutter: number | PositiveUniversalMeasure);
|
|
2337
|
-
}
|
|
2338
|
-
|
|
2339
2506
|
export declare const PageNumber: {
|
|
2340
2507
|
readonly CURRENT: "CURRENT";
|
|
2341
2508
|
readonly TOTAL_PAGES: "TOTAL_PAGES";
|
|
@@ -2355,18 +2522,6 @@ export declare const PageNumberSeparator: {
|
|
|
2355
2522
|
readonly EN_DASH: "endash";
|
|
2356
2523
|
};
|
|
2357
2524
|
|
|
2358
|
-
export declare class PageNumberType extends XmlComponent {
|
|
2359
|
-
constructor({ start, formatType, separator }: IPageNumberTypeAttributes);
|
|
2360
|
-
}
|
|
2361
|
-
|
|
2362
|
-
export declare class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
|
|
2363
|
-
protected readonly xmlKeys: {
|
|
2364
|
-
start: string;
|
|
2365
|
-
formatType: string;
|
|
2366
|
-
separator: string;
|
|
2367
|
-
};
|
|
2368
|
-
}
|
|
2369
|
-
|
|
2370
2525
|
export declare const PageOrientation: {
|
|
2371
2526
|
readonly PORTRAIT: "portrait";
|
|
2372
2527
|
readonly LANDSCAPE: "landscape";
|
|
@@ -2424,7 +2579,7 @@ declare type PatchDetectorOptions = {
|
|
|
2424
2579
|
readonly data: InputDataType;
|
|
2425
2580
|
};
|
|
2426
2581
|
|
|
2427
|
-
export declare const patchDocument: <T extends
|
|
2582
|
+
export declare const patchDocument: <T extends PatchDocumentOutputType = PatchDocumentOutputType>({ outputType, data, patches, keepOriginalStyles, placeholderDelimiters, recursive, }: PatchDocumentOptions<T>) => Promise<OutputByType[T]>;
|
|
2428
2583
|
|
|
2429
2584
|
export declare type PatchDocumentOptions<T extends PatchDocumentOutputType = PatchDocumentOutputType> = {
|
|
2430
2585
|
readonly outputType: T;
|
|
@@ -2507,17 +2662,13 @@ declare type RegularMediaData = {
|
|
|
2507
2662
|
readonly type: "jpg" | "png" | "gif" | "bmp";
|
|
2508
2663
|
};
|
|
2509
2664
|
|
|
2510
|
-
declare class Relationship extends XmlComponent {
|
|
2511
|
-
constructor(id: string, type: RelationshipType, target: string, targetMode?: (typeof TargetModeType)[keyof typeof TargetModeType]);
|
|
2512
|
-
}
|
|
2513
|
-
|
|
2514
2665
|
declare class Relationships extends XmlComponent {
|
|
2515
2666
|
constructor();
|
|
2516
|
-
|
|
2667
|
+
addRelationship(id: number | string, type: RelationshipType, target: string, targetMode?: (typeof TargetModeType)[keyof typeof TargetModeType]): void;
|
|
2517
2668
|
get RelationshipCount(): number;
|
|
2518
2669
|
}
|
|
2519
2670
|
|
|
2520
|
-
declare type RelationshipType = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" | "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/font";
|
|
2671
|
+
declare type RelationshipType = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/theme" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/fontTable" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/webSettings" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" | "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/endnotes" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments" | "http://schemas.microsoft.com/office/2011/relationships/commentsExtended" | "http://schemas.microsoft.com/office/2016/09/relationships/commentsIds" | "http://schemas.microsoft.com/office/2018/08/relationships/commentsExtensible" | "http://schemas.openxmlformats.org/officeDocument/2006/relationships/font";
|
|
2521
2672
|
|
|
2522
2673
|
export declare const RelativeHorizontalPosition: {
|
|
2523
2674
|
readonly CENTER: "center";
|
|
@@ -2538,16 +2689,16 @@ export declare const RelativeVerticalPosition: {
|
|
|
2538
2689
|
readonly TOP: "top";
|
|
2539
2690
|
};
|
|
2540
2691
|
|
|
2692
|
+
declare type RgbColorOptions = {
|
|
2693
|
+
readonly type: "rgb";
|
|
2694
|
+
readonly value: string;
|
|
2695
|
+
};
|
|
2696
|
+
|
|
2541
2697
|
export declare class Run extends XmlComponent {
|
|
2542
2698
|
protected readonly properties: RunProperties;
|
|
2543
2699
|
constructor(options: IRunOptions);
|
|
2544
2700
|
}
|
|
2545
2701
|
|
|
2546
|
-
export declare class RunFonts extends XmlComponent {
|
|
2547
|
-
constructor(name: string, hint?: string);
|
|
2548
|
-
constructor(attrs: string | IFontAttributesProperties);
|
|
2549
|
-
}
|
|
2550
|
-
|
|
2551
2702
|
export declare class RunProperties extends IgnoreIfEmptyXmlComponent {
|
|
2552
2703
|
constructor(options?: IRunPropertiesOptions);
|
|
2553
2704
|
push(item: XmlComponent): void;
|
|
@@ -2581,6 +2732,11 @@ declare const SchemeColor: {
|
|
|
2581
2732
|
readonly PHCLR: "phClr";
|
|
2582
2733
|
};
|
|
2583
2734
|
|
|
2735
|
+
declare type SchemeColorOptions = {
|
|
2736
|
+
readonly type: "scheme";
|
|
2737
|
+
readonly value: (typeof SchemeColor)[keyof typeof SchemeColor];
|
|
2738
|
+
};
|
|
2739
|
+
|
|
2584
2740
|
export declare const sectionMarginDefaults: {
|
|
2585
2741
|
TOP: number;
|
|
2586
2742
|
RIGHT: number;
|
|
@@ -2614,20 +2770,8 @@ export declare const SectionType: {
|
|
|
2614
2770
|
readonly ODD_PAGE: "oddPage";
|
|
2615
2771
|
};
|
|
2616
2772
|
|
|
2617
|
-
export declare class SectionTypeAttributes extends XmlAttributeComponent<{
|
|
2618
|
-
readonly val: (typeof SectionType)[keyof typeof SectionType];
|
|
2619
|
-
}> {
|
|
2620
|
-
protected readonly xmlKeys: {
|
|
2621
|
-
val: string;
|
|
2622
|
-
};
|
|
2623
|
-
}
|
|
2624
|
-
|
|
2625
2773
|
export declare type SectionVerticalAlign = (typeof VerticalAlignSection)[keyof typeof VerticalAlignSection];
|
|
2626
2774
|
|
|
2627
|
-
declare class Separate extends XmlComponent {
|
|
2628
|
-
constructor(dirty?: boolean);
|
|
2629
|
-
}
|
|
2630
|
-
|
|
2631
2775
|
export declare class Separator extends EmptyElement {
|
|
2632
2776
|
constructor();
|
|
2633
2777
|
}
|
|
@@ -2640,10 +2784,6 @@ declare class Settings extends XmlComponent {
|
|
|
2640
2784
|
constructor(options: ISettingsOptions);
|
|
2641
2785
|
}
|
|
2642
2786
|
|
|
2643
|
-
export declare class Shading extends XmlComponent {
|
|
2644
|
-
constructor({ fill, color, type }: IShadingAttributesProperties);
|
|
2645
|
-
}
|
|
2646
|
-
|
|
2647
2787
|
export declare const ShadingType: {
|
|
2648
2788
|
readonly CLEAR: "clear";
|
|
2649
2789
|
readonly DIAGONAL_CROSS: "diagCross";
|
|
@@ -2702,14 +2842,14 @@ export declare class SoftHyphen extends EmptyElement {
|
|
|
2702
2842
|
constructor();
|
|
2703
2843
|
}
|
|
2704
2844
|
|
|
2845
|
+
declare type SolidFillOptions = RgbColorOptions | SchemeColorOptions;
|
|
2846
|
+
|
|
2705
2847
|
export declare const SpaceType: {
|
|
2706
2848
|
readonly DEFAULT: "default";
|
|
2707
2849
|
readonly PRESERVE: "preserve";
|
|
2708
2850
|
};
|
|
2709
2851
|
|
|
2710
|
-
export declare
|
|
2711
|
-
constructor(options: ISpacingProperties);
|
|
2712
|
-
}
|
|
2852
|
+
export declare const standardizeData: (data: string | Buffer | Uint8Array | ArrayBuffer) => Buffer | Uint8Array | ArrayBuffer;
|
|
2713
2853
|
|
|
2714
2854
|
export declare class StringContainer extends XmlComponent {
|
|
2715
2855
|
constructor(name: string, val: string);
|
|
@@ -2723,20 +2863,16 @@ export declare class StringValueElement extends XmlComponent {
|
|
|
2723
2863
|
constructor(name: string, val: string);
|
|
2724
2864
|
}
|
|
2725
2865
|
|
|
2726
|
-
|
|
2727
|
-
constructor(styleId: string);
|
|
2728
|
-
}
|
|
2729
|
-
|
|
2730
|
-
declare class Style_2 extends XmlComponent {
|
|
2866
|
+
declare class Style extends XmlComponent {
|
|
2731
2867
|
constructor(attributes: IStyleAttributes, options: IStyleOptions);
|
|
2732
2868
|
}
|
|
2733
2869
|
|
|
2734
|
-
export declare class StyleForCharacter extends
|
|
2870
|
+
export declare class StyleForCharacter extends Style {
|
|
2735
2871
|
private readonly runProperties;
|
|
2736
2872
|
constructor(options: ICharacterStyleOptions);
|
|
2737
2873
|
}
|
|
2738
2874
|
|
|
2739
|
-
export declare class StyleForParagraph extends
|
|
2875
|
+
export declare class StyleForParagraph extends Style {
|
|
2740
2876
|
private readonly paragraphProperties;
|
|
2741
2877
|
private readonly runProperties;
|
|
2742
2878
|
constructor(options: IParagraphStyleOptions);
|
|
@@ -2771,20 +2907,8 @@ export declare class Tab extends EmptyElement {
|
|
|
2771
2907
|
constructor();
|
|
2772
2908
|
}
|
|
2773
2909
|
|
|
2774
|
-
export declare class TabAttributes extends XmlAttributeComponent<{
|
|
2775
|
-
readonly val: (typeof TabStopType)[keyof typeof TabStopType];
|
|
2776
|
-
readonly pos: string | number;
|
|
2777
|
-
readonly leader?: (typeof LeaderType)[keyof typeof LeaderType];
|
|
2778
|
-
}> {
|
|
2779
|
-
protected readonly xmlKeys: {
|
|
2780
|
-
val: string;
|
|
2781
|
-
pos: string;
|
|
2782
|
-
leader: string;
|
|
2783
|
-
};
|
|
2784
|
-
}
|
|
2785
|
-
|
|
2786
2910
|
export declare class Table extends FileChild {
|
|
2787
|
-
constructor({ rows, width, columnWidths, columnWidthsRevision, margins, indent, float, layout, style, borders, alignment, visuallyRightToLeft, cellSpacing, revision, }: ITableOptions);
|
|
2911
|
+
constructor({ rows, width, columnWidths, columnWidthsRevision, margins, indent, float, layout, style, borders, alignment, visuallyRightToLeft, tableLook, cellSpacing, revision, }: ITableOptions);
|
|
2788
2912
|
}
|
|
2789
2913
|
|
|
2790
2914
|
export declare const TableAnchorType: {
|
|
@@ -2794,38 +2918,7 @@ export declare const TableAnchorType: {
|
|
|
2794
2918
|
};
|
|
2795
2919
|
|
|
2796
2920
|
export declare class TableBorders extends XmlComponent {
|
|
2797
|
-
static readonly NONE:
|
|
2798
|
-
top: {
|
|
2799
|
-
style: "none";
|
|
2800
|
-
size: number;
|
|
2801
|
-
color: string;
|
|
2802
|
-
};
|
|
2803
|
-
bottom: {
|
|
2804
|
-
style: "none";
|
|
2805
|
-
size: number;
|
|
2806
|
-
color: string;
|
|
2807
|
-
};
|
|
2808
|
-
left: {
|
|
2809
|
-
style: "none";
|
|
2810
|
-
size: number;
|
|
2811
|
-
color: string;
|
|
2812
|
-
};
|
|
2813
|
-
right: {
|
|
2814
|
-
style: "none";
|
|
2815
|
-
size: number;
|
|
2816
|
-
color: string;
|
|
2817
|
-
};
|
|
2818
|
-
insideHorizontal: {
|
|
2819
|
-
style: "none";
|
|
2820
|
-
size: number;
|
|
2821
|
-
color: string;
|
|
2822
|
-
};
|
|
2823
|
-
insideVertical: {
|
|
2824
|
-
style: "none";
|
|
2825
|
-
size: number;
|
|
2826
|
-
color: string;
|
|
2827
|
-
};
|
|
2828
|
-
};
|
|
2921
|
+
static readonly NONE: ITableBordersOptions;
|
|
2829
2922
|
constructor(options: ITableBordersOptions);
|
|
2830
2923
|
}
|
|
2831
2924
|
|
|
@@ -2839,24 +2932,20 @@ export declare class TableCellBorders extends IgnoreIfEmptyXmlComponent {
|
|
|
2839
2932
|
constructor(options: ITableCellBorders);
|
|
2840
2933
|
}
|
|
2841
2934
|
|
|
2842
|
-
export declare class TableFloatProperties extends XmlComponent {
|
|
2843
|
-
constructor({ horizontalAnchor, verticalAnchor, absoluteHorizontalPosition, relativeHorizontalPosition, absoluteVerticalPosition, relativeVerticalPosition, bottomFromText, topFromText, leftFromText, rightFromText, overlap, }: ITableFloatOptions);
|
|
2844
|
-
}
|
|
2845
|
-
|
|
2846
|
-
export declare class TableLayout extends XmlComponent {
|
|
2847
|
-
constructor(type: (typeof TableLayoutType)[keyof typeof TableLayoutType]);
|
|
2848
|
-
}
|
|
2849
|
-
|
|
2850
2935
|
export declare const TableLayoutType: {
|
|
2851
2936
|
readonly AUTOFIT: "autofit";
|
|
2852
2937
|
readonly FIXED: "fixed";
|
|
2853
2938
|
};
|
|
2854
2939
|
|
|
2855
2940
|
export declare class TableOfContents extends FileChild {
|
|
2856
|
-
constructor(alias?: string, { contentChildren, beginDirty, ...properties }?: ITableOfContentsOptions & {
|
|
2941
|
+
constructor(alias?: string, { contentChildren, cachedEntries, beginDirty, ...properties }?: ITableOfContentsOptions & {
|
|
2857
2942
|
readonly contentChildren?: readonly (XmlComponent | string)[];
|
|
2943
|
+
readonly cachedEntries?: readonly ToCEntry[];
|
|
2858
2944
|
readonly beginDirty?: boolean;
|
|
2859
2945
|
});
|
|
2946
|
+
private getTabStopsForLevel;
|
|
2947
|
+
private buildCachedContentRun;
|
|
2948
|
+
private buildCachedContentParagraphChild;
|
|
2860
2949
|
}
|
|
2861
2950
|
|
|
2862
2951
|
export declare class TableProperties extends IgnoreIfEmptyXmlComponent {
|
|
@@ -2874,20 +2963,6 @@ export declare class TableRow extends XmlComponent {
|
|
|
2874
2963
|
columnIndexToRootIndex(columnIndex: number, allowEndNewCell?: boolean): number;
|
|
2875
2964
|
}
|
|
2876
2965
|
|
|
2877
|
-
export declare class TableRowHeight extends XmlComponent {
|
|
2878
|
-
constructor(value: number | PositiveUniversalMeasure, rule: (typeof HeightRule)[keyof typeof HeightRule]);
|
|
2879
|
-
}
|
|
2880
|
-
|
|
2881
|
-
export declare class TableRowHeightAttributes extends XmlAttributeComponent<{
|
|
2882
|
-
readonly value: number | string;
|
|
2883
|
-
readonly rule: (typeof HeightRule)[keyof typeof HeightRule];
|
|
2884
|
-
}> {
|
|
2885
|
-
protected readonly xmlKeys: {
|
|
2886
|
-
value: string;
|
|
2887
|
-
rule: string;
|
|
2888
|
-
};
|
|
2889
|
-
}
|
|
2890
|
-
|
|
2891
2966
|
export declare class TableRowProperties extends IgnoreIfEmptyXmlComponent {
|
|
2892
2967
|
constructor(options: ITableRowPropertiesOptions);
|
|
2893
2968
|
}
|
|
@@ -2898,24 +2973,12 @@ export declare class TableRowPropertiesChange extends XmlComponent {
|
|
|
2898
2973
|
|
|
2899
2974
|
export declare type TableVerticalAlign = (typeof VerticalAlignTable)[keyof typeof VerticalAlignTable];
|
|
2900
2975
|
|
|
2901
|
-
export declare class TableWidthElement extends XmlComponent {
|
|
2902
|
-
constructor(name: string, { type, size }: ITableWidthProperties);
|
|
2903
|
-
}
|
|
2904
|
-
|
|
2905
|
-
export declare class TabStop extends XmlComponent {
|
|
2906
|
-
constructor(tabDefinitions: readonly TabStopDefinition[]);
|
|
2907
|
-
}
|
|
2908
|
-
|
|
2909
2976
|
export declare type TabStopDefinition = {
|
|
2910
2977
|
readonly type: (typeof TabStopType)[keyof typeof TabStopType];
|
|
2911
2978
|
readonly position: number | (typeof TabStopPosition)[keyof typeof TabStopPosition];
|
|
2912
2979
|
readonly leader?: (typeof LeaderType)[keyof typeof LeaderType];
|
|
2913
2980
|
};
|
|
2914
2981
|
|
|
2915
|
-
export declare class TabStopItem extends XmlComponent {
|
|
2916
|
-
constructor({ type, position, leader }: TabStopDefinition);
|
|
2917
|
-
}
|
|
2918
|
-
|
|
2919
2982
|
export declare const TabStopPosition: {
|
|
2920
2983
|
readonly MAX: 9026;
|
|
2921
2984
|
};
|
|
@@ -2982,18 +3045,17 @@ export declare class ThematicBreak extends XmlComponent {
|
|
|
2982
3045
|
constructor();
|
|
2983
3046
|
}
|
|
2984
3047
|
|
|
2985
|
-
|
|
3048
|
+
declare type ToCEntry = {
|
|
3049
|
+
readonly title: string;
|
|
3050
|
+
readonly level: number;
|
|
3051
|
+
readonly page?: number;
|
|
3052
|
+
readonly href?: string;
|
|
3053
|
+
};
|
|
2986
3054
|
|
|
2987
|
-
export declare
|
|
2988
|
-
constructor(value: (typeof SectionType)[keyof typeof SectionType]);
|
|
2989
|
-
}
|
|
3055
|
+
export declare const twipsMeasureValue: (val: PositiveUniversalMeasure | number) => PositiveUniversalMeasure | number;
|
|
2990
3056
|
|
|
2991
3057
|
export declare const uCharHexNumber: (val: string) => string;
|
|
2992
3058
|
|
|
2993
|
-
export declare class Underline extends XmlComponent {
|
|
2994
|
-
constructor(underlineType?: (typeof UnderlineType)[keyof typeof UnderlineType], color?: string);
|
|
2995
|
-
}
|
|
2996
|
-
|
|
2997
3059
|
export declare const UnderlineType: {
|
|
2998
3060
|
readonly SINGLE: "single";
|
|
2999
3061
|
readonly WORDS: "words";
|
|
@@ -3036,18 +3098,6 @@ export declare const VerticalAlign: {
|
|
|
3036
3098
|
readonly BOTTOM: "bottom";
|
|
3037
3099
|
};
|
|
3038
3100
|
|
|
3039
|
-
export declare class VerticalAlignAttributes extends XmlAttributeComponent<{
|
|
3040
|
-
readonly verticalAlign?: (typeof VerticalAlign)[keyof typeof VerticalAlign];
|
|
3041
|
-
}> {
|
|
3042
|
-
protected readonly xmlKeys: {
|
|
3043
|
-
verticalAlign: string;
|
|
3044
|
-
};
|
|
3045
|
-
}
|
|
3046
|
-
|
|
3047
|
-
export declare class VerticalAlignElement extends XmlComponent {
|
|
3048
|
-
constructor(value: (typeof VerticalAlign)[keyof typeof VerticalAlign]);
|
|
3049
|
-
}
|
|
3050
|
-
|
|
3051
3101
|
export declare const VerticalAlignSection: {
|
|
3052
3102
|
readonly BOTH: "both";
|
|
3053
3103
|
readonly TOP: "top";
|
|
@@ -3061,6 +3111,12 @@ export declare const VerticalAlignTable: {
|
|
|
3061
3111
|
readonly BOTTOM: "bottom";
|
|
3062
3112
|
};
|
|
3063
3113
|
|
|
3114
|
+
export declare enum VerticalAnchor {
|
|
3115
|
+
CENTER = "ctr",
|
|
3116
|
+
TOP = "t",
|
|
3117
|
+
BOTTOM = "b"
|
|
3118
|
+
}
|
|
3119
|
+
|
|
3064
3120
|
export declare class VerticalMerge extends XmlComponent {
|
|
3065
3121
|
constructor(value: (typeof VerticalMergeType)[keyof typeof VerticalMergeType]);
|
|
3066
3122
|
}
|
|
@@ -3133,20 +3189,39 @@ export declare const WORKAROUND3 = "";
|
|
|
3133
3189
|
|
|
3134
3190
|
export declare const WORKAROUND4 = "";
|
|
3135
3191
|
|
|
3136
|
-
export declare
|
|
3137
|
-
|
|
3138
|
-
|
|
3192
|
+
export declare type WpgCommonMediaData = {
|
|
3193
|
+
readonly outline?: OutlineOptions;
|
|
3194
|
+
readonly solidFill?: SolidFillOptions;
|
|
3195
|
+
};
|
|
3139
3196
|
|
|
3140
|
-
export declare class
|
|
3141
|
-
|
|
3197
|
+
export declare class WpgGroupRun extends Run {
|
|
3198
|
+
private readonly wpgGroupData;
|
|
3199
|
+
private readonly mediaDatas;
|
|
3200
|
+
constructor(options: IWpgGroupOptions);
|
|
3201
|
+
prepForXml(context: IContext): IXmlableObject | undefined;
|
|
3142
3202
|
}
|
|
3143
3203
|
|
|
3144
|
-
export declare
|
|
3145
|
-
|
|
3146
|
-
|
|
3204
|
+
export declare type WpgMediaData = {
|
|
3205
|
+
readonly type: "wpg";
|
|
3206
|
+
readonly transformation: IMediaDataTransformation;
|
|
3207
|
+
readonly children: readonly IGroupChildMediaData[];
|
|
3208
|
+
};
|
|
3209
|
+
|
|
3210
|
+
export declare type WpsMediaData = {
|
|
3211
|
+
readonly type: "wps";
|
|
3212
|
+
readonly transformation: IMediaDataTransformation;
|
|
3213
|
+
readonly data: WpsShapeCoreOptions;
|
|
3214
|
+
};
|
|
3215
|
+
|
|
3216
|
+
declare type WpsShapeCoreOptions = {
|
|
3217
|
+
readonly children: readonly Paragraph[];
|
|
3218
|
+
readonly nonVisualProperties?: INonVisualShapePropertiesOptions;
|
|
3219
|
+
readonly bodyProperties?: IBodyPropertiesOptions;
|
|
3220
|
+
};
|
|
3147
3221
|
|
|
3148
|
-
export declare class
|
|
3149
|
-
|
|
3222
|
+
export declare class WpsShapeRun extends Run {
|
|
3223
|
+
private readonly wpsShapeData;
|
|
3224
|
+
constructor(options: IWpsShapeOptions);
|
|
3150
3225
|
}
|
|
3151
3226
|
|
|
3152
3227
|
export declare abstract class XmlAttributeComponent<T extends Record<string, any>> extends BaseXmlComponent {
|