VariationDescriptor

new VariationDescriptor(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/vrsatile/v1/vrsatile_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/vrsatile/v1/vrsatile_pb.js, line 116

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 865

List of repeated fields within this message type.

Methods

addAlternateLabels(value, opt_indexopt) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1413

Parameters:

Name	Type	Attributes	Description
`value`	string
`opt_index`	number	<optional>

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

addExpressions(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.ga4gh.vrsatile.v1.Expression}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1302

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.ga4gh.vrsatile.v1.Expression	<optional>
`opt_index`	number	<optional>

Returns:

Type: proto.org.ga4gh.vrsatile.v1.Expression

addExtensions(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.ga4gh.vrsatile.v1.Extension}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1451

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.ga4gh.vrsatile.v1.Extension	<optional>
`opt_index`	number	<optional>

Returns:

Type: proto.org.ga4gh.vrsatile.v1.Extension

addXrefs(value, opt_indexopt) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1376

Parameters:

Name	Type	Attributes	Description
`value`	string
`opt_index`	number	<optional>

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearAllelicState() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the message field making it undefined.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1561

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearAlternateLabelsList() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1422

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearExpressionsList() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1311

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearExtensionsList() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1460

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearGeneContext() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the message field making it undefined.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1264

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearStructuralType() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the message field making it undefined.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1506

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearVariation() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the message field making it undefined.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1191

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearVcfRecord() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the message field making it undefined.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1339

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

clearXrefsList() → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1385

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

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

Description:

optional org.phenopackets.schema.v2.core.OntologyClass allelic_state = 14;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1542

Returns:

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

getAlternateLabelsList() → (non-null) {Array.<string>}

Description:

repeated string alternate_labels = 9;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1394

Returns:

Type: Array.<string>

getDescription() → {string}

Description:

optional string description = 4;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1227

Returns:

Type: string

getExpressionsList() → (non-null) {Array.<!proto.org.ga4gh.vrsatile.v1.Expression>}

Description:

repeated Expression expressions = 6;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1282

Returns:

Type: Array.<!proto.org.ga4gh.vrsatile.v1.Expression>

getExtensionsList() → (non-null) {Array.<!proto.org.ga4gh.vrsatile.v1.Extension>}

Description:

repeated Extension extensions = 10;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1431

Returns:

Type: Array.<!proto.org.ga4gh.vrsatile.v1.Extension>

getGeneContext() → (nullable) {proto.org.ga4gh.vrsatile.v1.GeneDescriptor}

Description:

optional GeneDescriptor gene_context = 5;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1245

Returns:

Type: proto.org.ga4gh.vrsatile.v1.GeneDescriptor

getId() → {string}

Description:

optional string id = 1;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1154

Returns:

Type: string

getLabel() → {string}

Description:

optional string label = 3;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1209

Returns:

Type: string

getMoleculeContext() → (non-null) {proto.org.ga4gh.vrsatile.v1.MoleculeContext}

Description:

optional MoleculeContext molecule_context = 11;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1469

Returns:

Type: proto.org.ga4gh.vrsatile.v1.MoleculeContext

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

Description:

optional org.phenopackets.schema.v2.core.OntologyClass structural_type = 12;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1487

Returns:

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

getVariation() → (nullable) {proto.org.ga4gh.vrs.v1.Variation}

Description:

optional org.ga4gh.vrs.v1.Variation variation = 2;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1172

Returns:

Type: proto.org.ga4gh.vrs.v1.Variation

getVcfRecord() → (nullable) {proto.org.ga4gh.vrsatile.v1.VcfRecord}

Description:

optional VcfRecord vcf_record = 7;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1320

Returns:

Type: proto.org.ga4gh.vrsatile.v1.VcfRecord

getVrsRefAlleleSeq() → {string}

Description:

optional string vrs_ref_allele_seq = 13;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1524

Returns:

Type: string

getXrefsList() → (non-null) {Array.<string>}

Description:

repeated string xrefs = 8;

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1357

Returns:

Type: Array.<string>

hasAllelicState() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1570

Returns:

Type: boolean

hasGeneContext() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1273

Returns:

Type: boolean

hasStructuralType() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1515

Returns:

Type: boolean

hasVariation() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1200

Returns:

Type: boolean

hasVcfRecord() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1348

Returns:

Type: boolean

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

Description:

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

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1026

Returns:

Type: Uint8Array

setAllelicState(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1552

Parameters:

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

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setAlternateLabelsList(valuenon-null) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1403

Parameters:

Name	Type	Description
`value`	Array.<string>

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setDescription(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1236

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setExpressionsList(valuenon-null) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1292

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.ga4gh.vrsatile.v1.Expression>

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setExtensionsList(valuenon-null) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1441

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.ga4gh.vrsatile.v1.Extension>

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setGeneContext(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1255

Parameters:

Name	Type	Description
`value`	proto.org.ga4gh.vrsatile.v1.GeneDescriptor \| undefined

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setId(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1163

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setLabel(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1218

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setMoleculeContext(valuenon-null) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1478

Parameters:

Name	Type	Description
`value`	proto.org.ga4gh.vrsatile.v1.MoleculeContext

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setStructuralType(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1497

Parameters:

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

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setVariation(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1182

Parameters:

Name	Type	Description
`value`	proto.org.ga4gh.vrs.v1.Variation \| undefined

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setVcfRecord(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1330

Parameters:

Name	Type	Description
`value`	proto.org.ga4gh.vrsatile.v1.VcfRecord \| undefined

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setVrsRefAlleleSeq(value) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1533

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

setXrefsList(valuenon-null) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 1366

Parameters:

Name	Type	Description
`value`	Array.<string>

Returns:

returns this

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

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/vrsatile/v1/vrsatile_pb.js, line 882

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.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 929

Parameters:

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

Returns:

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.org.ga4gh.vrsatile.v1.VariationDescriptor}

Description:

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

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 943

Parameters:

Name	Type	Description
`msg`	proto.org.ga4gh.vrsatile.v1.VariationDescriptor	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Returns:

Type: proto.org.ga4gh.vrsatile.v1.VariationDescriptor

(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/vrsatile/v1/vrsatile_pb.js, line 1040

Parameters:

Name	Type	Description
`message`	proto.org.ga4gh.vrsatile.v1.VariationDescriptor
`writer`	jspb.BinaryWriter

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

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/vrsatile/v1/vrsatile_pb.js, line 896

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.ga4gh.vrsatile.v1.VariationDescriptor	The msg instance to transform.

Returns:

Type: Object