UNPKG

2.8 kBTypeScriptView Raw
1/**
2 * this prepares the JSON container for allocating SVG elements
3 * @param {Object} JSONcontainer
4 * @private
5 */
6export function prepareElements(JSONcontainer: any): void
7
8/**
9 * this cleans up all the unused SVG elements. By asking for the parentNode, we only need to supply the JSON container from
10 * which to remove the redundant elements.
11 *
12 * @param {Object} JSONcontainer
13 * @private
14 */
15export function cleanupElements(JSONcontainer: any): void
16
17/**
18 * Ensures that all elements are removed first up so they can be recreated cleanly
19 * @param {Object} JSONcontainer
20 */
21export function resetElements(JSONcontainer: any): void
22
23/**
24 * Allocate or generate an SVG element if needed. Store a reference to it in the JSON container and draw it in the svgContainer
25 * the JSON container and the SVG container have to be supplied so other svg containers (like the legend) can use this.
26 *
27 * @param {string} elementType
28 * @param {Object} JSONcontainer
29 * @param {Object} svgContainer
30 * @returns {Element}
31 * @private
32 */
33export function getSVGElement(
34 elementType: any,
35 JSONcontainer: any,
36 svgContainer: any
37): any
38
39/**
40 * Allocate or generate an SVG element if needed. Store a reference to it in the JSON container and draw it in the svgContainer
41 * the JSON container and the SVG container have to be supplied so other svg containers (like the legend) can use this.
42 *
43 * @param {string} elementType
44 * @param {Object} JSONcontainer
45 * @param {Element} DOMContainer
46 * @param {Element} insertBefore
47 * @returns {*}
48 */
49export function getDOMElement(
50 elementType: any,
51 JSONcontainer: any,
52 DOMContainer: any,
53 insertBefore: any
54): any
55
56/**
57 * Draw a point object. This is a separate function because it can also be called by the legend.
58 * The reason the JSONcontainer and the target SVG svgContainer have to be supplied is so the legend can use these functions
59 * as well.
60 *
61 * @param {number} x
62 * @param {number} y
63 * @param {Object} groupTemplate: A template containing the necessary information to draw the datapoint e.g., {style: 'circle', size: 5, className: 'className' }
64 * @param {Object} JSONcontainer
65 * @param {Object} svgContainer
66 * @param {Object} labelObj
67 * @returns {vis.PointItem}
68 */
69export function drawPoint(
70 x: any,
71 y: any,
72 groupTemplate: any,
73 JSONcontainer: any,
74 svgContainer: any,
75 labelObj: any
76): any
77
78/**
79 * draw a bar SVG element centered on the X coordinate
80 *
81 * @param {number} x
82 * @param {number} y
83 * @param {number} width
84 * @param {number} height
85 * @param {string} className
86 * @param {Object} JSONcontainer
87 * @param {Object} svgContainer
88 * @param {string} style
89 */
90export function drawBar(
91 x: any,
92 y: any,
93 width: any,
94 height: any,
95 className: any,
96 JSONcontainer: any,
97 svgContainer: any,
98 style: any
99): void
100
\No newline at end of file