Class RevReferenceableDataSource<Badness, TableRecordSourceDefinitionTypeId, TableFieldSourceDefinitionTypeId, TextFormattableValueTypeId, TextFormattableValueAttributeTypeId>

Type Parameters

Badness
TableRecordSourceDefinitionTypeId
TableFieldSourceDefinitionTypeId
TextFormattableValueTypeId
TextFormattableValueAttributeTypeId

Hierarchy (View Summary)

RevDataSource<
    Badness,
    TableRecordSourceDefinitionTypeId,
    TableFieldSourceDefinitionTypeId,
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>
- RevReferenceableDataSource

Implements

LockOpenListItem<
    RevReferenceableDataSource<
        Badness,
        TableRecordSourceDefinitionTypeId,
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    RevDataSource.LockErrorIdPlusTryError,
>
IndexedRecord

Constructors

constructor

new RevReferenceableDataSource<
    Badness,
    TableRecordSourceDefinitionTypeId,
    TableFieldSourceDefinitionTypeId,
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>(
    referenceableColumnLayouts: undefined | RevReferenceableColumnLayouts,
    tableFieldSourceDefinitionFactory: RevTableFieldSourceDefinitionFactory<
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    tableRecordSourceFactory: RevTableRecordSourceFactory<
        Badness,
        TableRecordSourceDefinitionTypeId,
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    lockedDefinition: RevReferenceableDataSourceDefinition<
        TableRecordSourceDefinitionTypeId,
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >,
    index: number,
): RevReferenceableDataSource<
    Badness,
    TableRecordSourceDefinitionTypeId,
    TableFieldSourceDefinitionTypeId,
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>
Type Parameters
- Badness
- TableRecordSourceDefinitionTypeId
- TableFieldSourceDefinitionTypeId
- TextFormattableValueTypeId
- TextFormattableValueAttributeTypeId
Parameters
- referenceableColumnLayouts: undefined | RevReferenceableColumnLayouts
- tableFieldSourceDefinitionFactory: RevTableFieldSourceDefinitionFactory<
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >
- tableRecordSourceFactory: RevTableRecordSourceFactory<
      Badness,
      TableRecordSourceDefinitionTypeId,
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >
- lockedDefinition: RevReferenceableDataSourceDefinition<
      TableRecordSourceDefinitionTypeId,
      TableFieldSourceDefinitionTypeId,
      TextFormattableValueTypeId,
      TextFormattableValueAttributeTypeId,
  >
- index: number
Returns RevReferenceableDataSource<
    Badness,
    TableRecordSourceDefinitionTypeId,
    TableFieldSourceDefinitionTypeId,
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>
Overrides RevDataSource.constructor

Properties

`Readonly`id

id: string

index

index: number

`Readonly`mapKey

mapKey: string

`Readonly`name

name: string

`Readonly`upperCaseName

upperCaseName: string

Accessors

initialRowOrderDefinition

get initialRowOrderDefinition(): undefined | RevRecordRowOrderDefinition
Returns undefined | RevRecordRowOrderDefinition
Inherited from RevDataSource.initialRowOrderDefinition

lockCount

get lockCount(): number
Returns number
Implementation of LockOpenListItem.lockCount
Inherited from RevDataSource.lockCount

lockedColumnLayout

get lockedColumnLayout(): undefined | RevColumnLayout
Returns undefined | RevColumnLayout
Inherited from RevDataSource.lockedColumnLayout

lockedReferenceableColumnLayout

get lockedReferenceableColumnLayout(): undefined | RevReferenceableColumnLayout
Returns undefined | RevReferenceableColumnLayout
Inherited from RevDataSource.lockedReferenceableColumnLayout

lockedTableRecordSource

get lockedTableRecordSource(): | undefined
| RevTableRecordSource<
    Badness,
    TableRecordSourceDefinitionTypeId,
    TableFieldSourceDefinitionTypeId,
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>
Returns
    | undefined
    | RevTableRecordSource<
        Badness,
        TableRecordSourceDefinitionTypeId,
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >
Inherited from RevDataSource.lockedTableRecordSource

lockers

get lockers(): readonly NamedLocker[]
Returns readonly NamedLocker[]
Implementation of LockOpenListItem.lockers
Inherited from RevDataSource.lockers

openCount

get openCount(): number
Returns number
Implementation of LockOpenListItem.openCount
Inherited from RevDataSource.openCount

openers

get openers(): readonly NamedLocker[]
Returns readonly NamedLocker[]
Implementation of LockOpenListItem.openers
Inherited from RevDataSource.openers

table

get table(): | undefined
| RevTable<
    Badness,
    TableRecordSourceDefinitionTypeId,
    TableFieldSourceDefinitionTypeId,
    TextFormattableValueTypeId,
    TextFormattableValueAttributeTypeId,
>
Returns
    | undefined
    | RevTable<
        Badness,
        TableRecordSourceDefinitionTypeId,
        TableFieldSourceDefinitionTypeId,
        TextFormattableValueTypeId,
        TextFormattableValueAttributeTypeId,
    >
Inherited from RevDataSource.table

Methods

closeLocked

closeLocked(opener: NamedLocker): void
Parameters
- opener: NamedLocker
Returns void
Implementation of LockOpenListItem.closeLocked
Inherited from RevDataSource.closeLocked

isLocked

isLocked(ignoreOnlyLocker: undefined | NamedLocker): boolean
Parameters
- ignoreOnlyLocker: undefined | NamedLocker
Returns boolean
Implementation of LockOpenListItem.isLocked
Inherited from RevDataSource.isLocked

openLocked

openLocked(opener: NamedLocker): void
Parameters
- opener: NamedLocker
Returns void
Implementation of LockOpenListItem.openLocked
Inherited from RevDataSource.openLocked

subscribeColumnLayoutSetEvent

subscribeColumnLayoutSetEvent(handler: GridColumnSetEventHandler): number
Parameters
- handler: GridColumnSetEventHandler
Returns number
Inherited from RevDataSource.subscribeColumnLayoutSetEvent

tryLock

tryLock(
locker: NamedLocker,
): Promise<Result<void, RevDataSource.LockErrorIdPlusTryError>>
Parameters
- locker: NamedLocker
Returns Promise<Result<void, RevDataSource.LockErrorIdPlusTryError>>
Implementation of LockOpenListItem.tryLock
Inherited from RevDataSource.tryLock

tryOpenColumnLayoutOrReferenceDefinition

tryOpenColumnLayoutOrReferenceDefinition(
definition: RevColumnLayoutOrReferenceDefinition,
opener: NamedLocker,
): Promise<Result<void, RevColumnLayoutOrReference.LockErrorIdPlusTryError>>
Can only call if a DataSource is already opened
Parameters
- definition: RevColumnLayoutOrReferenceDefinition
- opener: NamedLocker
Returns Promise<Result<void, RevColumnLayoutOrReference.LockErrorIdPlusTryError>>
Inherited from RevDataSource.tryOpenColumnLayoutOrReferenceDefinition

unlock

unlock(locker: NamedLocker): void
Parameters
- locker: NamedLocker
Returns void
Implementation of LockOpenListItem.unlock
Inherited from RevDataSource.unlock

unsubscribeColumnLayoutSetEvent

unsubscribeColumnLayoutSetEvent(subscriptionId: SubscriptionId): void
Parameters
- subscriptionId: SubscriptionId
Returns void
Inherited from RevDataSource.unsubscribeColumnLayoutSetEvent

Class RevReferenceableDataSource<Badness, TableRecordSourceDefinitionTypeId, TableFieldSourceDefinitionTypeId, TextFormattableValueTypeId, TextFormattableValueAttributeTypeId>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RevReferenceableDataSource< Badness, TableRecordSourceDefinitionTypeId, TableFieldSourceDefinitionTypeId, TextFormattableValueTypeId, TextFormattableValueAttributeTypeId,>

Properties

Readonlyid

index

ReadonlymapKey

Readonlyname

ReadonlyupperCaseName

Accessors

initialRowOrderDefinition

Returns undefined | RevRecordRowOrderDefinition

lockCount

Returns number

lockedColumnLayout

Returns undefined | RevColumnLayout

lockedReferenceableColumnLayout

Returns undefined | RevReferenceableColumnLayout

lockedTableRecordSource

Returns | undefined | RevTableRecordSource< Badness, TableRecordSourceDefinitionTypeId, TableFieldSourceDefinitionTypeId, TextFormattableValueTypeId, TextFormattableValueAttributeTypeId, >

lockers

Returns readonly NamedLocker[]

openCount

Returns number

openers

Returns readonly NamedLocker[]

table

Returns | undefined | RevTable< Badness, TableRecordSourceDefinitionTypeId, TableFieldSourceDefinitionTypeId, TextFormattableValueTypeId, TextFormattableValueAttributeTypeId, >

Methods

closeLocked

Parameters

Returns void

createColumnLayoutOrReferenceDefinition

Returns RevColumnLayoutOrReferenceDefinition

createDefinition

Parameters

Returns RevReferenceableDataSourceDefinition< TableRecordSourceDefinitionTypeId, TableFieldSourceDefinitionTypeId, TextFormattableValueTypeId, TextFormattableValueAttributeTypeId,>

createTableRecordSourceDefinition

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

equals

Parameters

Returns boolean

isLocked

Parameters

Returns boolean

openLocked

Parameters

Returns void

subscribeColumnLayoutSetEvent

Parameters

Returns number

tryLock

Parameters

Returns Promise<Result<void, RevDataSource.LockErrorIdPlusTryError>>

tryOpenColumnLayoutOrReferenceDefinition

Parameters

Returns Promise<Result<void, RevColumnLayoutOrReference.LockErrorIdPlusTryError>>

unlock

Parameters

Returns void

unsubscribeColumnLayoutSetEvent

Parameters

Returns void

Settings

On This Page

Returns RevReferenceableDataSource<
Badness,
TableRecordSourceDefinitionTypeId,
TableFieldSourceDefinitionTypeId,
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>

`Readonly`id

`Readonly`mapKey

`Readonly`name

`Readonly`upperCaseName

Returns
| undefined
| RevTableRecordSource<
Badness,
TableRecordSourceDefinitionTypeId,
TableFieldSourceDefinitionTypeId,
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>

Returns
| undefined
| RevTable<
Badness,
TableRecordSourceDefinitionTypeId,
TableFieldSourceDefinitionTypeId,
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>

Returns RevReferenceableDataSourceDefinition<
TableRecordSourceDefinitionTypeId,
TableFieldSourceDefinitionTypeId,
TextFormattableValueTypeId,
TextFormattableValueAttributeTypeId,
>

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