MAIDR JavaScript API
    Preparing search index...

    Interface VictoryAdapterConfig

    Configuration accepted by both the MaidrVictory wrapper component and the useVictoryAdapter hook.

    interface VictoryAdapterConfig {
        id: string;
        title?: string;
        subtitle?: string;
        caption?: string;
        children: ReactNode;
        layout?: VictoryPanelLayout;
        percentileBands?: PercentileBandOption[];
    }
    Index

    Properties

    id title? subtitle? caption? children layout? percentileBands?

    Properties

    id: string

    Unique identifier for the chart. Used for DOM element IDs.

    title?: string

    Chart title displayed in text descriptions.

    subtitle?: string

    Chart subtitle.

    caption?: string

    Chart caption.

    children: ReactNode

    Victory chart components to make accessible.

    layout?: VictoryPanelLayout

    Grid layout for multi-panel figures. Only consulted when children contains two or more top-level <VictoryChart> components; single-chart figures are unaffected.

    percentileBands?: PercentileBandOption[]

    Fan charts drawn in the chart, each read as one percentile_band layer.

    A <VictoryArea> given y0 fills between two values, and nothing in it says which quantiles those are. Each component is named by its own name prop: median names a <VictoryLine>, and each band's series a <VictoryArea> drawn with y0, with the band's two levels as fractions. The band's edges are its y0 and y, matched to the median by x.

    // <VictoryArea name="p90" data={rows} x="step" y0="p5" y="p95" />
    // <VictoryLine name="median" data={rows} x="step" y="p50" />
    percentileBands: [{
      median: 'median',
      bands: [{ series: 'p90', lower: 0.05, upper: 0.95 }],
    }]

    Settings

    Member Visibility

    On This Page

    Properties