Disease - Documentation

Disease

new Disease(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 37

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/disease_pb.js, line 46

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 54

List of repeated fields within this message type.

Methods

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 458

Parameters:

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

Returns:

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 420

Parameters:

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

Returns:

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

clearClinicalTnmFindingList() → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 467

Returns:

returns this

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

clearDiseaseStageList() → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 429

Returns:

returns this

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

clearLaterality() → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 532

Returns:

returns this

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

clearOnset() → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 345

Returns:

returns this

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

clearPrimarySite() → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 495

Returns:

returns this

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

clearResolution() → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 382

Returns:

returns this

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

clearTerm() → (non-null) {proto.org.phenopackets.schema.v2.core.Disease}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 290

Returns:

returns this

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

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

Description:

repeated OntologyClass clinical_tnm_finding = 6;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 438

Returns:

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

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

Description:

repeated OntologyClass disease_stage = 5;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 400

Returns:

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

getExcluded() → {boolean}

Description:

optional bool excluded = 2;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 308

Returns:

Type: boolean

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

Description:

optional OntologyClass laterality = 8;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 513

Returns:

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

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

Description:

optional TimeElement onset = 3;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 326

Returns:

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

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

Description:

optional OntologyClass primary_site = 7;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 476

Returns:

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

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

Description:

optional TimeElement resolution = 4;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 363

Returns:

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

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

Description:

optional OntologyClass term = 1;

Source:

phenopackets/schema/v2/core/disease_pb.js, line 271

Returns:

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

hasLaterality() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 541

Returns:

Type: boolean

hasOnset() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 354

Returns:

Type: boolean

hasPrimarySite() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 504

Returns:

Type: boolean

hasResolution() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 391

Returns:

Type: boolean

hasTerm() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 299

Returns:

Type: boolean

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

Description:

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 185

Returns:

Type: Uint8Array

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 448

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 410

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 317

Parameters:

Name	Type	Description
`value`	boolean

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 523

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 336

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 486

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 373

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 281

Parameters:

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

Returns:

returns this

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

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/disease_pb.js, line 71

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

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

Parameters:

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

Returns:

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

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

Description:

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

Source:

phenopackets/schema/v2/core/disease_pb.js, line 126

Parameters:

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

Returns:

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

(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/disease_pb.js, line 199

Parameters:

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

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

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v2/core/disease_pb.js, line 85

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

Returns:

Type: Object