Member Junction
    Preparing search index...

    Class TagCloudEngine

    Framework-agnostic (server + client safe) engine that produces weighted tag-cloud items for the Knowledge Hub "Visualize" surface's tag-cloud mode.

    Frequency is sourced by aggregating MJ: Content Item Tags within a scope; optional co-occurrence "connectedness" is blended in via TagCoOccurrenceEngine (reused, not reimplemented). Output items are plain objects that map 1:1 to @memberjunction/ng-word-cloud's WordCloudItem.

    Like ClassifyAnalyticsEngine, every method accepts an optional TagCloudScope, contextUser, and provider, batches reads with RunView using ResultType: 'simple' + narrow Fields, never queries per-item inside a loop, and returns plain typed objects (no BaseEntity instances).

    const cloud = await TagCloudEngine.Instance.GetTagCloud(
      { ContentSourceIDs: [sourceID] },
      { Limit: 50, MinWeight: 0.1, IncludeCoOccurrence: true },
      contextUser);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    GlobalKey Instance

    Methods

    GetGlobalObjectStore GetTagCloud getInstance

    Constructors

    Accessors

    • get GlobalKey(): string

      Returns string

    Methods

    • The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

      Returns GlobalObjectStore

    • Produce weighted tag-cloud items for a scope.

      Weighting:

      • Frequency-only (default): each tag's raw count is min-max normalized across the in-scope set into [0, 1].
      • With IncludeCoOccurrence: the per-tag co-occurrence total (sum of counts with all partners) is also min-max normalized, and the final weight is (1 - blend) * freqNorm + blend * coOccNorm.

      Pruning: MinWeight drops low-weight items; Limit keeps the top-N by weight (then alphabetical for stable ordering on ties).

      Parameters

      • Optionalscope: TagCloudScope

        Optional source / content-type / date-range / tag-root filter.

      • Optionaloptions: TagCloudOptions

        Optional limit / threshold / co-occurrence blending.

      • OptionalcontextUser: UserInfo

        User context for server-side data operations.

      • Optionalprovider: IMetadataProvider

        Optional metadata provider for multi-provider contexts.

      Returns Promise<TagCloudItem[]>

    • Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.

      Type Parameters

      Parameters

      • this: new () => T
      • OptionalclassName: string

      Returns T

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods