Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

eventAdded: ListenableEvent<void, SceneElement> = ...
eventBoundingBoxChanged: ListenableEvent<void, SceneElement> = ...
eventGeometryChanged: ListenableEvent<void, MainArticleElement> = ...

Will be triggered inside updateGeometry() if the geometry was successfully updated.

Should be triggered if the list of properties, the value or the state (visible, editable) of one or more properties has changed.

eventRemoved: ListenableEvent<void, SceneElement> = ...
eventTransformationChanged: ListenableEvent<void, SceneElement> = ...
mBasketId: null | string
mModel: ModelManager
mNode: TransformNode
mOapInteractors: Interactors
mRecoveryBasketId: string
CLASS_ID: string = "egr.wcf.cf:Article"

Accessors

  • get basketId(): null | string
  • BasketId may be null if the article is not intantiated yes (use ensureIsInstanced()). e.g. if article is a newly created clone

    Returns null | string

  • get boundingBox(): BoundingBox
  • Complete bounding box of this element inluding invisible nodes.

    Returns BoundingBox

  • get boundingBoxVisible(): BoundingBox
  • Bounding box of this element inluding only visible elements.

    Returns BoundingBox

  • get dimensionsColor(): string
  • Color of the dimensions as hex string.

    Default Value

    "#595959"

    Returns string

  • set dimensionsColor(pColor: string): void
  • Parameters

    • pColor: string

    Returns void

  • get dimensionsScaleFactor(): number
  • Custom scale factor of the dimension.

    Default Value

    1

    Returns number

  • set dimensionsScaleFactor(pFactor: number): void
  • Parameters

    • pFactor: number

    Returns void

  • get hasGeometry(): boolean
  • Returns false if the article (including its children) has no or an empty geometry.

    Returns boolean

  • get hasPlaceholderGeometry(): boolean
  • Returns boolean

  • get hideMainArticle(): boolean
  • If true the main article will not be visible. Only the sub-articles will be visible.

    Returns boolean

  • set hideMainArticle(pHide: boolean): void
  • Parameters

    • pHide: boolean

    Returns void

  • get isDisposed(): boolean
  • Returns boolean

  • get isSelected(): boolean
  • Returns boolean

  • get node(): TransformNode
  • Returns TransformNode

  • get showDimensions(): boolean
  • Returns boolean

  • set showDimensions(pShow: boolean): void
  • Parameters

    • pShow: boolean

    Returns void

  • get transform(): Matrix
  • Returns Matrix

  • get transformInverted(): Matrix
  • Returns Matrix

  • get visibleSubArticles(): null | readonly string[]
  • Array of sub-article ids. If not null only the sub-articles contained in this array are visible otherwise all sub-articles will be visible.

    Returns null | readonly string[]

  • set visibleSubArticles(pSubArticles: null | readonly string[]): void
  • Parameters

    • pSubArticles: null | readonly string[]

    Returns void

  • get worldTransform(): Matrix
  • Returns Matrix

  • get worldTransformInverted(): Matrix
  • Returns Matrix

Methods

  • Returns void

  • Should be called if the element was removed from the scene and will never be used again.

    Returns void

  • Returns Promise<void>

  • Retrieves the basket items which are not already cached (MainArticle + SubArticles) from the EAIWS and adds them to the cache.

    Returns Promise<void>

  • Retrieves the calculations which are not already cached (MainArticle + SubArticles) from the EAIWS and adds them to the cache.

    Returns Promise<void>

  • Retrieves the item properties which are not already cached (MainArticle + SubArticles) from the EAIWS and adds them to the cache.

    Returns Promise<void>

  • Fills the internal cache with the given items.

    Parameters

    Returns void

  • Fills the internal cache with the given calculations.

    Parameters

    Returns void

  • Fills the internal cache with the given data.

    Parameters

    Returns void

  • Fills the internal cache with the given item properties.

    Parameters

    Returns void

  • Retrieves the article data for this article. In order to retrieve the properties, the article has to be instantiated on server side. This may not be possible if the ofml data is not installed or it has changed (article requires migration). The operation would fail in those cases. If properties are not required the noProperties option can be set to true to avoid this. (Default: false)

    Parameters

    Returns Promise<ArticleData>

  • Parameters

    • pIncludeChildElementNodes: boolean

    Returns TransformNode[]

  • Returns true if this article has interactors. E.g. OAP interactors.

    Returns Promise<boolean>

  • Parameters

    • pSelectableOnly: boolean

    Returns boolean

  • Enables highlighting of selectabe sub articles for this main article. The highlighting will be disabled automatically e.g. if the article changed or a tool was started. Returns false if the default tool is currently not running (if a default tool exists) or the highlighting is enabled already.

    Parameters

    • pCreateCallback: ((pHighlights: readonly SubArticleHighlight[]) => void)

      Called after creation of the highlighting.

    • Optional pDisposeCallback: (() => void)

      Called if the highighting was diposed/disabled.

        • (): void
        • Returns void

    Returns boolean

  • Can be overridden to disable the default selection highlight for this element. (Default: true)

    Returns boolean

  • Will be called for certain operations to load the undo data which was saved with a previous saveUndoData() call.

    Parameters

    Returns void

  • Notify this main article that there was a change.

    Parameters

    • pArticle: ArticleElement

      The changed article. Can be a sub article of the main article or the main article itself.

    • pWholeComposite: boolean

      Shoud be true if the given article and also other articles have changed.

    Returns void

  • Parameters

    • pFlags: number
    • pNotifyParent: boolean = true

    Returns void

  • Parameters

    • pNewNode: TransformNode
    • pKeepTransfom: boolean
    • pKeepParent: boolean
    • pNotifyParent: boolean = true

    Returns void

  • Can be used to provide additional undo related data for certain operations. Will be called before the operation is performed.

    Parameters

    Returns null | object

  • Parameters

    • pCache: Map<string, null | string>

    Returns void

  • Parameters

    • pNode: TransformNode

    Returns void

  • Parameters

    • pTransform: Matrix

    Returns boolean

  • Returns boolean

  • Parameters

    • pValidateSelection: boolean = true

    Returns Promise<void>

  • Updates the ofml article and its sub articles to use the currently installed product data. If an update is necessary can be checked with 'getOfmlUpdateState()'. Returns true if the update was successful.

    PMigrate

    set to true if migration should be performed if necessary

    PUpdate Geometry

    set to true if geometry should also be updated

    PPrice Date

    price date to use for the update

    Parameters

    • pMigrate: boolean
    • pUpdateGeometry: boolean
    • Optional pPriceDate: string

    Returns Promise<boolean>

  • Should be called after the transformation of this.node was modified directly instead of using this.setTransform(). This function updates frozen world matrices and calls notifyChange with ElementChangedFlags.Transformation.

    Parameters

    • pUpdateChildNodes: boolean = true

    Returns void

  • If there is a pending geometry update this function will wait until it is finished, otherwise it will resovle immediately.

    Returns Promise<void>

  • Parameters

    Returns null | {
        basketId: null | string;
        catalogImageIds: Map<string, null | string>;
        geometryIncomplete: boolean;
        node: null | TransformNode;
    }

  • Parameters

    • pNode: TransformNode
    • Optional pNewParent: null | TransformNode
    • Optional pChildNodes: boolean

    Returns TransformNode

Generated using TypeDoc