Disease - Documentation

Disease

new Disease(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

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

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

Source:

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

Properties:

Name	Type	Description
`ONSET_NOT_SET`	number
`AGE_OF_ONSET`	number
`AGE_RANGE_OF_ONSET`	number
`CLASS_OF_ONSET`	number

Type:

number

(static) displayName

Source:

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

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

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 4383

List of repeated fields within this message type.

Methods

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

Source:

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

Parameters:

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

Returns:

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

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

Source:

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

Parameters:

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

Returns:

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

clearAgeOfOnset() → (non-null) {proto.org.phenopackets.schema.v1.core.Disease}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearAgeRangeOfOnset() → (non-null) {proto.org.phenopackets.schema.v1.core.Disease}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearClassOfOnset() → (non-null) {proto.org.phenopackets.schema.v1.core.Disease}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

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

Description:

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

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

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

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearTnmFindingList() → (non-null) {proto.org.phenopackets.schema.v1.core.Disease}

Description:

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

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

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

Description:

optional Age age_of_onset = 2;

Source:

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

Returns:

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

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

Description:

optional AgeRange age_range_of_onset = 3;

Source:

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

Returns:

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

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

Description:

optional OntologyClass class_of_onset = 4;

Source:

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

Returns:

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

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

Description:

repeated OntologyClass disease_stage = 5;

Source:

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

Returns:

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

getOnsetCase() → {proto.org.phenopackets.schema.v1.core.Disease.OnsetCase}

Source:

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

Returns:

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

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

Description:

optional OntologyClass term = 1;

Source:

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

Returns:

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

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

Description:

repeated OntologyClass tnm_finding = 6;

Source:

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

Returns:

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

hasAgeOfOnset() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasAgeRangeOfOnset() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasClassOfOnset() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasTerm() → {boolean}

Description:

Returns whether this field is set.

Source:

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

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 4530

Returns:

Type: Uint8Array

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

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

Parameters:

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

Returns:

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

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

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 4480

Parameters:

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

Returns:

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

Parameters:

Name	Type	Description
`message`	proto.org.phenopackets.schema.v1.core.Disease
`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 4441

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

Returns:

Type: Object