pCon.basket - Plugin Development
    Preparing search index...

    Interface ApplicationSettings

    interface ApplicationSettings {
        browserStorage: SettingsStorage;
        calculation: Readonly<CalculationSettings>;
        catalog: Readonly<CatalogSettings>;
        contactSupportUrl: string | null;
        dataLanguage: readonly string[];
        defaults: Readonly<DefaultSettings>;
        eaiws: Readonly<EaiwsSettings>;
        errorReportEmailAddress: string;
        eventCalculationChanged: ListenableEvent<void, ApplicationSettings>;
        eventCatalogChanged: ListenableEvent<void, ApplicationSettings>;
        eventDataLanguageChanged: ListenableEvent<void, ApplicationSettings>;
        eventEaiwsChanged: ListenableEvent<void, ApplicationSettings>;
        eventLengthUnitChanged: ListenableEvent<void, ApplicationSettings>;
        eventLocaleChanged: ListenableEvent<void, ApplicationSettings>;
        eventOrderChanged: ListenableEvent<void, ApplicationSettings>;
        eventProjectEditorChanged: ListenableEvent<void, ApplicationSettings>;
        eventProjectValidityChanged: ListenableEvent<void, ApplicationSettings>;
        eventReportChanged: ListenableEvent<void, ApplicationSettings>;
        eventThemeChanged: ListenableEvent<void, ApplicationSettings>;
        inputFieldCharacterLimits: ReadonlyMap<InputField, number>;
        language: string;
        lengthUnit: LengthUnit;
        locale: string;
        order: Readonly<OrderSettings>;
        priceDateSupported: boolean;
        projectEditor: Readonly<ProjectEditorSettings>;
        projectValidity: string;
        report: Readonly<ReportSettings>;
        specialModelInfoTextId: string;
        supportedProjectStates: readonly ProjectState[];
        supportEmailAddress: string | null;
        theme: Readonly<ThemeSettings>;
        userStorage: AsyncSettingsStorage | null;
        webGL: Readonly<WebGLSettings>;
        setCalculation(pCalculation: Partial<CalculationSettings>): void;
        setCatalog(pCatalog: CatalogSettings): void;
        setContactSupportUrl(pUrl: string | null): void;
        setDataLanguage(pLanguage: readonly string[]): void;
        setEaiws(pEaiws: EaiwsSettings): void;
        setErrorReportEmailAddress(pAddress: string): void;
        setInputFieldCharacterLimits(pLimits: Map<InputField, number>): void;
        setOrder(pOrder: OrderSettings): void;
        setPriceDateSupported(pSupported: boolean): void;
        setProjectEditor(pProjectEditor: Partial<ProjectEditorSettings>): void;
        setProjectValidity(pValidity: string): void;
        setReport(pReport: ReportSettings): void;
        setSupportEmailAddress(pAddress: string | null): void;
        setTheme(pTheme: ThemeSettings): void;
    }
    Index
    browserStorage: SettingsStorage

    Settings storage which stores settings for the current browser. Note: This is a synchronous api.

    calculation: Readonly<CalculationSettings>

    current calculation settings

    catalog: Readonly<CatalogSettings>

    current catalog settings

    contactSupportUrl: string | null

    Url to the Contact Support document/form of the application.

    dataLanguage: readonly string[]

    Default language used for the product data (Array of languages in order of priority). If the array is empty the UI language will be used as fallback. Use EaiwsSessionDefaults.applyDefaults() to apply the default language.

    defaults: Readonly<DefaultSettings>

    default application settings

    eaiws: Readonly<EaiwsSettings>

    current eaiws settings

    errorReportEmailAddress: string

    Email address used for error reporting

    eventCalculationChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the calculation settings are changed

    eventCatalogChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the catalog settings are changed

    eventDataLanguageChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the data language is changed

    eventEaiwsChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the eaiws settings are changed

    eventLengthUnitChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the length unit is changed

    eventLocaleChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the locale is changed

    eventOrderChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the order settings are changed

    eventProjectEditorChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the project editor settings are changed

    eventProjectValidityChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the project validity is changed

    eventReportChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the report settings are changed

    eventThemeChanged: ListenableEvent<void, ApplicationSettings>

    event which triggers if the theme settings are changed

    inputFieldCharacterLimits: ReadonlyMap<InputField, number>

    Character limits for input fields which will be used from UI.

    language: string

    UI language of the application (based on the current locale)

    lengthUnit: LengthUnit

    Length unit which is used to show length values.

    locale: string

    Locale of the application. Used for number and date formatting and defines the language of the application.

    order: Readonly<OrderSettings>

    current order settings

    priceDateSupported: boolean

    True if the articles price date is supported.

    projectEditor: Readonly<ProjectEditorSettings>

    current project editor settings

    projectValidity: string

    Default project validity. The validity is represented as an ISO 8601 duration string. An empty string is used for no validity. Use EaiwsSessionDefaults.applyDefaults() to apply the default project validity.

    report: Readonly<ReportSettings>

    current report settings

    specialModelInfoTextId: string

    ID of the special model information text.

    supportedProjectStates: readonly ProjectState[]

    List of supported project states in correct order.

    supportEmailAddress: string | null

    Email address used to contact the support.

    theme: Readonly<ThemeSettings>

    current theme settings

    userStorage: AsyncSettingsStorage | null

    Cross browser settings storage which stores settings for the current user. Only available if the user authentication provides a storage. Note: This is an asynchronous api.

    webGL: Readonly<WebGLSettings>

    current WebGL settings

    • Set the contact support url.

      Parameters

      • pUrl: string | null

      Returns void

    • Sets new data language.

      Parameters

      • pLanguage: readonly string[]

      Returns void

    • Set email address used for error reporting

      Parameters

      • pAddress: string

      Returns void

    • Set the input field character limits

      Parameters

      Returns void

    • Enables/disables article price date support.

      Parameters

      • pSupported: boolean

      Returns void

    • Sets new project validity.

      Parameters

      • pValidity: string

      Returns void

    • Set the support email address.

      Parameters

      • pAddress: string | null

      Returns void