Class: Collection

Collection


new Collection( [json])

A collection of genealogical data.
Parameters:
Name Type Argument Description
json Object <optional>
See:

Extends

Methods


addField(field)

Add a field
Parameters:
Name Type Description
field Field
Inherited From:
Returns:
this
Type
ExtensibleData

Add a link
Parameters:
Name Type Description
link Link
Inherited From:
Returns:
this
Type
ExtensibleData

getFields()

Get the fields
Inherited From:
Returns:
Type
Array.<Field>

getId()

Get the object's id.
Inherited From:
Returns:
Id
Type
String

Get a link
Parameters:
Name Type Description
rel String
Inherited From:
Returns:
Type
Link

Get the links
Inherited From:
Returns:
Type
Array.<Link>

init(json)

Initialize from JSON
Parameters:
Name Type Description
json Object
Inherited From:
Returns:
this
Type
ExtensibleData

setFields(fields)

Set the fields
Parameters:
Name Type Description
fields Array.<Field>
Inherited From:
Returns:
this
Type
ExtensibleData

setId(id)

Set the object's id.
Parameters:
Name Type Description
id String
Inherited From:
Returns:
This object, for chaining.
Type
ExtensibleData

Set the links
Parameters:
Name Type Description
links Links
Inherited From:
Returns:
this
Type
ExtensibleData

toJSON()

Export the object as JSON
Inherited From:
Returns:
JSON object
Type
Object