Member Junction
    Preparing search index...

    Class CreateSVGWordCloudAction

    Action that generates SVG word clouds and tag bars from weighted word lists.

    This action provides server-side SVG generation for text visualizations, designed for AI agents and workflows to create publication-quality word clouds from data.

    // Word cloud example
    await runAction({
      ActionName: 'Create SVG Word Cloud',
      Params: [
        { Name: 'CloudType', Value: 'cloud' },
        { Name: 'Words', Value: JSON.stringify([
          { text: 'TypeScript', weight: 100 },
          { text: 'JavaScript', weight: 80 },
          { text: 'React', weight: 60 },
          { text: 'Node.js', weight: 50 }
        ]) },
        { Name: 'MaxWords', Value: '50' },
        { Name: 'Rotation', Value: 'few' },
        { Name: 'Width', Value: '800' },
        { Name: 'Height', Value: '600' }
      ]
    });

    // Tag bar example
    await runAction({
      ActionName: 'Create SVG Word Cloud',
      Params: [
        { Name: 'CloudType', Value: 'tagbar' },
        { Name: 'Words', Value: JSON.stringify([
          { text: 'AI', weight: 67 },
          { text: 'Data', weight: 45 },
          { text: 'API', weight: 32 }
        ]) },
        { Name: 'MaxWords', Value: '10' }
      ]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    AuthorizesCaller

    Accessors

    SupportsAudience

    Methods

    InternalRunAction Run

    Constructors

    Properties

    AuthorizesCaller: boolean

    True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

    The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

    Accessors

    • get SupportsAudience(): boolean

      Whether this action can bound what it returns to an audience (RunActionParams.Audience): everyone besides the caller who will see its output, such as the other participants of a shared conversation.

      false by default, and the engine enforces it: when a run's audience adds a reader beyond the caller, ActionEngineServer.RunAction refuses the action with result code AUDIENCE_UNSUPPORTED, without running it. Override to return true only when the action honours the audience in full — every record, snippet and count it returns is something every reader may see (pass the audience to the search engine, check each reader's entitlement to anything it scopes by, and leave out aggregates computed before that filtering).

      Returns boolean

    Methods

    • Generates an SVG word cloud from the provided data and configuration

      Parameters

      • params: RunActionParams

        The action parameters containing:

        • CloudType: Type of visualization ('cloud' | 'tagbar')
        • Words: JSON array of {text, weight} objects
        • MaxWords: Maximum number of words to display (default: 50)
        • Rotation: Rotation strategy ('none' | 'few' | 'mixed') for clouds
        • MinFont: Minimum font size (default: 10)
        • MaxFont: Maximum font size (default: 80)
        • Seed: Random seed for deterministic layouts (optional)
        • Width: Width in pixels (optional, default: 800)
        • Height: Height in pixels (optional, default: 600)
        • Title: Visualization title (optional)
        • Palette: Color palette name (optional)

      Returns Promise<SVGActionResult>

      A promise resolving to an SVGActionResult

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods