Class CardRow

Строка коллекционной или древовидной секции.

Hierarchy (View Summary)

FieldStorageMap
- CardRow

Implements

Constructors

constructor

new CardRow(storage?: IStorage): CardRow
Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.
Parameters
- storage: IStorage = {}
  Хранилище, декоратором для которого является создаваемый объект.
Returns CardRow
Overrides FieldStorageMap.constructor
- Defined in @tessa/platform/src/cards/cardRow.ts:55

Properties - Other

`Readonly`[toStringTag]

"[toStringTag]": "Map" = 'Map'

`Readonly`fieldChanged

fieldChanged: EventHandler<FieldStorageMapChangedEventArgs, CardRow>

Событие, вызываемое при добавлении/удалении объектов в хранилище.

Remarks

Событие не будет вызвано при изменении внутреннего хранилища напрямую. Например через getStorage.

`Readonly`stateChanged

stateChanged: EventHandler<CardRowStateChangedEventArgs, CardRow>

Событие, возникающее при изменении состояния строки state.

Properties - Static Keys

`Static` `Readonly`parentRowIdKey

parentRowIdKey: "ParentRowID" = 'ParentRowID'

`Static` `Readonly`rowIdKey

rowIdKey: "RowID" = 'RowID'

`Static` `Readonly`systemChangedKey

systemChangedKey: string = ...

`Static` `Readonly`systemSortingOrderKey

systemSortingOrderKey: string = ...

`Static` `Readonly`systemStateKey

systemStateKey: string = ...

Accessors

parentRowId

get parentRowId(): null | string
Идентификатор родительской строки в древовидной секции.

Returns null | string
- Defined in @tessa/platform/src/cards/cardRow.ts:102
set parentRowId(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in @tessa/platform/src/cards/cardRow.ts:105

rowId

get rowId(): string
Идентификатор строки.

Returns string
- Defined in @tessa/platform/src/cards/cardRow.ts:92
set rowId(value: string): void
Parameters
- value: string
Returns void
- Defined in @tessa/platform/src/cards/cardRow.ts:95

size

get size(): number
Количество пар ключ/значение в хранилище.

Returns number
Inherited from FieldStorageMap.size
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:83

sortingOrder

get sortingOrder(): number
Порядок строки при сортировке строк для вставки, задаваемый вручную при указании типа сортировки CardRowSortingType.Manual для секции. Порядок строк при удалении будет обратным.

Returns number
Remarks
Значение по умолчанию 0 возвращается даже в том случае, если объект с соответствующим ключом отсутствует в хранилище.
- Defined in @tessa/platform/src/cards/cardRow.ts:137
set sortingOrder(value: number): void
Parameters
- value: number
Returns void
- Defined in @tessa/platform/src/cards/cardRow.ts:140

state

get state(): CardRowState
Состояние строки.

Returns CardRowState
Remarks
Значение по умолчанию CardRowState.None возвращается даже в том случае, если объект с соответствующим ключом отсутствует в хранилище.
- Defined in @tessa/platform/src/cards/cardRow.ts:115
set state(value: CardRowState): void
Parameters
- value: CardRowState
Returns void
- Defined in @tessa/platform/src/cards/cardRow.ts:118

Methods

[iterator]

"[iterator]"<T extends null | Primitive = Primitive>(): MapIterator<[string, T]>
Итератор по парам ключ/значение в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Returns MapIterator<[string, T]>
Inherited from FieldStorageMap.[iterator]
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:544

clean

clean(): void
Выполняет очистку хранилища от избыточных данных.

Returns void
Implementation of IStorageCleanable.clean
- Defined in @tessa/platform/src/cards/cardRow.ts:430

clear

clear(): void
Удаляет все значения из хранилища.

Returns void
Inherited from FieldStorageMap.clear
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:481

clearChanges

clearChanges(): IStorageObjectStateProvider
Удаляет всю информацию об изменённых объектах.

Returns IStorageObjectStateProvider
Текущий объект для цепочки вызовов.
Implementation of IStorageObjectStateProvider.clearChanges
- Defined in @tessa/platform/src/cards/cardRow.ts:421

clone

clone(): CardRow
Создает новый объект, который является копией текущего экземпляра.

Returns CardRow
Implementation of ICloneable.clone
Overrides FieldStorageMap.clone
- Defined in @tessa/platform/src/cards/cardRow.ts:447

delete

delete(key: string): boolean
Удаляет значение из хранилища по ключу.
Parameters
- key: string
  Ключ, по которому требуется удалить значение.
Returns boolean
true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.
Inherited from FieldStorageMap.delete
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:445

ensureCacheResolved

ensureCacheResolved(): void
Выполняет резолв кеша декораторов для данных объекта-хранилища.

Returns void
Inherited from FieldStorageMap.ensureCacheResolved
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:710

entries

entries<T extends null | Primitive = Primitive>(): MapIterator<[string, T]>
Итератор по парам ключ/значение в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Returns MapIterator<[string, T]>
Inherited from FieldStorageMap.entries
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:551

entryFields

entryFields<T extends null | TypedField = TypedField>(): MapIterator<
[string, T],
>
Итератор по парам ключ/поле в хранилище.
Type Parameters
- T extends null | TypedField = TypedField
Returns MapIterator<[string, T]>
Inherited from FieldStorageMap.entryFields
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:577

fields

fields<T extends null | TypedField = TypedField>(): MapIterator<T>
Итератор по полям в хранилище.
Type Parameters
- T extends null | TypedField = TypedField
Returns MapIterator<T>
Inherited from FieldStorageMap.fields
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:656

forEach

forEach<T extends null | Primitive = Primitive>(
callbackfn: (value: T, key: string, map: this) => void,
thisArg?: unknown,
): void
Вызывает колбек-функцию для каждого значения в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- callbackfn: (value: T, key: string, map: this) => void
  Колбек-функция, вызываемая для каждого объекта в хранилище. Ключ и значение передаются в качестве параметров.
- OptionalthisArg: unknown
  Объект контекста вызова функции-колбека.
Returns void
Inherited from FieldStorageMap.forEach
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:515

forEachFields

forEachFields<T extends null | TypedField = TypedField>(
callbackfn: (value: null | T, key: string, map: this) => void,
thisArg?: unknown,
): void
Вызывает колбек-функцию для каждого поля в хранилище.
Type Parameters
- T extends null | TypedField = TypedField
Parameters
- callbackfn: (value: null | T, key: string, map: this) => void
  Колбек-функция, вызываемая для каждого поля в хранилище. Ключ и поле передаются в качестве параметров.
- OptionalthisArg: unknown
  Объект контекста вызова функции-колбека.
Returns void
Inherited from FieldStorageMap.forEachFields
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:531

get

get<T extends undefined | null | Primitive = Primitive>(
key: string,
type?: FieldType,
): null | T
Возвращает значение, полученное по ключу key.
Type Parameters
- T extends undefined | null | Primitive = Primitive
Parameters
- key: string
  Ключ, по которому требуется найти значение.
- Optionaltype: FieldType
Returns null | T
Значение, полученное по ключу key.

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Inherited from FieldStorageMap.get
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:220

getAllChanges

getAllChanges(): string[]
Возвращает коллекцию ключей всех объектов, значения которых были изменены.

Returns string[]
Коллекция ключей всех объектов, значения которых были изменены.
Implementation of IStorageObjectStateProvider.getAllChanges
- Defined in @tessa/platform/src/cards/cardRow.ts:393

getBoolean

getBoolean(key: string): null | boolean
Возвращает значение, полученное по ключу key или null если значение не boolean.
Parameters
- key: string
  Ключ, по которому требуется найти значение.
Returns null | boolean
Значение, полученное по ключу key.

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Inherited from FieldStorageMap.getBoolean
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:250

getField

getField<T extends undefined | null | TypedField = TypedField>(
key: string,
): null | T
Возвращает поле, полученное по ключу key.
Type Parameters
- T extends undefined | null | TypedField = TypedField
Parameters
- key: string
  Ключ, по которому требуется найти поле.
Returns null | T
Поле, полученное по ключу key.

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Inherited from FieldStorageMap.getField
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:323

getNumber

getNumber(key: string): null | number
Возвращает значение, полученное по ключу key или null если значение не number.
Parameters
- key: string
  Ключ, по которому требуется найти значение.
Returns null | number
Значение, полученное по ключу key.

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Inherited from FieldStorageMap.getNumber
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:240

getStorage

getStorage(): IStorage
Возвращает хранилище IStorage, декоратором для которого является текущий объект.

Returns IStorage
Хранилище IStorage, декоратором для которого является текущий объект.
Inherited from FieldStorageMap.getStorage
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:694

getString

getString(key: string): null | string
Возвращает значение, полученное по ключу key или null если значение не string.
Parameters
- key: string
  Ключ, по которому требуется найти значение.
Returns null | string
Значение, полученное по ключу key.

Remarks
При отсутствии объекта в хранилище будет выброшено исключение.
Inherited from FieldStorageMap.getString
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:230

has

has(key: string): boolean
Проверяет наличие заданного ключа в хранилище.
Parameters
- key: string
  Ключ, наличие которого требуется проверить.
Returns boolean
true, если заданный ключ присутствует в коллекции; false в противном случае.
Inherited from FieldStorageMap.has
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:360

hasChanges

hasChanges(tableType?: CardTableType): boolean
Возвращает признак того, что объект содержит изменённые поля.
Parameters
- tableType: CardTableType = CardTableType.Unspecified
  Тип секции, в которую включена строка.
Returns boolean
true, если объект содержит изменённые поля; false в противном случае.

Remarks
Метод вернёт false в случае, если среди изменённых полей присутствуют только служебные поля. Метод не учитывает состояние строки state.
Implementation of IStorageObjectStateProvider.hasChanges
- Defined in @tessa/platform/src/cards/cardRow.ts:405

init

init(
stateProvider?: IStorageObjectStateProvider,
changedAction?: VoidFunction,
): void
Инициализирует хранилище.
Parameters
- OptionalstateProvider: IStorageObjectStateProvider
  Объект, предоставляющий информацию о наличии изменений в значениях объектов хранилища.
- OptionalchangedAction: VoidFunction
  Колбек-функция, вызываемая при изменении объекта-хранилища.
Returns void
Inherited from FieldStorageMap.init
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:207

isChanged

isChanged(key: string): boolean
Возвращает признак того, что значение объекта с ключом key было изменено.
Parameters
- key: string
  Ключ, по которому необходимо определить признак того, что значение соответствующего объекта было изменено.
Returns boolean
true, если значение объекта было изменено; false, если значение объекта осталось неизменным.
Implementation of IStorageObjectStateProvider.isChanged
- Defined in @tessa/platform/src/cards/cardRow.ts:381

keys

keys(): MapIterator<string>
Итератор по ключам в хранилище.

Returns MapIterator<string>
Inherited from FieldStorageMap.keys
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:603

notifyStorageUpdated

notifyStorageUpdated(): void
Метод, уведомляющий объект о наличии изменений в его хранилище.

Returns void
Implementation of IStorageNotificationReceiver.notifyStorageUpdated
Overrides FieldStorageMap.notifyStorageUpdated
- Defined in @tessa/platform/src/cards/cardRow.ts:370

rawSet

rawSet<T extends null | Primitive = Primitive>(
    key: string,
    value: null | T | TypedFieldFromValue<NonNullable<T>>,
    type?: FieldTypeFromJsType<NonNullable<T>>,
): this
Устанавливает значение по ключу. При этом не будут вызваны никакие уведомления об изменении.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- key: string
  Ключ, по которому устанавливается значение.
- value: null | T | TypedFieldFromValue<NonNullable<T>>
  Значение или типизированное поле.
- Optionaltype: FieldTypeFromJsType<NonNullable<T>>
  Тип значения.
Returns this
Возвращает ссылку на объект хранилище.
Inherited from FieldStorageMap.rawSet
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:400

remove

remove(key: string): boolean
Удаляет значение из хранилища по ключу.
Parameters
- key: string
  Ключ, по которому требуется удалить значение.
Returns boolean
true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.

Remarks
Аналогичен методу delete.
Inherited from FieldStorageMap.remove
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:474

removeAllButChanged

removeAllButChanged(tableType: CardTableType): void
Удаляет информацию о всех полях строки, которые не были изменены посредством IStorageObjectStateProvider и не являются служебными.
Parameters
- tableType: CardTableType
  Тип коллекционной или древовидной секции карточки, в которую включена строка.
Returns void
Remarks
Метод удаляет информацию об изменённых полях, поэтому повторный его вызов приведёт к удалению всех полей. Метод не удаляет поля rowId и state для любой секции, а также parentRowId для древовидной секции. Метод удаляет всю информацию, кроме служебной, о строках, у которых state равен CardRowState.Deleted, и не удаляет информацию у строк CardRowState.Inserted. Рекомендуется вызывать этот метод перед вызовом clean.
- Defined in @tessa/platform/src/cards/cardRow.ts:327

removeChanges

removeChanges(
tableType: CardTableType,
deletedHandling?: CardRemoveChangesDeletedHandling,
): boolean
Выполняет удаление информации по состояниям, из которой можно было бы определить, что строка изменена. Возвращает признак того, что при этом были внесены изменения.
Parameters
- tableType: CardTableType
  Тип секции, в которую включена строка.
- deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone
  Способ обработки удалённых строк, файлов и заданий.
Returns boolean
true, если в процессе удаления были внесены изменения; false в противном случае.
- Defined in @tessa/platform/src/cards/cardRow.ts:258

set

set<T extends null | Primitive = Primitive>(
    key: string,
    value: null | T | TypedFieldFromValue<NonNullable<T>>,
    type?: FieldTypeFromJsType<NonNullable<T>>,
): this
Устанавливает значение по ключу.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- key: string
  Ключ, по которому устанавливается значение.
- value: null | T | TypedFieldFromValue<NonNullable<T>>
  Значение, которое устанавливается в хранилище.
- Optionaltype: FieldTypeFromJsType<NonNullable<T>>
Returns this
Возвращает ссылку на объект хранилище.
Inherited from FieldStorageMap.set
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:375

setChanged

setChanged(key: string, isChanged: boolean): IStorageObjectStateProvider
Устанавливает признак isChanged, определяющий, было ли изменено значение объекта с ключом key.
Parameters
- key: string
  Ключ, по которому необходимо установить признак наличия изменений в значении объекта.
- isChanged: boolean
  Устанавливаемый признак наличия изменений в значении объекта с заданным ключом. Равен true, если значение объекта считается изменённым; false, если значение объекта считается неизменным.
Returns IStorageObjectStateProvider
Текущий объект для цепочки вызовов.
Implementation of IStorageObjectStateProvider.setChanged
- Defined in @tessa/platform/src/cards/cardRow.ts:385

setFrom

setFrom(row: CardRow): void
Создаёт полную копию хранилища заданной строки в текущей строке. При этом удаляются все поля и служебная информация из текущей строки, после чего она копируется из заданной.

Подписчики на события и другая информация, не являющаяся частью хранилища текущего объекта, остаётся неизменной.
Parameters
- row: CardRow
  Строка, из которой производится копирование полей и служебной информации.
Returns void
- Defined in @tessa/platform/src/cards/cardRow.ts:236

setStorage

setStorage(row: CardRow): void
Устанавливает хранилище объекта в соответствии с переданной коллекцией ключ / значение.
Parameters
- row: CardRow
  Строка, используемая в качестве хранилища данных.
Returns void
- Defined in @tessa/platform/src/cards/cardRow.ts:212

systemSet

systemSet<T extends null | Primitive = Primitive>(
    key: string,
    value: null | T | TypedFieldFromValue<NonNullable<T>>,
    type?: FieldTypeFromJsType<NonNullable<T>>,
): this
Устанавливает значение по ключу. При этом не будут вызваны уведомления о изменении состояния через IStorageObjectStateProvider.
Type Parameters
- T extends null | Primitive = Primitive
Parameters
- key: string
  Ключ, по которому устанавливается значение.
- value: null | T | TypedFieldFromValue<NonNullable<T>>
  Значение или типизированное поле.
- Optionaltype: FieldTypeFromJsType<NonNullable<T>>
  Тип значения.
Returns this
Возвращает ссылку на объект хранилище.
Inherited from FieldStorageMap.systemSet
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:423

tryGet

tryGet<T extends undefined | null | Primitive = Primitive>(
key: string,
type?: FieldType,
): null | T
Возвращает значение, полученное по ключу key, или null, если значение отсутствует.
Type Parameters
- T extends undefined | null | Primitive = Primitive
Parameters
- key: string
  Ключ, по которому требуется найти значение.
- Optionaltype: FieldType
Returns null | T
Значение, полученное по ключу key, или null, если значение отсутствует.
Inherited from FieldStorageMap.tryGet
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:261

tryGetBoolean

tryGetBoolean(key: string): null | boolean
Возвращает значение, полученное по ключу key, или null если значение не boolean или значение отсутствует.
Parameters
- key: string
  Ключ, по которому требуется найти значение.
Returns null | boolean
Значение, полученное по ключу key, или null, если значение отсутствует.
Inherited from FieldStorageMap.tryGetBoolean
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:305

tryGetField

tryGetField<T extends undefined | null | TypedField = TypedField>(
key: string,
): null | T
Возвращает поле, полученное по ключу key, или undefined, если поле отсутствует.
Type Parameters
- T extends undefined | null | TypedField = TypedField
Parameters
- key: string
  Ключ, по которому требуется найти поле.
Returns null | T
Поле, полученное по ключу key, или undefined, если поле отсутствует.
Inherited from FieldStorageMap.tryGetField
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:343

tryGetNumber

tryGetNumber(key: string): null | number
Возвращает значение, полученное по ключу key, или null если значение не number или значение отсутствует.
Parameters
- key: string
  Ключ, по которому требуется найти значение.
Returns null | number
Значение, полученное по ключу key, или null, если значение отсутствует.
Inherited from FieldStorageMap.tryGetNumber
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:291

tryGetParentRowId

tryGetParentRowId(): null | string
Возвращает идентификатор родительской строки parentRowId, если он присутствует в хранилище, или null в противном случае.

Returns null | string
Идентификатор родительской строки parentRowId, если он присутствует в хранилище, или null в противном случае.
- Defined in @tessa/platform/src/cards/cardRow.ts:168

tryGetRowId

tryGetRowId(): null | string
Возвращает идентификатор строки rowId, если он присутствует в хранилище, или null в противном случае.

Returns null | string
Идентификатор строки rowId, если он присутствует в хранилище, или null в противном случае.
- Defined in @tessa/platform/src/cards/cardRow.ts:154

tryGetSortingOrder

tryGetSortingOrder(): null | number
Возвращает порядок строки при сортировке строк для вставки или null, если порядок ещё не был указан.

Returns null | number
Порядок строки при сортировке строк для вставки или null, если порядок ещё не был указан.
- Defined in @tessa/platform/src/cards/cardRow.ts:196

tryGetState

tryGetState(): null | CardRowState
Возвращает состояние строки state, если оно присутствует в хранилище, или null в противном случае.

Returns null | CardRowState
Состояние строки state, если оно присутствует в хранилище, или null в противном случае.
- Defined in @tessa/platform/src/cards/cardRow.ts:182

tryGetString

tryGetString(key: string): null | string
Возвращает значение, полученное по ключу key, или null если значение не string или значение отсутствует.
Parameters
- key: string
  Ключ, по которому требуется найти значение.
Returns null | string
Значение, полученное по ключу key, или null, если значение отсутствует.
Inherited from FieldStorageMap.tryGetString
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:277

values

values<T extends null | Primitive = Primitive>(): MapIterator<T>
Итератор по значениям в хранилище.
Type Parameters
- T extends null | Primitive = Primitive
Returns MapIterator<T>
Inherited from FieldStorageMap.values
- Defined in @tessa/core/src/storage/fieldStorageMap.ts:630

`Static`getPlatformKeys

getPlatformKeys(tableType: CardTableType): string[]
Возвращает список системных ключей, используемых в объекте CardRow, в зависимости от типа коллекционной секции.
Parameters
- tableType: CardTableType
  Тип коллекционной секции.
Returns string[]
Список системных ключей.
- Defined in @tessa/platform/src/cards/cardRow.ts:309

Class CardRow

Hierarchy (View Summary)

Implements

Index

Constructors

Properties - Other

Properties - Static Keys

Accessors

Methods

Constructors

constructor

Parameters

Returns CardRow

Properties - Other

Readonly[toStringTag]

ReadonlyfieldChanged

Remarks

ReadonlystateChanged

Properties - Static Keys

Static ReadonlyparentRowIdKey

Static ReadonlyrowIdKey

Static ReadonlysystemChangedKey

Static ReadonlysystemSortingOrderKey

Static ReadonlysystemStateKey

Accessors

parentRowId

Returns null | string

Parameters

Returns void

rowId

Returns string

Parameters

Returns void

size

Returns number

sortingOrder

Returns number

Remarks

Parameters

Returns void

state

Returns CardRowState

Remarks

Parameters

Returns void

Methods

[iterator]

Type Parameters

Returns MapIterator<[string, T]>

clean

Returns void

clear

Returns void

clearChanges

Returns IStorageObjectStateProvider

clone

Returns CardRow

delete

Parameters

Returns boolean

ensureCacheResolved

Returns void

entries

Type Parameters

Returns MapIterator<[string, T]>

entryFields

Type Parameters

Returns MapIterator<[string, T]>

fields

Type Parameters

Returns MapIterator<T>

forEach

Type Parameters

Parameters

Returns void

forEachFields

Type Parameters

Parameters

Returns void

get

`Readonly`[toStringTag]

`Readonly`fieldChanged

`Readonly`stateChanged

`Static` `Readonly`parentRowIdKey

`Static` `Readonly`rowIdKey

`Static` `Readonly`systemChangedKey

`Static` `Readonly`systemSortingOrderKey

`Static` `Readonly`systemStateKey