Skip to content

Commit f7ec8c6

Browse files
tsvetomirtsvetomir
committed
Document element opacity
1 parent 0c7c8bd commit f7ec8c6

File tree

8 files changed

+171
-0
lines changed

8 files changed

+171
-0
lines changed

‎api/javascript/dataviz/drawing/arc.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ The configuration options.
3737
### fill `kendo.dataviz.drawing.FillOptions`
3838
The fill options of the shape.
3939

40+
### opacity `Number`
41+
The element opacity.
42+
Inherited from [Element.opacity](element#configuration-opacity)
43+
4044
### stroke `kendo.dataviz.drawing.StrokeOptions`
4145
The stroke options of the shape.
4246

@@ -85,6 +89,21 @@ The [fill opacity](fill-options#fields-opacity) to set.
8589
`kendo.dataviz.drawing.Arc` The current instance to allow chaining.
8690

8791

92+
### opacity
93+
Gets or sets the element opacity.
94+
Inherited from [Element.opacity](element#methods-opacity)
95+
96+
If set, the stroke and fill opacity will be multiplied by the element opacity.
97+
98+
#### Parameters
99+
100+
##### opacity `Number`
101+
The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
102+
103+
#### Returns
104+
`Number` The current element opacity.
105+
106+
88107
### stroke
89108
Sets the shape [stroke](#configuration-stroke).
90109

‎api/javascript/dataviz/drawing/circle.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ The configuration options.
3232
### fill `kendo.dataviz.drawing.FillOptions`
3333
The fill options of the shape.
3434

35+
### opacity `Number`
36+
The element opacity.
37+
Inherited from [Element.opacity](element#configuration-opacity)
38+
3539
### stroke `kendo.dataviz.drawing.StrokeOptions`
3640
The stroke options of the shape.
3741

@@ -80,6 +84,21 @@ The [fill opacity](fill-options#fields-opacity) to set.
8084
`kendo.dataviz.drawing.Circle` The current instance to allow chaining.
8185

8286

87+
### opacity
88+
Gets or sets the element opacity.
89+
Inherited from [Element.opacity](element#methods-opacity)
90+
91+
If set, the stroke and fill opacity will be multiplied by the element opacity.
92+
93+
#### Parameters
94+
95+
##### opacity `Number`
96+
The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
97+
98+
#### Returns
99+
`Number` The current element opacity.
100+
101+
83102
### stroke
84103
Sets the shape [stroke](#configuration-stroke).
85104

‎api/javascript/dataviz/drawing/element.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ The configuration of this Group.
1313

1414
## Configuration
1515

16+
### opacity `Number`
17+
The element opacity.
18+
1619
### transform `kendo.dataviz.geometry.Transformation`
1720
The transformation to apply to this element.
1821

@@ -33,6 +36,31 @@ Returns the bounding box of the element with transformations applied.
3336
`kendo.dataviz.geometry.Rect` The bounding box of the element with transformations applied.
3437

3538

39+
### opacity
40+
Gets or sets the element opacity.
41+
42+
#### Example - setting transformation on an element
43+
<div id="surface"></div>
44+
<script>
45+
var draw = kendo.dataviz.drawing;
46+
47+
var path = new draw.Path();
48+
path.moveTo(0, 0).lineTo(100, 100);
49+
path.opacity(0.5);
50+
51+
var surface = draw.Surface.create($("#surface"));
52+
surface.draw(path);
53+
</script>
54+
55+
#### Parameters
56+
57+
##### opacity `Number`
58+
The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
59+
60+
#### Returns
61+
`Number` The current element opacity.
62+
63+
3664
### transform
3765
Gets or sets the transformation of the element.
3866

‎api/javascript/dataviz/drawing/group.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,22 @@ Represents a set of drawing elements, possibly including other groups.
2626
### options `Object`
2727
The configuration of this Group.
2828

29+
## Configuration
30+
31+
### opacity `Number`
32+
The group opacity.
33+
Inherited from [Element.opacity](element#configuration-opacity)
34+
35+
The opacity of any child groups and elements will be multiplied by this value.
36+
37+
### transform `kendo.dataviz.geometry.Transformation`
38+
The transformation to apply to this group and its children.
39+
Inherited from [Element.transform](element#configuration-transform)
40+
41+
### visible `Boolean`
42+
A flag, indicating if the group and its children are visible.
43+
Inherited from [Element.visible](element#configuration-visible)
44+
2945
## Fields
3046

3147
### children `Array`
@@ -46,6 +62,21 @@ The element to append. Multiple parameters are accepted.
4662
Removes all child elements from the group.
4763

4864

65+
### opacity
66+
Gets or sets the group opacity.
67+
Inherited from [Element.opacity](element#methods-opacity)
68+
69+
The opacity of any child groups and elements will be multiplied by this value.
70+
71+
#### Parameters
72+
73+
##### opacity `Number`
74+
The group opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
75+
76+
#### Returns
77+
`Number` The current group opacity.
78+
79+
4980
### remove
5081
Removes the specified element from the group.
5182

‎api/javascript/dataviz/drawing/image.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ A rectange defining the position and size of the image.
3232

3333
## Configuration
3434

35+
### opacity `Number`
36+
The element opacity.
37+
Inherited from [Element.opacity](element#configuration-opacity)
38+
3539
### transform `kendo.dataviz.geometry.Transformation`
3640
The transformation to apply to this element.
3741
Inherited from [Element.transform](element#configuration-transform)
@@ -50,6 +54,19 @@ Inherited from [Element.bbox](element#methods-bbox)
5054
`kendo.dataviz.geometry.Rect` The bounding box of the element with transformations applied.
5155

5256

57+
### opacity
58+
Gets or sets the element opacity.
59+
Inherited from [Element.opacity](element#methods-opacity)
60+
61+
#### Parameters
62+
63+
##### opacity `Number`
64+
The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
65+
66+
#### Returns
67+
`Number` The current element opacity.
68+
69+
5370
### src
5471
Gets or sets the image source URL.
5572

‎api/javascript/dataviz/drawing/multi-path.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ The configuration options.
3333
### fill `kendo.dataviz.drawing.FillOptions`
3434
The fill options of the shape.
3535

36+
### opacity `Number`
37+
The element opacity.
38+
Inherited from [Element.opacity](element#configuration-opacity)
39+
3640
### stroke `kendo.dataviz.drawing.StrokeOptions`
3741
The stroke options of the shape.
3842

@@ -204,6 +208,21 @@ Optional if the first parameter is a Point/Array.
204208
`kendo.dataviz.drawing.MultiPath` The current instance to allow chaining.
205209

206210

211+
### opacity
212+
Gets or sets the element opacity.
213+
Inherited from [Element.opacity](element#methods-opacity)
214+
215+
If set, the stroke and fill opacity will be multiplied by the element opacity.
216+
217+
#### Parameters
218+
219+
##### opacity `Number`
220+
The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
221+
222+
#### Returns
223+
`Number` The current element opacity.
224+
225+
207226
### stroke
208227
Sets the shape [stroke](#configuration-stroke).
209228

‎api/javascript/dataviz/drawing/path.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ The [configuration](/api/dataviz/drawing/path#configuration) options for the pat
7676
### fill `kendo.dataviz.drawing.FillOptions`
7777
The fill options of the shape.
7878

79+
### opacity `Number`
80+
The element opacity.
81+
Inherited from [Element.opacity](element#configuration-opacity)
82+
7983
### stroke `kendo.dataviz.drawing.StrokeOptions`
8084
The stroke options of the shape.
8185

@@ -243,6 +247,21 @@ Optional if the first parameter is a Point/Array.
243247
`kendo.dataviz.drawing.Path` The current instance to allow chaining.
244248

245249

250+
### opacity
251+
Gets or sets the element opacity.
252+
Inherited from [Element.opacity](element#methods-opacity)
253+
254+
If set, the stroke and fill opacity will be multiplied by the element opacity.
255+
256+
#### Parameters
257+
258+
##### opacity `Number`
259+
The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
260+
261+
#### Returns
262+
`Number` The current element opacity.
263+
264+
246265
### stroke
247266
Sets the shape [stroke](#configuration-stroke).
248267

‎api/javascript/dataviz/drawing/text.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ The configuration options.
3535
### fill `kendo.dataviz.drawing.FillOptions`
3636
The fill options of the text.
3737

38+
### opacity `Number`
39+
The element opacity.
40+
Inherited from [Element.opacity](element#configuration-opacity)
41+
3842
### stroke `kendo.dataviz.drawing.StrokeOptions`
3943
The stroke options of the text.
4044

@@ -100,6 +104,21 @@ The [fill opacity](fill-options#fields-opacity) to set.
100104
`kendo.dataviz.drawing.Text` The current instance to allow chaining.
101105

102106

107+
### opacity
108+
Gets or sets the element opacity.
109+
Inherited from [Element.opacity](element#methods-opacity)
110+
111+
If set, the stroke and fill opacity will be multiplied by the element opacity.
112+
113+
#### Parameters
114+
115+
##### opacity `Number`
116+
The element opacity. Ranges from 0 (completely transparent) to 1 (completely opaque).
117+
118+
#### Returns
119+
`Number` The current element opacity.
120+
121+
103122
### position
104123
Gets or sets the position of the text upper left corner.
105124

0 commit comments

Comments
 (0)