Variant - Documentation

Variant

new Variant(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

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

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

Source:

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

Properties:

Name	Type	Description
`ALLELE_NOT_SET`	number
`HGVS_ALLELE`	number
`VCF_ALLELE`	number
`SPDI_ALLELE`	number
`ISCN_ALLELE`	number

Type:

number

(static) displayName

Source:

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

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

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.

Methods

clearHgvsAllele() → (non-null) {proto.org.phenopackets.schema.v1.core.Variant}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearIscnAllele() → (non-null) {proto.org.phenopackets.schema.v1.core.Variant}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearSpdiAllele() → (non-null) {proto.org.phenopackets.schema.v1.core.Variant}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearVcfAllele() → (non-null) {proto.org.phenopackets.schema.v1.core.Variant}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearZygosity() → (non-null) {proto.org.phenopackets.schema.v1.core.Variant}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

getAlleleCase() → {proto.org.phenopackets.schema.v1.core.Variant.AlleleCase}

Source:

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

Returns:

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

getHgvsAllele() → (nullable) {proto.org.phenopackets.schema.v1.core.HgvsAllele}

Description:

optional HgvsAllele hgvs_allele = 2;

Source:

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

Returns:

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

getIscnAllele() → (nullable) {proto.org.phenopackets.schema.v1.core.IscnAllele}

Description:

optional IscnAllele iscn_allele = 5;

Source:

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

Returns:

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

getSpdiAllele() → (nullable) {proto.org.phenopackets.schema.v1.core.SpdiAllele}

Description:

optional SpdiAllele spdi_allele = 4;

Source:

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

Returns:

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

getVcfAllele() → (nullable) {proto.org.phenopackets.schema.v1.core.VcfAllele}

Description:

optional VcfAllele vcf_allele = 3;

Source:

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

Returns:

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

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

Description:

optional OntologyClass zygosity = 6;

Source:

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

Returns:

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

hasHgvsAllele() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasIscnAllele() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasSpdiAllele() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasVcfAllele() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasZygosity() → {boolean}

Description:

Returns whether this field is set.

Source:

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

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 5893

Returns:

Type: Uint8Array

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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 5798

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

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

Parameters:

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

Returns:

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

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

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 5848

Parameters:

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

Returns:

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

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

Parameters:

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

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

Returns:

Type: Object