GedcomX JS Class: SourceDescription

new SourceDescription()

A description of a source.

See:

GEDCOM X JSON Spec

Extends

ExtensibleData

Methods

addCitation(citation)

Add a citation

Parameters:

Name	Type	Description
`citation`	SourceCitation \| Object

Returns:

Type: SourceDescription

addCoverage(coverage)

Add coverage

Parameters:

Name	Type	Description
`coverage`	Coverage

Returns:

Type: SourceDescription

addDescription(description)

Add a description

Parameters:

Name	Type	Description
`description`	TextValue \| Object

Returns:

Type: SourceDescription

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

addNote(note)

Add a source

Parameters:

Name	Type	Description
`note`	Note \| Object

Returns:

Type: SourceDescription

addRight(right)

Add a source

Parameters:

Name	Type	Description
`right`	ResourceReference \| Object

Returns:

Type: SourceDescription

addSource(source)

Add a source

Parameters:

Name	Type	Description
`source`	SourceReference \| Object

Returns:

Type: SourceDescription

addTitle(title)

Add a title

Parameters:

Name	Type	Description
`title`	TextValue \| Object

Returns:

Type: SourceDescription

getAbout()

Get the about property

Returns:

Type: String

getAnalysis()

Get the analysis

Returns:

Type: ResourceReference

getAttribution()

Get the attribution

Returns:

Type: Attribution

getCitations()

Get the citations

Returns:

Type: Array.<SourceCitation>

getComponentOf()

Get the componentOf property

Returns:

Type: SourceReference

getCoverage()

Get the coverage

Returns:

Type: Coverage

getCreated()

Get the created timestamp

Returns:

Type: Integer

getDescriptions()

Get the descriptions

Returns:

Type: Array.<TextValue>

getDescriptorRef()

Get the descriptor ref

Returns:

Type: String

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

getIdentifiers()

Get the identifiers

Returns:

Type: Identifiers

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>

getMediator()

Get the mediator

Returns:

Type: ResourceReference

getMediaType()

Get the media type

Returns:

Type: String

getModified()

Get the modified timestamp

Returns:

Type: Integer

getNotes()

Get notes

Returns:

Type: Array.<Note>

getRepository()

Get the repository

Returns:

Type: ResourceReference

getResourceType()

Get the resource type

Returns:

Type: String

getRights()

Get the rights

Returns:

Type: Array.<ResourceReference>

getSortKey()

Get the sort key

Returns:

sortKey

Type: String

getSortKey()

Get the sortKey

Returns:

sortKey

Type: Boolean

getSources()

Get sources

Returns:

Type: Array.<SourceReference>

getTitleLabel()

Get the title label

Returns:

titleLabel

Type: String

getTitles()

Get titles

Returns:

Type: Array.<TextValue>

getVersion()

Get the version

Returns:

Type: String

init(json)

Initialize from JSON

Parameters:

Name	Type	Description
`json`	Object

Overrides:

ExtensibleData#init

Returns:

this

Type: SourceDescription

<static> isInstance(obj)

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

Parameters:

Name	Type	Description
`obj`	Object

Returns:

Type: Boolean

setAbout(about)

Set the about property

Parameters:

Name	Type	Description
`about`	String

Returns:

Type: SourceDescription

setAnalysis(analysis)

Set the analysis

Parameters:

Name	Type	Description
`analysis`	ResourceReference \| Object

Returns:

Type: SourceDescription

setAttribution(attribution)

Set the attribution

Parameters:

Name	Type	Description
`attribution`	Attribution \| Object

Returns:

Type: SourceDescription

setCitations(citations)

Set the citations

Parameters:

Name	Type	Description
`citations`	Array.<SourceCitation> \| Array.<Object>

Returns:

Type: SourceDescription

setComponentOf(componentOf)

Set the componentOf property

Parameters:

Name	Type	Description
`componentOf`	SourceReference

setCoverage(coverage)

Set the coverage

Parameters:

Name	Type	Description
`coverage`	Array.<Coverage> \| Array.<Object>

Returns:

Type: SourceDescription

setCreated(created)

Set the created timestamp

Parameters:

Name	Type	Description
`created`	Integer

Returns:

Type: SourceDescription

setDescriptions(descriptions)

Set the descriptions

Parameters:

Name	Type	Description
`descriptions`	Array.<TextValue> \| Array.<Object>

Returns:

Type: SourceDescription

setDescriptorRef(descriptorRef)

Set the descriptor ref

Parameters:

Name	Type	Description
`descriptorRef`	String

Returns:

this

Type: SourceDescription

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

setIdentifiers(identifiers)

Set the identifiers

Parameters:

Name	Type	Description
`identifiers`	Identifiers

Returns:

Type: SourceDescription

setLinks(links)

Set the links

Parameters:

Name	Type	Description
`links`	Links

Inherited From:

ExtensibleData#setLinks

Returns:

this

Type: ExtensibleData

setMediator(mediator)

Set the mediator

Parameters:

Name	Type	Description
`mediator`	ResourceReference

Returns:

Type: SourceDescription

setMediaType(mediaType)

Set the media type

Parameters:

Name	Type	Description
`mediaType`	String

Returns:

Type: SourceDescription

setModified(modified)

Set the modified timestamp

Parameters:

Name	Type	Description
`modified`	Integer

Returns:

Type: SourceDescription

setNotes(notes)

Set the notes

Parameters:

Name	Type	Description
`notes`	Array.<Note> \| Array.<Object>

Returns:

Type: SourceDescription

setRepository(repository)

Set the repository

Parameters:

Name	Type	Description
`repository`	ResourceReference

Returns:

Type: SourceDescription

setResourceType(resourceType)

Set the resource type

Parameters:

Name	Type	Description
`resourceType`	String

Returns:

Type: SourceDescription

setRights(rights)

Set the rights

Parameters:

Name	Type	Description
`rights`	Array.<ResourceReference> \| Array.<Object>

Returns:

Type: SourceDescription

setSortKey(sortKey)

Set the sort key

Parameters:

Name	Type	Description
`sortKey`	String

Returns:

this

Type: SourceDescription

setSortKey(sortKey)

Set the sortKey

Parameters:

Name	Type	Description
`sortKey`	Boolean

Returns:

this

Type: SourceDescription

setSources(sources)

Set the sources

Parameters:

Name	Type	Description
`sources`	Array.<SourceReference> \| Array.<Object>

Returns:

Type: SourceDescription

setTitleLabel(titleLabel)

Set the title label

Parameters:

Name	Type	Description
`titleLabel`	String

Returns:

this

Type: SourceDescription

setTitles(titles)

Set the titles

Parameters:

Name	Type	Description
`titles`	Array.<TextValue> \| Array.<Object>

Returns:

Type: SourceDescription

setVersion(version)

Set the version

Parameters:

Name	Type	Description
`version`	String

Returns:

this

Type: SourceDescription

toJSON()

Export the object as JSON

Overrides:

ExtensibleData#toJSON

Returns:

JSON object

Type: Object