---
title: "ItemProperties"
slug: "api/basket/types/itemproperties"
sidebar:
  order: 241
---

<a id="ref-8e471968f91d"></a>
<a id="ref-8e7aae346f0f"></a>
<a id="ref-d3d7e0fd88b1"></a>

## Synopsis

```text
struct ItemProperties {
    BItemId*                    itemId;
    BasketItemType*             itemType;
    boolean*                    visible;
    boolean*                    expanded;
    string*                     label;
    BItemId*                    setArticleId;
    TMRow[]                 tmRows,
    DisplayText tmDescription,
    string positionNumber
    FolderProperties*           folder;
    ArticleProperties*          article;
    SetArticleProperties setArticle,
    ComposableGeometryProperties composableGeometry;
    ComposableGeometryProperties[]  composableGeometries;
    TextItemProperties textItem;
}
```

See also: [BasketItemType](/pCon/configuratorOnline/specs/api/basket/types/basketitemtype#ref-5d3667cadff0), [TMRow](/pCon/configuratorOnline/specs/api/basket/types/tmrow#ref-9adb2cb6dec5), [`DisplayText`](/pCon/configuratorOnline/specs/api/basket/types/displaytext-basket#ref-b19f0939e15a), [FolderProperties](/pCon/configuratorOnline/specs/api/basket/types/folderproperties#ref-d11e577ce20b), [ArticleProperties](/pCon/configuratorOnline/specs/api/basket/types/articleproperties#ref-6e1bbaf707f1), [SetArticleProperties](/pCon/configuratorOnline/specs/api/basket/types/setarticleproperties#ref-d6b51e8209a7), [ComposableGeometryProperties](/pCon/configuratorOnline/specs/api/basket/types/composablegeometryproperties#ref-f7a3aa90fa8b), [TextItemProperties](/pCon/configuratorOnline/specs/api/basket/types/textitemproperties#ref-174eaffa7c93), [`BItemId`](/pCon/configuratorOnline/specs/api/basket/types/bitemid)

The `ItemProperties` structure is used as the return value of the `getItemProperties` (§[getItemProperties](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties#ref-0443d746c320)) operation and as an argument type of the `setItemProperties` (§[setItemProperties](/pCon/configuratorOnline/specs/api/basket/operations/setitemproperties#ref-34e417ae27ba)) operation. Each field of this structure (except the fields referencing another structure) corresponds to a basket item property.

**itemId**

This field holds the UUID identifying the item.

**itemType**

This field holds the type of this item. See §[BasketItemType](/pCon/configuratorOnline/specs/api/basket/types/basketitemtype#ref-5d3667cadff0) for a description of possible item types.

**visible**

This field indicates whether or not the item should be displayed in the article list. This field is not returned for item properties of view items.

**expanded**

If `false`, the article list should show children of this item as sub-positions. If `true`, children of this item should be displayed in place of this item (if `visible` is `false`), or as siblings following this item (if `visible` is `true`). This field is not returned for item properties of view items.

**label**

This field contains the label for this item (the short text of article items or the name of folder items). It returns the label as plain text, even if the text is stored as formatted text.

**setArticleId**

If this item is part of a set article (§[BasketItemType](/pCon/configuratorOnline/specs/api/basket/types/basketitemtype#ref-5d3667cadff0)), this field contains the item ID of the set article. Otherwise, it contains the null UUID (not a null reference).

**positionNumber**

This field is present if and only if operation [`getItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties) has been invoked for view items. The position number of the view’s top folder is an empty string. The position number of all other items consists of a dot-separated list of unsigned decimal numbers.

**folder**

When used with the [`getItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties) operation, this field contains a reference to an instance of the `FolderProperties` (§[FolderProperties](/pCon/configuratorOnline/specs/api/basket/types/folderproperties#ref-d11e577ce20b)) structure if the corresponding basket item is a folder, and a null reference otherwise. When used with the [`setItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/setitemproperties) operation, the value of this field is ignored if the item is not a folder item. If the item is a folder item, the field should contain a reference to an instance of `FolderProperties`.

**article**

When used with the [`getItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties) operation, this field contains a reference to an instance of the `ArticleProperties` (§[ArticleProperties](/pCon/configuratorOnline/specs/api/basket/types/articleproperties#ref-6e1bbaf707f1)) structure if the corresponding basket item is an article, and a null reference otherwise. When used with the [`setItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/setitemproperties) operation, the value of this field is ignored if the item is not an article item. If the item is an article item, the field should contain a reference to an instance of `ArticleProperties`.

**composableGeometry**

With the properties for composable geometry items, it is possible to compose individual item geometries into a composite geometry. To do so, the items must be added as parts to a set-article, the property `enabled` (§[ComposableGeometryProperties](/pCon/configuratorOnline/specs/api/basket/types/composablegeometryproperties#ref-d851b5472caf)) must be set to true, and the position and or rotation may be set. The order of these operations does not matter.

The ID of the set-article can then be used with the operations getGeneratedImage (§[getGeneratedImage](/pCon/configuratorOnline/specs/api/basket/operations/getgeneratedimage#ref-ac7e59acfb5c)) and `getExportedGeometry` (§[getExportedGeometry](/pCon/configuratorOnline/specs/api/basket/operations/getexportedgeometry#ref-4d342d6bc0bb)) to generate an image for or export the geometry of the whole set-article.

Right now, the only set-article parts that can be used in this way are basket main article items.

Note that the use of set-article items with the aforementioned operations implies some restrictions compared with ordinary article items:

- The Multi Content Picture export (or whatever MCP) means)  is not supported.

- The GFX geometry export does not allow export of OBX data.

- The effective value of the 3D export option `no2D` should be `true` as the OFML object composed for the set-article does not contain 2D geometries. If 2D geometries are to be exported, the export uses the GX hidden liner to produce 2D symbols, which may take some time.

  In particular, this means that `no2D=true` should be used for the DWG export. For all other exports allowing export of 2D geometries, the default value of this option is `true` anyway.

An empty string passed as item property `composableGeometry.geometry` of operation [`setItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/setitemproperties) resets the geometry assigned to user article items.

**composableGeometries**

This field is used instead of field `composableGeometry` if operation [`getItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties) is invoked for view items instead of basket items[^1].

**TextItem**

When used with the [`getItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties) operation, this field contains a reference to an instance of the `TextItemProperties` (§[TextItemProperties](/pCon/configuratorOnline/specs/api/basket/types/textitemproperties#ref-174eaffa7c93)) structure if the corresponding basket item is a text item, and a null reference otherwise. When used with the [`setItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/setitemproperties) operation, the value of this field is ignored if the item is not a text item. If the item is a text item, the field should contain a reference to an instance of `TextItemProperties`.

While it is not an error to call the [`setItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/setitemproperties) operation with an `ItemProperties` argument whose `folder` or `article` field (whichever corresponds the the item type) contains a null reference, such a call would be pointless as all the basket item properties corresponding to the other fields of the `ItemProperties` structure are read-only.

**`tmRows`**

possible empty list of item text rows, always empty if option `tmGetText` (§ [tmGetText](/pCon/configuratorOnline/specs/api/basket/operations/tmgettext#ref-6055be8d3652)) is false or missing, otherwise a list of all text rows, including those rows that do not have a text defined. If no entry is found for a language from the prioritized list of effective product data languages the fallback is the text stored for the undetermined language.

**tmDescription**

The text-manager generated article description, see option [`tmDescrMode`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties) for more information. If no entry is found for a language from the prioritized list of effective product data languages the fallback is the text stored for the undetermined language.

[^1]: Field `composableGeometry` cannot be used in this case because view items may reference multiple basket items. Therefore, it may be necessary to return more than one instance of `ComposableGeometryProperties` for a single view item.
