HtsFile - Documentation

HtsFile

new HtsFile(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

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

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

Source:

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

Properties:

Name	Type	Description
`UNKNOWN`	number
`SAM`	number
`BAM`	number
`CRAM`	number
`VCF`	number
`BCF`	number
`GVCF`	number
`FASTQ`	number

Type:

number

(static) displayName

Source:

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

Methods

clearIndividualToSampleIdentifiersMap() → (non-null) {proto.org.phenopackets.schema.v1.core.HtsFile}

Description:

Clears values from the map. The map will be non-null.

Source:

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

Returns:

returns this

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

getDescription() → {string}

Description:

optional string description = 2;

Source:

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

Returns:

Type: string

getGenomeAssembly() → {string}

Description:

optional string genome_assembly = 4;

Source:

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

Returns:

Type: string

getHtsFormat() → (non-null) {proto.org.phenopackets.schema.v1.core.HtsFile.HtsFormat}

Description:

optional HtsFormat hts_format = 3;

Source:

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

Returns:

Type: proto.org.phenopackets.schema.v1.core.HtsFile.HtsFormat

getIndividualToSampleIdentifiersMap(opt_noLazyCreateopt) → (non-null) {jspb.Map.<string, string>}

Description:

map individual_to_sample_identifiers = 5;

Source:

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

Parameters:

Name	Type	Attributes	Description
`opt_noLazyCreate`	boolean	<optional>	Do not create the map if empty, instead returning `undefined`

Returns:

Type: jspb.Map.<string, string>

getUri() → {string}

Description:

optional string uri = 1;

Source:

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

Returns:

Type: string

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

Description:

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

Source:

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

Returns:

Type: Uint8Array

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

Source:

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

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

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

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

Source:

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

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

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

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

Source:

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

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v1.core.HtsFile.HtsFormat

Returns:

returns this

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

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

Source:

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

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

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

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 5286

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

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

Parameters:

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

Returns:

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

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

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 5336

Parameters:

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

Returns:

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

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

Parameters:

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

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

Returns:

Type: Object