Cohort - Documentation

Cohort

new Cohort(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

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

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 90

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

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

List of repeated fields within this message type.

Methods

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

Source:

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

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

addMembers(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Source:

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

Parameters:

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

Returns:

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

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

Description:

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

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

clearMembersList() → (non-null) {proto.org.phenopackets.schema.v1.Cohort}

Description:

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

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

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

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

getDescription() → {string}

Description:

optional string description = 2;

Source:

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

Returns:

Type: string

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

Description:

repeated core.HtsFile hts_files = 4;

Source:

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

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 1224

Returns:

Type: string

getMembersList() → (non-null) {Array.<!proto.org.phenopackets.schema.v1.Phenopacket>}

Description:

repeated Phenopacket members = 3;

Source:

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

Returns:

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

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

Description:

optional core.MetaData meta_data = 5;

Source:

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

Returns:

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

hasMetaData() → {boolean}

Description:

Returns whether this field is set.

Source:

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

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 1163

Returns:

Type: Uint8Array

setDescription(value) → (non-null) {proto.org.phenopackets.schema.v1.Cohort}

Source:

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

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

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

setMembersList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v1.Cohort}

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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 1068

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

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

Parameters:

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

Returns:

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

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

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 1120

Parameters:

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

Returns:

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

(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 1177

Parameters:

Name	Type	Description
`message`	proto.org.phenopackets.schema.v1.Cohort
`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 1082

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

Returns:

Type: Object