Individual - Documentation

Individual

new Individual(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 43

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Extends

jspb.Message

Members

(static) displayName

Source:

phenopackets/schema/v2/core/individual_pb.js, line 52

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 81

List of repeated fields within this message type.

Methods

addAlternateIds(value, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 341

Parameters:

Name	Type	Attributes	Description
`value`	string
`opt_index`	number	<optional>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

clearAlternateIdsList() → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 350

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

clearDateOfBirth() → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 378

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

clearGender() → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 525

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

clearTaxonomy() → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 562

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

clearTimeAtLastEncounter() → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 415

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

clearVitalStatus() → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 452

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

getAlternateIdsList() → (non-null) {Array.<string>}

Description:

repeated string alternate_ids = 2;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 322

Returns:

Type: Array.<string>

getDateOfBirth() → (nullable) {proto.google.protobuf.Timestamp}

Description:

optional google.protobuf.Timestamp date_of_birth = 3;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 359

Returns:

Type: proto.google.protobuf.Timestamp

getGender() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}

Description:

optional OntologyClass gender = 8;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 506

Returns:

Type: proto.org.phenopackets.schema.v2.core.OntologyClass

getId() → {string}

Description:

optional string id = 1;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 304

Returns:

Type: string

getKaryotypicSex() → (non-null) {proto.org.phenopackets.schema.v2.core.KaryotypicSex}

Description:

optional KaryotypicSex karyotypic_sex = 7;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 488

Returns:

Type: proto.org.phenopackets.schema.v2.core.KaryotypicSex

getSex() → (non-null) {proto.org.phenopackets.schema.v2.core.Sex}

Description:

optional Sex sex = 6;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 470

Returns:

Type: proto.org.phenopackets.schema.v2.core.Sex

getTaxonomy() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}

Description:

optional OntologyClass taxonomy = 9;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 543

Returns:

Type: proto.org.phenopackets.schema.v2.core.OntologyClass

getTimeAtLastEncounter() → (nullable) {proto.org.phenopackets.schema.v2.core.TimeElement}

Description:

optional TimeElement time_at_last_encounter = 4;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 396

Returns:

Type: proto.org.phenopackets.schema.v2.core.TimeElement

getVitalStatus() → (nullable) {proto.org.phenopackets.schema.v2.core.VitalStatus}

Description:

optional VitalStatus vital_status = 5;

Source:

phenopackets/schema/v2/core/individual_pb.js, line 433

Returns:

Type: proto.org.phenopackets.schema.v2.core.VitalStatus

hasDateOfBirth() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 387

Returns:

Type: boolean

hasGender() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 534

Returns:

Type: boolean

hasTaxonomy() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 571

Returns:

Type: boolean

hasTimeAtLastEncounter() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 424

Returns:

Type: boolean

hasVitalStatus() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 461

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Description:

Serializes the message to binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/core/individual_pb.js, line 213

Returns:

Type: Uint8Array

setAlternateIdsList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 331

Parameters:

Name	Type	Description
`value`	Array.<string>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setDateOfBirth(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 369

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Timestamp \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setGender(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 516

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.OntologyClass \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setId(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 313

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setKaryotypicSex(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 497

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.KaryotypicSex

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setSex(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 479

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.Sex

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setTaxonomy(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 553

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.OntologyClass \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setTimeAtLastEncounter(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 406

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.TimeElement \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

setVitalStatus(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Source:

phenopackets/schema/v2/core/individual_pb.js, line 443

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.VitalStatus \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Individual

toObject(opt_includeInstanceopt) → (non-null) {Object}

Description:

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 98

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/core/individual_pb.js, line 138

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Returns:

Type: proto.org.phenopackets.schema.v2.core.Individual

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 152

Parameters:

Name	Type	Description
`msg`	proto.org.phenopackets.schema.v2.core.Individual	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Returns:

Type: proto.org.phenopackets.schema.v2.core.Individual

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Description:

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 227

Parameters:

Name	Type	Description
`message`	proto.org.phenopackets.schema.v2.core.Individual
`writer`	jspb.BinaryWriter

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v2/core/individual_pb.js, line 112

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.org.phenopackets.schema.v2.core.Individual	The msg instance to transform.

Returns:

Type: Object