ProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedmProtectedasReturns true if this item represents an configurable OFML article.
Can be used to store runtime user/custom data. This data is not persistent. Use BasketService.setItemAppData() for persistent data.
Deletes the additional image with the given index and adjusts the index of the following images.
Fetches the user defined additional images if necessary and adds them to the cache.
If true the additional images of child items will be fetched too.
OptionalpShouldFetchCallback: (pItem: BasketItem) => boolean
Can be used to ignore certain items. The callback has to return false in this case.
Fetches the calculations if necessary and adds them to the cache.
If true the calculations of child items will be fetched too.
OptionalpShouldFetchCallback: (pItem: BasketItem) => boolean
Can be used to ignore certain items. The callback has to return false in this case.
If true the cached calculation will be returned even if the header calculation has changed in the meantime. Every condition which depends on a header condition may have a wrong/outdated value in this case. (default: false)
OptionalpPricingProcName: string
If defined the calculation for the given pricing procedure will be returned. Otherwise the default/active procedure will be used.
Fetches the comments if necessary and adds them to the cache.
If true the comments of child items will be fetched too.
OptionalpShouldFetchCallback: (pItem: BasketItem) => boolean
Can be used to ignore certain items. The callback has to return false in this case.
Fetches the external item numbers if necessary and adds them to the cache.
If true the item number of child items will be fetched too.
OptionalpShouldFetchCallback: (pItem: BasketItem) => boolean
Can be used to ignore certain items. The callback has to return false in this case.
Fetches the item properties if necessary and adds them to the cache.
If true the item properties of child items will be fetched too.
OptionalpShouldFetchCallback: (pItem: BasketItem) => boolean
Can be used to ignore certain items. The callback has to return false in this case.
Fetches the user defined images if necessary and adds them to the cache.
If true the user image of child items will be fetched too.
OptionalpShouldFetchCallback: (pItem: BasketItem) => boolean
Can be used to ignore certain items. The callback has to return false in this case.
Returns the active image for this item. If the user image is available the user image will be returned, otherwise the default image.
Returns the additional images for this item.
Note: undefined images should be handled as missing/broken images
Returns the additional images for this item from cache.
Note: undefined images should be handled as missing/broken images
Returns the cached item calculation.
If true the cached calculation will be returned even if the header calculation has changed in the meantime. Every condition which depends on a header condition may have a wrong/outdated value in this case. (default: false)
OptionalpPricingProcName: string
If defined the calculation for the given pricing procedure will be returned. Otherwise the default/active procedure will be used.
ProtectedgetReturns the item calculation.
If true the cached calculation will be returned even if the header calculation has changed in the meantime. Every condition which depends on a header condition may have a wrong/outdated value in this case. (default: false)
OptionalpPricingProcName: string
If defined the calculation for the given pricing procedure will be returned. Otherwise the default/active procedure will be used.
Returns the default image for this item. e.g. the generated image of an article
Returns if this item is marked as alternative or optional for the currently active pricing procedure. Returns undefined if the state is unknown or its an unsupported item. Undefined will be also returned if the ItemProperties are not available. get or fetchItemProperties() should be called before to ensure that they are available.
Note: The setArticleId which is part of the ItemProperties may not be up-to-date. Use this.item.setArticleId or this.getSetArticle() instead.
ProtectedgetOptionalpPPName: stringReturns the set if this item is part of a set.
Returns the user defined image.
ProtectedhandleProtectedinternalProtectedinvalidateOptionalpPricingProcName: stringOptionalpPricingProcName: stringReturns true if this item is excluded from the calculations for the currently active pricing procedure (e.g. its an alternative or optional item). Returns undefined if the state is unknown or its an unsupported item. Undefined will be also returned if the ItemProperties are not available. get or fetchItemProperties() should be called before to ensure that they are available.
Moves an additional image to a new position while adjusting the position of the other images.
Note: As a special case -1 can be used as index to address the UserImage.
ProtectedperformOptionalpOptions: ItemUpdateOptionsProtectedregisterSets an additional user defined image of this item.
Index of the image to set (range: [0,9])
Url of the image (supported formats: jpg and png). If pImportIntoSession is true this url has to
be an HTTP URL previously returned by the getUploadURL() eaiws operation and has to include a file extension.
If true the image will be imported into session, and thus will be embedded inside the obk. (default: true)
Note: Setting the url to null or empty will not delete the image its just set to null. Use deleteAdditionalImage function instead.
Sets comments for this item.
Sets the external item number of this item.
ProtectedsetSets the value of a text manager text row with the given id.
Id of the text manager text
New value of the text
OptionalpLanguage: string
Which language to set. If undefined the current primary project language will be used.
OptionalpFormat: TextFormat
Format of the text. If undefined Plain will be used.
Sets the user defined image of this item.
Url of the image (supported formats: jpg and png). If pImportIntoSession is true this url has to
be an HTTP URL previously returned by the getUploadURL() eaiws operation and has to include a file extension.
Null or an empty string can be used to remove the current user image.
If true the image will be imported into session, and thus will be embedded inside the obk. (default: true)
OptionalpOptions: ItemUpdateOptionsProtected StaticBuildOptionalpFormat: TextFormat
Index of this item inside the children array of its parent.