Skip to content

Commit b93f575

Browse files
Added api annotation
1 parent 48de0b2 commit b93f575

File tree

16 files changed

+1389
-1563
lines changed

16 files changed

+1389
-1563
lines changed
Lines changed: 92 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,94 @@
1-
/*
2-
Class: primitives.callout.Config
3-
Callout options class.
4-
5-
*/
1+
/**
2+
* @class primitives.callout.Config
3+
*
4+
* Callout configuration object.
5+
*/
66
primitives.callout.Config = function () {
7-
this.classPrefix = "bpcallout";
8-
9-
/*
10-
Property: graphicsType
11-
Preferable graphics type. If preferred graphics type is not supported widget switches to first available.
12-
13-
Default:
14-
<primitives.common.GraphicsType.SVG>
15-
*/
16-
this.graphicsType = primitives.common.GraphicsType.Canvas;
17-
18-
/*
19-
Property: pointerPlacement
20-
Defines pointer connection side or corner.
21-
22-
Default:
23-
<primitives.common.PlacementType.Auto>
24-
*/
25-
this.pointerPlacement = primitives.common.PlacementType.Auto;
26-
27-
/*
28-
Property: position
29-
Defines callout body position.
30-
31-
Type:
32-
<primitives.common.Rect>.
33-
*/
34-
this.position = null;
35-
36-
/*
37-
Property: snapPoint
38-
Callout snap point.
39-
40-
Type:
41-
<primitives.common.Point>.
42-
*/
43-
this.snapPoint = null;
44-
45-
/*
46-
Property: cornerRadius
47-
Body corner radius in percents or pixels.
48-
*/
49-
this.cornerRadius = "10%";
50-
51-
/*
52-
Property: offset
53-
Body rectangle offset.
54-
*/
55-
this.offset = 0;
56-
57-
/*
58-
Property: opacity
59-
Background color opacity.
60-
*/
61-
this.opacity = 1;
62-
63-
/*
64-
Property: lineWidth
65-
Border line width.
66-
*/
67-
this.lineWidth = 1;
68-
69-
/*
70-
Property: lineType
71-
Connector's line pattern.
72-
73-
Default:
74-
<primitives.common.LineType.Solid>
75-
*/
76-
this.lineType = primitives.common.LineType.Solid;
77-
78-
/*
79-
Property: pointerWidth
80-
Pointer base width in percents or pixels.
81-
*/
82-
this.pointerWidth = "10%";
83-
84-
/*
85-
Property: borderColor
86-
Border Color.
87-
88-
Default:
89-
<primitives.common.Colors.Black>
90-
*/
91-
this.borderColor = primitives.common.Colors.Black;
92-
93-
/*
94-
Property: fillColor
95-
Fill Color.
96-
97-
Default:
98-
<primitives.common.Colors.Gray>
99-
*/
100-
this.fillColor = primitives.common.Colors.LightGray;
101-
102-
/*
103-
method: update
104-
Makes full redraw of callout widget contents reevaluating all options.
105-
*/
7+
this.classPrefix = "bpcallout";
8+
9+
/**
10+
* Sets prefered rendering technology. If selected graphics type is not supported on the device,
11+
* then control will auto fallback to the first available one.
12+
*
13+
* @type {GraphicsType}
14+
*/
15+
this.graphicsType = primitives.common.GraphicsType.Canvas;
16+
17+
/**
18+
* Sets callout pointer attachment to one of its sides or corners.
19+
*
20+
* @type {PlacementType}
21+
*/
22+
this.pointerPlacement = primitives.common.PlacementType.Auto;
23+
24+
/**
25+
* Sets callout body position
26+
*
27+
*
28+
* @type {Rect}
29+
*/
30+
this.position = null;
31+
32+
/**
33+
* Sets callout snap point.
34+
*
35+
* @type {Point}
36+
*/
37+
this.snapPoint = null;
38+
39+
/**
40+
* Callout annotation corner radius.
41+
*
42+
* @type {string}
43+
*/
44+
this.cornerRadius = "10%";
45+
46+
/**
47+
* Callout body offset
48+
*
49+
* @type {number}
50+
*/
51+
this.offset = 0;
52+
53+
/**
54+
* Background fill opacity.
55+
*
56+
* @type {number}
57+
*/
58+
this.opacity = 1;
59+
60+
/**
61+
* Callout border line width
62+
*
63+
* @type {number}
64+
*/
65+
this.lineWidth = 1;
66+
67+
/**
68+
* Borde line pattern.
69+
*
70+
* @type {string}
71+
*/
72+
this.lineType = primitives.common.LineType.Solid;
73+
74+
/**
75+
* Pointer base width in percents or pixels.
76+
*
77+
* @type {string|number}
78+
*/
79+
this.pointerWidth = "10%";
80+
81+
/**
82+
* Border line color
83+
*
84+
* @type {string}
85+
*/
86+
this.borderColor = primitives.common.Colors.Black;
87+
88+
/**
89+
* Background fill color
90+
*
91+
* @type {string}
92+
*/
93+
this.fillColor = primitives.common.Colors.LightGray;
10694
};

0 commit comments

Comments
 (0)