Reincharts
    Preparing search index...

    Interface StandardDeviationChannelProps

    interface StandardDeviationChannelProps {
        appearance: {
            edgeFill?: string;
            edgeStroke?: string;
            edgeStrokeWidth?: number;
            fill?: string;
            r?: number;
            stroke?: string;
            strokeWidth?: number;
        };
        channels: any[];
        currentPositionOpacity?: number;
        currentPositionRadius?: number;
        currentPositionStroke?: string;
        currentPositionStrokeWidth?: number;
        enabled: boolean;
        hoverText: object;
        onComplete?: (e: MouseEvent, newChannels: any, moreProps: any) => void;
        onStart?: () => void;
        snapTo?: (data: any) => number;
    }
    Index

    Properties

    appearance channels currentPositionOpacity? currentPositionRadius? currentPositionStroke? currentPositionStrokeWidth? enabled hoverText onComplete? onStart? snapTo?

    Properties

    appearance: {
        edgeFill?: string;
        edgeStroke?: string;
        edgeStrokeWidth?: number;
        fill?: string;
        r?: number;
        stroke?: string;
        strokeWidth?: number;
    }

    Appearance configuration for the standard deviation channel.

    Type Declaration

    • Optional ReadonlyedgeFill?: string

      Fill color for the channel edge indicators.

    • Optional ReadonlyedgeStroke?: string

      Stroke color for the channel edge indicators.

    • Optional ReadonlyedgeStrokeWidth?: number

      Stroke width for the channel edge indicators.

    • Optional Readonlyfill?: string

      Fill color for the channel area.

    • Optional Readonlyr?: number

      Radius for the channel edge indicators.

    • Optional Readonlystroke?: string

      Stroke color for the channel lines.

    • Optional ReadonlystrokeWidth?: number

      Stroke width for the channel lines.

    channels: any[]

    Array of standard deviation channels that get drawn.

    currentPositionOpacity?: number

    Opacity of the current position indicator.

    currentPositionRadius?: number

    Radius of the current position indicator.

    currentPositionStroke?: string

    Stroke color for the current position indicator.

    currentPositionStrokeWidth?: number

    Stroke width for the current position indicator.

    enabled: boolean

    Whether the standard deviation channel drawing is enabled.

    hoverText: object

    Configuration for hover text display.

    onComplete?: (e: MouseEvent, newChannels: any, moreProps: any) => void

    Callback when channel drawing is completed. newChannels is a list of all channels with the new/updated channel included.

    onStart?: () => void

    Callback when channel drawing starts.

    snapTo?: (data: any) => number

    Function to snap the channel points to specific values in the data.

    Settings

    Member Visibility

    On This Page

    Properties