GedCom Parser Documentation

Class: Indi

Indi

new Indi( GedCom , Caller )

Indi class contains details of an individual, for example: name, birthday, families etc.
Parameters:
Name Type Description
GedCom GedCom GedCom parser instance
Caller mixed Caller instance where the class is being called
Author:
Copyright:

Extends

Members

callbacks :Object.<string, PropertySetter>

Callbacks are executed after a property has been set.
Type:
Inherited From:
Overrides:

(private) caller :mixed

Caller instance where the class has been called.
Type:
  • mixed
Inherited From:

(private) constructors :Array.<string>

Class chaining.
Type:
  • Array.<string>
Inherited From:
Overrides:

(private) gedcom :GedCom

GedCom parser instance.
Type:
Inherited From:

(private) id :string|Number

Data ID.
Type:
  • string|Number
Inherited From:

(private) props :IndiProperties

Indi properties.
Type:
Overrides:

(private) value :mixed

Data value.
Type:
  • mixed
Inherited From:

Methods

addToFamily( family , member [, type] ) → {Indi}

Add Self individual to a family.
Parameters:
Name Type Argument Default Description
family string|Number|Fam Family or family ID
member Types.FamilyMember Type of membership
type Types.Relationship|Object <optional>
 Types.Relationship.Natural Type of relationship
Properties
Name Type Argument Description
father Types.Relationship <optional>
 Type of relationship
mother Types.Relationship <optional>
 Type of relationship
Returns:
  • {Indi} - Self individual
Example:
new Indi(<gedcom>, <instance>).addToFamily(<family>, Types.FamilyMember.Mother, Types.Relationship.Adopted);

(private) checkSelectingMethods( [tryToGenerate] )

Checks selecting methods are existed in Indi, IndiList and IndiGroupList
Parameters:
Name Type Argument Description
tryToGenerate boolean <optional>
 When true, print a sample code to output

extend( opts ) → {boolean}

Merge the contents of passed Object into the Self instance.
Parameters:
Name Type Description
opts Object Extended options
Inherited From:
Overrides:
Returns:
  • {boolean} - True if extending is succeeded, false otherwise
Example:
new Base().extend({
	<property>: <value>,
	<method>: function(){
	}
});

fromObject( object , deep ) → {Data}

Imports properties from a specific primitive Object.
Parameters:
Name Type Description
object Object Object will be imported
deep boolean When true, the import will run recursively
Inherited From:
Returns:
  • {Data} - Self instance
Example:
new Data(<gedcom>, <instance>).fromObject(new Object({
	props: {
		'NAME': new Object({
			props: {
				//RECURSIVELY
			};
			value: <value>,
			type: 'Data'
		}
	},
	value: <value>,
	type: 'Data'
});

get( keys ) → {Data}

Get a Data property.
Parameters:
Name Type Description
keys array Keypath of the property
Inherited From:
Returns:
  • {Data} - Data property
Example:
new Data(<gedcom>, <instance>).get(['NAME', 'FIRST']);

getAdoptedChildren( ) → {IndiList}

Get adopted children of Self individual.
Returns:
  • {IndiList} - Adopted children of Self individual
Example:
new Indi(<gedcom>, <instance>).getAdoptedChildren();

getAdoptedDaughters( ) → {IndiList}

Get adopted daughters of Self individual.
Returns:
  • {IndiList} - Adopted daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getAdoptedDaughters();

getAdoptedFathers( ) → {IndiList}

Get adopted fathers of Self individual.
Returns:
  • {IndiList} - Adopted fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getAdoptedFathers();

getAdoptedMothers( ) → {IndiList}

Get adopted mothers of Self individual.
Returns:
  • {IndiList} - Adopted mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getAdoptedMothers();

getAdoptedParents( ) → {IndiList}

Get adopted parents of Self individual.
Returns:
  • {IndiList} - Adopted parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getAdoptedParents();

getAdoptedSons( ) → {IndiList}

Get adopted sons of Self individual.
Returns:
  • {IndiList} - Adopted sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getAdoptedSons();

getAllAncestors( ) → {IndiList}

Get all ancestors of Self individual.
Returns:
  • {IndiList} - All ancestors of Self individual
Example:
new Indi(<gedcom>, <instance>).getAllAncestors();

getAllDescendants( ) → {IndiList}

Get all descendants of Self individual.
Returns:
  • {IndiList} - All descendants of Self individual
Example:
new Indi(<gedcom>, <instance>).getAllDescendants();

(private) getAllRelatives( ) → {IndiList}

Get all relatives of Self individual. This method speed depends on the length of all relatives.
Returns:
  • {IndiList} - All relatives of Self individual
Example:
new Indi(<gedcom>, <instance>).getAllRelatives();

getAncestors( [level] ) → {IndiList}

Get ancestors of Self individual.
Parameters:
Name Type Argument Default Description
level Number|Object <optional>
 1 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 1 Get ancestors from generation level.from
to Number <optional>
 level.from Get ancestors until generation level.to
Returns:
  • {IndiList} - Ancestors of Self individual
Examples:
new Indi(<gedcom>, <instance>).getAncestors();
new Indi(<gedcom>, <instance>).getAncestors(2);
new Indi(<gedcom>, <instance>).getAncestors(new Object({from: 2, to: 3}));

getAunts( [level] ) → {IndiList}

Get aunts of Self individual.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns aunts, by 2 returns great aunts etc
Returns:
Examples:
new Indi(<gedcom>, <instance>).getAunts();
new Indi(<gedcom>, <instance>).getAunts(1);

getBiologicalChildren( ) → {IndiList}

Get biological children of Self individual.
Returns:
  • {IndiList} - Biological children of Self individual
Example:
new Indi(<gedcom>, <instance>).getBiologicalChildren();

getBiologicalDaughters( ) → {IndiList}

Get biological daughters of Self individual.
Returns:
  • {IndiList} - Biological daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getBiologicalDaughters();

getBiologicalFathers( ) → {IndiList}

Get biological fathers of Self individual.
Returns:
  • {IndiList} - Biological fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getBiologicalFathers();

getBiologicalMothers( ) → {IndiList}

Get biological mothers of Self individual.
Returns:
  • {IndiList} - Biological mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getBiologicalMothers();

getBiologicalParents( ) → {IndiList}

Get biological parents of Self individual.
Returns:
  • {IndiList} - Biological parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getBiologicalParents();

getBiologicalSons( ) → {IndiList}

Get biological sons of Self individual.
Returns:
  • {IndiList} - Biological sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getBiologicalSons();

getBrothers( ) → {IndiList}

Get brothers of Self individual.
Returns:
  • {IndiList} - Brothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getBrothers();

getBrothersAndSistersInLaw( ) → {IndiList}

Get brothers-in-law and sisters-in-law of Self individual.
Returns:
  • {IndiList} - Brothers-in-law and sisters-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getBrothersAndSistersInLaw();

getBrothersInLaw( ) → {IndiList}

Get brothers-in-law of Self individual.
Returns:
  • {IndiList} - Brothers-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getBrothersInLaw();

(private) getCache( args ) → {Object}

Get cached relatives from Self individual cache property
Parameters:
Name Type Description
args Arguments Arguments of caller method
Returns:
  • {Object} - Relatives as Object

(private) getCacheName( args ) → {string}

Get cache name by caller method arguments
Parameters:
Name Type Description
args Arguments Arguments of caller method
Returns:
  • {string} - Cache name

(private) getCaller( ) → {Data}

Get the Data caller instance.
Inherited From:
Returns:
  • {Data} - Self instance
Example:
new Data(<gedcom>, <instance>).getCaller();

getChildren( [type [, gender]] ) → {IndiList}

Get children of Self individual.
Parameters:
Name Type Argument Default Description
type Types.Relationship <optional>
 Type of relationship
gender Types.ChildrenGender <optional>
 Types.ChildrenGender.All Gender of children
Returns:
  • {IndiList} - Children of Self individual
Examples:
new Indi(<gedcom>, <instance>).getChildren();
new Indi(<gedcom>, <instance>).getChildren(Types.Relationship.Biological);
new Indi(<gedcom>, <instance>).getChildren(Types.Relationship.Biological, Types.ChildrenGender.Sons);

getChildrenInLaw( )

Synonym of Indi#getSonsAndDaughtersInLaw.

getCloseRelatives( ) → {IndiList}

Get close relatives of Self individual.
Returned list contains parents, children, siblings and spouses.
Returns:
  • {IndiList} - Close relatives of Self individual
Example:
new Indi(<gedcom>, <instance>).getCloseRelatives();

getCommonChildren( indi2 ) → {IndiList}

Get common children of two individuals.
Parameters:
Name Type Description
indi2 Indi Other individual to get common children with Self individual
Returns:
  • {IndiList} - Common children of two individuals
Example:
new Indi(<gedcom>, <instance>).getCommonChildren(new Indi(<gedcom>, <instance>));

getCousins( [degree] ) → {IndiList}

Get cousins of Self individual.
Parameters:
Name Type Argument Default Description
degree Number <optional>
 1 Degree in family, by 1 returns First cousins, by 2 returns Second cousins etc
Returns:
  • {IndiList} - Cousins of Self individual
Examples:
new Indi(<gedcom>, <instance>).getCousins();
new Indi(<gedcom>, <instance>).getCousins(2);

getDaughters( [type] ) → {IndiList}

Get daughters of Self individual.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {IndiList} - Daughters of Self individual
Examples:
new Indi(<gedcom>, <instance>).getDaughters();
new Indi(<gedcom>, <instance>).getDaughters(Types.Relationship.Biological);

getDaughtersInLaw( ) → {IndiList}

Get daughters-in-law of Self individual.
Returns:
  • {IndiList} - Daughters-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getDaughtersInLaw();

getDescendants( [level] ) → {IndiList}

Get descendants of Self individual.
Parameters:
Name Type Argument Default Description
level Number|Object <optional>
 -1 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 -1 Get descendants from generation level.from
to Number <optional>
 level.from Get descendants until generation level.to
Returns:
  • {IndiList} - Descendants of Self individual
Examples:
new Indi(<gedcom>, <instance>).getDescendants();
new Indi(<gedcom>, <instance>).getdescendants(2);
new Indi(<gedcom>, <instance>).getDescendants(new Object({from: -2, to: -3}));

(private) getFamilies( type ) → {FamList}

Get individual families by type.
Parameters:
Name Type Description
type Types.FamilyType Returned families type
Returns:
Example:
new Indi(<gedcom>, <instance>).getFamilies('Spouses');

getFamiliesByChildren( ) → {FamList}

Get individual families where Self individual is a child.
Returns:
Example:
new Indi(<gedcom>, <instance>).getFamiliesByChildren();

getFamiliesBySpouses( ) → {FamList}

Get individual families where Self individual is a spouse.
Returns:
Example:
new Indi(<gedcom>, <instance>).getFamiliesBySpouses();

getFathers( [type] ) → {IndiList}

Get fathers of Self individual.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {IndiList} - Fathers of Self individual
Examples:
new Indi(<gedcom>, <instance>).getFathers();
new Indi(<gedcom>, <instance>).getFathers(Types.Relationship.Biological);

getFathersAndMothersInLaw( ) → {IndiList}

Get fathers-in-law and mothers-in-law of Self individual.
Returns:
  • {IndiList} - Fathers-in-law and mothers-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getFathersAndMothersInLaw();

getFathersInLaw( ) → {IndiList}

Get fathers-in-law of Self individual.
Returns:
  • {IndiList} - Fathers-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getFathersInLaw();

getFosterChildren( ) → {IndiList}

Get foster children of Self individual.
Returns:
  • {IndiList} - Foster children of Self individual
Example:
new Indi(<gedcom>, <instance>).getFosterChildren();

getFosterDaughters( ) → {IndiList}

Get foster daughters of Self individual.
Returns:
  • {IndiList} - Foster daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getFosterDaughters();

getFosterFathers( ) → {IndiList}

Get foster fathers of Self individual.
Returns:
  • {IndiList} - Foster fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getFosterFathers();

getFosterMothers( ) → {IndiList}

Get foster mothers of Self individual.
Returns:
  • {IndiList} - Foster mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getFosterMothers();

getFosterParents( ) → {IndiList}

Get foster parents of Self individual.
Returns:
  • {IndiList} - Foster parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getFosterParents();

getFosterSons( ) → {IndiList}

Get foster sons of Self individual.
Returns:
  • {IndiList} - Foster sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getFosterSons();

getFullBrothers( ) → {IndiList}

Get full brothers of Self individual.
Returns:
  • {IndiList} - Full brothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getFullBrothers();

getFullSiblings( ) → {IndiList}

Get full siblings of Self individual.
Returns:
  • {IndiList} - Full siblings of Self individual
Example:
new Indi(<gedcom>, <instance>).getFullSiblings();

getFullSisters( ) → {IndiList}

Get full sisters of Self individual.
Returns:
  • {IndiList} - Full sisters of Self individual
Example:
new Indi(<gedcom>, <instance>).getFullSisters();

getGrandChildren( ) → {IndiList}

Get grandchildren of Self individual.
Returns:
  • {IndiList} - Grandchildren of Self individual
Example:
new Indi(<gedcom>, <instance>).getGrandChildren();

getGrandDaughters( ) → {IndiList}

Get granddaughters of Self individual.
Returns:
  • {IndiList} - Granddaughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getGrandDaughters();

getGrandFathers( ) → {IndiList}

Get grandfathers of Self individual.
Returns:
  • {IndiList} - Grandfathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getGrandFathers();

getGrandMothers( ) → {IndiList}

Get grandmothers of Self individual.
Returns:
  • {IndiList} - Grandmothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getGrandMothers();

getGrandParents( ) → {IndiList}

Get grandparents of Self individual.
Returns:
  • {IndiList} - Grandparents of Self individual
Example:
new Indi(<gedcom>, <instance>).getGrandParents();

getGrandSons( ) → {IndiList}

Get grandsons of Self individual.
Returns:
  • {IndiList} - Grandsons of Self individual
Example:
new Indi(<gedcom>, <instance>).getGrandSons();

getGreatGrandChildren( ) → {IndiList}

Get greatgrandchildren of Self individual.
Returns:
  • {IndiList} - Greatgrandchildren of Self individual
Example:
new Indi(<gedcom>, <instance>).getGreatGrandChildren();

getGreatGrandDaughters( ) → {IndiList}

Get greatgranddaughters of Self individual.
Returns:
  • {IndiList} - Greatgranddaughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getGreatGrandDaughters();

getGreatGrandFathers( ) → {IndiList}

Get greatgrandfathers of Self individual.
Returns:
  • {IndiList} - Greatgrandfathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getGreatGrandFathers();

getGreatGrandMothers( ) → {IndiList}

Get greatgrandmothers of Self individual.
Returns:
  • {IndiList} - Greatgrandmothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getGreatGrandMothers();

getGreatGrandParents( ) → {IndiList}

Get greatgrandparents of Self individual.
Returns:
  • {IndiList} - Greatgrandparents of Self individual
Example:
new Indi(<gedcom>, <instance>).getGreatGrandParents();

getGreatGrandSons( ) → {IndiList}

Get greatgrandsons of Self individual.
Returns:
  • {IndiList} - Greatgrandsons of Self individual
Example:
new Indi(<gedcom>, <instance>).getGreatGrandSons();

getGuardianChildren( ) → {IndiList}

Get guardian children of Self individual.
Returns:
  • {IndiList} - Guardian children of Self individual
Example:
new Indi(<gedcom>, <instance>).getGuardianChildren();

getGuardianDaughters( ) → {IndiList}

Get guardian daughters of Self individual.
Returns:
  • {IndiList} - Guardian daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getGuardianDaughters();

getGuardianFathers( ) → {IndiList}

Get guardian fathers of Self individual.
Returns:
  • {IndiList} - Guardian fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getGuardianFathers();

getGuardianMothers( ) → {IndiList}

Get guardian mothers of Self individual.
Returns:
  • {IndiList} - Guardian mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getGuardianMothers();

getGuardianParents( ) → {IndiList}

Get guardian parents of Self individual.
Returns:
  • {IndiList} - Guardian parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getGuardianParents();

getGuardianSons( ) → {IndiList}

Get guardian sons of Self individual.
Returns:
  • {IndiList} - Guardian sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getGuardianSons();

getHalfBrothers( ) → {IndiList}

Get half brothers of Self individual.
Returns:
  • {IndiList} - Half brothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getHalfBrothers();

getHalfSiblings( ) → {IndiList}

Get half siblings of Self individual.
Returns:
  • {IndiList} - Half siblings of Self individual
Example:
new Indi(<gedcom>, <instance>).getHalfSiblings();

getHalfSisters( ) → {IndiList}

Get half sisters of Self individual.
Returns:
  • {IndiList} - Half sisters of Self individual
Example:
new Indi(<gedcom>, <instance>).getHalfSisters();

getId( ) → {string|Number}

Get Data ID. Data ID is the key in parent Properties instance.
Inherited From:
Returns:
  • {string|Number} - Data ID
Example:
new Data(<gedcom>, <instance>).getId();

getIllegitimateChildren( ) → {IndiList}

Get illegitimate children of Self individual.
Returns:
  • {IndiList} - Illegitimate children of Self individual
Example:
new Indi(<gedcom>, <instance>).getIllegitimateChildren();

getIllegitimateDaughters( ) → {IndiList}

Get illegitimate daughters of Self individual.
Returns:
  • {IndiList} - Illegitimate daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getIllegitimateDaughters();

getIllegitimateFathers( ) → {IndiList}

Get illegitimate fathers of Self individual.
Returns:
  • {IndiList} - Illegitimate fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getIllegitimateFathers();

getIllegitimateMothers( ) → {IndiList}

Get illegitimate mothers of Self individual.
Returns:
  • {IndiList} - Illegitimate mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getIllegitimateMothers();

getIllegitimateParents( ) → {IndiList}

Get illegitimate parents of Self individual.
Returns:
  • {IndiList} - Illegitimate parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getIllegitimateParents();

getIllegitimateSons( ) → {IndiList}

Get illegitimate sons of Self individual.
Returns:
  • {IndiList} - Illegitimate sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getIllegitimateSons();

(private) getKeyPath( keys ) → {KeyPath}

Get the KeyPath of a property from an Array.
Parameters:
Name Type Description
keys array Keypath of the property
Inherited From:
Returns:
  • {KeyPath} - Keypath of the property
Example:
new Data(<gedcom>, <instance>).getKeyPath(['NAME', 'FIRST']);

(private) getLocalStorage( args ) → {Object}

Get cached relatives from LocalStorage if available
Parameters:
Name Type Description
args Arguments Arguments of caller method
Returns:
  • {Object} - Relatives as Object

(private) getMergedRelatives( […getters] ) → {IndiList}

Get relatives of Self individual by another relatives getters.
Parameters:
Name Type Argument Description
getters string <optional>
<repeatable>
 Other relatives getters name
Returns:
  • {IndiList} - Relatives of Self individual by another relatives getters
Examples:
new Indi(<gedcom>, <instance>).getMergedRelatives('getSpouses', 'getChildren', 'getCousins(1)');
new Indi(<gedcom>, <instance>).getMergedRelatives(['getSpouses', 'getChildren', 'getCousins(1)']);

(private) getMethodName( [instance] , method [, method [, indexInStack]] ) → {string}

Get the method name.
Parameters:
Name Type Argument Description
instance mixed <optional>
 A class instance
method function The method
method string <optional>
 Calling stack, only used in strict mode
indexInStack number <optional>
 Caller method index in stack, only used in strict mode
Inherited From:
Overrides:
Returns:
  • {string} - The method name

(private) getMethodParams( [instance] , method ) → {Array.<string>}

Get the method params.
Parameters:
Name Type Argument Description
instance mixed <optional>
 A class instance
method string The method name
Inherited From:
Overrides:
Returns:
  • {Array.<string>} - The method params

getMothers( [type] )

Get mothers of Self individual.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Examples:
new Indi(<gedcom>, <instance>).getMothers();
new Indi(<gedcom>, <instance>).getMothers(Types.Relationship.Biological);

getMothersInLaw( ) → {IndiList}

Get mothers-in-law of Self individual.
Returns:
  • {IndiList} - Mothers-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getMothersInLaw();

getName( [type] ) → {string}

Get individual name.
Parameters:
Name Type Argument Default Description
type Types.NamePart <optional>
 Types.NamePart.Full Returned name part
Returns:
  • {string} - Individual name
Examples:
new Indi(<gedcom>, <instance>).getName();
new Indi(<gedcom>, <instance>).getName(Types.NamePart.First);

getNaturalChildren( ) → {IndiList}

Get natural children of Self individual.
Returns:
  • {IndiList} - Natural children of Self individual
Example:
new Indi(<gedcom>, <instance>).getNaturalChildren();

getNaturalDaughters( ) → {IndiList}

Get natural daughters of Self individual.
Returns:
  • {IndiList} - Natural daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getNaturalDaughters();

getNaturalFathers( ) → {IndiList}

Get natural fathers of Self individual.
Returns:
  • {IndiList} - Natural fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getNaturalFathers();

getNaturalMothers( ) → {IndiList}

Get natural mothers of Self individual.
Returns:
  • {IndiList} - Natural mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getNaturalMothers();

getNaturalParents( ) → {IndiList}

Get natural parents of Self individual.
Returns:
  • {IndiList} - Natural parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getNaturalParents();

getNaturalSons( ) → {IndiList}

Get natural sons of Self individual.
Returns:
  • {IndiList} - Natural sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getNaturalSons();

getNephews( [level] ) → {IndiList}

Get nephews of Self individual.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns newphews, by 2 returns great nephews etc
Returns:
  • {IndiList} - Newphews of Self individual
Examples:
new Indi(<gedcom>, <instance>).getNephews();
new Indi(<gedcom>, <instance>).getNephews(1);

getNephewsAndNieces( [level] ) → {IndiList}

Get nephews and nieces of Self individual.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns newphews and nieces, by 2 returns grand nephews and nieces etc
Returns:
  • {IndiList} - Nephews and nieces of Self individual
Examples:
new Indi(<gedcom>, <instance>).getNephewsAndNieces();
new Indi(<gedcom>, <instance>).getNephewsAndNieces(1);

getNieces( [level] ) → {IndiList}

Get nieces of Self individual.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns nieces, by 2 returns great nieces etc
Returns:
  • {IndiList} - Nieces of Self individual
Examples:
new Indi(<gedcom>, <instance>).getNieces();
new Indi(<gedcom>, <instance>).getNieces(1);

getParents( [type [, gender]] ) → {IndiList}

Get parents of Self individual.
Parameters:
Name Type Argument Default Description
type Types.Relationship <optional>
 Type of relationship
gender Types.ParentsGender <optional>
 Types.ParentsGender.All Gender of siblings
Returns:
  • {IndiList} - Parents of Self individual
Examples:
new Indi(<gedcom>, <instance>).getParents();
new Indi(<gedcom>, <instance>).getParents(Types.Relationship.Biological);
new Indi(<gedcom>, <instance>).getParents(Types.ParentsGender.Fathers);

getParentsInLaw( )

Synonym of Indi#getFathersAndMothersInLaw.

getParentsOfChildren( ) → {IndiList}

Get other parents of Self individual's children.
Returns:
  • {IndiList} - Other parents of Self individual's children
Example:
new Indi(<gedcom>, <instance>).getParentsOfChildren();

(private) getProp( obj , keys ) → {Data}

Get a passed Data property.
Parameters:
Name Type Description
obj Data Passed Data
keys array Keypath of the property
Inherited From:
Returns:
  • {Data} - Passed Data property
Example:
new Data(<gedcom>, <instance>).get(new Data(<gedcom>, <instance>), ['NAME', 'FIRST']);

getRelatedChildren( ) → {IndiList}

Get related children of Self individual.
Returns:
  • {IndiList} - Related children of Self individual
Example:
new Indi(<gedcom>, <instance>).getRelatedChildren();

getRelatedDaughters( ) → {IndiList}

Get related daughters of Self individual.
Returns:
  • {IndiList} - Related daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getRelatedDaughters();

getRelatedFathers( ) → {IndiList}

Get related fathers of Self individual.
Returns:
  • {IndiList} - Related fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getRelatedFathers();

getRelatedMothers( ) → {IndiList}

Get related mothers of Self individual.
Returns:
  • {IndiList} - Related mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getRelatedMothers();

getRelatedParents( ) → {IndiList}

Get related parents of Self individual.
Returns:
  • {IndiList} - Related parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getRelatedParents();

getRelatedSons( ) → {IndiList}

Get related sons of Self individual.
Returns:
  • {IndiList} - Related sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getRelatedSons();

(private) getRelatives( [level [, degree]] ) → {IndiList}

Get relatives of Self individual. .
Parameters:
Name Type Argument Default Description
level Number|Object <optional>
 0 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 0 Get descendants from generation level.from
to Number <optional>
 level.from Get descendants until generation level.to
degree Number <optional>
 0 Degree in family
Returns:
  • {IndiList} - Relatives of Self individual
Examples:
new Indi(<gedcom>, <instance>).getRelatives(0, 0);
new Indi(<gedcom>, <instance>).getRelatives(1, 0);
new Indi(<gedcom>, <instance>).getRelatives(0, 2);
new Indi(<gedcom>, <instance>).getRelatives(-2, 0);
new Indi(<gedcom>, <instance>).getRelatives({from: -1, to: 1}, 0);

getRelativesSelectorMethods( ) → {Array.<string>}

Get all relative selector methods.
Returns:
  • {Array.<string>} - Selectors names

(private) getSelectingMethodByCallerMethod( method ) → {string}

Get selecting method name by matching or having method name.
Parameters:
Name Type Description
method string Name of caller method
Returns:
  • {string} - Name of selecting method
Example:
new Indi(<gedcom>, <instance>).getSelectingMethodByCallerMethod('isParent');

getSiblings( [type [, gender]] ) → {IndiList}

Get siblings of Self individual.
Parameters:
Name Type Argument Default Description
type Types.SiblingsType <optional>
 Types.SiblingsType.All Type of siblings
gender Types.SiblingsGender <optional>
 Types.SiblingsGender.All Gender of siblings
Returns:
  • {IndiList} - Siblings of Self individual
Examples:
new Indi(<gedcom>, <instance>).getSiblings();
new Indi(<gedcom>, <instance>).getSiblings(Types.SiblingsType.Full);
new Indi(<gedcom>, <instance>).getSiblings(undefined, Types.SiblingsGender.Sisters);
new Indi(<gedcom>, <instance>).getSiblings(Types.SiblingsType.Half, Types.SiblingsGender.Brothers);

getSiblingsInLaw( )

Synonym of Indi#getBrothersAndSistersInLaw.

getSisters( ) → {IndiList}

Get sisters of Self individual.
Returns:
  • {IndiList} - Sisters of Self individual
Example:
new Indi(<gedcom>, <instance>).getSisters();

getSistersInLaw( ) → {IndiList}

Get sisters-in-law of Self individual.
Returns:
  • {IndiList} - Sisters-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getSistersInLaw();

getSons( [type] ) → {IndiList}

Get sons of Self individual.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Returns:
Examples:
new Indi(<gedcom>, <instance>).getSons();
new Indi(<gedcom>, <instance>).getSons(Types.Relationship.Biological);

getSonsAndDaughtersInLaw( ) → {IndiList}

Get sons-in-law and daugthers-in-law of Self individual.
Returns:
  • {IndiList} - Sons-in-law and daugthers-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getSonsAndDaughtersInLaw();

getSonsInLaw( ) → {IndiList}

Get sons-in-law of Self individual.
Returns:
  • {IndiList} - Sons-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).getSonsInLaw();

getSpouses( [withChildrenOnEnd] ) → {IndiList}

Get spouses of Self individual.
Parameters:
Name Type Argument Description
withChildrenOnEnd boolean <optional>
 Spouses who have children put into the end (false) or the start (true) of Self individualList
Returns:
  • {IndiList} - Spouses of Self individual
Example:
new Indi(<gedcom>, <instance>).getSpouses();

getSpousesWithChildren( ) → {IndiList}

Get spouses of Self individual who have children.
Returns:
  • {IndiList} - Spouses of Self individual who have children
Example:
new Indi(<gedcom>, <instance>).getSpousesWithChildren();

getSpousesWithoutChildren( ) → {IndiList}

Get spouses of Self individual who do not have children.
Returns:
  • {IndiList} - Spouses of Self individual who do not have children
Example:
new Indi(<gedcom>, <instance>).getSpousesWithoutChildren();

getStepChildren( ) → {IndiList}

Get step children of Self individual.
Returns:
  • {IndiList} - Step children of Self individual
Example:
new Indi(<gedcom>, <instance>).getStepChildren();

getStepDaughters( ) → {IndiList}

Get step daughters of Self individual.
Returns:
  • {IndiList} - Step daughters of Self individual
Example:
new Indi(<gedcom>, <instance>).getStepSons();

getStepFathers( ) → {IndiList}

Get step fathers of Self individual.
Returns:
  • {IndiList} - Step fathers of Self individual
Example:
new Indi(<gedcom>, <instance>).getStep();

getStepMothers( ) → {IndiList}

Get step mothers of Self individual.
Returns:
  • {IndiList} - Step mothers of Self individual
Example:
new Indi(<gedcom>, <instance>).getStepMothers();

getStepParents( ) → {IndiList}

Get step parents of Self individual.
Returns:
  • {IndiList} - Step parents of Self individual
Example:
new Indi(<gedcom>, <instance>).getStepParents();

getStepSons( ) → {IndiList}

Get step sons of Self individual.
Returns:
  • {IndiList} - Step sons of Self individual
Example:
new Indi(<gedcom>, <instance>).getStepSons();

getType( ) → {string}

Get the type of a class.
Inherited From:
Overrides:
Returns:
  • {string} - The type of a class
Examples:
new Properties(<gedcom>, <instance>).getType();
new List(<gedcom>, <instance>).getType();
new Data(<gedcom>, <instance>).getType();

getUncles( [level] ) → {IndiList}

Get uncles of Self individual.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns uncles, by 2 returns great uncles etc
Returns:
  • {IndiList} - Uncles of Self individual
Examples:
new Indi(<gedcom>, <instance>).getUncles();
new Indi(<gedcom>, <instance>).getUncles(1);

getUnclesAndAunts( [level] ) → {IndiList}

Get uncles and aunts of Self individual.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns uncles and aunts, by 2 returns great uncles and aunts etc
Returns:
  • {IndiList} - Uncles and aunts of Self individual
Examples:
new Indi(<gedcom>, <instance>).getUnclesAndAunts();
new Indi(<gedcom>, <instance>).getUnclesAndAunts(1);

(private) getValidKey( key )

Validates keys of a property.
Parameters:
Name Type Description
key string Key of the property
Inherited From:
Examples:
new Data(<gedcom>, <instance>).getValidKey('Birthday'); //returns "BIRT"
new Data(<gedcom>, <instance>).getValidKey('_Birthday'); //returns "_BIRT"

getValue( ) → {mixed}

Get Data value.
Inherited From:
Returns:
  • {mixed} - Data value
Example:
new Data(<gedcom>, <instance>).getValue();

(private) has( args ) → {boolean}

Checks Self individual has relatives by caller having method.
Parameters:
Name Type Description
args Arguments Arguments of caller method
Returns:
  • {boolean} - Self individual has relatives by caller having method

hasAdoptedChild( ) → {boolean}

Checks Self individual has adopted child.
Returns:
  • {boolean} - Self individual has adopted child
Example:
new Indi(<gedcom>, <instance>).hasAdoptedChild();

hasAdoptedDaughter( ) → {boolean}

Checks Self individual has adopted daughters.
Returns:
  • {boolean} - Self individual has adopted daughters
Example:
new Indi(<gedcom>, <instance>).hasAdoptedDaughter();

hasAdoptedFather( ) → {boolean}

Checks Self individual has adopted father.
Returns:
  • {boolean} - Self individual has adopted father
Example:
new Indi(<gedcom>, <instance>).hasAdoptedFather();

hasAdoptedMother( ) → {boolean}

Checks Self individual has adopted mother.
Returns:
  • {boolean} - Self individual has adopted mother
Example:
new Indi(<gedcom>, <instance>).hasAdoptedMother();

hasAdoptedParent( ) → {boolean}

Checks Self individual has adopted parent.
Returns:
  • {boolean} - Self individual has adopted parent
Example:
new Indi(<gedcom>, <instance>).hasAdoptedParent();

hasAdoptedSon( ) → {boolean}

Checks Self individual has adopted son.
Returns:
  • {boolean} - Self individual has adopted son
Example:
new Indi(<gedcom>, <instance>).hasAdoptedSon();

hasAllAncestor( ) → {boolean}

Checks Self individual has all ancestor.
Returns:
  • {boolean} - Self individual has all ancestor
Example:
new Indi(<gedcom>, <instance>).hasAllAncestor();

hasAllDescendant( ) → {boolean}

Checks Self individual has all descendant.
Returns:
  • {boolean} - Self individual has all descendant
Example:
new Indi(<gedcom>, <instance>).hasAllDescendant();

(private) hasAllRelative( ) → {IndiList}

Checks Self individual has all relatives. This method speed depends on the length of all relatives.
Returns:
  • {IndiList} - Self individual has all relative
Example:
new Indi(<gedcom>, <instance>).hasAllRelatives();

hasAncestor( [level] ) → {boolean}

Checks Self individual has ancestor.
Parameters:
Name Type Argument Default Description
level Number|Object <optional>
 1 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 1 Get ancestors from generation level.from
to Number <optional>
 level.from Get ancestors until generation level.to
Returns:
  • {boolean} - Self individual has ancestor
Examples:
new Indi(<gedcom>, <instance>).hasAncestor();
new Indi(<gedcom>, <instance>).hasAncestor(2);
new Indi(<gedcom>, <instance>).hasAncestor(new Object({from: 2, to: 3}));

hasAunt( [level] ) → {boolean}

Checks Self individual has aunt.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns aunts, by 2 returns great aunts etc
Returns:
  • {boolean} - Self individual has aunt
Examples:
new Indi(<gedcom>, <instance>).hasAunt();
new Indi(<gedcom>, <instance>).hasAunt(1);

hasBiologicalChild( ) → {boolean}

Checks Self individual has biological child.
Returns:
  • {boolean} - Self individual has biological child
Example:
new Indi(<gedcom>, <instance>).hasBiologicalChild();

hasBiologicalDaughter( ) → {boolean}

Checks Self individual has biological daughters.
Returns:
  • {boolean} - Self individual has biological daughters
Example:
new Indi(<gedcom>, <instance>).hasBiologicalDaughter();

hasBiologicalFather( ) → {boolean}

Checks Self individual has biological father.
Returns:
  • {boolean} - Self individual has biological father
Example:
new Indi(<gedcom>, <instance>).hasBiologicalFather();

hasBiologicalMother( ) → {boolean}

Checks Self individual has biological mother.
Returns:
  • {boolean} - Self individual has biological mother
Example:
new Indi(<gedcom>, <instance>).hasBiologicalMother();

hasBiologicalParent( ) → {boolean}

Checks Self individual has biological parent.
Returns:
  • {boolean} - Self individual has biological parent
Example:
new Indi(<gedcom>, <instance>).hasBiologicalParent();

hasBiologicalSon( ) → {boolean}

Checks Self individual has biological son.
Returns:
  • {boolean} - Self individual has biological son
Example:
new Indi(<gedcom>, <instance>).hasBiologicalSon();

hasBrother( ) → {boolean}

Checks Self individual has brother.
Returns:
  • {boolean} - Self individual has brother
Example:
new Indi(<gedcom>, <instance>).hasBrother();

hasBrotherInLaw( ) → {boolean}

Checks Self individual has brother-in-law.
Returns:
  • {boolean} - Self individual has brother-in-law
Example:
new Indi(<gedcom>, <instance>).hasBrotherInLaw();

hasBrotherOrSisterInLaw( ) → {boolean}

Checks Self individual has brother-in-law or sister-in-law.
Returns:
  • {boolean} - Self individual has brother-in-law or sister-in-law
Example:
new Indi(<gedcom>, <instance>).hasBrotherOrSisterInLaw();

hasChild( [type [, gender]] ) → {boolean}

Checks Self individual has child.
Parameters:
Name Type Argument Default Description
type Types.Relationship <optional>
 Type of relationship
gender Types.ChildrenGender <optional>
 Types.ChildrenGender.All Gender of child
Returns:
  • {boolean} - Self individual has child
Examples:
new Indi(<gedcom>, <instance>).hasChild();
new Indi(<gedcom>, <instance>).hasChild(Types.Relationship.Biological);
new Indi(<gedcom>, <instance>).hasChild(Types.Relationship.Biological, Types.ChildrenGender.Sons);

hasChildInLaw( )

Synonym of Indi#hasSonOrDaughterInLaw.

hasCloseRelative( ) → {boolean}

Checks Self individual has close relative.
Returns:
  • {boolean} - Self individual has close relative
Example:
new Indi(<gedcom>, <instance>).hasCloseRelative();

hasCommonChild( indi2 ) → {boolean}

Checks Self individual and other individual have commonchild.
Parameters:
Name Type Description
indi2 Indi Other individual to get common children with Self individual
Returns:
  • {boolean} - Self individual and an other individual have commonchild
Example:
new Indi(<gedcom>, <instance>).hasCommonChild(new Indi(<gedcom>, <instance>));

hasCousin( ) → {boolean}

Checks Self individual has cousin.
Returns:
  • {boolean} - Self individual has cousin
Example:
new Indi(<gedcom>, <instance>).hasCousin();

hasDaughter( [type] ) → {boolean}

Checks Self individual has daughters.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {boolean} - Self individual has daughters
Examples:
new Indi(<gedcom>, <instance>).hasDaughter();
new Indi(<gedcom>, <instance>).hasDaughter(Types.Relationship.Biological);

hasDaughterInLaw( ) → {boolean}

Checks Self individual has daughter-in-law.
Returns:
  • {boolean} - Self individual has daughter-in-law
Example:
new Indi(<gedcom>, <instance>).hasDaughterInLaw();

hasDescendant( [level] ) → {boolean}

Checks Self individual has descendant.
Parameters:
Name Type Argument Default Description
level Number|Object <optional>
 -1 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 -1 Get descendants from generation level.from
to Number <optional>
 level.from Get descendants until generation level.to
Returns:
  • {boolean} - Self individual has descendant
Examples:
new Indi(<gedcom>, <instance>).hasDescendant();
new Indi(<gedcom>, <instance>).hasDescendant(2);
new Indi(<gedcom>, <instance>).hasDescendant(new Object({from: -2, to: -3}));

hasFather( [type] ) → {boolean}

Checks Self individual has father.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship type
Returns:
  • {boolean} - Self individual has father
Examples:
new Indi(<gedcom>, <instance>).hasFather();
new Indi(<gedcom>, <instance>).hasFather(Types.Relationship.Biological);

hasFatherInLaw( ) → {boolean}

Checks Self individual has father-in-law.
Returns:
  • {boolean} - Self individual has father-in-law
Example:
new Indi(<gedcom>, <instance>).hasFatherInLaw();

hasFatherOrMotherInLaw( ) → {boolean}

Checks Self individual has father-in-law or mother-in-law.
Returns:
  • {boolean} - Self individual has father-in-law or mother-in-law
Example:
new Indi(<gedcom>, <instance>).hasFatherOrMotherInLaw();

hasFosterChild( ) → {boolean}

Checks Self individual has foster child.
Returns:
  • {boolean} - Self individual has foster child
Example:
new Indi(<gedcom>, <instance>).hasFosterChild();

hasFosterDaughter( ) → {boolean}

Checks Self individual has foster daughters.
Returns:
  • {boolean} - Self individual has foster daughters
Example:
new Indi(<gedcom>, <instance>).hasFosterDaughter();

hasFosterFather( ) → {boolean}

Checks Self individual has foster father.
Returns:
  • {boolean} - -Self individual has foster father
Example:
new Indi(<gedcom>, <instance>).hasFosterFather();

hasFosterMother( ) → {boolean}

Checks Self individual has foster mother.
Returns:
  • {boolean} - Self individual has foster mother
Example:
new Indi(<gedcom>, <instance>).hasFosterMother();

hasFosterParent( ) → {boolean}

Checks Self individual has foster parent.
Returns:
  • {boolean} - Self individual has foster parent
Example:
new Indi(<gedcom>, <instance>).hasFosterParent();

hasFosterSon( ) → {boolean}

Checks Self individual has foster son.
Returns:
  • {boolean} - Self individual has foster son
Example:
new Indi(<gedcom>, <instance>).hasFosterSon();

hasFullBrother( ) → {boolean}

Checks Self individual has fullbrother.
Returns:
  • {boolean} - Self individual has fullbrother
Example:
new Indi(<gedcom>, <instance>).hasFullBrother();

hasFullSibling( ) → {boolean}

Checks Self individual has fullsibling.
Returns:
  • {boolean} - Self individual has fullsibling
Example:
new Indi(<gedcom>, <instance>).hasFullSibling();

hasFullSister( ) → {boolean}

Checks Self individual has fullsister.
Returns:
  • {boolean} - Self individual has fullsister
Example:
new Indi(<gedcom>, <instance>).hasFullSister();

hasGrandChild( ) → {boolean}

Checks Self individual has grandchild.
Returns:
  • {boolean} - Self individual has grandchild
Example:
new Indi(<gedcom>, <instance>).hasGrandChild();

hasGrandDaughter( ) → {boolean}

Checks Self individual has granddaughters.
Returns:
  • {boolean} - Self individual has granddaughters
Example:
new Indi(<gedcom>, <instance>).hasGrandDaughter();

hasGrandFather( ) → {boolean}

Checks Self individual has grandfather.
Returns:
  • {boolean} - Self individual has grandfather
Example:
new Indi(<gedcom>, <instance>).hasGrandFather();

hasGrandMother( ) → {boolean}

Checks Self individual has grandmother.
Returns:
  • {boolean} - Self individual has grandmother
Example:
new Indi(<gedcom>, <instance>).hasGrandMother();

hasGrandParent( ) → {boolean}

Checks Self individual has grandparent.
Returns:
  • {boolean} - Self individual has grandparent
Example:
new Indi(<gedcom>, <instance>).hasGrandParent();

hasGrandSon( ) → {boolean}

Checks Self individual has grandson.
Returns:
  • {boolean} - Self individual has grandson
Example:
new Indi(<gedcom>, <instance>).hasGrandSon();

hasGreatGrandChild( ) → {boolean}

Checks Self individual has greatgrandchild.
Returns:
  • {boolean} - Self individual has greatgrandchild
Example:
new Indi(<gedcom>, <instance>).hasGreatGrandChild();

hasGreatGrandDaughter( ) → {boolean}

Checks Self individual has greatgranddaughters.
Returns:
  • {boolean} - Self individual has greatgranddaughters
Example:
new Indi(<gedcom>, <instance>).hasGreatGrandDaughter();

hasGreatGrandFather( ) → {boolean}

Checks Self individual has greatgrandfather.
Returns:
  • {boolean} - Self individual has greatgrandfather
Example:
new Indi(<gedcom>, <instance>).hasGreatGrandFather();

hasGreatGrandMother( ) → {boolean}

Checks Self individual has greatgrandmother.
Returns:
  • {boolean} - Self individual has greatgrandmother
Example:
new Indi(<gedcom>, <instance>).hasGreatGrandMother();

hasGreatGrandParent( ) → {boolean}

Checks Self individual has greatgrandparent.
Returns:
  • {boolean} - Self individual has greatgrandparent
Example:
new Indi(<gedcom>, <instance>).hasGreatGrandParent();

hasGreatGrandSon( ) → {boolean}

Checks Self individual has greatgrandson.
Returns:
  • {boolean} - Self individual has greatgrandson
Example:
new Indi(<gedcom>, <instance>).hasGreatGrandSon();

hasGuardianChild( ) → {boolean}

Checks Self individual has guardian child.
Returns:
  • {boolean} - Self individual has guardian child
Example:
new Indi(<gedcom>, <instance>).hasGuardianChild();

hasGuardianDaughter( ) → {boolean}

Checks Self individual has guardian daughters.
Returns:
  • {boolean} - Self individual has guardian daughters
Example:
new Indi(<gedcom>, <instance>).hasGuardianDaughter();

hasGuardianFather( ) → {boolean}

Checks Self individual has guardian father.
Returns:
  • {boolean} - Self individual has guardian father
Example:
new Indi(<gedcom>, <instance>).hasGuardianFather();

hasGuardianMother( ) → {boolean}

Checks Self individual has guardian mother.
Returns:
  • {boolean} - Self individual has guardian mother
Example:
new Indi(<gedcom>, <instance>).hasGuardianMother();

hasGuardianParent( ) → {boolean}

Checks Self individual has guardian parent.
Returns:
  • {boolean} - Self individual has guardian parent
Example:
new Indi(<gedcom>, <instance>).hasGuardianParent();

hasGuardianSon( ) → {boolean}

Checks Self individual has guardian son.
Returns:
  • {boolean} - Self individual has guardian son
Example:
new Indi(<gedcom>, <instance>).hasGuardianSon();

hasHalfBrother( ) → {boolean}

Checks Self individual has halfbrother.
Returns:
  • {boolean} - Self individual has halfbrother
Example:
new Indi(<gedcom>, <instance>).hasHalfBrother();

hasHalfSibling( ) → {boolean}

Checks Self individual has halfsibling.
Returns:
  • {boolean} - Self individual has halfsibling
Example:
new Indi(<gedcom>, <instance>).hasHalfSibling();

hasHalfSister( ) → {boolean}

Checks Self individual has halfsister.
Returns:
  • {boolean} - Self individual has halfsister
Example:
new Indi(<gedcom>, <instance>).hasHalfSister();

hasIllegitimateChild( ) → {boolean}

Checks Self individual has illegitimate child.
Returns:
  • {boolean} - Self individual has illegitimate child
Example:
new Indi(<gedcom>, <instance>).hasIllegitimateChild();

hasIllegitimateDaughter( ) → {boolean}

Checks Self individual has illegitimate daughters.
Returns:
  • {boolean} - Self individual has illegitimate daughters
Example:
new Indi(<gedcom>, <instance>).hasIllegitimateDaughter();

hasIllegitimateFather( ) → {boolean}

Checks Self individual has illegitimate father.
Returns:
  • {boolean} - Self individual has illegitimate father
Example:
new Indi(<gedcom>, <instance>).hasIllegitimateFather();

hasIllegitimateMother( ) → {boolean}

Checks Self individual has illegitimate mother.
Returns:
  • {boolean} - Self individual has illegitimate mother
Example:
new Indi(<gedcom>, <instance>).hasIllegitimateMother();

hasIllegitimateParent( ) → {boolean}

Checks Self individual has illegitimate parent.
Returns:
  • {boolean} - Self individual has illegitimate parent
Example:
new Indi(<gedcom>, <instance>).hasIllegitimateParent();

hasIllegitimateSon( ) → {boolean}

Checks Self individual has illegitimate son.
Returns:
  • {boolean} - Self individual has illegitimate son
Example:
new Indi(<gedcom>, <instance>).hasIllegitimateSon();

hasMother( [type] ) → {boolean}

Checks Self individual has mother.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {boolean} - Self individual has mother
Examples:
new Indi(<gedcom>, <instance>).hasMother();
new Indi(<gedcom>, <instance>).hasMother(Types.Relationship.Biological);

hasMotherInLaw( ) → {boolean}

Checks Self individual has mother-in-law.
Returns:
  • {boolean} - Self individual has mother-in-law
Example:
new Indi(<gedcom>, <instance>).hasMotherInLaw();

hasNaturalChild( ) → {boolean}

Checks Self individual has natural child.
Returns:
  • {boolean} - Self individual has natural child
Example:
new Indi(<gedcom>, <instance>).hasNaturalChild();

hasNaturalDaughter( ) → {boolean}

Checks Self individual has natural daughters.
Returns:
  • {boolean} - Self individual has natural daughters
Example:
new Indi(<gedcom>, <instance>).hasNaturalDaughter();

hasNaturalFather( ) → {boolean}

Checks Self individual has natural father.
Returns:
  • {boolean} - Self individual has natural father
Example:
new Indi(<gedcom>, <instance>).hasNaturalFather();

hasNaturalMother( ) → {boolean}

Checks Self individual has natural mother.
Returns:
  • {boolean} - Self individual has natural mother
Example:
new Indi(<gedcom>, <instance>).hasNaturalMother();

hasNaturalParent( ) → {boolean}

Checks Self individual has natural parent.
Returns:
  • {boolean} - Self individual has natural parent
Example:
new Indi(<gedcom>, <instance>).hasNaturalParent();

hasNaturalSon( ) → {boolean}

Checks Self individual has natural son.
Returns:
  • {boolean} - Self individual has natural son
Example:
new Indi(<gedcom>, <instance>).hasNaturalSon();

hasNephew( [level] ) → {boolean}

Checks Self individual has nephew.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns nephews, by 2 returns great nephews etc
Returns:
  • {boolean} - Self individual has nephew
Examples:
new Indi(<gedcom>, <instance>).hasNephew();
new Indi(<gedcom>, <instance>).hasNephew(1);

hasNephewOrNiece( [level] ) → {boolean}

Checks Self individual has nephew or niece.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns newphews and nieces, by 2 returns grand nephews and nieces etc
Returns:
  • {boolean} - Self individual has nephew or niece
Examples:
new Indi(<gedcom>, <instance>).hasNephewOrNiece();
new Indi(<gedcom>, <instance>).hasNephewOrNiece(1);

hasNiece( [level] ) → {boolean}

Checks Self individual has niece.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns nieces, by 2 returns great nieces etc
Returns:
  • {boolean} - Self individual has niece
Examples:
new Indi(<gedcom>, <instance>).hasNiece();
new Indi(<gedcom>, <instance>).hasNiece(1);

hasParent( [type] ) → {boolean}

Checks Self individual has parent.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {boolean} - Self individual has parent
Examples:
new Indi(<gedcom>, <instance>).hasParent();
new Indi(<gedcom>, <instance>).hasParent(Types.Relationship.Biological);

hasParentInLaw( )

Synonym of Indi#hasFatherOrMotherInLaw.

hasParentOfChildren( ) → {boolean}

Checks children of Self individual have parents.
Returns:
  • {boolean} - Self individual has parents of children
Example:
new Indi(<gedcom>, <instance>).hasParentOfChildren();

hasRelatedChild( ) → {boolean}

Checks Self individual has related child.
Returns:
  • {boolean} - Self individual has related child
Example:
new Indi(<gedcom>, <instance>).hasRelatedChild();

hasRelatedDaughter( ) → {boolean}

Checks Self individual has related daughters.
Returns:
  • {boolean} - Self individual has related daughters
Example:
new Indi(<gedcom>, <instance>).hasRelatedDaughter();

hasRelatedFather( ) → {boolean}

Checks Self individual has related father.
Returns:
  • {boolean} - Self individual has related father
Example:
new Indi(<gedcom>, <instance>).hasRelatedFather();

hasRelatedMother( ) → {boolean}

Checks Self individual has related mother.
Returns:
  • {boolean} - Self individual has related mother
Example:
new Indi(<gedcom>, <instance>).hasRelatedMother();

hasRelatedParent( ) → {boolean}

Checks Self individual has related parent.
Returns:
  • {boolean} - Self individual has related parent
Example:
new Indi(<gedcom>, <instance>).hasRelatedParent();

hasRelatedSon( ) → {boolean}

Checks Self individual has related son.
Returns:
  • {boolean} - Self individual has related son
Example:
new Indi(<gedcom>, <instance>).hasRelatedSon();

(private) hasRelative( [level [, degree]] ) → {boolean}

Checks Self individual has relative. .
Parameters:
Name Type Argument Default Description
level Number|Object <optional>
 0 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 0 Get descendants from generation level.from
to Number <optional>
 level.from Get descendants until generation level.to
degree Number <optional>
 0 Degree in family
Returns:
  • {boolean} - Self individual has relative
Examples:
new Indi(<gedcom>, <instance>).hasRelative(0, 0);
new Indi(<gedcom>, <instance>).hasRelative(1, 0);
new Indi(<gedcom>, <instance>).hasRelative(0, 2);
new Indi(<gedcom>, <instance>).hasRelative(-2, 0);
new Indi(<gedcom>, <instance>).hasRelative({from: -1, to: 1}, 0);

hasSibling( [type [, gender]] ) → {boolean}

Checks Self individual has sibling.
Parameters:
Name Type Argument Default Description
type Types.SiblingsType <optional>
 Types.SiblingsType.All Type of siblings
gender Types.SiblingsGender <optional>
 Types.SiblingsGender.All Gender of siblings
Returns:
  • {boolean} - Self individual has sibling
Examples:
new Indi(<gedcom>, <instance>).hasSibling();
new Indi(<gedcom>, <instance>).hasSibling(Types.SiblingsType.Full);
new Indi(<gedcom>, <instance>).hasSibling(undefined, Types.SiblingsGender.Sisters);
new Indi(<gedcom>, <instance>).hasSibling(Types.SiblingsType.Half,Types.SiblingsGender.Brothers);

hasSiblingInLaw( )

Synonym of Indi#hasBrotherOrSisterInLaw.

hasSister( ) → {boolean}

Checks Self individual has sister.
Returns:
  • {boolean} - Self individual has sister
Example:
new Indi(<gedcom>, <instance>).hasSister();

hasSisterInLaw( ) → {boolean}

Checks Self individual has sister-in-law.
Returns:
  • {boolean} - Self individual has sister-in-law
Example:
new Indi(<gedcom>, <instance>).hasSisterInLaw();

hasSon( [type] ) → {boolean}

Checks Self individual has son.
Parameters:
Name Type Argument Description
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {boolean} - Self individual has son
Examples:
new Indi(<gedcom>, <instance>).hasSon();
new Indi(<gedcom>, <instance>).hasSon(Types.Relationship.Biological);

hasSonInLaw( ) → {boolean}

Checks Self individual has son-in-law.
Returns:
  • {boolean} - Self individual has son-in-law
Example:
new Indi(<gedcom>, <instance>).hasSonInLaw();

hasSonOrDaughterInLaw( ) → {boolean}

Checks Self individual has son-in-law or daughter-in-law.
Returns:
  • {boolean} - Self individual has son-in-law or daughter-in-law
Example:
new Indi(<gedcom>, <instance>).hasSonOrDaughterInLaw();

hasSpouse( ) → {boolean}

Checks Self individual has spouse.
Returns:
  • {boolean} - Self individual has spouse
Example:
new Indi(<gedcom>, <instance>).hasSpouse();

hasSpouseWithChildren( ) → {boolean}

Checks Self individual has spouse who has children.
Returns:
  • {boolean} - Self individual has spouse who has children
Example:
new Indi(<gedcom>, <instance>).hasSpouseWithChildren();

hasSpouseWithoutChildren( ) → {boolean}

Checks Self individual has spouse who does not have children
Returns:
  • {boolean} - Self individual has spouse who does not have children
Example:
new Indi(<gedcom>, <instance>).hasSpouseWithoutChildren();

hasStepChild( ) → {boolean}

Checks Self individual has step child.
Returns:
  • {boolean} - Self individual has step child
Example:
new Indi(<gedcom>, <instance>).hasStepChild();

hasStepDaughter( ) → {boolean}

Checks Self individual has step daughters.
Returns:
  • {boolean} - Self individual has step daughters
Example:
new Indi(<gedcom>, <instance>).hasStepDaughter();

hasStepFather( ) → {boolean}

Checks Self individual has step father.
Returns:
  • {boolean} - Self individual has step father
Example:
new Indi(<gedcom>, <instance>).hasStepFather();

hasStepMother( ) → {boolean}

Checks Self individual has step mother.
Returns:
  • {boolean} - Self individual has step mother
Example:
new Indi(<gedcom>, <instance>).hasStepMother();

hasStepParent( ) → {boolean}

Checks Self individual has step parent.
Returns:
  • {boolean} - Self individual has step parent
Example:
new Indi(<gedcom>, <instance>).hasStepParent();

hasStepSon( ) → {boolean}

Checks Self individual has step son.
Returns:
  • {boolean} - Self individual has step son
Example:
new Indi(<gedcom>, <instance>).hasStepSon();

hasUncle( [level] ) → {boolean}

Checks Self individual has uncle.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns uncles, by 2 returns great uncles etc
Returns:
  • {boolean} - Self individual has uncle
Examples:
new Indi(<gedcom>, <instance>).hasUncle();
new Indi(<gedcom>, <instance>).hasUncle(1);

hasUncleOrAunt( [level] ) → {boolean}

Checks Self individual has uncle or aunt.
Parameters:
Name Type Argument Description
level Number <optional>
 Generation level from Indi, by 1 returns uncles and aunts, by 2 returns great uncles and aunts etc
Returns:
  • {boolean} - Self individual has uncle or aunt
Examples:
new Indi(<gedcom>, <instance>).hasUncleOrAunt();
new Indi(<gedcom>, <instance>).hasUncleOrAunt(1);

(private) init( instance )

Creates a class.
Parameters:
Name Type Description
instance function Self class
Inherited From:
Overrides:

(private) is( args ) → {boolean}

Checks an individual is a relative of Self individual by caller matching method.
Parameters:
Name Type Description
args Arguments Arguments of caller method
Returns:
  • {boolean} - Self individual and an other individual are relatives by caller method

isAdoptedChild( ) → {boolean}

Checks an individual is adopted child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is adopted child of Self individual
Example:
new Indi(<gedcom>, <instance>).isAdoptedChild(new Indi(<gedcom>, <instance>));

isAdoptedDaughter( ) → {boolean}

Checks an individual is adopted daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is adopted daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isAdoptedDaughter(new Indi(<gedcom>, <instance>));

isAdoptedFather( ) → {boolean}

Checks an individual is adopted father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is adopted father of Self individual
Example:
new Indi(<gedcom>, <instance>).isAdoptedFather(new Indi(<gedcom>, <instance>));

isAdoptedMother( ) → {boolean}

Checks an individual is adopted mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is adopted mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isAdoptedMother(new Indi(<gedcom>, <instance>));

isAdoptedParent( ) → {boolean}

Checks an individual is adopted parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is adopted parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isAdoptedParent(new Indi(<gedcom>, <instance>));

isAdoptedSon( ) → {boolean}

Checks an individual is adopted son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is adopted son of Self individual
Example:
new Indi(<gedcom>, <instance>).isAdoptedSon(new Indi(<gedcom>, <instance>));

isAllAncestor( ) → {boolean}

Checks an individual is all ancestor of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is all ancestor of Self individual
Example:
new Indi(<gedcom>, <instance>).isAllAncestor(new Indi(<gedcom>, <instance>));

isAllDescendant( ) → {boolean}

Checks an individual is all descendant of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is all descendant of Self individual
Example:
new Indi(<gedcom>, <instance>).isAllDescendant(new Indi(<gedcom>, <instance>));

(private) isAllRelative( ) → {IndiList}

Checks an individual is all relatives of Self individual. This method speed depends on the length of all relatives.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {IndiList} - Passed individual is all relative of Self individual
Example:
new Indi(<gedcom>, <instance>).getAllRelatives();

isAncestor( [level] ) → {boolean}

Checks an individual is ancestor of Self individual.
Parameters:
Name Type Argument Default Description
string|Number|Indi Individual or individual ID
level Number|Object <optional>
 1 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 1 Get ancestors from generation level.from
to Number <optional>
 level.from Get ancestors until generation level.to
Returns:
  • {boolean} - Passed individual is ancestor of Self individual
Examples:
new Indi(<gedcom>, <instance>).isAncestor(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isAncestor(new Indi(<gedcom>, <instance>), 2);
new Indi(<gedcom>, <instance>).isAncestor(new Indi(<gedcom>, <instance>), new Object({from: 2, to: 3}));

isAunt( [level] ) → {boolean}

Checks an individual is aunt of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
level Number <optional>
 Generation level from Indi, by 1 returns aunts, by 2 returns great aunts etc
Returns:
  • {boolean} - Passed individual is aunt of Self individual
Examples:
new Indi(<gedcom>, <instance>).isAunt(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isAunt(new Indi(<gedcom>, <instance>), 1);

isBiologicalChild( ) → {boolean}

Checks an individual is biological child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is biological child of Self individual
Example:
new Indi(<gedcom>, <instance>).isBiologicalChild(new Indi(<gedcom>, <instance>));

isBiologicalDaughter( ) → {boolean}

Checks an individual is biological daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is biological daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isBiologicalDaughter(new Indi(<gedcom>, <instance>));

isBiologicalFather( ) → {boolean}

Checks an individual is biological father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is biological father of Self individual
Example:
new Indi(<gedcom>, <instance>).isBiologicalFather(new Indi(<gedcom>, <instance>));

isBiologicalMother( ) → {boolean}

Checks an individual is biological mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is biological mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isBiologicalMother(new Indi(<gedcom>, <instance>));

isBiologicalParent( ) → {boolean}

Checks an individual is biological parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is biological parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isBiologicalParent(new Indi(<gedcom>, <instance>));

isBiologicalSon( ) → {boolean}

Checks an individual is biological son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is biological son of Self individual
Example:
new Indi(<gedcom>, <instance>).isBiologicalSon(new Indi(<gedcom>, <instance>));

isBrother( ) → {boolean}

Checks an individual is brother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is brother of Self individual
Example:
new Indi(<gedcom>, <instance>).isBrother(new Indi(<gedcom>, <instance>));

isBrotherInLaw( ) → {boolean}

Checks an individual is borther-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is borther-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isBrotherInLaw(new Indi(<gedcom>, <instance>));

isBrotherOrSisterInLaw( ) → {boolean}

Checks an individual is brother-in-law or sister-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is brother-in-law or sister-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isBrotherOrSisterInLaw(new Indi(<gedcom>, <instance>));

isChild( [type [, gender]] ) → {boolean}

Checks an individual is child of Self individual.
Parameters:
Name Type Argument Default Description
string|Number|Indi Individual or individual ID
type string <optional>
 Type of relationship
gender Types.ChildrenGender <optional>
 Types.ChildrenGender.All Gender of child
Returns:
  • {boolean} - Passed individual is child of Self individual
Examples:
new Indi(<gedcom>, <instance>).isChild(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isChild(new Indi(<gedcom>, <instance>), Types.Relationship.Biological);
new Indi(<gedcom>, <instance>).isChild(new Indi(<gedcom>, <instance>), Types.Relationship.Biological, Types.ChildrenGender.Sons);

isChildInLaw( )

Synonym of Indi#isSonOrDaughterInLaw.

isCloseRelative( ) → {boolean}

Checks an individual is close relative of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is close relative of Self individual
Example:
new Indi(<gedcom>, <instance>).isCloseRelative(new Indi(<gedcom>, <instance>));

isCommonChild( indi2 ) → {boolean}

Checks an individual is commonchild of Self individual and an other individual.
Parameters:
Name Type Description
string|Number|Indi Individual or individual ID
indi2 Indi Other individual to get common children with Self individual
Returns:
  • {boolean} - Passed individual is commonchild of Self individual and an other individual
Example:
new Indi(<gedcom>, <instance>).isCommonChild(new Indi(<gedcom>, <instance>), new Indi(<gedcom>, <instance>));

isCousin( ) → {boolean}

Checks an individual is cousin of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is cousin of Self individual
Example:
new Indi(<gedcom>, <instance>).isCousin(new Indi(<gedcom>, <instance>));

isDaughter( [type] ) → {boolean}

Checks an individual is daughter of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
type string <optional>
 Type of relationship
Returns:
  • {boolean} - Passed individual is daughter of Self individual
Examples:
new Indi(<gedcom>, <instance>).isDaughter(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isDaughter(new Indi(<gedcom>, <instance>), Types.Relationship.Biological);

isDaughterInLaw( ) → {boolean}

Checks an individual is daughter-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is daughter-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isDaughterInLaw(new Indi(<gedcom>, <instance>));

isDescendant( [level] ) → {boolean}

Checks an individual is descendant of Self individual.
Parameters:
Name Type Argument Default Description
string|Number|Indi Individual or individual ID
level Number|Object <optional>
 -1 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 -1 Get descendants from generation level.from
to Number <optional>
 level.from Get descendants until generation level.to
Returns:
  • {boolean} - Passed individual is descendant of Self individual
Examples:
new Indi(<gedcom>, <instance>).isDescendant(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isDescendant(new Indi(<gedcom>, <instance>), 2);
new Indi(<gedcom>, <instance>).isDescendant(new Indi(<gedcom>, <instance>), new Object({from: -2, to: -3}));

isFamilyMember( family ) → {boolean}

Checks Self individual is in the passed family.
Parameters:
Name Type Description
family string|Number|Fam Family or family ID
Returns:
  • {boolean} - Self individual is member of passed family or not
Examples:
new Indi(<gedcom>, <instance>).isFamilyMember(<familyID>);
new Indi(<gedcom>, <instance>).isFamilyMember(new Fam(<gedcom>, <instance>));

isFather( [type] ) → {boolean}

Checks an individual is father of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {boolean} - Passed individual is father of Self individual
Examples:
new Indi(<gedcom>, <instance>).isFather(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isFather(new Indi(<gedcom>, <instance>), Types.Relationship.Biological);

isFatherInLaw( ) → {boolean}

Checks an individual is father-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is father-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isFatherInLaw(new Indi(<gedcom>, <instance>));

isFatherOrMotherInLaw( ) → {boolean}

Checks an individual is father-in-law or mother-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is father-in-law or mother-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isFatherOrMotherInLaw(new Indi(<gedcom>, <instance>));

isFosterChild( ) → {boolean}

Checks an individual is foster child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is foster child of Self individual
Example:
new Indi(<gedcom>, <instance>).isFosterChild(new Indi(<gedcom>, <instance>));

isFosterDaughter( ) → {boolean}

Checks an individual is foster daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is foster daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isFosterDaughter(new Indi(<gedcom>, <instance>));

isFosterFather( ) → {boolean}

Checks an individual is foster father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is foster father of Self individual
Example:
new Indi(<gedcom>, <instance>).isFosterFather(new Indi(<gedcom>, <instance>));

isFosterMother( ) → {boolean}

Checks an individual is foster mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is foster mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isFosterMother(new Indi(<gedcom>, <instance>));

isFosterParent( ) → {boolean}

Checks an individual is foster parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is foster parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isFosterParent(new Indi(<gedcom>, <instance>));

isFosterSon( ) → {boolean}

Checks an individual is foster son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is foster son of Self individual
Example:
new Indi(<gedcom>, <instance>).isFosterSon(new Indi(<gedcom>, <instance>));

isFullBrother( ) → {boolean}

Checks an individual is fullbrother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is fullbrother of Self individual
Example:
new Indi(<gedcom>, <instance>).isFullBrother(new Indi(<gedcom>, <instance>));

isFullSibling( ) → {boolean}

Checks an individual is fullsibling of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is fullsibling of Self individual
Example:
new Indi(<gedcom>, <instance>).isFullSibling(new Indi(<gedcom>, <instance>));

isFullSister( ) → {boolean}

Checks an individual is fullsister of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is fullsister of Self individual
Example:
new Indi(<gedcom>, <instance>).isFullSister(new Indi(<gedcom>, <instance>));

isGrandChild( ) → {boolean}

Checks an individual is grandchild of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is grandchild of Self individual
Example:
new Indi(<gedcom>, <instance>).isGrandChild(new Indi(<gedcom>, <instance>));

isGrandDaughter( ) → {boolean}

Checks an individual is granddaughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is granddaughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isGrandDaughter(new Indi(<gedcom>, <instance>));

isGrandFather( ) → {boolean}

Checks an individual is grandfather of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is grandfather of Self individual
Example:
new Indi(<gedcom>, <instance>).isGrandFather(new Indi(<gedcom>, <instance>));

isGrandMother( ) → {boolean}

Checks an individual is grandmother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is grandmother of Self individual
Example:
new Indi(<gedcom>, <instance>).isGrandMother(new Indi(<gedcom>, <instance>));

isGrandParent( ) → {boolean}

Checks an individual is grandparent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is grandparent of Self individual
Example:
new Indi(<gedcom>, <instance>).isGrandParent(new Indi(<gedcom>, <instance>));

isGrandSon( ) → {boolean}

Checks an individual is grandson of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is grandson of Self individual
Example:
new Indi(<gedcom>, <instance>).isGrandSon(new Indi(<gedcom>, <instance>));

isGreatGrandChild( ) → {boolean}

Checks an individual is greatgrandchild of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is greatgrandchild of Self individual
Example:
new Indi(<gedcom>, <instance>).isGreatGrandChild(new Indi(<gedcom>, <instance>));

isGreatGrandDaughter( ) → {boolean}

Checks an individual is greatgranddaughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is greatgranddaughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isGreatGrandDaughter(new Indi(<gedcom>, <instance>));

isGreatGrandFather( ) → {boolean}

Checks an individual is greatgrandfather of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is greatgrandfather of Self individual
Example:
new Indi(<gedcom>, <instance>).isGreatGrandFather(new Indi(<gedcom>, <instance>));

isGreatGrandMother( ) → {boolean}

Checks an individual is greatgrandmother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is greatgrandmother of Self individual
Example:
new Indi(<gedcom>, <instance>).isGreatGrandMother(new Indi(<gedcom>, <instance>));

isGreatGrandParent( ) → {boolean}

Checks an individual is greatgrandparent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is greatgrandparent of Self individual
Example:
new Indi(<gedcom>, <instance>).isGreatGrandParent(new Indi(<gedcom>, <instance>));

isGreatGrandSon( ) → {boolean}

Checks an individual is greatgrandson of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is greatgrandson of Self individual
Example:
new Indi(<gedcom>, <instance>).isGreatGrandSon(new Indi(<gedcom>, <instance>));

isGuardianChild( ) → {boolean}

Checks an individual is guardian child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is guardian child of Self individual
Example:
new Indi(<gedcom>, <instance>).isGuardianChild(new Indi(<gedcom>, <instance>));

isGuardianDaughter( ) → {boolean}

Checks an individual is guardian daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is guardian daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isGuardianDaughter(new Indi(<gedcom>, <instance>));

isGuardianFather( ) → {boolean}

Checks an individual is guardian father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is guardian father of Self individual
Example:
new Indi(<gedcom>, <instance>).isGuardianFather(new Indi(<gedcom>, <instance>));

isGuardianMother( ) → {boolean}

Checks an individual is guardian mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is guardian mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isGuardianMother(new Indi(<gedcom>, <instance>));

isGuardianParent( ) → {boolean}

Checks an individual is guardian parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is guardian parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isGuardianParent(new Indi(<gedcom>, <instance>));

isGuardianSon( ) → {boolean}

Checks an individual is guardian son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is guardian son of Self individual
Example:
new Indi(<gedcom>, <instance>).isGuardianSon(new Indi(<gedcom>, <instance>));

isHalfBrother( ) → {boolean}

Checks an individual is halfbrother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is halfbrother of Self individual
Example:
new Indi(<gedcom>, <instance>).isHalfBrother(new Indi(<gedcom>, <instance>));

isHalfSibling( ) → {boolean}

Checks an individual is halfsibling of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is halfsibling of Self individual
Example:
new Indi(<gedcom>, <instance>).isHalfSibling(new Indi(<gedcom>, <instance>));

isHalfSister( ) → {boolean}

Checks an individual is halfsister of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is halfsister of Self individual
Example:
new Indi(<gedcom>, <instance>).isHalfSister(new Indi(<gedcom>, <instance>));

isIllegitimateChild( ) → {boolean}

Checks an individual is illegitimate child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is illegitimate child of Self individual
Example:
new Indi(<gedcom>, <instance>).isIllegitimateChild(new Indi(<gedcom>, <instance>));

isIllegitimateDaughter( ) → {boolean}

Checks an individual is illegitimate daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is illegitimate daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isIllegitimateDaughter(new Indi(<gedcom>, <instance>));

isIllegitimateFather( ) → {boolean}

Checks an individual is illegitimate father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is illegitimate father of Self individual
Example:
new Indi(<gedcom>, <instance>).isIllegitimateFather(new Indi(<gedcom>, <instance>));

isIllegitimateMother( ) → {boolean}

Checks an individual is illegitimate mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is illegitimate mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isIllegitimateMother(new Indi(<gedcom>, <instance>));

isIllegitimateParent( ) → {boolean}

Checks an individual is illegitimate parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is illegitimate parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isIllegitimateParent(new Indi(<gedcom>, <instance>));

isIllegitimateSon( ) → {boolean}

Checks an individual is illegitimate son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is illegitimate son of Self individual
Example:
new Indi(<gedcom>, <instance>).isIllegitimateSon(new Indi(<gedcom>, <instance>));

isMother( [type] ) → {boolean}

Checks an individual is mother of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {boolean} - Passed individual is mother of Self individual
Examples:
new Indi(<gedcom>, <instance>).isMother(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isMother(new Indi(<gedcom>, <instance>), Types.Relationship.Biological);

isMotherInLaw( ) → {boolean}

Checks an individual is mother-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is mother-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isMotherInLaw(new Indi(<gedcom>, <instance>));

isNaturalChild( ) → {boolean}

Checks an individual is natural child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is natural child of Self individual
Example:
new Indi(<gedcom>, <instance>).isNaturalChild(new Indi(<gedcom>, <instance>));

isNaturalDaughter( ) → {boolean}

Checks an individual is natural daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is natural daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isNaturalDaughter(new Indi(<gedcom>, <instance>));

isNaturalFather( ) → {boolean}

Checks an individual is natural father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is natural father of Self individual
Example:
new Indi(<gedcom>, <instance>).isNaturalFather(new Indi(<gedcom>, <instance>));

isNaturalMother( ) → {boolean}

Checks an individual is natural mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is natural mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isNaturalMother(new Indi(<gedcom>, <instance>));

isNaturalParent( ) → {boolean}

Checks an individual is natural parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is natural parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isNaturalParent(new Indi(<gedcom>, <instance>));

isNaturalSon( ) → {boolean}

Checks an individual is natural son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is natural son of Self individual
Example:
new Indi(<gedcom>, <instance>).isNaturalSon(new Indi(<gedcom>, <instance>));

isNephew( [level] ) → {boolean}

Checks an individual is nephew of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
level Number <optional>
 Generation level from Indi, by 1 returns nephews, by 2 returns great nephews etc
Returns:
  • {boolean} - Passed individual is nephew of Self individual
Examples:
new Indi(<gedcom>, <instance>).isNephew(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isNephew(new Indi(<gedcom>, <instance>), 1);

isNephewOrNiece( [level] ) → {boolean}

Checks an individual is nephew or niece of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
level Number <optional>
 Generation level from Indi, by 1 returns newphews and nieces, by 2 returns grand nephews and nieces etc
Returns:
  • {boolean} - Passed individual is nephew or niece of Self individual
Examples:
new Indi(<gedcom>, <instance>).isNephewOrNiece(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isNephewOrNiece(new Indi(<gedcom>, <instance>), 1);

isNiece( [level] ) → {boolean}

Checks an individual is niece of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
level Number <optional>
 Generation level from Indi, by 1 returns nieces, by 2 returns great nieces etc
Returns:
  • {boolean} - Passed individual is niece of Self individual
Examples:
new Indi(<gedcom>, <instance>).isNiece(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isNiece(new Indi(<gedcom>, <instance>), 1);

isParent( [type] ) → {boolean}

Checks an individual is parent of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
type Types.Relationship <optional>
 Type of relationship
Returns:
  • {boolean} - Passed individual is parent of Self individual
Examples:
new Indi(<gedcom>, <instance>).isParent(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isParent(new Indi(<gedcom>, <instance>), Types.Relationship.Biological);

isParentInLaw( )

Synonym of Indi#isFatherOrMotherInLaw.

isParentOfChildren( ) → {boolean}

Checks an individual is parents of children of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is parents of children of Self individual
Example:
new Indi(<gedcom>, <instance>).isParentOfChildren(new Indi(<gedcom>, <instance>));

isRelatedChild( ) → {boolean}

Checks an individual is related child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is related child of Self individual
Example:
new Indi(<gedcom>, <instance>).isRelatedChild(new Indi(<gedcom>, <instance>));

isRelatedDaughter( ) → {boolean}

Checks an individual is related daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is related daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isRelatedDaughter(new Indi(<gedcom>, <instance>));

isRelatedFather( ) → {boolean}

Checks an individual is related father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is related father of Self individual
Example:
new Indi(<gedcom>, <instance>).isRelatedFather(new Indi(<gedcom>, <instance>));

isRelatedMother( ) → {boolean}

Checks an individual is related mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is related mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isRelatedMother(new Indi(<gedcom>, <instance>));

isRelatedParent( ) → {boolean}

Checks an individual is related parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is related parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isRelatedParent(new Indi(<gedcom>, <instance>));

isRelatedSon( ) → {boolean}

Checks an individual is related son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is related son of Self individual
Example:
new Indi(<gedcom>, <instance>).isRelatedSon(new Indi(<gedcom>, <instance>));

(private) isRelative( [level [, degree]] ) → {boolean}

Checks an individual is relative of Self individual. .
Parameters:
Name Type Argument Default Description
string|Number|Indi Individual or individual ID
level Number|Object <optional>
 0 Generation level from Indi
Properties
Name Type Argument Default Description
from Number <optional>
 0 Get descendants from generation level.from
to Number <optional>
 level.from Get descendants until generation level.to
degree Number <optional>
 0 Degree in family
Returns:
  • {boolean} - Passed individual is relative of Self individual
Examples:
new Indi(<gedcom>, <instance>).isRelative(new Indi(<gedcom>, <instance>), 0, 0);
new Indi(<gedcom>, <instance>).isRelative(new Indi(<gedcom>, <instance>), 1, 0);
new Indi(<gedcom>, <instance>).isRelative(new Indi(<gedcom>, <instance>), 0, 2);
new Indi(<gedcom>, <instance>).isRelative(new Indi(<gedcom>, <instance>), -2, 0);
new Indi(<gedcom>, <instance>).isRelative(new Indi(<gedcom>, <instance>), {from: -1, to: 1}, 0);

isRelativesSelectorMethods( method ) → {Array.<string>}

Checks a method is a relatives selector method.
Parameters:
Name Type Description
method string|function Checked method name
Returns:
  • {Array.<string>} - Selector

isSibling( [type [, gender]] ) → {boolean}

Checks an individual is sibling of Self individual.
Parameters:
Name Type Argument Default Description
string|Number|Indi Individual or individual ID
type Types.SiblingsType <optional>
 Types.SiblingsType.All Type of siblings
gender Types.SiblingsGender <optional>
 Types.SiblingsGender.All Gender of siblings
Returns:
  • {boolean} - Passed individual is sibling of Self individual
Examples:
new Indi(<gedcom>, <instance>).isSibling(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isSibling(new Indi(<gedcom>, <instance>), Types.SiblingsType.Full);
new Indi(<gedcom>, <instance>).isSibling(new Indi(<gedcom>, <instance>), undefined, Types.SiblingsGender.Sisters);
new Indi(<gedcom>, <instance>).isSibling(new Indi(<gedcom>, <instance>), Types.SiblingsType.Half, Types.SiblingsGender.Brothers);

isSiblingInLaw( )

Synonym of Indi#isBrotherOrSisterInLaw.

isSister( ) → {boolean}

Checks an individual is sister of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is sister of Self individual
Example:
new Indi(<gedcom>, <instance>).isSister(new Indi(<gedcom>, <instance>));

isSisterInLaw( ) → {boolean}

Checks an individual is sister-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is sister-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isSisterInLaw(new Indi(<gedcom>, <instance>));

isSon( [type] ) → {boolean}

Checks an individual is son of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
type string <optional>
 Type of relationship
Returns:
  • {boolean} - Passed individual is son of Self individual
Examples:
new Indi(<gedcom>, <instance>).isSon(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isSon(new Indi(<gedcom>, <instance>), Types.Relationship.Biological);

isSonInLaw( ) → {boolean}

Checks an individual is son-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is son-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isSonInLaw(new Indi(<gedcom>, <instance>));

isSonOrDaughterInLaw( ) → {boolean}

Checks an individual is son-in-law or daughter-in-law of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is son-in-law or daughter-in-law of Self individual
Example:
new Indi(<gedcom>, <instance>).isSonOrDaughterInLaw(new Indi(<gedcom>, <instance>));

isSpouse( ) → {boolean}

Checks an individual is spouse of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is spouse of Self individual
Example:
new Indi(<gedcom>, <instance>).isSpouse(new Indi(<gedcom>, <instance>));

isSpouseWithChildren( ) → {boolean}

Checks an individual is spouse of Self individual who has children.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is spouse of Self individual who has children
Example:
new Indi(<gedcom>, <instance>).isSpouseWithChildren(new Indi(<gedcom>, <instance>));

isSpouseWithoutChildren( ) → {boolean}

Checks an individual is spouse of Self individual who does not have children
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is spouse of Self individual who does not have children
Example:
new Indi(<gedcom>, <instance>).isSpouseWithoutChildren(new Indi(<gedcom>, <instance>));

isStepChild( ) → {boolean}

Checks an individual is step child of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is step child of Self individual
Example:
new Indi(<gedcom>, <instance>).isStepChild(new Indi(<gedcom>, <instance>));

isStepDaughter( ) → {boolean}

Checks an individual is step daughter of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is step daughter of Self individual
Example:
new Indi(<gedcom>, <instance>).isStepDaughter(new Indi(<gedcom>, <instance>));

isStepFather( ) → {boolean}

Checks an individual is step father of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is step father of Self individual
Example:
new Indi(<gedcom>, <instance>).isStepFather(new Indi(<gedcom>, <instance>));

isStepMother( ) → {boolean}

Checks an individual is step mother of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is step mother of Self individual
Example:
new Indi(<gedcom>, <instance>).isStepMother(new Indi(<gedcom>, <instance>));

isStepParent( ) → {boolean}

Checks an individual is step parent of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is step parent of Self individual
Example:
new Indi(<gedcom>, <instance>).isStepParent(new Indi(<gedcom>, <instance>));

isStepSon( ) → {boolean}

Checks an individual is step son of Self individual.
Parameters:
Type Description
string|Number|Indi Individual or individual ID
Returns:
  • {boolean} - Passed individual is step son of Self individual
Example:
new Indi(<gedcom>, <instance>).isStepSon(new Indi(<gedcom>, <instance>));

isUncle( [level] ) → {boolean}

Checks an individual is uncle of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
level Number <optional>
 Generation level from Indi, by 1 returns uncles, by 2 returns great uncles etc
Returns:
  • {boolean} - Passed individual is uncle of Self individual
Examples:
new Indi(<gedcom>, <instance>).isUncle(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isUncle(new Indi(<gedcom>, <instance>), 1);

isUncleOrAunt( [level] ) → {boolean}

Checks an individual is uncle or aunt of Self individual.
Parameters:
Name Type Argument Description
string|Number|Indi Individual or individual ID
level Number <optional>
 Generation level from Indi, by 1 returns uncles and aunts, by 2 returns great uncles and aunts etc
Returns:
  • {boolean} - Passed individual is uncle or aunt of Self individual
Examples:
new Indi(<gedcom>, <instance>).isUncleOrAunt(new Indi(<gedcom>, <instance>));
new Indi(<gedcom>, <instance>).isUncleOrAunt(new Indi(<gedcom>, <instance>), 1);

remove( keys [, value [, index]] )

Removes a Data property.
Parameters:
Name Type Argument Description
keys array Keypath of the property
value mixed <optional>
 Removed if property values matched passed valu
index mixed <optional>
 Removed if property values index matched passed index
Inherited From:
Examples:
new Data(<gedcom>, <instance>).remove(['NAME', 'FIRST']);
new Data(<gedcom>, <instance>).remove(['NAME', 'FIRST'], 'Kevin');
new Data(<gedcom>, <instance>).remove(['NAME', 'FIRST'], undefined, 1);

removeFromFamily( family ) → {Indi}

Add Self individual to a family.
Parameters:
Name Type Description
family string|Number|Fam Family or family ID
Returns:
  • {Indi} - Self individual
Example:
new Indi(<gedcom>, <instance>).removeFromFamily(<family>);

(private) removeProp( obj , keys [, value [, index]] )

Removes a passed Data property.
Parameters:
Name Type Argument Description
obj Data Passed Data
keys array Keypath of the property
value mixed <optional>
 Removed if property values matched passed value
index mixed <optional>
 Removed if property values index matched passed index
Inherited From:
Examples:
new Data(<gedcom>, <instance>).remove(new Data(<gedcom>, <instance>), ['NAME', 'FIRST']);
new Data(<gedcom>, <instance>).remove(new Data(<gedcom>, <instance>), ['NAME', 'FIRST'], 'Kevin');
new Data(<gedcom>, <instance>).remove(new Data(<gedcom>, <instance>), ['NAME', 'FIRST'], undefined, 1);

(private) runCallback( obj , keys [, value [, keyPath]] ) → {mixed}

Runs callbacks after a property has been set.
Parameters:
Name Type Argument Description
obj Data Passed Data
keys array Keypath of the property
value mixed <optional>
 Data value
keyPath KeyPath <optional>
 Keypath of the property
Inherited From:
Returns:
  • {mixed} - Callback return value
Example:
new Data(<gedcom>, <instance>).runCallback(<referenced Data>, ['NAME', 'FIRST']);

set( keys [, value [, override]] ) → {Data}

Set a Data property.
Parameters:
Name Type Argument Description
keys array Keypath of the property
value mixed <optional>
 New Data value
override boolean <optional>
 When true, the existing value will be overridden
Inherited From:
Returns:
  • {Data} - Set property
Examples:
new Data(<gedcom>, <instance>).set(['NAME', 'FIRST'], 'Brian');
new Data(<gedcom>, <instance>).set(['NAME', 'FIRST'], 'Brian', true);

(private) setCache( args , value ) → {IndiList}

Set cached relatives to Self individual cache property
Parameters:
Name Type Description
args Arguments Arguments of caller method
value IndiList Relatives as IndiList
Returns:

(private) setCaller( instance ) → {Data}

Set the Data caller instance.
Parameters:
Name Type Description
instance mixed Data caller instance
Inherited From:
Returns:
  • {Data} - Self instance
Example:
new Data(<gedcom>, <instance>).setCaller(<instance>);

(private) setGeneration( type , obj , keyData )

Set Self individual generation
Parameters:
Name Type Description
type Types.FamilyType Family type
obj Indi Referenced Indi
keyData Object
Properties
Name Type Description
keys Array Keys of property
keyPath string Keypath of property
mixed Value of property

setId( id ) → {Data}

Set Data ID.
Parameters:
Name Type Description
id string|Number New Data ID
Inherited From:
Returns:
  • {Data} - Self instance
Example:
new Data(<gedcom>, <instance>).setId(<ID>);

(private) setLocalStorage( args , value ) → {IndiList}

Set cached relatives to LocalStorage if available
Parameters:
Name Type Description
args Arguments Arguments of caller method
value IndiList Relatives as IndiList
Returns:

(private) setProp( obj , keys [, value [, override]] ) → {Data}

Set a passed Data property.
Parameters:
Name Type Argument Description
obj Data Passed Data
keys array Keypath of the property
value mixed <optional>
 New passed Data value
override boolean <optional>
 When true, the existing value will be overridden
Inherited From:
Returns:
  • {Data} - Set property of passed Data
Examples:
new Data(<gedcom>, <instance>).set(new Data(<gedcom>, <instance>), ['NAME', 'FIRST'], 'Brian');
new Data(<gedcom>, <instance>).set(new Data(<gedcom>, <instance>), ['NAME', 'FIRST'], 'Brian', true);

setValue( value [, override] ) → {mixed}

Set Data value.
Parameters:
Name Type Argument Description
value mixed New Data value
override boolean <optional>
 When true, the existing value will be overridden
Inherited From:
Returns:
  • {mixed} - Self instance
Examples:
new Data(<gedcom>, <instance>).setValue(<value>);
new Data(<gedcom>, <instance>).setValue(<value>, true);

toDate( ) → {Date|NaN}

Converts Data to Date.
Inherited From:
Returns:
  • {Date|NaN} - Data value as Date or NaN
Example:
new Data(<gedcom>, <instance>).toDate();

toGedCom( [indention [, suffix [, index]]] ) → {string}

Converts Data to GEDCOM structure string.
Parameters:
Name Type Argument Default Description
indention Number <optional>
 0 Line indention
suffix string|Number <optional>
 Line suffix
index Number <optional>
 Value index when value is an array
Inherited From:
Returns:
  • {string} - GEDCOM structure string
Examples:
new Data(<gedcom>, <instance>).toGedCom();
new Data(<gedcom>, <instance>).toGedCom(1, <suffix>);

toObject( ) → {Object}

Converts Data to a specific pritimive Object.
Inherited From:
Returns:
  • {Object} - Converted Data
Example:
new Data(<gedcom>, <instance>).toObject();

toString( returnMethod ) → {string}

Converts Data to string.
Parameters:
Name Type Description
returnMethod string Custom convert method to get Data value as string
Inherited From:
Returns:
  • {string} - Data value or type of Data if value is undefined
Examples:
new Data(<gedcom>, <instance>).toString();
new Data(<gedcom>, <instance>).toString('getId');