@octanejs/recharts 0.1.40 → 0.1.42

package/src/polar/PolarGrid.tsrx.d.ts

@@ -1,117 +0,0 @@
-import * as React from 'octane';
-import { SVGProps } from 'octane';
-import { AxisId } from '../state/cartesianAxisSlice';
-import { ZIndexable } from '../zIndex/ZIndexLayer';
-interface PolarGridProps extends ZIndexable {
-	/**
-	 * The x-coordinate of center.
-	 * When used inside a chart context, this prop is calculated based on the chart's dimensions,
-	 * and this prop is ignored.
-	 *
-	 * This is only used when rendered outside a chart context.
-	 */
-	cx?: number;
-	/**
-	 * The y-coordinate of center.
-	 * When used inside a chart context, this prop is calculated based on the chart's dimensions,
-	 * and this prop is ignored.
-	 *
-	 * This is only used when rendered outside a chart context.
-	 */
-	cy?: number;
-	/**
-	 * The radius of the inner polar grid.
-	 * When used inside a chart context, this prop is calculated based on the chart's dimensions,
-	 * and this prop is ignored.
-	 *
-	 * This is only used when rendered outside a chart context.
-	 */
-	innerRadius?: number;
-	/**
-	 * The radius of the outer polar grid.
-	 * When used inside a chart context, this prop is calculated based on the chart's dimensions,
-	 * and this prop is ignored.
-	 *
-	 * This is only used when rendered outside a chart context.
-	 */
-	outerRadius?: number;
-	/**
-	 * The array of every line grid's angle.
-	 */
-	polarAngles?: ReadonlyArray<number>;
-	/**
-	 * The array of every circle grid's radius.
-	 */
-	polarRadius?: ReadonlyArray<number>;
-	/**
-	 * The type of polar grids.
-	 * @defaultValue polygon
-	 */
-	gridType?: 'polygon' | 'circle';
-	/**
-	 * @defaultValue true
-	 */
-	radialLines?: boolean;
-	/**
-	 * @defaultValue 0
-	 */
-	angleAxisId?: AxisId;
-	/**
-	 * @defaultValue 0
-	 */
-	radiusAxisId?: AxisId;
-	/**
-	 * 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 -100
-	 * @see {@link https://recharts.github.io/en-US/guide/zIndex/ Z-Index and layers guide}
-	 */
-	zIndex?: number;
-	/**
-	 * The stroke color. If "none", no line will be drawn.
-	 * @defaultValue #ccc
-	 */
-	stroke?: string;
-	/**
-	 * The width of the stroke.
-	 * @defaultValue 1
-	 */
-	strokeWidth?: number | string;
-	/**
-	 * The pattern of dashes and gaps used to paint the lines of the grid.
-	 * @see {@link https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray stroke-dasharray on MDN}
-	 */
-	strokeDasharray?: string | number;
-	/**
-	 * The background color used to fill the space between grid lines.
-	 * @defaultValue none
-	 */
-	fill?: string;
-	/**
-	 * The opacity of the background used to fill the space between grid lines.
-	 */
-	fillOpacity?: number | string;
-}
-export type Props = SVGProps<SVGLineElement> & PolarGridProps;
-export declare const defaultPolarGridProps: {
-	readonly angleAxisId: 0;
-	readonly radiusAxisId: 0;
-	readonly gridType: 'polygon';
-	readonly radialLines: true;
-	readonly zIndex: -100;
-	readonly stroke: '#ccc';
-	readonly strokeWidth: 1;
-	readonly fill: 'none';
-};
-/**
- * @consumes PolarViewBoxContext
- */
-export declare const PolarGrid: {
-	(outsideProps: Props): React.JSX.Element | null;
-	displayName: string;
-};
-export {};

package/src/polar/PolarRadiusAxis.tsrx.d.ts

@@ -1,209 +0,0 @@
-import * as React from 'octane';
-import { FunctionComponent, SVGProps } from 'octane';
-import {
-	RenderableAxisProps,
-	PresentationAttributesAdaptChildEvent,
-	AxisDomain,
-	ScaleType,
-	AxisDomainTypeInput,
-	TickProp,
-	BaseTickContentProps,
-	AxisTick,
-} from '../util/types';
-import { NiceTicksAlgorithm } from '../state/cartesianAxisSlice';
-import { defaultPolarRadiusAxisProps } from './defaultPolarRadiusAxisProps';
-import { RequiresDefaultProps } from '../util/resolveDefaultProps';
-import { ZIndexable } from '../zIndex/ZIndexLayer';
-import { CustomScaleDefinition } from '../util/scale/CustomScaleDefinition';
-type TickOrientation = 'left' | 'right' | 'middle';
-export interface PolarRadiusAxisProps<DataPointType = any, DataValueType = any>
-	extends
-		Omit<
-			RenderableAxisProps<DataPointType, DataValueType>,
-			'axisLine' | 'angle' | 'type' | 'tickSize' | 'domain' | 'scale' | 'tick'
-		>,
-		ZIndexable {
-	/**
-	 * Determines how the axis line is drawn. Options:
-	 * - `true`: the axis line is drawn with default props;
-	 * - `false`: the axis line is not visible;
-	 * - `object`: passed as props to SVG `<line>` element representing the axis line.
-	 *
-	 * @example <PolarRadiusAxis axisLine={false} />
-	 * @example <PolarRadiusAxis axisLine={{ stroke: 'red', strokeWidth: 2 }} />
-	 * @defaultValue true
-	 */
-	axisLine?: boolean | SVGProps<SVGLineElement>;
-	/**
-	 * The angle of the whole axis: the line, ticks and labels, everything.
-	 *
-	 * This is different from other graphical elements where angle usually means
-	 * the angle of text. Here, it means the angle of everything.
-	 *
-	 * @defaultValue 0
-	 */
-	angle?: number;
-	/**
-	 * The type of axis.
-	 *
-	 * `category`: Treats data as distinct values.
-	 * Each value is in the same distance from its neighbors, regardless of their actual numeric difference.
-	 *
-	 * `number`: Treats data as continuous range.
-	 * Values that are numerically closer are placed closer together on the axis.
-	 *
-	 * `auto`: the type is inferred based on the chart layout.
-	 *
-	 * @defaultValue auto
-	 */
-	type?: AxisDomainTypeInput;
-	/**
-	 * The orientation of axis text.
-	 * @defaultValue right
-	 */
-	orientation?: TickOrientation;
-	/**
-	 * Specify the domain of axis when the axis is a number axis.
-	 *
-	 * If undefined, then the domain is calculated based on the data and dataKeys.
-	 *
-	 * The length of domain should be 2, and we will validate the values in domain.
-	 *
-	 * Each element in the array can be a number, 'auto', 'dataMin', 'dataMax', a string like 'dataMin - 20', 'dataMax + 100',
-	 * or a function that accepts a single argument and returns a number.
-	 *
-	 * If any element of domain is set to be 'auto', comprehensible scale ticks will be calculated, and the final domain of axis is generated by the ticks.
-	 * If a function, receives '[dataMin, dataMax]', and must return a computed domain as '[min, max]'.
-	 *
-	 * @example <PolarRadiusAxis type="number" domain={['dataMin', 'dataMax']} />
-	 * @example <PolarRadiusAxis type="number" domain={[0, 'dataMax']} />
-	 * @example <PolarRadiusAxis type="number" domain={['auto', 'auto']} />
-	 * @example <PolarRadiusAxis type="number" domain={[0, 'dataMax + 1000']} />
-	 * @example <PolarRadiusAxis type="number" domain={['dataMin - 100', 'dataMax + 100']} />
-	 * @example <PolarRadiusAxis type="number" domain={[dataMin => (0 - Math.abs(dataMin)), dataMax => (dataMax * 2)]} />
-	 * @example <PolarRadiusAxis type="number" domain={([dataMin, dataMax]) => { const absMax = Math.max(Math.abs(dataMin), Math.abs(dataMax)); return [-absMax, absMax]; }} />
-	 * @example <PolarRadiusAxis type="number" domain={[0, 100]} allowDataOverflow />
-	 */
-	domain?: AxisDomain;
-	/**
-	 * Scale function determines how data values are mapped to visual values.
-	 * In other words, decided the mapping between data domain and coordinate range.
-	 *
-	 * If undefined, or 'auto', the scale function is created internally according to the type of axis and data.
-	 *
-	 * You can define a custom scale, either as a string shortcut to a d3 scale, or as a complete scale definition object.
-	 *
-	 * @defaultValue auto
-	 * @example <PolarRadiusAxis scale="log" />
-	 * @example
-	 * import { scaleLog } from 'd3-scale';
-	 * const scale = scaleLog().base(Math.E);
-	 * <PolarRadiusAxis scale={scale} />
-	 */
-	scale?:
-		| ScaleType
-		| CustomScaleDefinition
-		| CustomScaleDefinition<string>
-		| CustomScaleDefinition<number>
-		| CustomScaleDefinition<Date>;
-	/**
-	 * The customized event handler of click on the ticks of this axis
-	 */
-	onClick?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * The customized event handler of mousedown on the ticks of this axis
-	 */
-	onMouseDown?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * The customized event handler of mouseup on the ticks of this axis
-	 */
-	onMouseUp?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * The customized event handler of mousemove on the ticks of this axis
-	 */
-	onMouseMove?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * The customized event handler of mouseover on the ticks of this axis
-	 */
-	onMouseOver?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * The customized event handler of mouseout on the ticks of this axis
-	 */
-	onMouseOut?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * The customized event handler of mouseenter on the ticks of this axis
-	 */
-	onMouseEnter?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * The customized event handler of mouseleave on the ticks of this axis
-	 */
-	onMouseLeave?: (data: any, index: number, e: React.MouseEvent) => void;
-	/**
-	 * Allow the ticks of axis to be decimals or not.
-	 *
-	 * @defaultValue false
-	 */
-	allowDecimals?: boolean;
-	/**
-	 * Controls how Recharts calculates "nice" tick values for this axis.
-	 * Options: `'none'`, `'auto'`, `'adaptive'`, `'snap125'`.
-	 * See {@link NiceTicksAlgorithm} for a full description of each option.
-	 *
-	 * @defaultValue 'auto'
-	 */
-	niceTicks?: NiceTicksAlgorithm;
-	/**
-	 * @defaultValue 0
-	 */
-	radiusAxisId?: string | number;
-	/**
-	 * Defines how the individual label text is rendered.
-	 * This controls the settings for individual ticks; on a typical axis, there are multiple ticks, depending on your data.
-	 *
-	 * If you want to customize the overall axis label, use the `label` prop instead.
-	 *
-	 * Options:
-	 * - `false`: Do not render any tick labels.
-	 * - `true`: Render tick labels with default settings.
-	 * - `object`: An object of props to be merged into the internally calculated tick props.
-	 * - `ReactElement`: A custom React element to be used as the tick label.
-	 * - `function`: A function that returns a React element for custom rendering of tick labels.
-	 *
-	 * @defaultValue true
-	 */
-	tick?: TickProp<BaseTickContentProps>;
-	ticks?: ReadonlyArray<AxisTick>;
-	/**
-	 * 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 500
-	 * @see {@link https://recharts.github.io/en-US/guide/zIndex/ Z-Index and layers guide}
-	 */
-	zIndex?: number;
-}
-type AxisSvgProps = Omit<
-	PresentationAttributesAdaptChildEvent<any, SVGTextElement>,
-	'scale' | 'type'
->;
-export type Props<DataPointType = any, DataValueType = any> = AxisSvgProps &
-	PolarRadiusAxisProps<DataPointType, DataValueType>;
-type PropsWithDefaults<DataPointType = any, DataValueType = any> = RequiresDefaultProps<
-	Props<DataPointType, DataValueType>,
-	typeof defaultPolarRadiusAxisProps
->;
-export declare const PolarRadiusAxisWrapper: FunctionComponent<PropsWithDefaults>;
-/**
- * @provides PolarLabelContext
- * @consumes PolarViewBoxContext
- */
-export declare function PolarRadiusAxis<DataPointType = any, DataValueType = any>(
-	outsideProps: Props<DataPointType, DataValueType>,
-): React.JSX.Element;
-export declare namespace PolarRadiusAxis {
-	var displayName: string;
-}
-export {};

package/src/polar/Radar.tsrx.d.ts

@@ -1,215 +0,0 @@
-import * as React from 'octane';
-import { MouseEvent, ReactElement, SVGProps } from 'octane';
-import { ImplicitLabelListType } from '../component/LabelList';
-import {
-	ActiveDotType,
-	AnimationDuration,
-	DataConsumer,
-	DataKey,
-	DotType,
-	EasingInput,
-	LegendType,
-	PolarLayout,
-	TooltipType,
-} from '../util/types';
-import { AnimationInterpolateFn } from '../animation/AnimatedItems';
-import { AnimationMatchByProp } from '../animation/matchBy';
-import { RequiresDefaultProps } from '../util/resolveDefaultProps';
-import { WithIdRequired } from '../util/useUniqueId';
-import { ZIndexable } from '../zIndex/ZIndexLayer';
-import { RechartsScale } from '../util/scale/RechartsScale';
-export interface RadarPoint {
-	x: number;
-	y: number;
-	cx?: number;
-	cy?: number;
-	angle: number;
-	radius?: number;
-	value?: number;
-	payload?: any;
-	name?: string | number;
-}
-interface RadarProps<DataPointType = any, DataValueType = any>
-	extends ZIndexable, DataConsumer<DataPointType, DataValueType> {
-	/**
-	 * @defaultValue true
-	 */
-	activeDot?: ActiveDotType;
-	/**
-	 * @defaultValue 0
-	 */
-	angleAxisId?: string | number;
-	/**
-	 * Specifies when the animation should begin, the unit of this option is ms.
-	 * @defaultValue 0
-	 */
-	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<RadarPoint, PolarLayout>;
-	/**
-	 * 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.
-	 *
-	 * - `matchByIndex` (default): match by array position with proportional stretching
-	 * - `matchAppend`: match sequentially by index and treat newly appended items as new
-	 * - `matchByDataKey('someKey')`: match by a data key from the payload
-	 * - Custom function `(item, index) => key`: match by the returned key
-	 *
-	 * @defaultValue index
-	 * @see matchByIndex
-	 * @see matchByDataKey
-	 * @see matchAppend
-	 */
-	animationMatchBy?: AnimationMatchByProp<RadarPoint>;
-	baseLinePoints?: RadarPoint[];
-	className?: string;
-	connectNulls?: boolean;
-	/**
-	 * Renders a circle element at each data point. Options:
-	 *
-	 * - `false`: no dots are drawn;
-	 * - `true`: renders the dots with default settings;
-	 * - `object`: the props of the dot. This will be merged with the internal calculated props of each dot;
-	 * - `ReactElement`: the custom dot element;
-	 * - `function`: a render function of the custom dot.
-	 *
-	 * @defaultValue false
-	 */
-	dot?: DotType;
-	/**
-	 * @defaultValue false
-	 */
-	hide?: boolean;
-	/**
-	 * If set false, animation of polygon 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';
-	isRange?: boolean;
-	/**
-	 * Renders one label for each point. Options:
-	 * - `true`: renders default labels;
-	 * - `false`: no labels are rendered;
-	 * - `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
-	 */
-	label?: ImplicitLabelListType;
-	/**
-	 * The type of icon in legend.  If set to 'none', no legend item will be rendered.
-	 * @defaultValue rect
-	 */
-	legendType?: LegendType;
-	/**
-	 * The customized event handler of animation end
-	 */
-	onAnimationEnd?: () => void;
-	/**
-	 * The customized event handler of animation start
-	 */
-	onAnimationStart?: () => void;
-	onMouseEnter?: (props: InternalRadarProps, e: MouseEvent<SVGPolygonElement>) => void;
-	onMouseLeave?: (props: InternalRadarProps, e: MouseEvent<SVGPolygonElement>) => void;
-	/**
-	 * @defaultValue 0
-	 */
-	radiusAxisId?: string | number;
-	/**
-	 * If set a ReactElement, the shape of radar can be customized.
-	 * If set a function, the function will be called to render customized shape.
-	 */
-	shape?: ReactElement<SVGElement> | ((props: any) => ReactElement<SVGElement>);
-	tooltipType?: TooltipType;
-	/**
-	 * @defaultValue 100
-	 */
-	zIndex?: number;
-}
-export type RadiusAxisForRadar = {
-	scale: RechartsScale;
-};
-export type AngleAxisForRadar = {
-	scale: RechartsScale;
-	type: 'number' | 'category';
-	dataKey: DataKey<any> | undefined;
-	cx: number;
-	cy: number;
-};
-export type Props<DataPointType = any, DataValueType = any> = Omit<
-	SVGProps<SVGGraphicsElement>,
-	'onMouseEnter' | 'onMouseLeave' | 'points' | 'ref'
-> &
-	RadarProps<DataPointType, DataValueType>;
-export type RadarComposedData = {
-	points: RadarPoint[];
-	baseLinePoints: RadarPoint[];
-	isRange: boolean;
-};
-export declare function computeRadarPoints({
-	radiusAxis,
-	angleAxis,
-	displayedData,
-	dataKey,
-	bandSize,
-}: {
-	radiusAxis: RadiusAxisForRadar;
-	angleAxis: AngleAxisForRadar;
-	displayedData: any[];
-	dataKey: RadarProps['dataKey'];
-	bandSize: number;
-}): RadarComposedData;
-export declare const defaultRadarProps: {
-	readonly activeDot: true;
-	readonly angleAxisId: 0;
-	readonly animationBegin: 0;
-	readonly animationDuration: 1500;
-	readonly animationEasing: 'ease';
-	readonly animationMatchBy: 'index';
-	readonly animationInterpolateFn: AnimationInterpolateFn<RadarPoint, PolarLayout>;
-	readonly dot: false;
-	readonly hide: false;
-	readonly isAnimationActive: 'auto';
-	readonly label: false;
-	readonly legendType: 'rect';
-	readonly radiusAxisId: 0;
-	readonly zIndex: 100;
-};
-type PropsWithDefaults = RequiresDefaultProps<Props, typeof defaultRadarProps>;
-export type InternalRadarProps = WithIdRequired<PropsWithDefaults> & RadarComposedData;
-/**
- * @consumes PolarChartContext
- * @provides LabelListContext
- */
-export declare function Radar<DataPointType = any, DataValueType = any>(
-	outsideProps: Props<DataPointType, DataValueType>,
-): React.JSX.Element;
-export declare namespace Radar {
-	var displayName: string;
-}
-export {};