Functions (by category)

Fact Functions

A fact is an event (such as Birth) or an attribute (such as Occupation). Facts can be Individual facts, in which case they are 'owned' by one individual only, or Family facts in which case they are said to be 'owned' by the parents of the family.

 

Function Short Description
FactAbbrev Returns the abbreviated form for the label of a given fact.
FactLabel Returns the label for a given fact.
FactName Returns the official name of a given fact.
FactOwner Returns the owner (an Individual record) of a given fact. Family facts can have 2 owners - the husband and wife.
FactSentence Returns a narrative sentence describing the fact (usually mentioning date and place, if known).
FactSet Returns the name of the fact set that a given fact belongs to.
FactText Returns formatted text describing the fact (event or attribute).
FactValue Returns the value for a given fact. Only attributes have values. This funtion always returns NULL for events.
GetFact Returns a fact of a specified type (and, optionally, instance or year) for a given person - if there is one. The person may be a principal or a witness with respect to the fact in question.
GetRole Behaves exactly like the GetFact function, except that instead of returning the fact, this function returns the person's role with respect to the fact if they are listed as a witness for the fact in question, with a defined role.
IsAttribute Returns TRUE if a data item represents an Attribute.
IsEvent Returns TRUE if a data item represents an Event.
IsFact Returns TRUE if a data item represents an Fact.
IsFamilyFact Returns TRUE if a data item is a Family Fact.
IsIndividualFact Returns TRUE if a data item is an Individual Fact.
TimelineFactAge Returns a textual representation of a person's age at the time of a given timeline fact.
TimelineFactOrder Returns a number giving the position, in order, of a given timeline fact for a given person.
TimelineFactText Returns a description of a given timeline fact, from the perspective of a given person.
Witness Returns a witness for a given fact, identified by role.