Class RevTableRecordSource<Badness, TypeId, TableFieldSourceDefinitionTypeId, TextFormattableValueTypeId, TextFormattableValueAttributeTypeId>Abstract

constructor

• new RevTableRecordSource<
      Badness,
      TypeId,
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >(
      textFormatter: RevTextFormatter<
          TextFormattableValueTypeId,
          TextFormattableValueAttributeTypeId,
      >,
      customHeadings: undefined | RevSourcedFieldCustomHeadings,
      tableFieldSourceDefinitionCachingFactory: RevTableFieldSourceDefinitionCachingFactory<
          TableFieldSourceDefinitionTypeId,
          TextFormattableValueTypeId,
          TextFormattableValueAttributeTypeId,
      >,
      _correctnessState: CorrectnessState<Badness>,
      _definition: RevTableRecordSourceDefinition<
          TypeId,
          TableFieldSourceDefinitionTypeId,
          TextFormattableValueTypeId,
          TextFormattableValueAttributeTypeId,
      >,
      allowedFieldSourceDefinitionTypeIds: readonly TableFieldSourceDefinitionTypeId[],
  ): RevTableRecordSource<
      Badness,
      TypeId,
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >

  Type Parameters

  • Badness
  • TypeId
  • TableFieldSourceDefinitionTypeId
  • TextFormattableValueTypeId
  • TextFormattableValueAttributeTypeId

  Parameters

  • textFormatter: RevTextFormatter<
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >
  • customHeadings: undefined | RevSourcedFieldCustomHeadings
  • tableFieldSourceDefinitionCachingFactory: RevTableFieldSourceDefinitionCachingFactory<
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >
  • _correctnessState: CorrectnessState<Badness>
  • _definition: RevTableRecordSourceDefinition<
        TypeId,
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >
  • allowedFieldSourceDefinitionTypeIds: readonly TableFieldSourceDefinitionTypeId[]

  Returns RevTableRecordSource<
      Badness,
      TypeId,
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >

ReadonlyallowedFieldSourceDefinitionTypeIds

ReadonlycustomHeadings

ReadonlytableFieldSourceDefinitionCachingFactory

ReadonlytextFormatter

activeFieldSources

• get activeFieldSources(): readonly RevTableFieldSource<
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >[]

  Returns readonly RevTableFieldSource<
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >[]

AsArray

• get AsArray(): RevTableRecordDefinition<TableFieldSourceDefinitionTypeId>[]

  Returns RevTableRecordDefinition<TableFieldSourceDefinitionTypeId>[]

badness

• get badness(): Badness

  Returns Badness

count

• get count(): number

  Returns number

fields

• get fields(): readonly RevTableField<
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >[]

  Returns readonly RevTableField<
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >[]

opened

• get opened(): boolean

  Returns boolean

usable

• get usable(): boolean

  Returns boolean

checkSetUnusable

• checkSetUnusable(badness: Badness): void

  Parameters

  • badness: Badness

  Returns void

closeLocked

• closeLocked(_opener: NamedLocker): void

  Parameters

  • _opener: NamedLocker

  Returns void

createAllowedFields

• createAllowedFields(): readonly RevAllowedRecordSourcedField<
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >[]

  Returns readonly RevAllowedRecordSourcedField<
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >[]

AbstractcreateDefinition

• createDefinition(): RevTableRecordSourceDefinition<
      TypeId,
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >

  Returns RevTableRecordSourceDefinition<
      TypeId,
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >

AbstractcreateRecordDefinition

• createRecordDefinition(
      recordIdx: number,
  ): RevTableRecordDefinition<TableFieldSourceDefinitionTypeId>

  Parameters

  • recordIdx: number

  Returns RevTableRecordDefinition<TableFieldSourceDefinitionTypeId>

AbstractcreateTableRecord

• createTableRecord(
      recordIndex: number,
      eventHandlers: EventHandlers,
  ): RevTableRecord<
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >

  Parameters

  • recordIndex: number
  • eventHandlers: EventHandlers

  Returns RevTableRecord<TextFormattableValueTypeId, TextFormattableValueAttributeTypeId>

finalise

• finalise(): void

  Returns void

indexOf

• indexOf(
      value: RevTableRecordDefinition<TableFieldSourceDefinitionTypeId>,
  ): number

  Parameters

  • value: RevTableRecordDefinition<TableFieldSourceDefinitionTypeId>

  Returns number

openLocked

• openLocked(_opener: NamedLocker): void

  Parameters

  • _opener: NamedLocker

  Returns void

setActiveFieldSources

• setActiveFieldSources(
      fieldSourceTypeIds: readonly TableFieldSourceDefinitionTypeId[],
  ): void

  Parameters

  • fieldSourceTypeIds: readonly TableFieldSourceDefinitionTypeId[]

  Returns void

setUnusable

• setUnusable(badness: Badness): void

  Parameters

  • badness: Badness

  Returns void

setUsable

• setUsable(badness: Badness): void

  Parameters

  • badness: Badness

  Returns void

subscribeAfterRecDefinitionChangeEvent

• subscribeAfterRecDefinitionChangeEvent(
      handler: RecDefinitionChangeEventHandler,
  ): number

  Parameters

  • handler: RecDefinitionChangeEventHandler

  Returns number

subscribeBadnessChangedEvent

• subscribeBadnessChangedEvent(
      handler: BadnessChangedEventHandler,
  ): SubscriptionId

  Parameters

  • handler: BadnessChangedEventHandler

  Returns SubscriptionId

subscribeBeforeRecDefinitionChangeEvent

• subscribeBeforeRecDefinitionChangeEvent(
      handler: RecDefinitionChangeEventHandler,
  ): number

  Parameters

  • handler: RecDefinitionChangeEventHandler

  Returns number

subscribeListChangeEvent

• subscribeListChangeEvent(handler: ListChangeEventHandler): number

  Parameters

  • handler: ListChangeEventHandler

  Returns number

subscribeUsableChangedEvent

• subscribeUsableChangedEvent(handler: UsableChangedEventHandler): SubscriptionId

  Parameters

  • handler: UsableChangedEventHandler

  Returns SubscriptionId

tryLock

• tryLock(_locker: NamedLocker): Promise<Result<void>>

  Parameters

  • _locker: NamedLocker

  Returns Promise<Result<void>>

unlock

• unlock(_locker: NamedLocker): void

  Parameters

  • _locker: NamedLocker

  Returns void

unsubscribeAfterRecDefinitionChangeEvent

• unsubscribeAfterRecDefinitionChangeEvent(subscriptionId: SubscriptionId): void

  Parameters

  • subscriptionId: SubscriptionId

  Returns void

unsubscribeBadnessChangedEvent

• unsubscribeBadnessChangedEvent(subscriptionId: SubscriptionId): void

  Parameters

  • subscriptionId: SubscriptionId

  Returns void

unsubscribeBeforeRecDefinitionChangeEvent

• unsubscribeBeforeRecDefinitionChangeEvent(subscriptionId: SubscriptionId): void

  Parameters

  • subscriptionId: SubscriptionId

  Returns void

unsubscribeListChangeEvent

• unsubscribeListChangeEvent(subscriptionId: SubscriptionId): void

  Parameters

  • subscriptionId: SubscriptionId

  Returns void

unsubscribeUsableChangedEvent

• unsubscribeUsableChangedEvent(subscriptionId: SubscriptionId): void

  Parameters

  • subscriptionId: SubscriptionId

  Returns void