new Biosample(opt_dataopt)
- Description:
- Generated by JsPbCodeGenerator.
- Source:
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
(private, static, constant) repeatedFields_
- Description:
- List of repeated fields within this message type.
- Source:
List of repeated fields within this message type.
Methods
addDiagnosticMarkers(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.OntologyClass}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_value |
proto.org.phenopackets.schema.v2.core.OntologyClass |
<optional> |
|
opt_index |
number |
<optional> |
Returns:
addFiles(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.File}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_value |
proto.org.phenopackets.schema.v2.core.File |
<optional> |
|
opt_index |
number |
<optional> |
Returns:
addMeasurements(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Measurement}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_value |
proto.org.phenopackets.schema.v2.core.Measurement |
<optional> |
|
opt_index |
number |
<optional> |
Returns:
addPathologicalTnmFinding(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.OntologyClass}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_value |
proto.org.phenopackets.schema.v2.core.OntologyClass |
<optional> |
|
opt_index |
number |
<optional> |
Returns:
addPhenotypicFeatures(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.PhenotypicFeature}
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
opt_value |
proto.org.phenopackets.schema.v2.core.PhenotypicFeature |
<optional> |
|
opt_index |
number |
<optional> |
Returns:
clearDiagnosticMarkersList() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the list making it empty but non-null.
- Source:
Returns:
returns this
clearFilesList() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the list making it empty but non-null.
- Source:
Returns:
returns this
clearHistologicalDiagnosis() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearMaterialSample() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearMeasurementsList() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the list making it empty but non-null.
- Source:
Returns:
returns this
clearPathologicalStage() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearPathologicalTnmFindingList() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the list making it empty but non-null.
- Source:
Returns:
returns this
clearPhenotypicFeaturesList() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the list making it empty but non-null.
- Source:
Returns:
returns this
clearProcedure() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearSampleProcessing() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearSampleStorage() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearSampleType() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearSampledTissue() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearTaxonomy() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearTimeOfCollection() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearTumorGrade() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
clearTumorProgression() → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Clears the message field making it undefined.
- Source:
Returns:
returns this
getDerivedFromId() → {string}
- Description:
- optional string derived_from_id = 3;
- Source:
Returns:
- Type
- string
getDescription() → {string}
- Description:
- optional string description = 4;
- Source:
Returns:
- Type
- string
getDiagnosticMarkersList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.OntologyClass>}
- Description:
- repeated OntologyClass diagnostic_markers = 16;
- Source:
Returns:
- Type
- Array.<!proto.org.phenopackets.schema.v2.core.OntologyClass>
getFilesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.File>}
- Description:
- repeated File files = 18;
- Source:
Returns:
- Type
- Array.<!proto.org.phenopackets.schema.v2.core.File>
getHistologicalDiagnosis() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass histological_diagnosis = 11;
- Source:
Returns:
getId() → {string}
- Description:
- optional string id = 1;
- Source:
Returns:
- Type
- string
getIndividualId() → {string}
- Description:
- optional string individual_id = 2;
- Source:
Returns:
- Type
- string
getMaterialSample() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass material_sample = 19;
- Source:
Returns:
getMeasurementsList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.Measurement>}
- Description:
- repeated Measurement measurements = 8;
- Source:
Returns:
- Type
- Array.<!proto.org.phenopackets.schema.v2.core.Measurement>
getPathologicalStage() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass pathological_stage = 14;
- Source:
Returns:
getPathologicalTnmFindingList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.OntologyClass>}
- Description:
- repeated OntologyClass pathological_tnm_finding = 15;
- Source:
Returns:
- Type
- Array.<!proto.org.phenopackets.schema.v2.core.OntologyClass>
getPhenotypicFeaturesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.PhenotypicFeature>}
- Description:
- repeated PhenotypicFeature phenotypic_features = 7;
- Source:
Returns:
- Type
- Array.<!proto.org.phenopackets.schema.v2.core.PhenotypicFeature>
getProcedure() → (nullable) {proto.org.phenopackets.schema.v2.core.Procedure}
- Description:
- optional Procedure procedure = 17;
- Source:
Returns:
getSampleProcessing() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass sample_processing = 20;
- Source:
Returns:
getSampleStorage() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass sample_storage = 21;
- Source:
Returns:
getSampleType() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass sample_type = 6;
- Source:
Returns:
getSampledTissue() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass sampled_tissue = 5;
- Source:
Returns:
getTaxonomy() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass taxonomy = 9;
- Source:
Returns:
getTimeOfCollection() → (nullable) {proto.org.phenopackets.schema.v2.core.TimeElement}
- Description:
- optional TimeElement time_of_collection = 10;
- Source:
Returns:
getTumorGrade() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass tumor_grade = 13;
- Source:
Returns:
getTumorProgression() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}
- Description:
- optional OntologyClass tumor_progression = 12;
- Source:
Returns:
hasHistologicalDiagnosis() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasMaterialSample() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasPathologicalStage() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasProcedure() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasSampleProcessing() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasSampleStorage() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasSampleType() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasSampledTissue() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasTaxonomy() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasTimeOfCollection() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasTumorGrade() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasTumorProgression() → {boolean}
- Description:
- Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
serializeBinary() → (non-null) {Uint8Array}
- Description:
- Serializes the message to binary data (in protobuf wire format).
- Source:
Returns:
- Type
- Uint8Array
setDerivedFromId(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setDescription(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setDiagnosticMarkersList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Array.<!proto.org.phenopackets.schema.v2.core.OntologyClass> |
Returns:
returns this
setFilesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Array.<!proto.org.phenopackets.schema.v2.core.File> |
Returns:
returns this
setHistologicalDiagnosis(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setId(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setIndividualId(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string |
Returns:
returns this
setMaterialSample(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setMeasurementsList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Array.<!proto.org.phenopackets.schema.v2.core.Measurement> |
Returns:
returns this
setPathologicalStage(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setPathologicalTnmFindingList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Array.<!proto.org.phenopackets.schema.v2.core.OntologyClass> |
Returns:
returns this
setPhenotypicFeaturesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
Array.<!proto.org.phenopackets.schema.v2.core.PhenotypicFeature> |
Returns:
returns this
setProcedure(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.Procedure | undefined |
Returns:
returns this
setSampleProcessing(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setSampleStorage(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setSampleType(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setSampledTissue(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setTaxonomy(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setTimeOfCollection(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.TimeElement | undefined |
Returns:
returns this
setTumorGrade(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
setTumorProgression(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
proto.org.phenopackets.schema.v2.core.OntologyClass | undefined |
Returns:
returns this
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.
- 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_
- Source:
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.Biosample}
- Description:
- Deserializes binary data (in protobuf wire format).
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
bytes |
jspb.ByteSource | The bytes to deserialize. |
Returns:
(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Biosample}
- Description:
- Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
msg |
proto.org.phenopackets.schema.v2.core.Biosample | The message object to deserialize into. |
reader |
jspb.BinaryReader | The BinaryReader to use. |
Returns:
(static) serializeBinaryToWriter(messagenon-null, writernon-null)
- Description:
- Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
message |
proto.org.phenopackets.schema.v2.core.Biosample | |
writer |
jspb.BinaryWriter |
(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}
- Description:
- Static version of the {@see toObject} method.
- Source:
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.Biosample | The msg instance to transform. |
Returns:
- Type
- Object