Individual - Documentation

Individual

new Individual(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v1/base_pb.js, line 214

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) AgeCase :number

Source:

phenopackets/schema/v1/base_pb.js, line 2515

Properties:

Name	Type	Description
`AGE_NOT_SET`	number
`AGE_AT_COLLECTION`	number
`AGE_RANGE_AT_COLLECTION`	number

Type:

number

(static) displayName

Source:

phenopackets/schema/v1/base_pb.js, line 223

(private, static, constant) oneofGroups_

Description:

Oneof group definitions for this message. Each group defines the field numbers belonging to that group. When of these fields' value is set, all other fields in the group are cleared. During deserialization, if multiple fields are encountered for a group, only the last value seen will be kept.

Source:

phenopackets/schema/v1/base_pb.js, line 2510

Oneof group definitions for this message. Each group defines the field numbers belonging to that group. When of these fields' value is set, all other fields in the group are cleared. During deserialization, if multiple fields are encountered for a group, only the last value seen will be kept.

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v1/base_pb.js, line 2500

List of repeated fields within this message type.

Methods

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

Source:

phenopackets/schema/v1/base_pb.js, line 2772

Parameters:

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

Returns:

returns this

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

clearAgeAtCollection() → (non-null) {proto.org.phenopackets.schema.v1.core.Individual}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/base_pb.js, line 2846

Returns:

returns this

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

clearAgeRangeAtCollection() → (non-null) {proto.org.phenopackets.schema.v1.core.Individual}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/base_pb.js, line 2883

Returns:

returns this

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

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

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/base_pb.js, line 2781

Returns:

returns this

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

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

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/base_pb.js, line 2809

Returns:

returns this

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

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

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/base_pb.js, line 2956

Returns:

returns this

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

getAgeAtCollection() → (nullable) {proto.org.phenopackets.schema.v1.core.Age}

Description:

optional Age age_at_collection = 4;

Source:

phenopackets/schema/v1/base_pb.js, line 2827

Returns:

Type: proto.org.phenopackets.schema.v1.core.Age

getAgeCase() → {proto.org.phenopackets.schema.v1.core.Individual.AgeCase}

Source:

phenopackets/schema/v1/base_pb.js, line 2524

Returns:

Type: proto.org.phenopackets.schema.v1.core.Individual.AgeCase

getAgeRangeAtCollection() → (nullable) {proto.org.phenopackets.schema.v1.core.AgeRange}

Description:

optional AgeRange age_range_at_collection = 5;

Source:

phenopackets/schema/v1/base_pb.js, line 2864

Returns:

Type: proto.org.phenopackets.schema.v1.core.AgeRange

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

Description:

repeated string alternate_ids = 2;

Source:

phenopackets/schema/v1/base_pb.js, line 2753

Returns:

Type: Array.<string>

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

Description:

optional google.protobuf.Timestamp date_of_birth = 3;

Source:

phenopackets/schema/v1/base_pb.js, line 2790

Returns:

Type: proto.google.protobuf.Timestamp

getId() → {string}

Description:

optional string id = 1;

Source:

phenopackets/schema/v1/base_pb.js, line 2735

Returns:

Type: string

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

Description:

optional KaryotypicSex karyotypic_sex = 7;

Source:

phenopackets/schema/v1/base_pb.js, line 2919

Returns:

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

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

Description:

optional Sex sex = 6;

Source:

phenopackets/schema/v1/base_pb.js, line 2901

Returns:

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

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

Description:

optional OntologyClass taxonomy = 8;

Source:

phenopackets/schema/v1/base_pb.js, line 2937

Returns:

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

hasAgeAtCollection() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/base_pb.js, line 2855

Returns:

Type: boolean

hasAgeRangeAtCollection() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/base_pb.js, line 2892

Returns:

Type: boolean

hasDateOfBirth() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/base_pb.js, line 2818

Returns:

Type: boolean

hasTaxonomy() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/base_pb.js, line 2965

Returns:

Type: boolean

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

Description:

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

Source:

phenopackets/schema/v1/base_pb.js, line 2652

Returns:

Type: Uint8Array

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

Source:

phenopackets/schema/v1/base_pb.js, line 2837

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v1.core.Age \| undefined

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/base_pb.js, line 2874

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v1.core.AgeRange \| undefined

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/base_pb.js, line 2762

Parameters:

Name	Type	Description
`value`	Array.<string>

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/base_pb.js, line 2800

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/base_pb.js, line 2744

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/base_pb.js, line 2928

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/base_pb.js, line 2910

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/base_pb.js, line 2947

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.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/v1/base_pb.js, line 2543

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.v1.core.Individual}

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v1/base_pb.js, line 2582

Parameters:

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

Returns:

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

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

Description:

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

Source:

phenopackets/schema/v1/base_pb.js, line 2596

Parameters:

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

Returns:

Type: proto.org.phenopackets.schema.v1.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/v1/base_pb.js, line 2666

Parameters:

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

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

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v1/base_pb.js, line 2557

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.v1.core.Individual	The msg instance to transform.

Returns:

Type: Object