@dfnivo/sankey/dist/types/types.d.ts

<a href="https://nivo.rocks"><img alt="nivo" src="https://raw.githubusercontent.com/plouc/nivo/master/nivo.png" width="216" height="68"/></a>

import { AriaAttributes, MouseEvent, FunctionComponent } from 'react';
import { SankeyLink, SankeyNode, SankeyNodeMinimal } from 'd3-sankey';
import { Box, Theme, CssMixBlendMode, Dimensions, ModernMotionProps, PropertyAccessor, ValueFormat } from '@dfnivo/core';
import { InheritedColorConfig, OrdinalColorScaleConfig } from '@dfnivo/colors';
import { LegendProps } from '@dfnivo/legends';
export interface SankeyRawNode {
    id: string;
}
export interface DefaultNode {
    id: string;
    label?: string;
    color?: string;
}
export interface DefaultLink {
    startColor?: string;
    endColor?: string;
}
export interface SankeyRawLink {
    source: string;
    target: string;
    value: number;
    startColor?: string;
    endColor?: string;
}
type ExtraLinkProps<L extends DefaultLink> = Omit<L, 'source' | 'target' | 'value'>;
export type SankeyLinkDatum<N extends DefaultNode, L extends DefaultLink> = ExtraLinkProps<L> & SankeyLink<N, L> & {
    pos0?: number;
    pos1?: number;
    thickness: number;
    color: string;
    formattedValue: string;
    startColor?: string;
    endColor?: string;
};
export type SankeyNodeDatum<N extends DefaultNode, L extends DefaultLink> = N & SankeyNode<N, L> & {
    color: string;
    label: string;
    formattedValue: string;
    layer: number;
    x: number;
    y: number;
    width: number;
    height: number;
};
export interface SankeyDataProps<N extends DefaultNode, L extends DefaultLink> {
    data: {
        nodes: N[];
        links: ({
            source: string;
            target: string;
            value: number;
        } & L)[];
    };
}
export type SankeyLayerId = 'links' | 'nodes' | 'labels' | 'legends';
export type SankeyMouseHandler = <N extends DefaultNode, L extends DefaultLink>(data: SankeyNodeDatum<N, L> | SankeyLinkDatum<N, L>, event: MouseEvent) => void;
export type SankeyAlignType = 'center' | 'justify' | 'start' | 'end';
export type SankeyAlignFunction<N extends DefaultNode, L extends DefaultLink> = (node: SankeyNodeMinimal<N, L>, n: number) => number;
export type SankeySortType = 'auto' | 'input' | 'ascending' | 'descending';
export type SankeySortFunction<N extends DefaultNode, L extends DefaultLink> = (a: SankeyNode<N, L>, b: SankeyNode<N, L>) => number | undefined | null;
export interface SankeyCommonProps<N extends DefaultNode, L extends DefaultLink> {
    valueFormat: ValueFormat<number>;
    layout: 'horizontal' | 'vertical';
    align: SankeyAlignType | SankeyAlignFunction<N, L>;
    sort: SankeySortType | SankeySortFunction<N, L>;
    layers: SankeyLayerId[];
    margin: Box;
    colors: OrdinalColorScaleConfig<Omit<SankeyNodeDatum<N, L>, 'color' | 'label'>>;
    theme: Theme;
    nodeOpacity: number;
    nodeHoverOpacity: number;
    nodeHoverOthersOpacity: number;
    nodeThickness: number;
    nodeSpacing: number;
    nodeInnerPadding: number;
    nodeBorderWidth: number;
    nodeBorderColor: InheritedColorConfig<SankeyNodeDatum<N, L>>;
    nodeBorderRadius: number;
    linkOpacity: number;
    linkHoverOpacity: number;
    linkHoverOthersOpacity: number;
    linkContract: number;
    linkBlendMode: CssMixBlendMode;
    enableLinkGradient: boolean;
    enableLabels: boolean;
    label: PropertyAccessor<Omit<SankeyNodeDatum<N, L>, 'color' | 'label'>, string>;
    labelPosition: 'inside' | 'outside';
    labelPadding: number;
    labelOrientation: 'horizontal' | 'vertical';
    labelTextColor: InheritedColorConfig<SankeyNodeDatum<N, L>>;
    isInteractive: boolean;
    onClick: SankeyMouseHandler;
    nodeTooltip: FunctionComponent<{
        node: SankeyNodeDatum<N, L>;
    }>;
    linkTooltip: FunctionComponent<{
        link: SankeyLinkDatum<N, L>;
    }>;
    legends: LegendProps[];
    renderWrapper: boolean;
    role: string;
    ariaLabel: AriaAttributes['aria-label'];
    ariaLabelledBy: AriaAttributes['aria-labelledby'];
    ariaDescribedBy: AriaAttributes['aria-describedby'];
}
export type SankeySvgProps<N extends DefaultNode, L extends DefaultLink> = Partial<SankeyCommonProps<N, L>> & SankeyDataProps<N, L> & Dimensions & ModernMotionProps;
export {};
//# sourceMappingURL=types.d.ts.map