class RelationshipsXml
extends XmlFile
import { RelationshipsXml } from "https://deno.land/x/docxml@5.5.1/src/files/RelationshipsXml.ts";
Constructors
Properties
readonly
meta: Array<RelationshipMeta>All relationship data
Methods
protected
toNode(): Documentadd(type: RelationshipType, target: File | string): string
Create a new relationship and return the new identifier
addToArchive(archive: Archive): Promise<void>
ensureRelationship<C extends File>(type: RelationshipType, createInstance: () => C): C
filterInstances<R extends File = File>(cb: (meta: RelationshipMeta) => boolean): R[]
deprecated
find<R extends File = File>(cb: (meta: RelationshipMeta) => boolean): R | nullfindInstance<R extends File = File>(cb: (meta: RelationshipMeta) => boolean): R | null
Find a relationship instance (eg. a DocumentXml) by its metadata. The metadata would tell you what type of relationship it is.
getRelated(): File[]
Get all XmlFile instances related to this one, including self. This helps the system serialize itself back to DOCX fullly. Probably not useful for consumers of the library.
By default only returns the instance itself but no other related instances.
hasType(type: RelationshipType)
Static Methods
fromArchive(archive: Archive, location: string): Promise<RelationshipsXml>
Instantiate this class by looking at the DOCX XML for it.