Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AttributeDefinition

Defines the datatype, entity and other parameters of an attribute with a specific K value.

Hierarchy

  • AttributeDefinition

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    • key: number

      An unsigned short to identify the attribute.

    • description: string

      An unlocalized description text of the attribute.

    • dataType: AttributeType

      The datatype of the values of the attribute.

    • entityType: ConfigurationEntity

      The entity type this attribute belongs to.

    • catalogId: string | undefined

      The id of the Catalog that is used by this attribute.

    Returns AttributeDefinition

Properties

catalogId

catalogId: string | undefined

In case the dataType is catalog, this field contains the id of the Catalog that is used by this attribute. You can pass the id or the whole attribute definition into a CatalogCollection to get the Catalog.

dataType

dataType: AttributeType

The datatype of the values of the attribute.

description

description: string

An unlocalized description text of the attribute.

entityType

entityType: ConfigurationEntity

The entity type this attribute belongs to.

key

key: number

An unsigned short to identify the attribute.

Generated using TypeDoc