API / geotoolkit / seismic / data / BinaryField / BinaryField
data.BinaryField.BinaryField
Define binary header
↳
BinaryField
Constructors
| [new BinaryField(offset, dataType, fieldId, name)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield.md#new binaryfield(offset, datatype, fieldid, name)) | [new BinaryField(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.data-3.binaryfield.binaryfield.md#new binaryfield(options)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
datatype | DataFormatType | Type of the data |
fieldid | string | number | Identifier (type) |
name | string | Name of the field |
offset | number | Offset of the header |
title | string | Title of the field |
Constructors
• new BinaryField(offset, dataType, fieldId, name)
Creates a new BinaryField
| Name | Type | Description |
|---|---|---|
offset | string | number | bytes offset in the header |
dataType | DataFormatType | type of the data |
fieldId | string | unique identifier of the field |
name | string | name of the field |
FieldDesc.constructor
• new BinaryField(options?)
Creates a new BinaryField
| Name | Type | Description |
|---|---|---|
Optional options | Options | options |
FieldDesc.constructor
Methods
▸ clone(): FieldDesc
Returns clone of the field descriptor
clone
▸ equalsTo(header): boolean
Returns true if headers are identical
| Name | Type | Description |
|---|---|---|
header | FieldDesc | { identifier?: string ; name?: string } | header |
boolean
▸ getClassName(): string
string
▸ getClone(): FieldDesc
Returns clone of the field descriptor
Deprecated
since 4.0 Use clone instead
clone
▸ getDataType(): DataFormatType
Returns data type
▸ getIdentifier(): string | number
Returns identifier (type)
string | number
▸ getName(): string
Returns name
string
▸ getOffset(): number
Returns offset
number
▸ getProperties(): Required<Options>
Returns properties
Required<Options>
properties
▸ getTitle(): string
Returns title
string
▸ setProperties(properties?): BinaryField
Sets properties
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
▸ setTitle(title): BinaryField
Set title
| Name | Type | Description |
|---|---|---|
title | string | title |
this
▸ toString(): string
Returns string representation
string
▸ Static getClassName(): string
string