@simspace/nivo-radar/dist/types/types.d.ts

[](https://www.npmjs.com/package/@nivo/radar)

import { FunctionComponent, AriaAttributes } from 'react';
import { AnimatedProps } from '@react-spring/web';
import { Box, Theme, CssMixBlendMode, Dimensions, ModernMotionProps, PropertyAccessor, ValueFormat, ClosedCurveFactoryId, DotsItemSymbolComponent, SvgDefsAndFill } from '@simspace/nivo-core';
import { InheritedColorConfig, OrdinalColorScaleConfig } from '@simspace/nivo-colors';
import { LegendProps } from '@simspace/nivo-legends';
import { ScaleLinear } from 'd3-scale';
export interface RadarDataProps<D extends Record<string, unknown>> {
    data: D[];
    keys: string[];
    indexBy: PropertyAccessor<D, string>;
}
export interface GridLabelProps {
    id: string;
    anchor: 'start' | 'middle' | 'end';
    angle: number;
    x: number;
    y: number;
    animated: AnimatedProps<{
        transform: string;
    }>;
}
export declare type GridLabelComponent = FunctionComponent<GridLabelProps>;
export declare type PointData = {
    index: string;
    key: string;
    value: number;
    formattedValue: string;
    color: string;
};
export interface PointProps {
    key: string;
    label: string | number | undefined;
    data: PointData;
    style: {
        fill: string;
        stroke: string;
        x: number;
        y: number;
    };
}
export interface RadarSliceTooltipDatum {
    color: string;
    id: string;
    value: number;
    formattedValue: string;
}
export interface RadarSliceTooltipProps {
    index: string | number;
    data: RadarSliceTooltipDatum[];
}
export declare type RadarSliceTooltipComponent = FunctionComponent<RadarSliceTooltipProps>;
export interface RadarCustomLayerProps<D extends Record<string, unknown>> {
    data: D[];
    keys: string[];
    indices: string[] | number[];
    colorByKey: RadarColorMapping;
    centerX: number;
    centerY: number;
    radiusScale: ScaleLinear<number, number>;
    angleStep: number;
}
export declare type RadarCustomLayer<D extends Record<string, unknown>> = FunctionComponent<RadarCustomLayerProps<D>>;
export declare type RadarLayerId = 'grid' | 'layers' | 'slices' | 'dots' | 'legends';
export declare type RadarColorMapping = Record<string, string>;
export interface RadarCommonProps<D extends Record<string, unknown>> {
    maxValue: number | 'auto';
    valueFormat: ValueFormat<number, string>;
    layers: (RadarLayerId | RadarCustomLayer<D>)[];
    margin: Box;
    curve: ClosedCurveFactoryId;
    gridLevels: number;
    gridShape: 'circular' | 'linear';
    gridLabel: GridLabelComponent;
    gridLabelOffset: number;
    enableDots: boolean;
    dotSymbol: DotsItemSymbolComponent;
    dotSize: number;
    dotColor: InheritedColorConfig<PointData>;
    dotBorderWidth: number;
    dotBorderColor: InheritedColorConfig<PointData>;
    enableDotLabel: boolean;
    dotLabel: PropertyAccessor<PointData, string | number>;
    dotLabelFormat: ValueFormat<number>;
    dotLabelYOffset: number;
    theme: Theme;
    colors: OrdinalColorScaleConfig<{
        key: string;
        index: number;
    }>;
    fillOpacity: number;
    blendMode: CssMixBlendMode;
    borderWidth: number;
    borderColor: InheritedColorConfig<{
        key: string;
        color: string;
    }>;
    isInteractive: boolean;
    sliceTooltip: RadarSliceTooltipComponent;
    renderWrapper: boolean;
    legends: LegendProps[];
    role: string;
    ariaLabel: AriaAttributes['aria-label'];
    ariaLabelledBy: AriaAttributes['aria-labelledby'];
    ariaDescribedBy: AriaAttributes['aria-describedby'];
}
export interface RadarSvgFillMatcherDatum<D extends Record<string, unknown>> {
    color: string;
    data: RadarDataProps<D>['data'];
    key: string;
}
export declare type RadarSvgProps<D extends Record<string, unknown>> = Partial<RadarCommonProps<D>> & RadarDataProps<D> & Dimensions & ModernMotionProps & SvgDefsAndFill<RadarSvgFillMatcherDatum<D>>;
export declare type BoundLegendProps = Required<Pick<LegendProps, 'data'>> & Omit<LegendProps, 'data'>;
//# sourceMappingURL=types.d.ts.map