Skip to content

Commit 05bda18

Browse files
committed
docs: Server API updated for R1 2017
1 parent a2da181 commit 05bda18

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1017
-219
lines changed

api/server/Telerik.Web.UI.Diagram/ConnectionContent.md

+28-4
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,45 @@ description: Telerik.Web.UI.Diagram.ConnectionContent
66

77
# Telerik.Web.UI.Diagram.ConnectionContent
88

9-
Defines the connections content settings.
9+
Defines the content configuration.
1010

1111
## Inheritance Hierarchy
1212

1313
* System.Object
1414
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager
15-
* Telerik.Web.UI.Diagram.ConnectionContent
15+
* Telerik.Web.UI.Diagram.ConnectionContent : IDefaultCheck
1616

1717
## Properties
1818

1919
### Color `String`
2020

21-
The color of the text.
21+
The color of the connection content text.
22+
23+
### FontFamily `String`
24+
25+
The font family of the connection content text.
26+
27+
### FontSize `Double`
28+
29+
The font size of the connection content text.
30+
31+
### FontStyle `String`
32+
33+
The font style of the connection content text.
34+
35+
### FontWeight `String`
36+
37+
The font weight of the connection content text.
38+
39+
### Template `String`
40+
41+
The template which renders the labels.The fields which can be used in the template are:
2242

2343
### Text `String`
2444

25-
The text displayed above the connection.
45+
The static text displayed on the connection.
46+
47+
### Visual `String`
48+
49+
A function returning a visual element to render for the content of a connection.
2650

api/server/Telerik.Web.UI.Diagram/ConnectionDefaults.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,31 @@ Defines the label displayed on the connection path.
2222

2323
### Editable `Boolean`
2424

25-
Defines the editing behavior of the connections.
25+
Enable editing for connections by default.
2626

2727
### EditableSettings `Boolean`
2828

29-
Defines the editing behavior of the connections.
29+
Defines the editable configuration by default.
3030

3131
### EndCap `ConnectionEndCap`
3232

3333
The end cap (arrow, head or decoration) of the connection.
3434

35+
### EndCapSettings `ConnectionEndCap`
36+
37+
The connection end cap configuration or type name.
38+
39+
### FromConnector `String`
40+
41+
Specifies the name of the source shape connector that should be used by default.
42+
3543
### HoverSettings `ConnectionHover`
3644

3745
Defines the hover configuration.
3846

3947
### Selectable `Boolean`
4048

41-
Defines the selection behavior of the connections.
49+
Specifies if the connection can be selected.
4250

4351
### SelectionSettings `Selection`
4452

@@ -48,11 +56,19 @@ Defines the connection selection configuration.
4856

4957
The start cap (arrow, head or decoration) of the connection.
5058

59+
### StartCapSettings `ConnectionStartCap`
60+
61+
The connection start cap configuration or type name.
62+
5163
### StrokeSettings `ConnectionStroke`
5264

5365
Defines the stroke configuration.
5466

67+
### ToConnector `String`
68+
69+
Specifies the name of the target shape connector that should be used by default.
70+
5571
### Type `ConnectionType`
5672

57-
The type of the connections that defines the way it routes.
73+
The type of the connection that defines the way it routes.
5874

api/server/Telerik.Web.UI.Diagram/ConnectionEditable.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Telerik.Web.UI.Diagram.ConnectionEditable
66

77
# Telerik.Web.UI.Diagram.ConnectionEditable
88

9-
Defines the editing behavior of the connections.
9+
Defines the editable configuration by default.
1010

1111
## Inheritance Hierarchy
1212

@@ -16,11 +16,7 @@ Defines the editing behavior of the connections.
1616

1717
## Properties
1818

19-
### ConnectionTemplate `String`
19+
### ToolsCollection `DiagramConnectionEditableToolsCollection`
2020

21-
Specifies the connection editor template which shows up when editing the connection via a pop-up editor much like 'editable.template' configuration of the Kendo UI Grid widget.
22-
23-
### ToolsCollection `EditableToolsCollection`
24-
25-
Specifies the the toolbar tools. Predefined tools are:
21+
Specifies the the toolbar tools. Supports all options supported for the toolbar.items. Predefined tools are:
2622

api/server/Telerik.Web.UI.Diagram/ConnectionEditableConverter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Telerik.Web.UI.Diagram.ConnectionEditableConverter
66

77
# Telerik.Web.UI.Diagram.ConnectionEditableConverter
88

9-
Serialization JS converter class for Editable
9+
Serialization JS converter class for ConnectionEditable
1010

1111
## Inheritance Hierarchy
1212

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Telerik.Web.UI.Diagram.ConnectorDefaults
3+
page_title: Telerik.Web.UI.Diagram.ConnectorDefaults
4+
description: Telerik.Web.UI.Diagram.ConnectorDefaults
5+
---
6+
7+
# Telerik.Web.UI.Diagram.ConnectorDefaults
8+
9+
Defines default options for the shape connectors.
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager
15+
* Telerik.Web.UI.Diagram.ConnectorDefaults : IDefaultCheck
16+
17+
## Properties
18+
19+
### Fill `String`
20+
21+
Defines the fill options of the shape connectors.
22+
23+
### FillSettings `String`
24+
25+
Defines the fill options of the shape connectors.
26+
27+
### Height `Double`
28+
29+
Defines the height of the shape connectors.
30+
31+
### HoverSettings `Hover`
32+
33+
Defines the hover configuration of the shape connectors.
34+
35+
### Stroke `String`
36+
37+
Defines the stroke options of the shape connectors.
38+
39+
### StrokeSettings `String`
40+
41+
Defines the stroke options of the shape connectors.
42+
43+
### Width `Double`
44+
45+
Defines the width of the shape connectors.
46+

api/server/Telerik.Web.UI.Diagram/ConnectionPointConverter.md renamed to api/server/Telerik.Web.UI.Diagram/ConnectorDefaultsConverter.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: Telerik.Web.UI.Diagram.ConnectionPointConverter
3-
page_title: Telerik.Web.UI.Diagram.ConnectionPointConverter
4-
description: Telerik.Web.UI.Diagram.ConnectionPointConverter
2+
title: Telerik.Web.UI.Diagram.ConnectorDefaultsConverter
3+
page_title: Telerik.Web.UI.Diagram.ConnectorDefaultsConverter
4+
description: Telerik.Web.UI.Diagram.ConnectorDefaultsConverter
55
---
66

7-
# Telerik.Web.UI.Diagram.ConnectionPointConverter
7+
# Telerik.Web.UI.Diagram.ConnectorDefaultsConverter
88

9-
Serialization JS converter class for ConnectionPoint
9+
Serialization JS converter class for ConnectorDefaults
1010

1111
## Inheritance Hierarchy
1212

1313
* System.Object
1414
* System.Web.Script.Serialization.JavaScriptConverter
1515
* Telerik.Web.UI.ExplicitJavaScriptConverter
16-
* Telerik.Web.UI.Diagram.ConnectionPointConverter
16+
* Telerik.Web.UI.Diagram.ConnectorDefaultsConverter
1717

1818
## Methods
1919

api/server/Telerik.Web.UI.Diagram/Content.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Telerik.Web.UI.Diagram.Content
66

77
# Telerik.Web.UI.Diagram.Content
88

9-
Defines the shapes content settings.
9+
Defines the label displayed on the connection path.
1010

1111
## Inheritance Hierarchy
1212

@@ -32,6 +32,14 @@ The font family of the shape content text.
3232

3333
The font size of the shape content text.
3434

35+
### FontStyle `String`
36+
37+
The font style of the shape content text.
38+
39+
### FontWeight `String`
40+
41+
The font weight of the shape content text.
42+
3543
### Html `String`
3644

3745
Define rich-text content using Html syntax
+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Telerik.Web.UI.Diagram.Drag
3+
page_title: Telerik.Web.UI.Diagram.Drag
4+
description: Telerik.Web.UI.Diagram.Drag
5+
---
6+
7+
# Telerik.Web.UI.Diagram.Drag
8+
9+
Specifies if the shapes and connections can be dragged.
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager
15+
* Telerik.Web.UI.Diagram.Drag : IDefaultCheck
16+
17+
## Properties
18+
19+
### Snap `Boolean`
20+
21+
Specifies the shapes drag snap options.
22+
23+
### SnapSettings `Boolean`
24+
25+
Specifies the shapes drag snap options.
26+

api/server/Telerik.Web.UI.Diagram/GridConverter.md renamed to api/server/Telerik.Web.UI.Diagram/DragConverter.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: Telerik.Web.UI.Diagram.GridConverter
3-
page_title: Telerik.Web.UI.Diagram.GridConverter
4-
description: Telerik.Web.UI.Diagram.GridConverter
2+
title: Telerik.Web.UI.Diagram.DragConverter
3+
page_title: Telerik.Web.UI.Diagram.DragConverter
4+
description: Telerik.Web.UI.Diagram.DragConverter
55
---
66

7-
# Telerik.Web.UI.Diagram.GridConverter
7+
# Telerik.Web.UI.Diagram.DragConverter
88

9-
Serialization JS converter class for Grid
9+
Serialization JS converter class for Drag
1010

1111
## Inheritance Hierarchy
1212

1313
* System.Object
1414
* System.Web.Script.Serialization.JavaScriptConverter
1515
* Telerik.Web.UI.ExplicitJavaScriptConverter
16-
* Telerik.Web.UI.Diagram.GridConverter
16+
* Telerik.Web.UI.Diagram.DragConverter
1717

1818
## Methods
1919

api/server/Telerik.Web.UI.Diagram/EditableTool.md

-26
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Telerik.Web.UI.Diagram.EndCap
3+
page_title: Telerik.Web.UI.Diagram.EndCap
4+
description: Telerik.Web.UI.Diagram.EndCap
5+
---
6+
7+
# Telerik.Web.UI.Diagram.EndCap
8+
9+
The connection end cap configuration or type name.
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager
15+
* Telerik.Web.UI.Diagram.EndCap : IDefaultCheck
16+
17+
## Properties
18+
19+
### Fill `String`
20+
21+
The connection end cap fill options or color.
22+
23+
### FillSettings `String`
24+
25+
The connection end cap fill options or color.
26+
27+
### Stroke `String`
28+
29+
The connection end cap stroke options or color.
30+
31+
### StrokeSettings `String`
32+
33+
The connection end cap stroke options or color.
34+
35+
### Type `ConnectionEndCap`
36+
37+
The type of end cap (arrow, head or decoration) of the connection.
38+

api/server/Telerik.Web.UI.Diagram/EditableConverter.md renamed to api/server/Telerik.Web.UI.Diagram/EndCapConverter.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
---
2-
title: Telerik.Web.UI.Diagram.EditableConverter
3-
page_title: Telerik.Web.UI.Diagram.EditableConverter
4-
description: Telerik.Web.UI.Diagram.EditableConverter
2+
title: Telerik.Web.UI.Diagram.EndCapConverter
3+
page_title: Telerik.Web.UI.Diagram.EndCapConverter
4+
description: Telerik.Web.UI.Diagram.EndCapConverter
55
---
66

7-
# Telerik.Web.UI.Diagram.EditableConverter
7+
# Telerik.Web.UI.Diagram.EndCapConverter
88

9-
Serialization JS converter class for Editable
9+
Serialization JS converter class for EndCap
1010

1111
## Inheritance Hierarchy
1212

1313
* System.Object
1414
* System.Web.Script.Serialization.JavaScriptConverter
1515
* Telerik.Web.UI.ExplicitJavaScriptConverter
16-
* Telerik.Web.UI.Diagram.EditableConverter
16+
* Telerik.Web.UI.Diagram.EndCapConverter
1717

1818
## Methods
1919

0 commit comments

Comments
 (0)