W-CF Documentation - v11.0.0
    Preparing search index...

    Class ViewSetArticleItem

    Hierarchy (View Summary)

    Index
    mActiveImageUrl: string | null | undefined
    mAdditionalImageUrls: (string | undefined)[] | undefined
    mCalculation: Map<string, CalculationSheetInfo | undefined> | undefined
    mCalculationHdrVersion: Map<string, number>
    mChildIndex: number
    mChildren: ViewItem[]
    mComments: string | null | undefined
    mExtItemNumber: string | null | undefined
    mImageUrl: string | null | undefined
    mIsDisposed: boolean
    mIsSelected: boolean
    mItem: BasketItem
    mItemNumber: string | undefined
    mItemNumberArray: number[] | undefined
    mItemProps: ItemProperties | undefined
    mManager: View
    mParent: ViewItem | null
    mUserData: GroupedMap
    mUserImageUrl: string | null | undefined
    • get childIndex(): number

      Index of this item inside the children array of its parent.

      Returns number

    • get children(): readonly T[]

      Returns readonly T[]

    • get id(): string

      Returns string

    • get isDisposed(): boolean

      Returns boolean

    • get isGroup(): boolean

      Returns boolean

    • get isOfmlArticle(): boolean

      Returns true if this item represents an configurable OFML article.

      Returns boolean

    • get isSelected(): boolean

      Returns boolean

    • get label(): string

      Returns string

    • get parent(): T | null

      Returns T | null

    • get userData(): GroupedMap

      Can be used to store runtime user/custom data. This data is not persistent. Use BasketService.setItemAppData() for persistent data.

      Returns GroupedMap

    • get view(): View

      Returns View

    • Fetches the user defined additional images if necessary and adds them to the cache.

      Parameters

      • pIncludeChildren: boolean

        If true the additional images of child items will be fetched too.

      • OptionalpShouldFetchCallback: (pItem: ViewItem) => boolean

        Can be used to ignore certain items. The callback has to return false in this case.

      Returns Promise<void>

    • Fetches the calculations if necessary and adds them to the cache.

      Parameters

      • pIncludeChildren: boolean

        If true the calculations of child items will be fetched too.

      • OptionalpShouldFetchCallback: (pItem: ViewItem) => boolean

        Can be used to ignore certain items. The callback has to return false in this case.

      • pIgnoreHeaderCalculation: boolean = false

        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 Promise<void>

    • Fetches the comments if necessary and adds them to the cache.

      Parameters

      • pIncludeChildren: boolean

        If true the comments of child items will be fetched too.

      • OptionalpShouldFetchCallback: (pItem: ViewItem) => boolean

        Can be used to ignore certain items. The callback has to return false in this case.

      Returns Promise<void>

    • Fetches the external item numbers if necessary and adds them to the cache.

      Parameters

      • pIncludeChildren: boolean

        If true the item number of child items will be fetched too.

      • OptionalpShouldFetchCallback: (pItem: ViewItem) => boolean

        Can be used to ignore certain items. The callback has to return false in this case.

      Returns Promise<void>

    • Fetches the item properties if necessary and adds them to the cache.

      Parameters

      • pIncludeChildren: boolean

        If true the item properties of child items will be fetched too.

      • OptionalpShouldFetchCallback: (pItem: ViewItem) => boolean

        Can be used to ignore certain items. The callback has to return false in this case.

      Returns Promise<void>

    • Fetches the user defined images if necessary and adds them to the cache.

      Parameters

      • pIncludeChildren: boolean

        If true the user image of child items will be fetched too.

      • OptionalpShouldFetchCallback: (pItem: ViewItem) => boolean

        Can be used to ignore certain items. The callback has to return false in this case.

      Returns Promise<void>

    • Returns the active image for this item. If the user image is available the user image will be returned, otherwise the default image.

      Returns Promise<string | null>

    • Returns the additional images for this item. Note: undefined images should be handled as missing/broken images

      Returns Promise<(string | undefined)[]>

    • Returns the additional images for this item from cache. Note: undefined images should be handled as missing/broken images

      Returns (string | undefined)[] | undefined

    • Returns the cached item calculation.

      Parameters

      • pIgnoreHeaderCalculation: boolean = false

        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 CalculationSheetInfo | undefined

    • Returns the item calculation.

      Parameters

      • pIgnoreHeaderCalculation: boolean = false

        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 Promise<CalculationSheetInfo>

    • Returns the default image for this item. e.g. the generated image of an article

      Returns Promise<string | null>

    • 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.

      Returns ItemInactiveState | undefined

    • Returns the user defined image.

      Returns Promise<string | null>

    • Parameters

      • pTriggerUpdateEvent: boolean
      • OptionalpPricingProcName: string

      Returns void

    • Returns 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.

      Returns boolean | undefined

    • Parameters

      • pProps: ItemProperties
      • pUpdateItem: boolean
      • pUpdateCalculation: boolean
      • pAdditionalUpdateFlags: number = 0

      Returns Promise<void>

    • Parameters

      • pQuantity: number

      Returns Promise<void>