Class CardMetadataSection

Содержит метаинформацию о секции.

Hierarchy

CardSerializableObject
- CardMetadataSection

Implements

ICardMetadataSection

Index

Constructors

constructor

new CardMetadataSection(id: string, name: string, sectionType: CardSectionType, tableType: SchemeTableContentType, order: number, flags: CardMetadataSectionFlags, cardTypeIdList: string[], group?: null | string): CardMetadataSection
Создаёт экземпляр класса с указанием свойств секции.
Parameters
- id: string
  
  Идентификатор создаваемой секции.
- name: string
  
  Имя создаваемой секции.
- sectionType: CardSectionType
  
  Тип создаваемой секции.
- tableType: SchemeTableContentType
  
  Тип таблицы для создаваемой секции.
- order: number
  
  Порядок сортировки создаваемой секции.
- flags: CardMetadataSectionFlags
  
  Флаги секции карточки.
- cardTypeIdList: string[]
  
  Список типов карточек.
- Optional group: null | string
  
  Наименование группы к которой относится секция.
Returns CardMetadataSection
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:38
new CardMetadataSection(section: ICardMetadataSection, columns?: null | ICardMetadataColumn[]): CardMetadataSection
Создаёт экземпляр класса с указанием копируемого объекта и списка колонок.
Parameters
- section: ICardMetadataSection
  
  Объект, для которого создаётся полная копия, за исключением списка колонок, если список колонок передается отдельно.
- Optional columns: null | ICardMetadataColumn[]
  
  Список колонок в секции.
Returns CardMetadataSection
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:54
new CardMetadataSection(): CardMetadataSection
Конструктор по умолчанию.

Returns CardMetadataSection
Overrides CardSerializableObject.constructor
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:58

Properties

flags

flags: CardMetadataSectionFlags

Флаги секции карточки.

group

group: null | string

Наименование группы к которой относится секция.

id

id: string

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

name

name: string

Имя секции.

order

order: number

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

sectionType

sectionType: CardSectionType

Тип секции.

tableType

tableType: SchemeTableContentType

Тип таблицы.

Accessors

cardTypeIdList

get cardTypeIdList(): string[]
Список идентификаторов типов карточек, в которых используется секция.

Returns string[]
Implementation of ICardMetadataSection.cardTypeIdList
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:159
set cardTypeIdList(value: string[]): void
Список идентификаторов типов карточек, в которых используется секция.
Parameters
- value: string[]
Returns void
Implementation of ICardMetadataSection.cardTypeIdList
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:162

columns

get columns(): ICardMetadataColumnArray<ICardMetadataColumn>
Колонки секции.

Returns ICardMetadataColumnArray<ICardMetadataColumn>
Implementation of ICardMetadataSection.columns
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:166
set columns(value: ICardMetadataColumnArray<ICardMetadataColumn>): void
Колонки секции.
Parameters
- value: ICardMetadataColumnArray<ICardMetadataColumn>
Returns void
Implementation of ICardMetadataSection.columns
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:169

isVirtual

get isVirtual(): boolean
Получает или задаёт признак того, что секция является виртуальной. Значение поля определяется флагом Virtual.

Returns boolean
Implementation of ICardMetadataSection.isVirtual
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:173
set isVirtual(value: boolean): void
Получает или задаёт признак того, что секция является виртуальной. Значение поля определяется флагом Virtual.
Parameters
- value: boolean
Returns void
Implementation of ICardMetadataSection.isVirtual
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:176

sectionTableType

get sectionTableType(): CardTableType
Тип таблицы, указываемый в свойстве секции CardSection.tableType. Зависит от свойств sectionType и tableType. При изменении значения этого свойства будут также изменены оба зависимых свойства, причём значение CardTableType.Unspecified недопустимо в качестве устанавливаемого.

Returns CardTableType
Implementation of ICardMetadataSection.sectionTableType
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:132
set sectionTableType(value: CardTableType): void
Тип таблицы, указываемый в свойстве секции CardSection.tableType. Зависит от свойств sectionType и tableType. При изменении значения этого свойства будут также изменены оба зависимых свойства, причём значение CardTableType.Unspecified недопустимо в качестве устанавливаемого.
Parameters
- value: CardTableType
Returns void
Implementation of ICardMetadataSection.sectionTableType
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:142

Methods

clone

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

Returns CardMetadataSection
Implementation of ICardMetadataSection.clone
- Defined in @tessa/platform/src/cards/metadata/cardMetadataSection.ts:238

deserializeFromStorage

deserializeFromStorage(storage: IStorage<unknown>, context?: StorageSerializableContext): CardMetadataSection
Parameters
- storage: IStorage<unknown>
- Optional context: StorageSerializableContext
Returns CardMetadataSection
Implementation of ICardMetadataSection.deserializeFromStorage

Inherited from CardSerializableObject.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:54

isSealed

isSealed(): boolean
Returns boolean
Implementation of ICardMetadataSection.isSealed

Inherited from CardSerializableObject.isSealed
- Defined in @tessa/core/src/serialization/storageSerializable.ts:102

seal

seal(): CardMetadataSection
Returns CardMetadataSection
Implementation of ICardMetadataSection.seal

Inherited from CardSerializableObject.seal
- Defined in @tessa/core/src/serialization/storageSerializable.ts:85

serializeToStorage

serializeToStorage(storage?: IStorage<unknown>, context?: StorageSerializableContext): IStorage<unknown>
Parameters
- storage: IStorage<unknown> = {}
- Optional context: StorageSerializableContext
Returns IStorage<unknown>
Implementation of ICardMetadataSection.serializeToStorage

Inherited from CardSerializableObject.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:44

Class CardMetadataSection

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

name: string

sectionType: CardSectionType

tableType: SchemeTableContentType

order: number

flags: CardMetadataSectionFlags

cardTypeIdList: string[]

Optional group: null | string

Returns CardMetadataSection

Parameters

section: ICardMetadataSection

Optional columns: null | ICardMetadataColumn[]

Returns CardMetadataSection

Returns CardMetadataSection

Properties

flags

group

id

name

order

sectionType

tableType

Accessors

cardTypeIdList

Returns string[]

Parameters

value: string[]

Returns void

columns

Returns ICardMetadataColumnArray<ICardMetadataColumn>

Parameters

value: ICardMetadataColumnArray<ICardMetadataColumn>

Returns void

isVirtual

Returns boolean

Parameters

value: boolean

Returns void

sectionTableType

Returns CardTableType

Parameters

value: CardTableType

Returns void

Methods

clone

Returns CardMetadataSection

deserializeFromStorage

Parameters

storage: IStorage<unknown>

Optional context: StorageSerializableContext

Returns CardMetadataSection

isSealed

Returns boolean

seal

Returns CardMetadataSection

serializeToStorage

Parameters

storage: IStorage<unknown> = {}

Optional context: StorageSerializableContext

Returns IStorage<unknown>

`Optional` group: null | string

`Optional` columns: null | ICardMetadataColumn[]

`Optional` context: StorageSerializableContext

`Optional` context: StorageSerializableContext