MAIDR Documentation - v3.65.0
    Preparing search index...

    Interface D3BoxConfig

    Configuration for binding a D3 box plot.

    interface D3BoxConfig {
        id?: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        axes?: { x?: D3AxisInput; y?: D3AxisInput; fill?: D3AxisInput };
        format?: AxisFormat;
        autoApply?: boolean;
        selector: string;
        boxSelector?: string;
        medianSelector?: string;
        whiskerSelector?: string;
        outlierSelector?: string;
        fill?: DataAccessor<string>;
        min?: DataAccessor<number>;
        q1?: DataAccessor<number>;
        q2?: DataAccessor<number>;
        q3?: DataAccessor<number>;
        max?: DataAccessor<number>;
        lowerOutliers?: DataAccessor<number[]>;
        upperOutliers?: DataAccessor<number[]>;
        orientation?: Orientation;
    }

    Hierarchy (View Summary)

    Index

    Properties

    id? title? subtitle? caption? axes? format? autoApply? selector boxSelector? medianSelector? whiskerSelector? outlierSelector? fill? min? q1? q2? q3? max? lowerOutliers? upperOutliers? orientation?

    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 box group elements. Each matched element should represent one box (e.g., 'g.box').

    boxSelector?: string

    Selector for the IQR box rectangle within each box group.

    'rect'
    medianSelector?: string

    Selector for the median line within each box group.

    'line.median'
    whiskerSelector?: string

    Selector for the whisker lines within each box group.

    outlierSelector?: string

    Selector for outlier points within each box group.

    'circle'
    fill?: DataAccessor<string>

    Accessor for the group/fill label.

    'fill'
    min?: DataAccessor<number>

    Accessor for the min value.

    'min'
    q1?: DataAccessor<number>

    Accessor for q1 value.

    'q1'
    q2?: DataAccessor<number>

    Accessor for median (q2) value.

    'q2'
    q3?: DataAccessor<number>

    Accessor for q3 value.

    'q3'
    max?: DataAccessor<number>

    Accessor for the max value.

    'max'
    lowerOutliers?: DataAccessor<number[]>

    Accessor for lower outlier values.

    'lowerOutliers'
    upperOutliers?: DataAccessor<number[]>

    Accessor for upper outlier values.

    'upperOutliers'
    orientation?: Orientation

    Chart orientation.

    Orientation.VERTICAL

    Settings

    Member Visibility

    On This Page

    Properties