Quantity - Documentation

Quantity

new Quantity(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 107

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/measurement_pb.js, line 116

Methods

clearReferenceRange() → (non-null) {proto.org.phenopackets.schema.v2.core.Quantity}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1177

Returns:

returns this

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

clearUnit() → (non-null) {proto.org.phenopackets.schema.v2.core.Quantity}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1122

Returns:

returns this

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

getReferenceRange() → (nullable) {proto.org.phenopackets.schema.v2.core.ReferenceRange}

Description:

optional ReferenceRange reference_range = 3;

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1158

Returns:

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

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

Description:

optional OntologyClass unit = 1;

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1103

Returns:

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

getValue() → {number}

Description:

optional double value = 2;

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1140

Returns:

Type: number

hasReferenceRange() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1186

Returns:

Type: boolean

hasUnit() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1131

Returns:

Type: boolean

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

Description:

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

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1057

Returns:

Type: Uint8Array

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

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1168

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1113

Parameters:

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

Returns:

returns this

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

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

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1149

Parameters:

Name	Type	Description
`value`	number

Returns:

returns this

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

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/measurement_pb.js, line 975

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1009

Parameters:

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

Returns:

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

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

Description:

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

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 1023

Parameters:

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

Returns:

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

(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/measurement_pb.js, line 1071

Parameters:

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

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

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v2/core/measurement_pb.js, line 989

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

Returns:

Type: Object