@octanejs/recharts 0.1.41 → 0.1.42

package/src/cartesian/ErrorBar.tsrx.d.ts

@@ -1,131 +0,0 @@
-/**
- * @fileOverview Render a group of error bar
- */
-import * as React from 'octane';
-import { SVGProps } from 'octane';
-import { EasingInput, DataKey } from '../util/types';
-import { BarRectangleItem } from './Bar';
-import { LinePointItem } from './Line';
-import { ScatterPointItem } from './Scatter';
-import { ZIndexable } from '../zIndex/ZIndexLayer';
-export interface ErrorBarDataItem {
-	x: number | undefined;
-	y: number | undefined;
-	value: number;
-	errorVal?: number[] | number;
-}
-/**
- * So usually the direction is decided by the chart layout.
- * Horizontal layout means error bars are vertical means direction=y
- * Vertical layout means error bars are horizontal means direction=x
- *
- * Except! In Scatter chart, error bars can go both ways.
- *
- * So this property is only ever used in Scatter chart, and ignored elsewhere.
- */
-export type ErrorBarDirection = 'x' | 'y';
-export type ErrorBarDataPointFormatter<
-	T extends BarRectangleItem | LinePointItem | ScatterPointItem,
-> = (
-	entry: T,
-	dataKey: DataKey<T, number[] | number>,
-	direction: ErrorBarDirection,
-) => ErrorBarDataItem;
-/**
- * External ErrorBar props, visible for users of the library
- */
-interface ErrorBarProps<DataPointType = any, DataValueType = any> extends ZIndexable {
-	/**
-	 * Decides how to extract the value of this ErrorBar from the data:
-	 * - `string`: the name of the field in the data object;
-	 * - `number`: the index of the field in the data;
-	 * - `function`: a function that receives the data object and returns the value of this ErrorBar.
-	 *
-	 * The error values can be a single value for symmetric error bars;
-	 * or an array of a lower and upper error value for asymmetric error bars.
-	 */
-	dataKey: DataKey<DataPointType, DataValueType>;
-	/**
-	 * Width of the error bar ends (the serifs) in pixels.
-	 * This is not the total width of the error bar, but just the width of the little lines at the ends.
-	 *
-	 * The total width of the error bar is determined by the data value plus/minus the error value.
-	 *
-	 * @defaultValue 5
-	 */
-	width?: number;
-	/**
-	 * Direction of the error bar. Usually determined by chart layout, except in Scatter chart.
-	 * In Scatter chart, "x" means horizontal error bars, "y" means vertical error bars.
-	 */
-	direction?: ErrorBarDirection;
-	/**
-	 * @defaultValue true
-	 */
-	isAnimationActive?: boolean;
-	/**
-	 * @defaultValue 0
-	 */
-	animationBegin?: number;
-	/**
-	 * @defaultValue 400
-	 */
-	animationDuration?: number;
-	/**
-	 * @defaultValue ease-in-out
-	 */
-	animationEasing?: EasingInput;
-	/**
-	 * The width of the stroke
-	 */
-	strokeWidth?: number | string;
-	/**
-	 * The stroke color. If "none", no line will be drawn.
-	 *
-	 * @defaultValue black
-	 */
-	stroke?: string;
-	/**
-	 * @defaultValue 400
-	 */
-	zIndex?: number;
-}
-export type Props = SVGProps<SVGLineElement> & ErrorBarProps;
-export declare const errorBarDefaultProps: {
-	readonly stroke: 'black';
-	readonly strokeWidth: 1.5;
-	readonly width: 5;
-	readonly offset: 0;
-	readonly isAnimationActive: true;
-	readonly animationBegin: 0;
-	readonly animationDuration: 400;
-	readonly animationEasing: 'ease-in-out';
-	readonly zIndex: 400;
-};
-/**
- * ErrorBar renders whiskers to represent error margins on a chart.
- *
- * It must be a child of a graphical element.
- *
- * ErrorBar expects data in one of the following forms:
- * - Symmetric error bars: a single error value representing both lower and upper bounds.
- * - Asymmetric error bars: an array of two values representing lower and upper bounds separately. First value is the lower bound, second value is the upper bound.
- *
- * The values provided are relative to the main data value.
- * For example, if the main data value is 10 and the error value is 2,
- * the error bar will extend from 8 to 12 for symmetric error bars.
- *
- * In other words, what ErrorBar will render is:
- * - For symmetric error bars: [value - errorVal, value + errorVal]
- * - For asymmetric error bars: [value - errorVal[0], value + errorVal[1]]
- *
- * In stacked or ranged Bar charts, ErrorBar will use the higher data value
- * as the reference point for calculating the error bar positions.
- *
- * @consumes ErrorBarContext
- */
-export declare function ErrorBar(outsideProps: Props): React.JSX.Element;
-export declare namespace ErrorBar {
-	var displayName: string;
-}
-export {};

package/src/cartesian/Funnel.tsrx.d.ts

@@ -1,274 +0,0 @@
-import * as React from 'octane';
-import { ReactElement } from 'octane';
-import { Props as TrapezoidProps } from '../shape/Trapezoid';
-import { ImplicitLabelListType } from '../component/LabelList';
-import {
-	ActiveShape,
-	AnimationDuration,
-	EasingInput,
-	CartesianViewBoxRequired,
-	ChartOffsetInternal,
-	Coordinate,
-	DataConsumer,
-	DataKey,
-	DataProvider,
-	LegendType,
-	PresentationAttributesAdaptChildEvent,
-	ShapeAnimationProps,
-	TooltipType,
-	TrapezoidViewBox,
-	CartesianLayout,
-} from '../util/types';
-import { TooltipPayload } from '../state/tooltipSlice';
-import { Formatter } from '../component/DefaultTooltipContent';
-import { AnimationInterpolateFn } from '../animation/AnimatedItems';
-import { AnimationMatchByProp } from '../animation/matchBy';
-import { GraphicalItemId } from '../state/graphicalItemsSlice';
-export type FunnelTrapezoidItem = TrapezoidProps &
-	TrapezoidViewBox & {
-		value?: number | string;
-		payload?: any;
-		tooltipPosition: Coordinate;
-		name: string;
-		labelViewBox: TrapezoidViewBox;
-		parentViewBox: CartesianViewBoxRequired;
-		val: number | ReadonlyArray<number>;
-		tooltipPayload: TooltipPayload;
-	};
-/**
- * External props, intended for end users to fill in
- */
-interface FunnelProps<DataPointType = any, DataValueType = any>
-	extends DataProvider<DataPointType>, Required<DataConsumer<DataPointType, DataValueType>> {
-	/**
-	 * This component is rendered when this graphical item is activated
-	 * (could be by mouse hover, touch, keyboard, programmatically).
-	 */
-	activeShape?: ActiveShape<FunnelTrapezoidItem, SVGPathElement>;
-	/**
-	 * Specifies when the animation should begin, the unit of this option is ms.
-	 * @defaultValue 400
-	 */
-	animationBegin?: number;
-	/**
-	 * Specifies the duration of animation, the unit of this option is ms.
-	 * @defaultValue 1500
-	 */
-	animationDuration?: AnimationDuration;
-	/**
-	 * The type of easing function.
-	 * @defaultValue ease
-	 */
-	animationEasing?: EasingInput;
-	/**
-	 * Custom animation function for interpolating data items.
-	 * When provided, this replaces the default animation interpolation.
-	 *
-	 * @param prevItems The items from the previous animation frame, or null on first render
-	 * @param nextItems The target items to animate towards
-	 * @param animationElapsedTime A normalized time value (0 = start, 1 = end)
-	 * @returns The interpolated items at time animationElapsedTime
-	 *
-	 * @since 3.9
-	 * @see {@link https://recharts.github.io/en-US/guide/animations/ Animations guide}
-	 */
-	animationInterpolateFn?: AnimationInterpolateFn<FunnelTrapezoidItem, CartesianLayout>;
-	/**
-	 * Strategy for matching previous items to next items during animation.
-	 * Determines how Recharts pairs old data points with new data points
-	 * to create smooth transitions.
-	 *
-	 * - `matchAppend` (default): match sequentially by index and treat newly appended items as new
-	 * - `matchByIndex`: match by array position with proportional stretching
-	 * - `matchByDataKey('someKey')`: match by a data key from the payload
-	 * - Custom function `(item, index) => key`: match by the returned key
-	 *
-	 * @defaultValue append
-	 * @see matchByIndex
-	 * @see matchByDataKey
-	 * @see matchAppend
-	 *
-	 * @since 3.9
-	 * @see {@link https://recharts.github.io/en-US/guide/animations/ Animations guide}
-	 */
-	animationMatchBy?: AnimationMatchByProp<FunnelTrapezoidItem>;
-	className?: string;
-	/**
-	 * Hides the whole graphical element when true.
-	 *
-	 * Hiding an element is different from removing it from the chart:
-	 * Hidden graphical elements are still visible in Legend,
-	 * and can be included in axis domain calculations,
-	 * depending on `includeHidden` props of your XAxis/YAxis.
-	 *
-	 * @defaultValue false
-	 */
-	hide?: boolean;
-	/**
-	 * Unique identifier of this component.
-	 * Used as an HTML attribute `id`, and also to identify this element internally.
-	 *
-	 * If undefined, Recharts will generate a unique ID automatically.
-	 */
-	id?: string;
-	/**
-	 * If set false, animation of funnel will be disabled.
-	 * If set "auto", the animation will be disabled in SSR and will respect the user's prefers-reduced-motion system preference for accessibility.
-	 * @defaultValue auto
-	 */
-	isAnimationActive?: boolean | 'auto';
-	label?: ImplicitLabelListType;
-	/**
-	 * @defaultValue triangle
-	 */
-	lastShapeType?: 'triangle' | 'rectangle';
-	/**
-	 * The type of icon in legend.  If set to 'none', no legend item will be rendered.
-	 * @defaultValue rect
-	 */
-	legendType?: LegendType;
-	/**
-	 * Name represents each sector in the tooltip.
-	 * This allows you to extract the name from the data:
-	 *
-	 * - `string`: the name of the field in the data object;
-	 * - `number`: the index of the field in the data;
-	 * - `function`: a function that receives the data object and returns the name.
-	 *
-	 * @defaultValue name
-	 */
-	nameKey?: DataKey<DataPointType, DataValueType>;
-	/**
-	 * The customized event handler of animation end
-	 */
-	onAnimationEnd?: () => void;
-	/**
-	 * The customized event handler of animation start
-	 */
-	onAnimationStart?: () => void;
-	reversed?: boolean;
-	/**
-	 * If set a ReactElement, the shape of funnel can be customized.
-	 * If set a function, the function will be called to render customized shape.
-	 * During animations, the function shape also receives `animationElapsedTime`, `isAnimating`, and `isEntrance`.
-	 * By default, renders a trapezoid.
-	 */
-	shape?: ActiveShape<FunnelTrapezoidItem & ShapeAnimationProps, SVGPathElement>;
-	tooltipType?: TooltipType;
-	/**
-	 * Formats the value displayed in the tooltip for this Funnel.
-	 * When set, takes precedence over the `formatter` prop on the Tooltip component.
-	 */
-	formatter?: Formatter;
-	/**
-	 * The customized event handler of click on the area in this group
-	 */
-	onClick?: (data: FunnelTrapezoidItem, index: number, e: React.MouseEvent<SVGPathElement>) => void;
-	/**
-	 * The customized event handler of mousedown on the area in this group
-	 */
-	onMouseDown?: (
-		data: FunnelTrapezoidItem,
-		index: number,
-		e: React.MouseEvent<SVGPathElement>,
-	) => void;
-	/**
-	 * The customized event handler of mouseup on the area in this group
-	 */
-	onMouseUp?: (
-		data: FunnelTrapezoidItem,
-		index: number,
-		e: React.MouseEvent<SVGPathElement>,
-	) => void;
-	/**
-	 * The customized event handler of mousemove on the area in this group
-	 */
-	onMouseMove?: (
-		data: FunnelTrapezoidItem,
-		index: number,
-		e: React.MouseEvent<SVGPathElement>,
-	) => void;
-	/**
-	 * The customized event handler of mouseover on the area in this group
-	 */
-	onMouseOver?: (
-		data: FunnelTrapezoidItem,
-		index: number,
-		e: React.MouseEvent<SVGPathElement>,
-	) => void;
-	/**
-	 * The customized event handler of mouseout on the area in this group
-	 */
-	onMouseOut?: (
-		data: FunnelTrapezoidItem,
-		index: number,
-		e: React.MouseEvent<SVGPathElement>,
-	) => void;
-	/**
-	 * The customized event handler of mouseenter on the area in this group
-	 */
-	onMouseEnter?: (
-		data: FunnelTrapezoidItem,
-		index: number,
-		e: React.MouseEvent<SVGPathElement>,
-	) => void;
-	/**
-	 * The customized event handler of mouseleave on the area in this group
-	 */
-	onMouseLeave?: (
-		data: FunnelTrapezoidItem,
-		index: number,
-		e: React.MouseEvent<SVGPathElement>,
-	) => void;
-}
-type FunnelSvgProps = Omit<
-	PresentationAttributesAdaptChildEvent<FunnelTrapezoidItem, SVGPathElement>,
-	'ref'
->;
-export type Props<DataPointType = any, DataValueType = any> = FunnelSvgProps &
-	FunnelProps<DataPointType, DataValueType>;
-type RealFunnelData = unknown;
-export declare const defaultFunnelProps: {
-	readonly animationBegin: 400;
-	readonly animationDuration: 1500;
-	readonly animationEasing: 'ease';
-	readonly animationInterpolateFn: AnimationInterpolateFn<FunnelTrapezoidItem, CartesianLayout>;
-	readonly animationMatchBy: 'append';
-	readonly fill: '#808080';
-	readonly hide: false;
-	readonly isAnimationActive: 'auto';
-	readonly lastShapeType: 'triangle';
-	readonly legendType: 'rect';
-	readonly nameKey: 'name';
-	readonly reversed: false;
-	readonly shape: React.FC<TrapezoidProps>;
-	readonly stroke: '#fff';
-};
-export declare function computeFunnelTrapezoids({
-	dataKey,
-	nameKey,
-	displayedData,
-	tooltipType,
-	lastShapeType,
-	reversed,
-	offset,
-	customWidth,
-	graphicalItemId,
-}: {
-	dataKey: Props['dataKey'];
-	nameKey: Props['nameKey'];
-	offset: ChartOffsetInternal;
-	displayedData: ReadonlyArray<RealFunnelData>;
-	tooltipType?: TooltipType;
-	lastShapeType?: Props['lastShapeType'];
-	reversed?: boolean;
-	customWidth: number | string | undefined;
-	graphicalItemId: GraphicalItemId;
-}): ReadonlyArray<FunnelTrapezoidItem>;
-export declare const Funnel: {
-	<DataPointType = any, DataValueType = any>(
-		outsideProps: Props<DataPointType, DataValueType>,
-	): ReactElement;
-	(outsideProps: Props<any, any>): ReactElement;
-};
-export {};

package/src/cartesian/Line.tsrx.d.ts

@@ -1,4 +0,0 @@
-// Type declaration for the .tsrx component (resolved by relative path).
-export declare const defaultLineProps: Record<string, unknown>;
-export declare const Line: (props: Record<string, unknown>) => unknown;
-export declare function computeLinePoints(input: Record<string, unknown>): unknown[];

package/src/cartesian/LineDrawShape.tsrx.d.ts

@@ -1,2 +0,0 @@
-// Type declaration for the .tsrx component (resolved by relative path).
-export declare const LineDrawShape: (props: Record<string, unknown>) => unknown;

package/src/cartesian/ReferenceLine.tsrx.d.ts

@@ -1,178 +0,0 @@
-/**
- * @fileOverview Reference Line
- */
-import * as React from 'octane';
-import { ReactElement, SVGProps } from 'octane';
-import { ImplicitLabelType } from '../component/Label';
-import { Overflowable } from '../util/IfOverflow';
-import { CartesianViewBoxRequired, Coordinate } from '../util/types';
-import { RequiresDefaultProps } from '../util/resolveDefaultProps';
-import { ZIndexable } from '../zIndex/ZIndexLayer';
-import { BandPosition, RechartsScale } from '../util/scale/RechartsScale';
-/**
- * Single point that defines one end of a segment.
- * These coordinates are in data space, meaning that you should provide
- * values that correspond to the data domain of the axes.
- * So you would provide a value of `Page A` to indicate the data value `Page A`
- * and then recharts will convert that to pixels.
- *
- * Likewise for numbers. If your x-axis goes from 0 to 100,
- * and you want the line to end at 50, you would provide `50` here.
- *
- * @inline
- */
-export type ReferenceLineSegment = readonly [
-	{
-		x?: number | string;
-		y?: number | string;
-	},
-	{
-		x?: number | string;
-		y?: number | string;
-	},
-];
-type ReferenceCoordinateValue = number | string;
-interface ReferenceLineProps<
-	XValueType extends ReferenceCoordinateValue = any,
-	YValueType extends ReferenceCoordinateValue = any,
->
-	extends Overflowable, ZIndexable {
-	/**
-	 * If defined, renders a horizontal line on this position.
-	 *
-	 * This value is using your chart's domain, so you will provide a data value instead of a pixel value.
-	 * ReferenceLine will internally calculate the correct pixel position.
-	 *
-	 * @example <ReferenceLine y="Page D" />
-	 */
-	y?: YValueType;
-	/**
-	 * If defined, renders a vertical line on this position.
-	 *
-	 * This value is using your chart's domain, so you will provide a data value instead of a pixel value.
-	 * ReferenceLine will internally calculate the correct pixel position.
-	 *
-	 * @example <ReferenceLine x="Monday" />
-	 */
-	x?: XValueType;
-	/**
-	 * Tuple of coordinates. If defined, renders a diagonal line segment.
-	 */
-	segment?: readonly [
-		{
-			x?: XValueType;
-			y?: YValueType;
-		},
-		{
-			x?: XValueType;
-			y?: YValueType;
-		},
-	];
-	/**
-	 * The position of the reference line when the axis has bandwidth
-	 * (e.g., a band scale). This determines where within the band
-	 * the line is drawn.
-	 * @defaultValue 'middle'
-	 */
-	position?: BandPosition;
-	className?: number | string;
-	/**
-	 * The id of y-axis which is corresponding to the data.
-	 * Required when there are multiple YAxes.
-	 * @defaultValue 0
-	 */
-	yAxisId?: number | string;
-	/**
-	 * The id of x-axis which is corresponding to the data.
-	 * Required when there are multiple XAxes.
-	 * @defaultValue 0
-	 */
-	xAxisId?: number | string;
-	shape?: ReactElement<SVGElement> | ((props: any) => ReactElement<SVGElement>);
-	/**
-	 * Renders a single label.
-	 *
-	 * - `false`: no labels are rendered
-	 * - `string` | `number`: the content of the label
-	 * - `object`: the props of LabelList component
-	 * - `ReactElement`: a custom SVG label element, such as `<text>` or `<g>`.
-	 *   HTML elements such as `<div>` are not valid inside the chart SVG and may trigger React DOM warnings.
-	 * - `function`: a render function of custom label
-	 *
-	 * @defaultValue false
-	 *
-	 * @see {@link https://recharts.github.io/en-US/examples/LineChartWithReferenceLines/ Reference elements with a label}
-	 */
-	label?: ImplicitLabelType;
-	/**
-	 * Z-Index of this component and its children. The higher the value,
-	 * the more on top it will be rendered.
-	 * Components with higher zIndex will appear in front of components with lower zIndex.
-	 * If undefined or 0, the content is rendered in the default layer without portals.
-	 *
-	 * @since 3.4
-	 * @defaultValue 400
-	 * @see {@link https://recharts.github.io/en-US/guide/zIndex/ Z-Index and layers guide}
-	 */
-	zIndex?: number;
-	/**
-	 * The width of the stroke
-	 * @defaultValue 1
-	 */
-	strokeWidth?: number | string;
-}
-/**
- * This excludes `viewBox` prop from svg for two reasons:
- * 1. The components wants viewBox of object type, and svg wants string
- *    - so there's a conflict, and the component will throw if it gets string
- * 2. Internally the component calls `svgPropertiesNoEvents` which filters the viewBox away anyway
- */
-export type Props<
-	XValueType extends ReferenceCoordinateValue = any,
-	YValueType extends ReferenceCoordinateValue = any,
-> = Omit<SVGProps<SVGLineElement>, 'viewBox'> & ReferenceLineProps<XValueType, YValueType>;
-type EndPointsPropsSubset = Pick<PropsWithDefaults, 'y' | 'x' | 'segment' | 'ifOverflow'>;
-export declare const getEndPoints: (
-	xAxisScale: RechartsScale,
-	yAxisScale: RechartsScale,
-	viewBox: CartesianViewBoxRequired,
-	position: Props['position'],
-	xAxisOrientation: Props['orientation'],
-	yAxisOrientation: Props['orientation'],
-	props: EndPointsPropsSubset,
-) => ReadonlyArray<Coordinate> | null;
-export declare const referenceLineDefaultProps: {
-	readonly ifOverflow: 'discard';
-	readonly xAxisId: 0;
-	readonly yAxisId: 0;
-	readonly fill: 'none';
-	readonly label: false;
-	readonly stroke: '#ccc';
-	readonly fillOpacity: 1;
-	readonly strokeWidth: 1;
-	readonly position: 'middle';
-	readonly zIndex: 400;
-};
-type PropsWithDefaults = RequiresDefaultProps<Props, typeof referenceLineDefaultProps>;
-/**
- * Draws a line on the chart connecting two points.
- *
- * This component, unlike {@link https://developer.mozilla.org/en-US/docs/Web/SVG/Reference/Element/line line}, is aware of the cartesian coordinate system,
- * so you specify the dimensions by using data coordinates instead of pixels.
- *
- * ReferenceLine will calculate the pixels based on the provided data coordinates.
- *
- * If you prefer to render using pixels rather than data coordinates,
- * consider using the {@link https://developer.mozilla.org/en-US/docs/Web/SVG/Reference/Element/line line SVG element} instead.
- *
- * @provides CartesianLabelContext
- * @consumes CartesianChartContext
- */
-export declare function ReferenceLine<
-	XValueType extends ReferenceCoordinateValue = any,
-	YValueType extends ReferenceCoordinateValue = any,
->(outsideProps: Props<XValueType, YValueType>): React.JSX.Element;
-export declare namespace ReferenceLine {
-	var displayName: string;
-}
-export {};