Skip to content

Commit a43cdc6

Browse files
Update connections start, end cap documention
1 parent ef3d7f1 commit a43cdc6

File tree

2 files changed

+363
-16
lines changed

2 files changed

+363
-16
lines changed

api/javascript/dataviz/diagram/connection.md

Lines changed: 112 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,24 +58,130 @@ Defines the highlight color when the pointer is hovering over the connection.
5858
});
5959
</script>
6060

61-
### startCap `String` *(default: "FilledCircle")*
61+
### startCap `String|Object`
6262

63-
The start cap (arrow, head or decoration) of the connection:
63+
The connection start cap configuration or type name.
64+
65+
#### Example - configuring the connection start cap
66+
67+
<div id="diagram"></div>
68+
<script>
69+
var Point = kendo.dataviz.diagram.Point;
70+
var diagram = $("#diagram").kendoDiagram({ }).getKendoDiagram();
71+
var connection = diagram.connect(new Point(100,100), new Point(300,100), {
72+
startCap: {
73+
type: "FilledCircle",
74+
fill: {
75+
color: "red"
76+
},
77+
stroke: {
78+
color: "blue",
79+
width: 2
80+
}
81+
}
82+
});
83+
</script>
84+
85+
### startCap.fill `String|Object`
86+
87+
The connection start cap fill options or color.
88+
89+
### startCap.fill.color `String` *(default: "black")*
90+
91+
The connection start cap fill color.
92+
93+
### startCap.fill.opacity
94+
95+
The connection start cap fill opacity.
96+
97+
### startCap.stroke `String|Object`
98+
99+
The connection start cap stroke options or color.
100+
101+
### startCap.stroke.color `String`
102+
103+
The connection start cap stroke color.
104+
105+
### startCap.stroke.dashType `String`
106+
107+
The connection start cap stroke dash type.
108+
109+
### startCap.stroke.width `Number`
110+
111+
The connection start cap stroke width.
112+
113+
### startCap.type *(default: "none")*
114+
115+
The connection start cap type.
116+
117+
The supported values are:
64118

65119
* "none": no cap
66120
* "ArrowStart": a filled arrow
67121
* "FilledCircle": a filled circle
68122

69-
### endCap `String` *(default: "ArrowEnd")*
123+
### endCap `String|Object`
124+
125+
The connection end cap configuration or type name.
70126

71-
The start cap (arrow, head or decoration) of the connection:
127+
#### Example - configuring the connection end cap
128+
129+
<div id="diagram"></div>
130+
<script>
131+
var Point = kendo.dataviz.diagram.Point;
132+
var diagram = $("#diagram").kendoDiagram({ }).getKendoDiagram();
133+
var connection = diagram.connect(new Point(100,100), new Point(300,100), {
134+
endCap: {
135+
type: "ArrowEnd",
136+
fill: {
137+
color: "red"
138+
},
139+
stroke: {
140+
color: "blue",
141+
width: 2
142+
}
143+
}
144+
});
145+
</script>
146+
147+
### endCap.fill `String|Object`
148+
149+
The connection end cap fill options or color.
150+
151+
### endCap.fill.color `String` *(default: "black")*
152+
153+
The connection end cap fill color.
154+
155+
### endCap.fill.opacity
156+
157+
The connection end cap fill opacity.
158+
159+
### endCap.stroke `String|Object`
160+
161+
The connection end cap stroke options or color.
162+
163+
### endCap.stroke.color `String`
164+
165+
The connection end cap stroke color.
166+
167+
### endCap.stroke.dashType `String`
168+
169+
The connection end cap stroke dash type.
170+
171+
### endCap.stroke.width `Number`
172+
173+
The connection end cap stroke width.
174+
175+
### endCap.type *(default: "none")*
176+
177+
The connection end cap type.
178+
179+
The supported values are:
72180

73181
* "none": no cap
74182
* "ArrowEnd": a filled arrow
75183
* "FilledCircle": a filled circle
76184

77-
Note that you can also use the "ArrowStart" for the endCap but its direction will be inversed.
78-
79185
### points `Array`
80186

81187
Sets the intermediate points (in global coordinates) of the connection.

0 commit comments

Comments
 (0)