Family - Documentation

Family

new Family(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 60

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/v1/phenopackets_pb.js, line 69

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 655

List of repeated fields within this message type.

Methods

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 994

Parameters:

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

Returns:

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

addRelatives(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v1.Phenopacket}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 919

Parameters:

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

Returns:

Type: proto.org.phenopackets.schema.v1.Phenopacket

clearHtsFilesList() → (non-null) {proto.org.phenopackets.schema.v1.Family}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 1003

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

clearMetaData() → (non-null) {proto.org.phenopackets.schema.v1.Family}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 1031

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

clearPedigree() → (non-null) {proto.org.phenopackets.schema.v1.Family}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 956

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

clearProband() → (non-null) {proto.org.phenopackets.schema.v1.Family}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 881

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

clearRelativesList() → (non-null) {proto.org.phenopackets.schema.v1.Family}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 928

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

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

Description:

repeated core.HtsFile hts_files = 5;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 974

Returns:

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

getId() → {string}

Description:

optional string id = 1;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 844

Returns:

Type: string

getMetaData() → (nullable) {proto.org.phenopackets.schema.v1.core.MetaData}

Description:

optional core.MetaData meta_data = 6;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 1012

Returns:

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

getPedigree() → (nullable) {proto.org.phenopackets.schema.v1.core.Pedigree}

Description:

optional core.Pedigree pedigree = 4;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 937

Returns:

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

getProband() → (nullable) {proto.org.phenopackets.schema.v1.Phenopacket}

Description:

optional Phenopacket proband = 2;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 862

Returns:

Type: proto.org.phenopackets.schema.v1.Phenopacket

getRelativesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v1.Phenopacket>}

Description:

repeated Phenopacket relatives = 3;

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 899

Returns:

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

hasMetaData() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 1040

Returns:

Type: boolean

hasPedigree() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 965

Returns:

Type: boolean

hasProband() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 890

Returns:

Type: boolean

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

Description:

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 774

Returns:

Type: Uint8Array

setHtsFilesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v1.Family}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 984

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

setId(value) → (non-null) {proto.org.phenopackets.schema.v1.Family}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 853

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

setMetaData(value) → (non-null) {proto.org.phenopackets.schema.v1.Family}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 1022

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

setPedigree(value) → (non-null) {proto.org.phenopackets.schema.v1.Family}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 947

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

setProband(value) → (non-null) {proto.org.phenopackets.schema.v1.Family}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 872

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

setRelativesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v1.Family}

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 909

Parameters:

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

Returns:

returns this

Type: proto.org.phenopackets.schema.v1.Family

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/phenopackets_pb.js, line 672

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

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 711

Parameters:

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

Returns:

Type: proto.org.phenopackets.schema.v1.Family

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

Description:

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

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 725

Parameters:

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

Returns:

Type: proto.org.phenopackets.schema.v1.Family

(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/phenopackets_pb.js, line 788

Parameters:

Name	Type	Description
`message`	proto.org.phenopackets.schema.v1.Family
`writer`	jspb.BinaryWriter

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

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v1/phenopackets_pb.js, line 686

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

Returns:

Type: Object