Phenopacket

new Phenopacket(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 57

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/phenopackets_pb.js, line 66

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 116

List of repeated fields within this message type.

Methods

addBiosamples(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 517

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.Biosample	<optional>
`opt_index`	number	<optional>

Returns:

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

addDiseases(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 593

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.Disease	<optional>
`opt_index`	number	<optional>

Returns:

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

addFiles(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.File}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 669

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.File	<optional>
`opt_index`	number	<optional>

Returns:

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

addInterpretations(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Interpretation}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 555

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.Interpretation	<optional>
`opt_index`	number	<optional>

Returns:

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

addMeasurements(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Measurement}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 479

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.Measurement	<optional>
`opt_index`	number	<optional>

Returns:

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

addMedicalActions(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.MedicalAction}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 631

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.MedicalAction	<optional>
`opt_index`	number	<optional>

Returns:

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

addPhenotypicFeatures(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.PhenotypicFeature}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 441

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.PhenotypicFeature	<optional>
`opt_index`	number	<optional>

Returns:

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

clearBiosamplesList() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 526

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearDiseasesList() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 602

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearFilesList() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 678

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearInterpretationsList() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 564

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearMeasurementsList() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 488

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearMedicalActionsList() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 640

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearMetaData() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 706

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearPhenotypicFeaturesList() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 450

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

clearSubject() → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 403

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

getBiosamplesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.Biosample>}

Description:

repeated core.Biosample biosamples = 5;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 497

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.Biosample>

getDiseasesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.Disease>}

Description:

repeated core.Disease diseases = 7;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 573

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.Disease>

getFilesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.File>}

Description:

repeated core.File files = 10;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 649

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.File>

getId() → {string}

Description:

optional string id = 1;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 366

Returns:

Type: string

getInterpretationsList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.Interpretation>}

Description:

repeated core.Interpretation interpretations = 6;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 535

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.Interpretation>

getMeasurementsList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.Measurement>}

Description:

repeated core.Measurement measurements = 4;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 459

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.Measurement>

getMedicalActionsList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.MedicalAction>}

Description:

repeated core.MedicalAction medical_actions = 9;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 611

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.MedicalAction>

getMetaData() → (nullable) {proto.org.phenopackets.schema.v2.core.MetaData}

Description:

optional core.MetaData meta_data = 11;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 687

Returns:

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

getPhenotypicFeaturesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.PhenotypicFeature>}

Description:

repeated core.PhenotypicFeature phenotypic_features = 3;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 421

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.PhenotypicFeature>

getSubject() → (nullable) {proto.org.phenopackets.schema.v2.core.Individual}

Description:

optional core.Individual subject = 2;

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 384

Returns:

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

hasMetaData() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 715

Returns:

Type: boolean

hasSubject() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 412

Returns:

Type: boolean

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

Description:

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

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 264

Returns:

Type: Uint8Array

setBiosamplesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 507

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.Biosample>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setDiseasesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 583

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.Disease>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setFilesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 659

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.File>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

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

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 375

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setInterpretationsList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 545

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.Interpretation>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setMeasurementsList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 469

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.Measurement>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setMedicalActionsList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 621

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.MedicalAction>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setMetaData(value) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 697

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setPhenotypicFeaturesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 431

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.PhenotypicFeature>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

setSubject(value) → (non-null) {proto.org.phenopackets.schema.v2.Phenopacket}

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 394

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.Phenopacket

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/phenopackets_pb.js, line 133

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.Phenopacket}

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 181

Parameters:

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

Returns:

Type: proto.org.phenopackets.schema.v2.Phenopacket

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

Description:

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

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 195

Parameters:

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

Returns:

Type: proto.org.phenopackets.schema.v2.Phenopacket

(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/phenopackets_pb.js, line 278

Parameters:

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

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

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v2/phenopackets_pb.js, line 147

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.Phenopacket	The msg instance to transform.

Returns:

Type: Object