Phenopacket

new Phenopacket(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 39

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

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 98

List of repeated fields within this message type.

Methods

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 446

Parameters:

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

Returns:

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

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 560

Parameters:

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

Returns:

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

addGenes(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v1.core.Gene}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 484

Parameters:

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

Returns:

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

addHtsFiles(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v1.core.HtsFile}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 598

Parameters:

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

Returns:

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

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 408

Parameters:

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

Returns:

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

addVariants(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v1.core.Variant}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 522

Parameters:

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

Returns:

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

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

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 455

Returns:

returns this

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

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

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 569

Returns:

returns this

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

clearGenesList() → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 493

Returns:

returns this

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

clearHtsFilesList() → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 607

Returns:

returns this

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

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

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 635

Returns:

returns this

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

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

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 417

Returns:

returns this

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

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

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 370

Returns:

returns this

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

clearVariantsList() → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 531

Returns:

returns this

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

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

Description:

repeated core.Biosample biosamples = 4;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 426

Returns:

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

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

Description:

repeated core.Disease diseases = 7;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 540

Returns:

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

getGenesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v1.core.Gene>}

Description:

repeated core.Gene genes = 5;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 464

Returns:

Type: Array.<!proto.org.phenopackets.schema.v1.core.Gene>

getHtsFilesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v1.core.HtsFile>}

Description:

repeated core.HtsFile hts_files = 8;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 578

Returns:

Type: Array.<!proto.org.phenopackets.schema.v1.core.HtsFile>

getId() → {string}

Description:

optional string id = 1;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 333

Returns:

Type: string

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

Description:

optional core.MetaData meta_data = 9;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 616

Returns:

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

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

Description:

repeated core.PhenotypicFeature phenotypic_features = 3;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 388

Returns:

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

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

Description:

optional core.Individual subject = 2;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 351

Returns:

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

getVariantsList() → (non-null) {Array.<!proto.org.phenopackets.schema.v1.core.Variant>}

Description:

repeated core.Variant variants = 6;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 502

Returns:

Type: Array.<!proto.org.phenopackets.schema.v1.core.Variant>

hasMetaData() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 644

Returns:

Type: boolean

hasSubject() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 379

Returns:

Type: boolean

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

Description:

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 239

Returns:

Type: Uint8Array

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 436

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 550

Parameters:

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

Returns:

returns this

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

setGenesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 474

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v1.core.Gene>

Returns:

returns this

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

setHtsFilesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 588

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v1.core.HtsFile>

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 342

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 626

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 398

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 361

Parameters:

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

Returns:

returns this

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

setVariantsList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 512

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v1.core.Variant>

Returns:

returns this

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

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 161

Parameters:

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

Returns:

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

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

Description:

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 175

Parameters:

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

Returns:

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

Parameters:

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

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

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 129

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

Returns:

Type: Object