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

    Class ArticleManager

    Index
    eventArticleAdded: ListenableEvent<ArticleElement, ArticleManager> = ...

    Will be triggered if an article was added to the model.

    eventArticleInstanceRestored: ListenableEvent<
        MainArticleElement,
        ArticleManager,
    > = ...

    Will be triggered if an article instance (basket id) was restored.

    eventArticleRemoved: ListenableEvent<ArticleElement, ArticleManager> = ...

    Will be triggered if an article was removed/deleted from the model.

    Will be triggered for every error during execution of OAP actions.

    fatherItemId: string | null

    Optional father item which will be used as father/parent in the basket hierarchy for newly inserted/created articles.

    includeCalculationErrorsInInconsistencies: boolean

    If true calculation line errors will be also included in the inconsistencyReason of the article ItemProperties.

    true
    
    itemTextFormat: TextFormat

    Text format used for the item properties.

    "Plain"
    
    oapInteractorFilter: OAPInteractorFilterFunc | undefined

    Custom filter function for OAP interactors.

    undefined
    
    placeholderCreator: PlaceholderCreator

    Placeholder creator for articles without geometry. Can be overriden with a custom implementation. The DefaultPlaceholderCreator is used as the default implementation.

    • get maxGfjTextureSize(): number

      Returns number

    • Creates a MainArticleElement for the given basket id which should belong to an already existing main article in the EAIWS session. Note: The MainArticleElement will not be added to the ModelManager here. This should be done afterwards.

      Parameters

      • pBasketId: string

        The id of the article to load.

      • OptionalpLoadTransformations: boolean

        If true the transformations will be loaded. (Default: false)

      • OptionalpBasketItems: BasketItem[]

        If the basket.BasketItems of the articles are already known. They can be passed here to speed up the operation. The list of items has to be complete. It has to conatin all main articles and all of its sub articles. Further, the geometryId and setArticleId (if the item is part of a set) of each BasketItem should be available.

      Returns Promise<MainArticleElement>

    • Creates MainArticleElements for the given basket ids which should belong to already existing main articles in the EAIWS session. Note: The MainArticleElements will not be added to the ModelManager here. This should be done afterwards.

      Parameters

      • pBasketIds: string[]

        The ids of the articles to load.

      • OptionalpLoadTransformations: boolean

        If true the transformations will be loaded. (default: false)

      • OptionalpBasketItems: BasketItem[]

        If the basket.BasketItems of the articles are already known. They can be passed here to speed up the operation. The list of items has to be complete. It has to conatin all main articles and all of its sub articles. Further, the geometryId and setArticleId (if the item is part of a set) of each BasketItem should be available.

      • OptionalpGfjUrls: Map<string, string>

        Map from basketId to gfj url. Can be used to speed up insertion in case the urls are already known.

      Returns Promise<MainArticleElement[]>

    • Returns the article element with the given id.

      Parameters

      • pBasketId: string

      Returns ArticleElement | null

    • Resets cached ArticleData and ItemProperties for all existing articles.

      Parameters

      • pNotifyPropertyChange: boolean

      Returns void

    • Parameters

      • pSaveArticleTransformations: boolean

      Returns Promise<string>

    • Enables 2D geometries for GFJ export. (default: false)

      Parameters

      • pEnabled: boolean

      Returns void

    • If enabled, GFJ files will contain invisible layers.

      Parameters

      • pEnabled: boolean

      Returns void

    • Parameters

      • pMaxSize: number

      Returns void

    • Parameters

      • pSaveArticleTransformations: boolean

      Returns Promise<void>