Class RevReferenceableColumnLayout

Readonlyid

index

ReadonlymapKey

columnCount

• get columnCount(): number

  Returns number

columns

• get columns(): readonly RevColumnLayout.Column[]

  Returns readonly RevColumnLayout.Column[]

lockCount

• get lockCount(): number

  Returns number

lockers

• get lockers(): readonly NamedLocker[]

  Returns readonly NamedLocker[]

openCount

• get openCount(): number

  Returns number

openers

• get openers(): readonly NamedLocker[]

  Returns readonly NamedLocker[]

addColumn

• addColumn(
      initiator: ChangeInitiator,
      columnOrName: string | RevColumnLayoutDefinition.Column,
  ): void

  Parameters

  • initiator: ChangeInitiator
  • columnOrName: string | RevColumnLayoutDefinition.Column

  Returns void

addColumns

• addColumns(
      initiator: ChangeInitiator,
      columnsNames: (string | RevColumnLayoutDefinition.Column)[],
  ): void

  Parameters

  • initiator: ChangeInitiator
  • columnsNames: (string | RevColumnLayoutDefinition.Column)[]

  Returns void

applyDefinition

• applyDefinition(
      initiator: ChangeInitiator,
      definition: RevColumnLayoutDefinition,
  ): void

  Parameters

  • initiator: ChangeInitiator
  • definition: RevColumnLayoutDefinition

  Returns void

beginChange

• beginChange(initiator: ChangeInitiator): void

  Parameters

  • initiator: ChangeInitiator

  Returns void

clearColumns

• clearColumns(initiator: ChangeInitiator): void

  Parameters

  • initiator: ChangeInitiator

  Returns void

closeLocked

• closeLocked(opener: NamedLocker): void

  Parameters

  • opener: NamedLocker

  Returns void

createCopy

• createCopy(): RevColumnLayout

  Returns RevColumnLayout

endChange

• endChange(): void

  Returns void

equals

• equals(other: RevColumnLayout): boolean

  Parameters

  • other: RevColumnLayout

  Returns boolean

findColumn

• findColumn(fieldName: string): undefined | RevColumnLayout.Column

  Parameters

  • fieldName: string

  Returns undefined | RevColumnLayout.Column

getColumn

• getColumn(columnIndex: number): RevColumnLayout.Column

  Parameters

  • columnIndex: number

  Returns RevColumnLayout.Column

indexOfColumn

• indexOfColumn(column: RevColumnLayout.Column): number

  Parameters

  • column: RevColumnLayout.Column

  Returns number

indexOfColumnByFieldName

• indexOfColumnByFieldName(fieldName: string): number

  Parameters

  • fieldName: string

  Returns number

insertColumns

• insertColumns(
      initiator: ChangeInitiator,
      index: number,
      columnOrFieldNames: (string | RevColumnLayoutDefinition.Column)[],
  ): void

  Parameters

  • initiator: ChangeInitiator
  • index: number
  • columnOrFieldNames: (string | RevColumnLayoutDefinition.Column)[]

  Returns void

isLocked

• isLocked(ignoreOnlyLocker: undefined | NamedLocker): boolean

  Parameters

  • ignoreOnlyLocker: undefined | NamedLocker

  Returns boolean

moveColumn

• moveColumn(
      initiator: ChangeInitiator,
      fromColumnIndex: number,
      toColumnIndex: number,
  ): boolean

  Parameters

  • initiator: ChangeInitiator
  • fromColumnIndex: number
  • toColumnIndex: number

  Returns boolean

moveColumns

• moveColumns(
      initiator: ChangeInitiator,
      fromColumnIndex: number,
      toColumnIndex: number,
      count: number,
  ): boolean

  Parameters

  • initiator: ChangeInitiator
  • fromColumnIndex: number
  • toColumnIndex: number
  • count: number

  Returns boolean

openLocked

• openLocked(opener: NamedLocker): void

  Parameters

  • opener: NamedLocker

  Returns void

removeColumn

• removeColumn(initiator: ChangeInitiator, index: number): void

  Parameters

  • initiator: ChangeInitiator
  • index: number

  Returns void

removeColumns

• removeColumns(initiator: ChangeInitiator, index: number, count: number): void

  Parameters

  • initiator: ChangeInitiator
  • index: number
  • count: number

  Returns void

setColumns

• setColumns(
      initiator: ChangeInitiator,
      columns: readonly RevColumnLayout.Column[],
  ): void

  Parameters

  • initiator: ChangeInitiator
  • columns: readonly RevColumnLayout.Column[]

  Returns void

setColumnWidth

• setColumnWidth(
      initiator: ChangeInitiator,
      fieldName: string,
      width: undefined | number,
  ): void

  Parameters

  • initiator: ChangeInitiator
  • fieldName: string
  • width: undefined | number

  Returns void

subscribeChangedEvent

• subscribeChangedEvent(handler: RevColumnLayout.ChangedEventHandler): number

  Parameters

  • handler: RevColumnLayout.ChangedEventHandler

  Returns number

subscribeWidthsChangedEvent

• subscribeWidthsChangedEvent(handler: WidthsChangedEventHandler): number

  Parameters

  • handler: WidthsChangedEventHandler

  Returns number

tryLock

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

  Parameters

  • locker: NamedLocker

  Returns Promise<Result<void>>

unlock

• unlock(locker: NamedLocker): void

  Parameters

  • locker: NamedLocker

  Returns void

unsubscribeChangedEvent

• unsubscribeChangedEvent(subscriptionId: SubscriptionId): void

  Parameters

  • subscriptionId: SubscriptionId

  Returns void

unsubscribeWidthsChangedEvent

• unsubscribeWidthsChangedEvent(subscriptionId: SubscriptionId): void

  Parameters

  • subscriptionId: SubscriptionId

  Returns void