MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface D3WordCloudConfig

    Configuration for binding a D3 word cloud.

    The layout — d3-cloud's cloud().words(...), or any other — is deliberately not read: where a term landed carries no data, so the payload is the term and its weight alone. Point selector at the <text> glyphs.

    The default accessors are d3-cloud's own datum keys (text and size), since that is what all but hand-rolled clouds are laid out with.

    bindD3WordCloud(svgElement, {
      selector: 'text.term',
      axes: { x: 'Term', y: 'Occurrences' },
    });
    interface D3WordCloudConfig {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        axes?: { x?: D3AxisInput; y?: D3AxisInput; fill?: D3AxisInput };
        format?: AxisFormat;
        autoApply?: boolean;
        selector: string;
        x?: DataAccessor<string>;
        y?: DataAccessor<string | number>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id? title? subtitle? caption? axes? format? autoApply? selector x? y?

    Properties

    id?: string

    Unique identifier for the chart. Used as the MAIDR id.

    title?: string

    Chart title displayed in text descriptions.

    subtitle?: string

    Chart subtitle.

    caption?: string

    Chart caption.

    axes?: { x?: D3AxisInput; y?: D3AxisInput; fill?: D3AxisInput }

    Axis configuration. Each axis may be provided as either a plain string (shorthand for { label: value }) or a full AxisConfig object (for per-axis format, or grid navigation on scatter).

    For heatmaps and segmented bar charts, use fill for the color/category axis; the binder maps it to the canonical z axis in the MAIDR schema.

    Type Declaration

    format?: AxisFormat

    Optional formatting configuration applied to axes that do not specify their own format. Per-axis format on AxisConfig takes precedence.

    autoApply?: boolean

    When true (the default), the binder writes the generated MAIDR schema to the SVG as a maidr-data attribute so vanilla-JS users don't need to call svg.setAttribute(...) themselves. The returned result is unchanged either way.

    Set to false if you are driving MAIDR yourself — e.g. passing the returned schema to <Maidr data={...}> or persisting it elsewhere. The React adapter (useD3Adapter, MaidrD3) forces this to false internally so it can stay in control of the schema.

    true
    selector: string

    CSS selector for the term elements (e.g. 'text.term').

    x?: DataAccessor<string>

    Accessor for the term.

    'text', falling back to word, term, label, name, or x.

    y?: DataAccessor<string | number>

    Accessor for the term's weight.

    'size', falling back to value, weight, count, frequency, or y.

    Settings

    Member Visibility

    On This Page

    Properties