10386186400

Committed 14 Aug 2024 10:49AM UTC coverage: 90.893% (-0.02%) from 90.915%

Build # 10386186400

Build Type

Pull #6181

github

Committed by

yvonneyx

Commit Message

test: add polyline unit tests

Pull Request Pull Request #6181: feat: use a-star pathfinding algorithm to draw polyline

Run Details

2861 of 3505 branches covered (81.63%)

Branch coverage included in aggregate %.

210 of 220 new or added lines in 5 files covered. (95.45%)

9 existing lines in 2 files now uncovered.

6471 of 6762 relevant lines covered (95.7%)

11687.62 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.18

/packages/g6/src/elements/edges/polyline.ts

import type { DisplayObjectConfig } from '@antv/g';
import type { PathArray } from '@antv/util';
import type { LoopStyleProps, Point, PolylineRouter } from '../../types';
import { getBBoxHeight, getBBoxWidth, getNodeBBox } from '../../utils/bbox';
import { getPolylineLoopPath, getPolylinePath } from '../../utils/edge';
import { subStyleProps } from '../../utils/prefix';
import { orth } from '../../utils/router/orth';
import { aStarSearch } from '../../utils/router/shortest-path';
import { mergeOptions } from '../../utils/style';
import type { BaseEdgeStyleProps } from './base-edge';
import { BaseEdge } from './base-edge';

/**
 * <zh/> 折线样式配置项
 *
 * <en/> Polyline style properties
 */
export interface PolylineStyleProps extends BaseEdgeStyleProps {
  /**
   * <zh/> 圆角半径
   *
   * <en/> The radius of the rounded corner
   * @defaultValue 0
   */
  radius?: number;
  /**
   * <zh/> 控制点数组
   *
   * <en/> Control point array
   */
  controlPoints?: Point[];
  /**
   * <zh/> 是否启用路由，默认开启且 controlPoints 会自动计入
   *
   * <en/> Whether to enable routing, it is enabled by default and controlPoints will be automatically included
   * @defaultValue false
   */
  router?: PolylineRouter;
}

type ParsedPolylineStyleProps = Required<PolylineStyleProps>;

/**
 * <zh/> 折线
 *
 * <en/> Polyline
 */
export class Polyline extends BaseEdge {
  static defaultStyleProps: Partial<PolylineStyleProps> = {
    radius: 0,
    controlPoints: [],
    router: false,
  };

  constructor(options: DisplayObjectConfig<PolylineStyleProps>) {
    super(mergeOptions({ style: Polyline.defaultStyleProps }, options));
  }

  protected getPoints(attributes: ParsedPolylineStyleProps): Point[] {
    const { router } = attributes;
    const { sourceNode, targetNode } = this;
    const [sourcePoint, targetPoint] = this.getEndpoints(attributes, false);

    let controlPoints: Point[] = [];

    if (!router) {
      controlPoints = attributes.controlPoints;
    } else {
      if (router.type === 'shortest-path') {
        const nodes = this.context.element!.getNodes();
        controlPoints = aStarSearch(sourceNode, targetNode, nodes, router);
        if (!controlPoints.length) {
          controlPoints = orth(sourcePoint, targetPoint, sourceNode, targetNode, attributes.controlPoints, {
            padding: router.offset,
          });
        }
      } else if (router.type === 'orth') {
        controlPoints = orth(sourcePoint, targetPoint, sourceNode, targetNode, attributes.controlPoints, router);
      }
    }

    const [newSourcePoint, newTargetPoint] = this.getEndpoints(attributes, true, controlPoints);
    return [newSourcePoint, ...controlPoints, newTargetPoint];
  }

  protected getKeyPath(attributes: ParsedPolylineStyleProps): PathArray {
    const points = this.getPoints(attributes);
    return getPolylinePath(points, attributes.radius);
  }

  protected getLoopPath(attributes: ParsedPolylineStyleProps): PathArray {
    const { sourcePort: sourcePortKey, targetPort: targetPortKey, radius } = attributes;
    const node = this.sourceNode;

    const bbox = getNodeBBox(node);
    // 默认转折点距离为 bbox 的最大宽高的 1/4
    // Default distance of the turning point is 1/4 of the maximum width and height of the bbox
    const defaultDist = Math.max(getBBoxWidth(bbox), getBBoxHeight(bbox)) / 4;

    const {
      placement,
      clockwise,
      dist = defaultDist,
    } = subStyleProps<Required<LoopStyleProps>>(this.getGraphicStyle(attributes), 'loop');

    return getPolylineLoopPath(node, radius, placement, clockwise, dist, sourcePortKey, targetPortKey);
  }
}

1	import type { DisplayObjectConfig } from '@antv/g';
2	import type { PathArray } from '@antv/util';
3	import type { LoopStyleProps, Point, PolylineRouter } from '../../types';
4	import { getBBoxHeight, getBBoxWidth, getNodeBBox } from '../../utils/bbox';	274✔
5	import { getPolylineLoopPath, getPolylinePath } from '../../utils/edge';	274✔
6	import { subStyleProps } from '../../utils/prefix';	274✔
7	import { orth } from '../../utils/router/orth';	274✔
8	import { aStarSearch } from '../../utils/router/shortest-path';	274✔
9	import { mergeOptions } from '../../utils/style';	274✔
10	import type { BaseEdgeStyleProps } from './base-edge';
11	import { BaseEdge } from './base-edge';	274✔
12
13	/**
14	* <zh/> 折线样式配置项
15	*
16	* <en/> Polyline style properties
17	*/
18	export interface PolylineStyleProps extends BaseEdgeStyleProps {
19	/**
20	* <zh/> 圆角半径
21	*
22	* <en/> The radius of the rounded corner
23	* @defaultValue 0
24	*/
25	radius?: number;
26	/**
27	* <zh/> 控制点数组
28	*
29	* <en/> Control point array
30	*/
31	controlPoints?: Point[];
32	/**
33	* <zh/> 是否启用路由，默认开启且 controlPoints 会自动计入
34	*
35	* <en/> Whether to enable routing, it is enabled by default and controlPoints will be automatically included
36	* @defaultValue false
37	*/
38	router?: PolylineRouter;
39	}
40
41	type ParsedPolylineStyleProps = Required<PolylineStyleProps>;
42
43	/**
44	* <zh/> 折线
45	*
46	* <en/> Polyline
47	*/
48	export class Polyline extends BaseEdge {	272✔
49	static defaultStyleProps: Partial<PolylineStyleProps> = {	274✔
50	radius: 0,
51	controlPoints: [],
52	router: false,
53	};
54
55	constructor(options: DisplayObjectConfig<PolylineStyleProps>) {
56	super(mergeOptions({ style: Polyline.defaultStyleProps }, options));	108✔
57	}
58
59	protected getPoints(attributes: ParsedPolylineStyleProps): Point[] {
60	const { router } = attributes;	436✔
61	const { sourceNode, targetNode } = this;	436✔
62	const [sourcePoint, targetPoint] = this.getEndpoints(attributes, false);	436✔
63
64	let controlPoints: Point[] = [];	436✔
65
66	if (!router) {	436✔
67	controlPoints = attributes.controlPoints;	200✔
68	} else {
69	if (router.type === 'shortest-path') {	236✔
70	const nodes = this.context.element!.getNodes();	22✔
71	controlPoints = aStarSearch(sourceNode, targetNode, nodes, router);	22✔
72	if (!controlPoints.length) {	22!
NEW 73	controlPoints = orth(sourcePoint, targetPoint, sourceNode, targetNode, attributes.controlPoints, {	×
74	padding: router.offset,
75	});
76	}
77	} else if (router.type === 'orth') {	214✔
78	controlPoints = orth(sourcePoint, targetPoint, sourceNode, targetNode, attributes.controlPoints, router);	214✔
79	}
80	}
81
82	const [newSourcePoint, newTargetPoint] = this.getEndpoints(attributes, true, controlPoints);	436✔
83	return [newSourcePoint, ...controlPoints, newTargetPoint];	436✔
84	}
85
86	protected getKeyPath(attributes: ParsedPolylineStyleProps): PathArray {
87	const points = this.getPoints(attributes);	436✔
88	return getPolylinePath(points, attributes.radius);	436✔
89	}
90
91	protected getLoopPath(attributes: ParsedPolylineStyleProps): PathArray {
92	const { sourcePort: sourcePortKey, targetPort: targetPortKey, radius } = attributes;	68✔
93	const node = this.sourceNode;	68✔
94
95	const bbox = getNodeBBox(node);	68✔
96	// 默认转折点距离为 bbox 的最大宽高的 1/4
97	// Default distance of the turning point is 1/4 of the maximum width and height of the bbox
98	const defaultDist = Math.max(getBBoxWidth(bbox), getBBoxHeight(bbox)) / 4;	68✔
99
100	const {
101	placement,
102	clockwise,
103	dist = defaultDist,	34✔
104	} = subStyleProps<Required<LoopStyleProps>>(this.getGraphicStyle(attributes), 'loop');	68✔
105
106	return getPolylineLoopPath(node, radius, placement, clockwise, dist, sourcePortKey, targetPortKey);	68✔
107	}
108	}

antvis / G6 / 10386186400

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous