Class CardMetadataColumn

constructor

• new CardMetadataColumn(
      id: string,
      name: string,
      schemeType: SchemeType,
      columnType: CardMetadataColumnType,
      cardTypeIdList: string[],
      defaultValue: null | Primitive,
      defaultValidValue: null | Primitive,
      parentRowSection: null | ICardMetadataSectionReference,
      referencedSection: null | ICardMetadataSectionReference,
      complexColumnIndex: number,
      isReference: boolean,
      isVirtual?: boolean,
      normalizationSourceId?: null | string,
      normalizationRole?: CardMetadataNormalizationRole,
  ): CardMetadataColumn

  Создаёт экземпляр класса с указанием свойств колонки.

  Parameters

  • id: string

    Идентификатор создаваемой колонки.

  • name: string

    Имя создаваемой колонки.

  • schemeType: SchemeType

    Тип колонки из схемы.

  • columnType: CardMetadataColumnType

    Тип колонки.

  • cardTypeIdList: string[]

    Список типов карточек.

  • defaultValue: null | Primitive

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

  • defaultValidValue: null | Primitive

    Значение колонки по умолчанию, которое всегда является валидным при сохранении.

  • parentRowSection: null | ICardMetadataSectionReference

    Секция, на строку которой ссылается текущая колонка.

  • referencedSection: null | ICardMetadataSectionReference

    Секция, на которую ссылается комплексная колонка, или null, если колонка является физической.

  • complexColumnIndex: number

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

  • isReference: boolean

    Признак того, что колонка является ссылочной и входит во внешний ключ при его наличии. Значение актуально только для физических колонок.

  • OptionalisVirtual: boolean

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

  • OptionalnormalizationSourceId: null | string

    Идентификатор справочника нормализации для комплексных колонок или null, если комплексная колонка не участвует в нормализации (или это физическая колонка).

  • OptionalnormalizationRole: CardMetadataNormalizationRole

    Роль физической колонки при использовании со справочниками нормализации. Для комлексных колонок не указывается, т.е. равна CardMetadataNormalizationRole.None.

  Returns CardMetadataColumn

• new CardMetadataColumn(
      column: ICardMetadataColumn,
      cardTypeId?: null | string,
  ): CardMetadataColumn

  Создаёт экземпляр класса с указанием копируемого объекта и идентификатора типа карточек.

  Parameters

  • column: ICardMetadataColumn

    Объект, для которого создаётся полная копия, за исключением списка типов карточек, если список типов карточек передается отдельно.

  • OptionalcardTypeId: null | string

    Идентификатор типа карточки, который представлен как единственный для создаваемого объекта.

  Returns CardMetadataColumn

• new CardMetadataColumn(): CardMetadataColumn

  Конструктор по умолчанию.

  Returns CardMetadataColumn

columnType

complexColumnIndex

defaultValidValue

defaultValue

id

isReference

isVirtual

name

normalizationRole

normalizationSourceId

parentRowSection

referencedSection

cardTypeIdList

• get cardTypeIdList(): string[]

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

  Returns string[]

• set cardTypeIdList(value: string[]): void

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

  Parameters

  • value: string[]

  Returns void

metadataType

• get metadataType(): ICardMetadataType

  Тип данных, которые могут быть размещены в карточке.

  Returns ICardMetadataType

• set metadataType(value: ICardMetadataType): void

  Тип данных, которые могут быть размещены в карточке.

  Parameters

  • value: ICardMetadataType

  Returns void

clone

• clone(): CardMetadataColumn

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

  Returns CardMetadataColumn