API / geotoolkit / seismic / data / FieldDesc / FieldDesc
The FieldDesc is a base class for seismic trace header's field descriptors. It is common to all field descriptors. A header field descriptor describes the name and identifier of a given header field.
FieldDesc
Constructors
| [new FieldDesc(fieldId, name, title)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.data-3.fielddesc.fielddesc.md#new fielddesc(fieldid, name, title)) | [new FieldDesc(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.seismic.data-3.fielddesc.fielddesc.md#new fielddesc(options)) |
|---|
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
fieldid | string | number | Identifier (type) |
name | string | Name of the field |
title | string | Title of the field |
Constructors
• new FieldDesc(fieldId, name, title?)
Creates field description
| Name | Type | Description |
|---|---|---|
fieldId | string | number | identifier of the field |
name | string | name of the field |
Optional title | string | title of the field |
• new FieldDesc(options?)
Creates field description
| Name | Type | Description |
|---|---|---|
Optional options | Options | options to specify fieldId, name and title |
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
▸ getIdentifier(): string | number
Returns identifier (type)
string | number
▸ getName(): string
Returns name
string
▸ getProperties(): Required<Options>
Gets the properties
Required<Options>
▸ getTitle(): string
Returns title
string
▸ setProperties(props?): FieldDesc
Sets the properties
| Name | Type | Description |
|---|---|---|
Optional props | Options | properties |
this
▸ setTitle(title): FieldDesc
Set title
| Name | Type | Description |
|---|---|---|
title | string | title |
this
▸ toString(): string
Returns string representation
string
▸ Static getClassName(): string
string