Class FtFieldDefinition`Abstract`

Abstract base class for all field definitions. Field definitions hold metadata and configuration for fields in fielded text.

Hierarchy (View Summary)

FtFieldDefinition
- FtGenericFieldDefinition

Constructors

`Protected`constructor

new FtFieldDefinition(
    dataType: FtDataType,
    valueType: string,
    formatter: FtFieldFormatter,
    autoLeftPad: boolean,
    index: number,
): FtFieldDefinition
Parameters
- dataType: FtDataType
- valueType: string
- formatter: FtFieldFormatter
- autoLeftPad: boolean
- index: number
Returns FtFieldDefinition
- Defined in lib/src/fields/definitions/ft-field-definition.ts:73

Properties

`Readonly`autoLeftPad

autoLeftPad: boolean

`Readonly`dataType

dataType: FtDataType

`Protected` `Readonly`formatter

formatter: FtFieldFormatter

`Readonly`valueType

valueType: string

Accessors

autoPadChar

get autoPadChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:178

constant

get constant(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:109

culture

get culture(): DotNetLocaleSettings | undefined
Returns DotNetLocaleSettings | undefined
- Defined in lib/src/fields/definitions/ft-field-definition.ts:100

fixedWidth

get fixedWidth(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:103

fixedWidthNullValueText

get fixedWidthNullValueText(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:187

headingAlwaysWriteOptionalQuote

get headingAlwaysWriteOptionalQuote(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:153

headingConstraint

get headingConstraint(): FtHeadingConstraint
Returns FtHeadingConstraint
- Defined in lib/src/fields/definitions/ft-field-definition.ts:147

headingEndOfValueChar

get headingEndOfValueChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:174

headingLeftPad

get headingLeftPad(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:181

headingPadAlignment

get headingPadAlignment(): FtPadAlignment
Returns FtPadAlignment
- Defined in lib/src/fields/definitions/ft-field-definition.ts:159

headingPadChar

get headingPadChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:165

headingPadCharType

get headingPadCharType(): FtPadCharType
Returns FtPadCharType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:162

headingQuotedType

get headingQuotedType(): FtQuotedType
Returns FtQuotedType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:150

headingTruncateChar

get headingTruncateChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:171

headingTruncateType

get headingTruncateType(): FtTruncateType
Returns FtTruncateType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:168

headingWritePrefixSpace

get headingWritePrefixSpace(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:156

id

get id(): number | undefined
Returns number | undefined
- Defined in lib/src/fields/definitions/ft-field-definition.ts:85

index

get index(): number
Returns number
- Defined in lib/src/fields/definitions/ft-field-definition.ts:82

mainHeadingIndex

get mainHeadingIndex(): number
Returns number
- Defined in lib/src/fields/definitions/ft-field-definition.ts:97

metaHeadingCount

get metaHeadingCount(): number
Returns number
- Defined in lib/src/fields/definitions/ft-field-definition.ts:94

metaHeadings

get metaHeadings(): string[]
Returns string[]
- Defined in lib/src/fields/definitions/ft-field-definition.ts:91

metaName

get metaName(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:88

null

get null(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:112

valueAlwaysWriteOptionalQuote

get valueAlwaysWriteOptionalQuote(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:119

valueEndOfValueChar

get valueEndOfValueChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:140

valueLeftPad

get valueLeftPad(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:184

valueNullChar

get valueNullChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:143

valuePadAlignment

get valuePadAlignment(): FtPadAlignment
Returns FtPadAlignment
- Defined in lib/src/fields/definitions/ft-field-definition.ts:125

valuePadChar

get valuePadChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:131

valuePadCharType

get valuePadCharType(): FtPadCharType
Returns FtPadCharType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:128

valueQuotedType

get valueQuotedType(): FtQuotedType
Returns FtQuotedType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:116

valueTruncateChar

get valueTruncateChar(): string
Returns string
- Defined in lib/src/fields/definitions/ft-field-definition.ts:137

valueTruncateType

get valueTruncateType(): FtTruncateType
Returns FtTruncateType
- Defined in lib/src/fields/definitions/ft-field-definition.ts:134

valueWritePrefixSpace

get valueWritePrefixSpace(): boolean
Returns boolean
- Defined in lib/src/fields/definitions/ft-field-definition.ts:122

width

get width(): number
Returns number
- Defined in lib/src/fields/definitions/ft-field-definition.ts:106

Methods

loadMeta

loadMeta(
    metaField: FtMetaField,
    myCulture: DotNetLocaleSettings | undefined,
    myMainHeadingIndex: number,
): void
Load metadata from a meta field.
Parameters
- metaField: FtMetaField
  The meta field containing configuration
- myCulture: DotNetLocaleSettings | undefined
  The culture settings for formatting
- myMainHeadingIndex: number
  Index of the main heading
Returns void
- Defined in lib/src/fields/definitions/ft-field-definition.ts:197