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

    Class CalculationManager

    Index
    eventActivePricingProcedureChanged: ListenableEvent<void, CalculationManager> = ...

    Will be triggered if the active pricing procedure has changed.

    eventCurrencyChanged: ListenableEvent<void, CalculationManager> = ...

    Will be triggered if the currency has changed.

    eventExchangeRatesChanged: ListenableEvent<void, CalculationManager> = ...

    Will be triggered if the exchange rates have changed.

    eventTaxSchemeChanged: ListenableEvent<void, CalculationManager> = ...

    Will be triggered if the tax scheme has changed.

    • get activePricingProcedure(): string | null

      The name of the currently active pricing procedure.

      Returns string | null

    • get currency(): string

      Returns string

    • get defaultPricingProcedure(): string | null

      The name of the default pricing procedure.

      Returns string | null

    • Activates the pricing procedure with the given name. The pricing procedure will be added to the project if it was not added yet.

      Parameters

      • pPricingProcName: string

        name of the pricing procedure to activate

      • pMakeDefault: boolean = true

        if true the pricing procedure will be used as the default calculation fo the project (default: true)

      Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pCondType: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Adds a pricing procedure to the project if not already added.

      Parameters

      • pPricingProcName: string

        name of the pricing procedure to activate

      • pMakeDefault: boolean = true

        if true the pricing procedure will be used as the default calculation fo the project (default: true)

      Returns Promise<boolean>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pLevel: number
      • pCounter: number
      • pAmount: number
      • pCurrency: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pLevel: number
      • pCounter: number
      • pValue: number
      • pCurrency: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pCondType: string
      • pCounter: number
      • pValue: number
      • pCurrency: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Returns Promise<string>

    • Returns Promise<Map<string, number>>

    • Returns a group calculation for the given items. Note: Group calculations are not cached internally and will be requested everytime from EAIWS.

      Parameters

      • pItems: readonly BasketItem[]
      • OptionalpPPName: string

      Returns Promise<CalculationSheetInfo>

    • Returns the pricing procedure with the given name.

      Parameters

      • pPricingProcName: string

      Returns Promise<PricingProcedureInfo>

    • Returns Promise<string>

    • Returns Promise<string>

    • Can be used to trigger an update of the cached exchange rates. Calling this function is only necessary if the exchange rates were modified without using the provided functions of this class.

      Parameters

      • pReferenceCurrencyChanged: boolean

      Returns Promise<void>

    • Can be used to trigger an update of the cached tax scheme. Calling this function is only necessary if the tax scheme was modified/switched without using the provided functions of this class.

      Parameters

      • OptionalpNewTaxSchemeId: string

        Can be provided if the new tax scheme id is already known as a performance improvement.

      Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pCondType: string
      • pCounter: number
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pCondType: string
      • pCounter: number
      • OptionalpPPName: string

      Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pCondType: string
      • pCounter: number
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pType: string
      • pCategory: string

      Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pCondType: string
      • pCounter: number
      • pAmount: number
      • pCurrency: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pCondType: string
      • pLang: string | null
      • pDescription: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pCurrency: string

      Returns Promise<void>

    • Makes the provided pricing procedure the default for the current project.

      Parameters

      • pPricingProcName: string

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[]
      • pCondType: string
      • pCounter: number
      • pLang: string | null
      • pDescription: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pItems: readonly BasketItem[] | null
      • pCondType: string
      • pCounter: number
      • pAmount: number
      • pUnit: string
      • OptionalpPPName: string

      Returns Promise<void>

    • Parameters

      • pType: string
      • pCategory: string
      • pRate: number

      Returns Promise<void>

    • Parameters

      • pSchemeId: string

      Returns Promise<void>

    • Updates the default value of all conditions (in case it has changed) for the given items. If an amount was overridden manually, it will not be changed.

      Parameters

      Returns Promise<void>