Class CellMergeAttributes

Base class for creating XML attributes with automatic name mapping.

XmlAttributeComponent allows you to define attributes using JavaScript-friendly property names that are automatically mapped to XML attribute names. Subclasses can define an xmlKeys map to specify the transformation.

Example

class MyAttributes extends XmlAttributeComponent<{ fontSize: number }> {
  protected readonly xmlKeys = { fontSize: "w:sz" };
}

new MyAttributes({ fontSize: 24 });
// Generates: _attr: { "w:sz": 24 }

Hierarchy (View Summary)

XmlAttributeComponent<ICellMergeAttributes>
- CellMergeAttributes

Index

Constructors

constructor

new CellMergeAttributes(root: ICellMergeAttributes): CellMergeAttributes
Creates a new attribute component.
Parameters
- root: ICellMergeAttributes
  The attribute data object
Returns CellMergeAttributes
Inherited from XmlAttributeComponent.constructor
- Defined in file/xml-components/default-attributes.ts:60

Accessors

writtenAs

get writtenAs(): readonly BaseXmlComponent[] | undefined
Internal
The components written in this one's place, one after another, when it can't be written as a single element, such as a run with another run in its children. Undefined when it is written as itself.

Returns readonly BaseXmlComponent[] | undefined
Inherited from XmlAttributeComponent.writtenAs
- Defined in file/xml-components/base.ts:84

Methods

prepForXml

prepForXml(_: IContext): IXmlableObject
Converts the attribute data to an XML-serializable object.

This method transforms the property names using xmlKeys (if defined) and filters out undefined values.
Parameters
- _: IContext
  Context (unused for attributes)
Returns IXmlableObject
Object with _attr key containing the mapped attributes
Inherited from XmlAttributeComponent.prepForXml
- Defined in file/xml-components/default-attributes.ts:73

Class CellMergeAttributes

Example

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CellMergeAttributes

Accessors

writtenAs

Returns readonly BaseXmlComponent[] | undefined

Methods

prepForXml

Parameters

Returns IXmlableObject

Settings

On This Page