GedcomX FS JS Class: Root

new Root( [json])

A GEDCOM X document.

Parameters:

Name	Type	Argument	Description
`json`	Object	<optional>

See:

GEDCOM X JSON Spec

Extends

ExtensibleData

Methods

addAgent(agent)

Add an agent

Parameters:

Name	Type	Description
`agent`	Agent \| Object

Returns:

Type: Root

addChildAndParentsRelationship(childAndParentsRelationship)

Add a child and parents relationship

Parameters:

Name	Type	Description
`childAndParentsRelationship`	ChildAndParentsRelationship

Returns:

this

Type: Root

addCollection(collection)

Add a collection

Parameters:

Name	Type	Description
`collection`	Collection

Returns:

this

Type: Root

addDiscussion(discussion)

Add a discussion

Parameters:

Name	Type	Description
`discussion`	Discussion

Returns:

this

Type: Root

addDocument(doc)

Add a document

Parameters:

Name	Type	Description
`doc`	Document \| Object

Returns:

Type: Root

addEvent(event)

Add an event

Parameters:

Name	Type	Description
`event`	Event \| Object

Returns:

Type: Root

addFeature(feature)

Add a feature

Parameters:

Name	Type	Description
`feature`	FeatureSet

Returns:

this

Type: Root

addField(field)

Add a field

Parameters:

Name	Type	Description
`field`	Field

Inherited From:

ExtensibleData#addField

Returns:

this

Type: ExtensibleData

addLink(link)

Add a link

Parameters:

Name	Type	Description
`link`	Link

Inherited From:

ExtensibleData#addLink

Returns:

this

Type: ExtensibleData

addMerge()

Add a merge

Parameters:

Type	Description
Merge

Returns:

this

Type: Root

addMergeAnalysis(mergeAnalysis)

Add a merge analysis

Parameters:

Name	Type	Description
`mergeAnalysis`	MergeAnalysis

Returns:

this

Type: Root

addPerson(person)

Add a person

Parameters:

Name	Type	Description
`person`	Person \| Object

Returns:

This instance

Type: Root

addPlace(place)

Add a place

Parameters:

Name	Type	Description
`place`	PlaceDescription

Returns:

Type: Root

addRecordDescriptor(recordDescriptor)

Add a record descriptor

Parameters:

Name	Type	Description
`recordDescriptor`	RecordDescriptor

Returns:

this

Type: Root

addRelationship(relationship)

Add a relationship

Parameters:

Name	Type	Description
`relationship`	Relationship \| Object

Returns:

Type: Root

addSourceDescription(sourceDescription)

Add a ource description

Parameters:

Name	Type	Description
`sourceDescription`	SourceDescription \| Object

Returns:

Type: Root

addUser(user)

Add a user

Parameters:

Name	Type	Description
`user`	User

Returns:

this

Type: Root

getAgents()

Get the agents

Returns:

Type: Array.<Agent>

getAttribution()

Get attritbution

Returns:

Type: Attribution

getChildAndParentsRelationships()

Get the child and parent relationships

Returns:

Type: Array.<ChildAndParentsRelationship>

getCollections()

Get the collections

Returns:

collections

Type: Array.<Collection>

getDescription()

Get the description

Returns:

Type: String

getDiscussions()

Get the discussions

Returns:

discussions

Type: Array.<Discussion>

getDocuments()

Get the documents

Returns:

Type: Array.<Document>

getEvents()

Get events

Returns:

Type: Array.<Event>

getFeatures()

Get the features

Returns:

features

Type: Array.<FeatureSet>

getFields()

Get the fields

Inherited From:

ExtensibleData#getFields

Returns:

Type: Array.<Field>

getId()

Get the object's id.

Inherited From:

ExtensibleData#getId

Returns:

Type: String

getLang()

Get the lang

Returns:

Type: String

getLink(rel)

Get a link

Parameters:

Name	Type	Description
`rel`	String

Inherited From:

ExtensibleData#getLink

Returns:

Type: Link

getLinks()

Get the links

Inherited From:

ExtensibleData#getLinks

Returns:

Type: Array.<Link>

getMergeAnalyses()

Get the merge analyses

Returns:

Type: Array.<MergeAnalysis>

getMerges()

Get the errors

Returns:

Type: Array.<Error>

getMerges()

Get the merges

Returns:

Type: Array.<Merge>

getMerges(errors)

Set the errors

Parameters:

Name	Type	Description
`errors`	Array.<Error>

Returns:

this

Type: Root

getMerges(error)

Add a errors

Parameters:

Name	Type	Description
`error`	Error

Returns:

this

Type: Root

getPersons()

Get the persons

Returns:

Type: Array.<Person>

getPlaces()

Get places

Returns:

Type: Array.<PlaceDescription>

getRecordDescriptors()

Get the recordDescriptors

Returns:

recordDescriptors

Type: Boolean

getRelationships()

Get the relationships

Returns:

Type: Array.<Relationship>

getSourceDescriptions()

Get the source descriptions

Returns:

Type: Array.<SourceDescription>

getUsers()

Get the users

Returns:

users

Type: Array.<User>

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
`json`	Object

Overrides:

ExtensibleData#init

Returns:

this

Type: Root

<static> isInstance(obj)

Check whether the given object is an instance of this class.

Parameters:

Name	Type	Description
`obj`	Object

Returns:

Type: Boolean

setAgents(agents)

Set the agents

Parameters:

Name	Type	Description
`agents`	Array.<Agent> \| Array.<Object>

Returns:

Type: Root

setAttribution(attribution)

Set attribution

Parameters:

Name	Type	Description
`attribution`	Attribution

Returns:

Type: Root

setChildAndParentsRelationships(childAndParentRelationships)

Set the child and parents relationships

Parameters:

Name	Type	Description
`childAndParentRelationships`	Array.<ChildAndParentsRelationship>

Returns:

this

Type: Root

setCollections(collections)

Set the collections

Parameters:

Name	Type	Description
`collections`	Array.<Collection>

Returns:

this

Type: Root

setDescription(description)

Set the description

Parameters:

Name	Type	Description
`description`	String	URI that must resolve to a SourceDescription

Returns:

This instance

Type: Root

setDiscussions(discussions)

Set the discussions

Parameters:

Name	Type	Description
`discussions`	Array.<Discussion>

Returns:

this

Type: Root

setDocuments(documents)

Set the documents

Parameters:

Name	Type	Description
`documents`	Array.<Documents> \| Array.<Object>

Returns:

Type: Root

setEvents(events)

Set events

Parameters:

Name	Type	Description
`events`	Array.<Event> \| Array.<Object>

Returns:

Type: Root

setFeatures(features)

Set the features

Parameters:

Name	Type	Description
`features`	Array.<FeatureSet>

Returns:

this

Type: Root

setFields(fields)

Set the fields

Parameters:

Name	Type	Description
`fields`	Array.<Field>

Inherited From:

ExtensibleData#setFields

Returns:

this

Type: ExtensibleData

setId(id)

Set the object's id.

Parameters:

Name	Type	Description
`id`	String

Inherited From:

ExtensibleData#setId

Returns:

This object, for chaining.

Type: ExtensibleData

setLang(lang)

Set the lang

Parameters:

Name	Type	Description
`lang`	String

Returns:

This instance

Type: Root

setLinks(links)

Set the links

Parameters:

Name	Type	Description
`links`	Links

Inherited From:

ExtensibleData#setLinks

Returns:

this

Type: ExtensibleData

setMergeAnalyses(mergeAnalyses)

Set the merge analyses

Parameters:

Name	Type	Description
`mergeAnalyses`	Array.<MergeAnalysis>

Returns:

this

Type: Root

setMerges()

Set the merges

Parameters:

Type	Description
Array.<Merge>

Returns:

this

Type: Root

setPersons(persons)

Set the persons

Parameters:

Name	Type	Description
`persons`	Array.<Person> \| Array.<Object>

Returns:

This instance

Type: Root

setPlaces(places)

Set the places

Parameters:

Name	Type	Description
`places`	Array.<PlaceDescription> \| Object

Returns:

Type: Root

setRecordDescriptors(recordDescriptors)

Set the record descriptors

Parameters:

Name	Type	Description
`recordDescriptors`	Array.<RecordDescriptor>

Returns:

this

Type: Root

setRelationships(relationships)

Set the relationships

Parameters:

Name	Type	Description
`relationships`	Array.<Relationship> \| Array.<Object>

Returns:

Type: Root

setSourceDescriptions(sourceDescriptions)

Set the source descriptions

Parameters:

Name	Type	Description
`sourceDescriptions`	Array.<SourceDescription> \| Array.<Object>

Returns:

Type: Root

setUsers(users)

Set the users

Parameters:

Name	Type	Description
`users`	Array.<User>

Returns:

this

Type: Root

toJSON()

Export the object as JSON

Overrides:

ExtensibleData#toJSON

Returns:

JSON object

Type: Object