Class CardRow

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

Hierarchy

Implements

Constructors

constructor

Properties - Other

[toStringTag] fieldChanged stateChanged

Properties - Static Keys

parentRowIdKey rowIdKey systemChangedKey systemSortingOrderKey systemStateKey

Accessors

parentRowId rowId size sortingOrder state

Methods

[iterator] clean clear clearChanges clone delete ensureCacheResolved entries entryFields fields forEach forEachFields get getAllChanges getBoolean getField getNumber getStorage getString has hasChanges init isChanged keys notifyStorageUpdated rawSet remove removeAllButChanged removeChanges set setChanged setFrom setStorage systemSet tryGet tryGetBoolean tryGetField tryGetNumber tryGetParentRowId tryGetRowId tryGetSortingOrder tryGetState tryGetString values getPlatformKeys

Constructors

constructor

  • Создаёт экземпляр класса с указанием хранилища, декоратором для которого является создаваемый объект.

    Parameters

    • storage: IStorage<unknown> = {}

      Хранилище, декоратором для которого является создаваемый объект.

    Returns CardRow

Other Properties

Readonly [toStringTag]

[toStringTag]: "Map" = 'Map'

Readonly fieldChanged

fieldChanged: EventHandler<FieldStorageMapChangedEventArgs, CardRow>

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

Remarks

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

Readonly stateChanged

stateChanged: EventHandler<CardRowStateChangedEventArgs, CardRow>

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

Static Keys Properties

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

  • set parentRowId(value: null | string): void

  • Parameters

    • value: null | string

    Returns void

rowId

  • get rowId(): string

  • Идентификатор строки.

    Returns string

  • set rowId(value: string): void

  • Parameters

    • value: string

    Returns void

size

  • get size(): number

  • Количество пар ключ/значение в хранилище.

    Returns number

sortingOrder

  • get sortingOrder(): number

  • Порядок строки при сортировке строк для вставки, задаваемый вручную при указании типа сортировки Manual для секции. Порядок строк при удалении будет обратным.

    Remarks

    Значение по умолчанию 0 возвращается даже в том случае, если объект с соответствующим ключом отсутствует в хранилище.

    Returns number

  • set sortingOrder(value: number): void

  • Parameters

    • value: number

    Returns void

state

  • get state(): CardRowState

  • Состояние строки.

    Remarks

    Значение по умолчанию None возвращается даже в том случае, если объект с соответствующим ключом отсутствует в хранилище.

    Returns CardRowState

  • set state(value: CardRowState): void

  • Parameters

    Returns void

Methods

[iterator]

  • [iterator]<T>(): IterableIterator<[string, T]>

  • Итератор по парам ключ/значение в хранилище.

    Type Parameters

    Returns IterableIterator<[string, T]>

clean

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

clear

  • Удаляет все значения из хранилища.

    Returns void

clearChanges

clone

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

    Returns CardRow

delete

  • Удаляет значение из хранилища по ключу.

    Returns

    true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.

    Parameters

    • key: string

      Ключ, по которому требуется удалить значение.

    Returns boolean

ensureCacheResolved

  • Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

entries

  • Итератор по парам ключ/значение в хранилище.

    Type Parameters

    Returns IterableIterator<[string, T]>

entryFields

  • Итератор по парам ключ/поле в хранилище.

    Type Parameters

    Returns IterableIterator<[string, T]>

fields

  • Итератор по полям в хранилище.

    Type Parameters

    Returns IterableIterator<T>

forEach

  • Вызывает колбек-функцию для каждого значения в хранилище.

    Type Parameters

    Parameters

    • callbackfn: ((value: T, key: string, map: CardRow) => void)

      Колбек-функция, вызываемая для каждого объекта в хранилище. Ключ и значение передаются в качестве параметров.

        • (value: T, key: string, map: CardRow): void

        • Parameters

          Returns void

    • Optional thisArg: unknown

      Объект контекста вызова функции-колбека.

    Returns void

forEachFields

  • Вызывает колбек-функцию для каждого поля в хранилище.

    Type Parameters

    Parameters

    • callbackfn: ((value: null | T, key: string, map: CardRow) => void)

      Колбек-функция, вызываемая для каждого поля в хранилище. Ключ и поле передаются в качестве параметров.

        • (value: null | T, key: string, map: CardRow): void

        • Parameters

          • value: null | T
          • key: string
          • map: CardRow

          Returns void

    • Optional thisArg: unknown

      Объект контекста вызова функции-колбека.

    Returns void

get

  • Возвращает значение, полученное по ключу key.

    Returns

    Значение, полученное по ключу key.

    Remarks

    При отсутствии объекта в хранилище будет выброшено исключение.

    Type Parameters

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    • Optional type: FieldType

    Returns null | T

getAllChanges

  • Возвращает коллекцию ключей всех объектов, значения которых были изменены.

    Returns

    Коллекция ключей всех объектов, значения которых были изменены.

    Returns string[]

getBoolean

  • Возвращает значение, полученное по ключу key или null если значение не boolean.

    Returns

    Значение, полученное по ключу key.

    Remarks

    При отсутствии объекта в хранилище будет выброшено исключение.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns null | boolean

getField

  • Возвращает поле, полученное по ключу key.

    Returns

    Поле, полученное по ключу key.

    Remarks

    При отсутствии объекта в хранилище будет выброшено исключение.

    Type Parameters

    Parameters

    • key: string

      Ключ, по которому требуется найти поле.

    Returns null | T

getNumber

  • Возвращает значение, полученное по ключу key или null если значение не number.

    Returns

    Значение, полученное по ключу key.

    Remarks

    При отсутствии объекта в хранилище будет выброшено исключение.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns null | number

getStorage

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

    Returns

    Хранилище IStorage, декоратором для которого является текущий объект.

    Returns IStorage<unknown>

getString

  • Возвращает значение, полученное по ключу key или null если значение не string.

    Returns

    Значение, полученное по ключу key.

    Remarks

    При отсутствии объекта в хранилище будет выброшено исключение.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns null | string

has

  • Проверяет наличие заданного ключа в хранилище.

    Returns

    true, если заданный ключ присутствует в коллекции; false в противном случае.

    Parameters

    • key: string

      Ключ, наличие которого требуется проверить.

    Returns boolean

hasChanges

  • Возвращает признак того, что объект содержит изменённые поля.

    Returns

    true, если объект содержит изменённые поля; false в противном случае.

    Remarks

    Метод вернёт false в случае, если среди изменённых полей присутствуют только служебные поля. Метод не учитывает состояние строки state.

    Parameters

    • tableType: CardTableType = CardTableType.Unspecified

      Тип секции, в которую включена строка.

    Returns boolean

init

  • Инициализирует хранилище.

    Parameters

    • Optional stateProvider: IStorageObjectStateProvider

      Объект, предоставляющий информацию о наличии изменений в значениях объектов хранилища.

    • Optional changedAction: VoidFunction

      Колбек-функция, вызываемая при изменении объекта-хранилища.

    Returns void

isChanged

  • Возвращает признак того, что значение объекта с ключом key было изменено.

    Returns

    true, если значение объекта было изменено; false, если значение объекта осталось неизменным.

    Parameters

    • key: string

      Ключ, по которому необходимо определить признак того, что значение соответствующего объекта было изменено.

    Returns boolean

keys

  • Итератор по ключам в хранилище.

    Returns IterableIterator<string>

notifyStorageUpdated

rawSet

  • Устанавливает значение по ключу. При этом не будут вызваны никакие уведомления об изменении.

    Returns

    Возвращает ссылку на объект хранилище.

    Type Parameters

    Parameters

    • key: string

      Ключ, по которому устанавливается значение.

    • value: null | T | TypedFieldFromValue<NonNullable<T>, FieldTypeFromJsType<NonNullable<T>>>

      Значение или типизированное поле.

    • Optional type: FieldTypeFromJsType<NonNullable<T>>

      Тип значения.

    Returns CardRow

remove

  • Удаляет значение из хранилища по ключу.

    Returns

    true, если значение было найдено и удалено из хранилища; false, если значение не удалось найти.

    Remarks

    Аналогичен методу delete.

    Parameters

    • key: string

      Ключ, по которому требуется удалить значение.

    Returns boolean

removeAllButChanged

  • Удаляет информацию о всех полях строки, которые не были изменены посредством IStorageObjectStateProvider и не являются служебными.

    Remarks

    Метод удаляет информацию об изменённых полях, поэтому повторный его вызов приведёт к удалению всех полей. Метод не удаляет поля rowId и state для любой секции, а также parentRowId для древовидной секции. Метод удаляет всю информацию, кроме служебной, о строках, у которых state равен Deleted, и не удаляет информацию у строк Inserted. Рекомендуется вызывать этот метод перед вызовом clean.

    Parameters

    • tableType: CardTableType

      Тип коллекционной или древовидной секции карточки, в которую включена строка.

    Returns void

removeChanges

  • Выполняет удаление информации по состояниям, из которой можно было бы определить, что строка изменена. Возвращает признак того, что при этом были внесены изменения.

    Returns

    true, если в процессе удаления были внесены изменения; false в противном случае.

    Parameters

    • tableType: CardTableType

      Тип секции, в которую включена строка.

    • deletedHandling: CardRemoveChangesDeletedHandling = CardRemoveChangesDeletedHandling.ResetToNone

      Способ обработки удалённых строк, файлов и заданий.

    Returns boolean

set

setChanged

  • Устанавливает признак isChanged, определяющий, было ли изменено значение объекта с ключом key.

    Returns

    Текущий объект для цепочки вызовов.

    Parameters

    • key: string

      Ключ, по которому необходимо установить признак наличия изменений в значении объекта.

    • isChanged: boolean

      Устанавливаемый признак наличия изменений в значении объекта с заданным ключом. Равен true, если значение объекта считается изменённым; false, если значение объекта считается неизменным.

    Returns IStorageObjectStateProvider

setFrom

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

    Подписчики на события и другая информация, не являющаяся частью хранилища текущего объекта, остаётся неизменной.

    Parameters

    • row: CardRow

      Строка, из которой производится копирование полей и служебной информации.

    Returns void

setStorage

  • Устанавливает хранилище объекта в соответствии с переданной коллекцией ключ / значение.

    Parameters

    • row: CardRow

      Строка, используемая в качестве хранилища данных.

    Returns void

systemSet

tryGet

  • Возвращает значение, полученное по ключу key, или null, если значение отсутствует.

    Returns

    Значение, полученное по ключу key, или null, если значение отсутствует.

    Type Parameters

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    • Optional type: FieldType

    Returns null | T

tryGetBoolean

  • Возвращает значение, полученное по ключу key, или null если значение не boolean или значение отсутствует.

    Returns

    Значение, полученное по ключу key, или null, если значение отсутствует.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns null | boolean

tryGetField

  • Возвращает поле, полученное по ключу key, или undefined, если поле отсутствует.

    Returns

    Поле, полученное по ключу key, или undefined, если поле отсутствует.

    Type Parameters

    Parameters

    • key: string

      Ключ, по которому требуется найти поле.

    Returns null | T

tryGetNumber

  • Возвращает значение, полученное по ключу key, или null если значение не number или значение отсутствует.

    Returns

    Значение, полученное по ключу key, или null, если значение отсутствует.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns null | number

tryGetParentRowId

  • Возвращает идентификатор родительской строки parentRowId, если он присутствует в хранилище, или null в противном случае.

    Returns

    Идентификатор родительской строки parentRowId, если он присутствует в хранилище, или null в противном случае.

    Returns null | string

tryGetRowId

  • Возвращает идентификатор строки rowId, если он присутствует в хранилище, или null в противном случае.

    Returns

    Идентификатор строки rowId, если он присутствует в хранилище, или null в противном случае.

    Returns null | string

tryGetSortingOrder

  • Возвращает порядок строки при сортировке строк для вставки или null, если порядок ещё не был указан.

    Returns

    Порядок строки при сортировке строк для вставки или null, если порядок ещё не был указан.

    Returns null | number

tryGetState

  • Возвращает состояние строки state, если оно присутствует в хранилище, или null в противном случае.

    Returns

    Состояние строки state, если оно присутствует в хранилище, или null в противном случае.

    Returns null | CardRowState

tryGetString

  • Возвращает значение, полученное по ключу key, или null если значение не string или значение отсутствует.

    Returns

    Значение, полученное по ключу key, или null, если значение отсутствует.

    Parameters

    • key: string

      Ключ, по которому требуется найти значение.

    Returns null | string

values

  • Итератор по значениям в хранилище.

    Type Parameters

    Returns IterableIterator<T>

Static getPlatformKeys

  • Возвращает список системных ключей, используемых в объекте CardRow, в зависимости от типа коллекционной секции.

    Returns

    Список системных ключей.

    Parameters

    • tableType: CardTableType

      Тип коллекционной секции.

    Returns string[]

Generated using TypeDoc