1c3ae6d8ad565fbe3de6e957fb7bced0abbeadb7.svn-base 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DevExpress.Sparkline.v15.1.Core</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DevExpress.Sparkline.LineSparklineView">
  8. <summary>
  9. <para>The <b>Line</b> sparkline view.
  10. </para>
  11. </summary>
  12. </member>
  13. <member name="M:DevExpress.Sparkline.LineSparklineView.#ctor">
  14. <summary>
  15. <para>Initializes a new instance of the LineSparklineView class with default settings.
  16. </para>
  17. </summary>
  18. </member>
  19. <member name="P:DevExpress.Sparkline.LineSparklineView.ActualMarkerColor">
  20. <summary>
  21. <para>Gets the actual color of a sparkline marker.
  22. </para>
  23. </summary>
  24. <value>A <see cref="T:System.Drawing.Color"/> value that is the actual marker color.
  25. </value>
  26. </member>
  27. <member name="M:DevExpress.Sparkline.LineSparklineView.Assign(DevExpress.Sparkline.SparklineViewBase)">
  28. <summary>
  29. <para>Copies all the settings from the LineSparklineView object passed as the parameter.
  30. </para>
  31. </summary>
  32. <param name="view">
  33. A LineSparklineView object (which is the <see cref="T:DevExpress.Sparkline.SparklineViewBase"/> descendant) whose settings are assigned to the current object. If <b>null</b> (<b>Nothing</b> in Visual Basic), then a <see cref="T:System.ArgumentNullException"/> will be thrown.
  34. </param>
  35. </member>
  36. <member name="P:DevExpress.Sparkline.LineSparklineView.EnableAntialiasing">
  37. <summary>
  38. <para>Gets or sets whether anti-aliasing (smoothing) is applied to the line view.
  39. </para>
  40. </summary>
  41. <value><b>True</b> to apply anti-aliasing to the line view; <b>False</b> to disable anti-aliasing.
  42. </value>
  43. </member>
  44. <member name="P:DevExpress.Sparkline.LineSparklineView.EndPointMarkerSize">
  45. <summary>
  46. <para>Gets or sets the size of an end point's marker.
  47. </para>
  48. </summary>
  49. <value>An integer value specifying the marker size, in pixels.
  50. </value>
  51. </member>
  52. <member name="P:DevExpress.Sparkline.LineSparklineView.HighlightNegativePoints">
  53. <summary>
  54. <para>Gets or sets a value specifying whether or not to highlight all sparkline points that have negative values (less than 0).
  55. </para>
  56. </summary>
  57. <value><b>true</b>, to highlight points with negative values; otherwise, <b>false</b>.
  58. </value>
  59. </member>
  60. <member name="P:DevExpress.Sparkline.LineSparklineView.LineWidth">
  61. <summary>
  62. <para>Specifies the width of a line in a LineSparklineView.
  63. </para>
  64. </summary>
  65. <value>An integer value specifying the line width (in pixels).
  66. </value>
  67. </member>
  68. <member name="P:DevExpress.Sparkline.LineSparklineView.MarkerColor">
  69. <summary>
  70. <para>Gets or sets the color to draw line markers.
  71. </para>
  72. </summary>
  73. <value>A <see cref="T:System.Drawing.Color"/> that defines the color to draw line markers.
  74. </value>
  75. </member>
  76. <member name="P:DevExpress.Sparkline.LineSparklineView.MarkerSize">
  77. <summary>
  78. <para>Gets or sets the size of markers for data points in a line sparkline.
  79. </para>
  80. </summary>
  81. <value>An integer value specifying the marker size, in pixels.
  82. </value>
  83. </member>
  84. <member name="P:DevExpress.Sparkline.LineSparklineView.MaxPointMarkerSize">
  85. <summary>
  86. <para>Gets or sets the marker size of a data point that has the maximum value among all data points.
  87. </para>
  88. </summary>
  89. <value>An integer value specifying the marker size, in pixels.
  90. </value>
  91. </member>
  92. <member name="P:DevExpress.Sparkline.LineSparklineView.MinPointMarkerSize">
  93. <summary>
  94. <para>Gets or sets the marker size of a data point that has the minimum value among all data points.
  95. </para>
  96. </summary>
  97. <value>An integer value specifying the marker size, in pixels.
  98. </value>
  99. </member>
  100. <member name="P:DevExpress.Sparkline.LineSparklineView.NegativePointMarkerSize">
  101. <summary>
  102. <para>Gets or sets the marker size of all data points that have negative values (less than 0).
  103. </para>
  104. </summary>
  105. <value>An integer value specifying the marker size, in pixels.
  106. </value>
  107. </member>
  108. <member name="M:DevExpress.Sparkline.LineSparklineView.SetSizeForAllMarkers(System.Int32)">
  109. <summary>
  110. <para>Sets size for all markers of a sparkline.
  111. </para>
  112. </summary>
  113. <param name="markerSize">
  114. An integer value specifying the new size for sparkline markers (in pixels).
  115. </param>
  116. </member>
  117. <member name="P:DevExpress.Sparkline.LineSparklineView.ShowMarkers">
  118. <summary>
  119. <para>Gets or sets a value specifying the visibility of point markers on a sparkline.
  120. </para>
  121. </summary>
  122. <value><b>true</b> to show markers for each data point; <b>false</b> to hide them.
  123. </value>
  124. </member>
  125. <member name="P:DevExpress.Sparkline.LineSparklineView.StartPointMarkerSize">
  126. <summary>
  127. <para>Gets or sets the size of a start point's marker.
  128. </para>
  129. </summary>
  130. <value>An integer value specifying the marker size, in pixels.
  131. </value>
  132. </member>
  133. <member name="P:DevExpress.Sparkline.LineSparklineView.Type">
  134. <summary>
  135. <para>Gets the type of the sparkline view.
  136. </para>
  137. </summary>
  138. <value>Always <see cref="F:DevExpress.Sparkline.SparklineViewType.Line"/>.
  139. </value>
  140. </member>
  141. <member name="T:DevExpress.Sparkline.SparklineRange">
  142. <summary>
  143. <para>Represents a range to be used in DevExpress Sparkline controls.
  144. </para>
  145. </summary>
  146. </member>
  147. <member name="M:DevExpress.Sparkline.SparklineRange.#ctor(System.Double,System.Double)">
  148. <summary>
  149. <para>Initializes a new instance of the SparklineRange class with the specified minimum and maximum limits.
  150. </para>
  151. </summary>
  152. <param name="min">
  153. A <see cref="T:System.Double"/> value, specifying the minimum limit. This value is assigned to the <see cref="P:DevExpress.Sparkline.SparklineRange.Limit1"/> property.
  154. </param>
  155. <param name="max">
  156. A <see cref="T:System.Double"/> value, specifying the maximum limit. This value is assigned to the <see cref="P:DevExpress.Sparkline.SparklineRange.Limit2"/> property.
  157. </param>
  158. </member>
  159. <member name="M:DevExpress.Sparkline.SparklineRange.#ctor">
  160. <summary>
  161. <para>Initializes a new instance of the SparklineRange class with default settings.
  162. </para>
  163. </summary>
  164. </member>
  165. <member name="P:DevExpress.Sparkline.SparklineRange.IsAuto">
  166. <summary>
  167. <para>Gets or sets a value indicating whether or not range limits should be calculated automatically.
  168. </para>
  169. </summary>
  170. <value><b>true</b> to calculate range limits automatically; <b>false</b> to use the <see cref="P:DevExpress.Sparkline.SparklineRange.Limit1"/> and <see cref="P:DevExpress.Sparkline.SparklineRange.Limit2"/> property values.
  171. </value>
  172. </member>
  173. <member name="P:DevExpress.Sparkline.SparklineRange.Limit1">
  174. <summary>
  175. <para>Gets or sets a value specifying the first limit of the range.
  176. </para>
  177. </summary>
  178. <value>A <see cref="T:System.Double"/> value that specifies the first limit.
  179. </value>
  180. </member>
  181. <member name="P:DevExpress.Sparkline.SparklineRange.Limit2">
  182. <summary>
  183. <para>Gets or sets a value specifying the second limit of the range.
  184. </para>
  185. </summary>
  186. <value>A <see cref="T:System.Double"/> value that specifies the second limit.
  187. </value>
  188. </member>
  189. <member name="E:DevExpress.Sparkline.SparklineRange.PropertiesChanged">
  190. <summary>
  191. <para>This event is hidden, because it is not appropriate for the SparklineRange class.
  192. </para>
  193. </summary>
  194. </member>
  195. <member name="T:DevExpress.Sparkline.WinLossSparklineView">
  196. <summary>
  197. <para>The <b>WinLoss</b> sparkline view.
  198. </para>
  199. </summary>
  200. </member>
  201. <member name="M:DevExpress.Sparkline.WinLossSparklineView.#ctor">
  202. <summary>
  203. <para>Initializes a new instance of the WinLossSparklineView class with default settings.
  204. </para>
  205. </summary>
  206. </member>
  207. <member name="P:DevExpress.Sparkline.WinLossSparklineView.Type">
  208. <summary>
  209. <para>Gets the type of the sparkline view.
  210. </para>
  211. </summary>
  212. <value>Always <see cref="F:DevExpress.Sparkline.SparklineViewType.WinLoss"/>.
  213. </value>
  214. </member>
  215. <member name="T:DevExpress.Sparkline.BarSparklineViewBase">
  216. <summary>
  217. <para>The base for <b>Bar</b> and <b>WinLoss</b> sparkline views.
  218. </para>
  219. </summary>
  220. </member>
  221. <member name="M:DevExpress.Sparkline.BarSparklineViewBase.Assign(DevExpress.Sparkline.SparklineViewBase)">
  222. <summary>
  223. <para>Copies all the settings from the BarSparklineViewBase object passed as the parameter.
  224. </para>
  225. </summary>
  226. <param name="view">
  227. A BarSparklineViewBase object (which is the <see cref="T:DevExpress.Sparkline.SparklineViewBase"/> descendant) whose settings are assigned to the current object. If <b>null</b> (<b>Nothing</b> in Visual Basic), then a <see cref="T:System.ArgumentNullException"/> will be thrown.
  228. </param>
  229. </member>
  230. <member name="P:DevExpress.Sparkline.BarSparklineViewBase.BarDistance">
  231. <summary>
  232. <para>Specifies the distance between two bars of a bar sparkline.
  233. </para>
  234. </summary>
  235. <value>An integer value (in pixels).
  236. </value>
  237. </member>
  238. <member name="T:DevExpress.Sparkline.BarSparklineView">
  239. <summary>
  240. <para>The <b>Bar</b> sparkline view.
  241. </para>
  242. </summary>
  243. </member>
  244. <member name="M:DevExpress.Sparkline.BarSparklineView.#ctor">
  245. <summary>
  246. <para>Initializes a new instance of the BarSparklineView class with default settings.
  247. </para>
  248. </summary>
  249. </member>
  250. <member name="M:DevExpress.Sparkline.BarSparklineView.Assign(DevExpress.Sparkline.SparklineViewBase)">
  251. <summary>
  252. <para>Copies all the settings from the BarSparklineView object passed as the parameter.
  253. </para>
  254. </summary>
  255. <param name="view">
  256. A BarSparklineView object (which is the <see cref="T:DevExpress.Sparkline.SparklineViewBase"/> descendant) whose settings are assigned to the current object. If <b>null</b> (<b>Nothing</b> in Visual Basic), then a <see cref="T:System.ArgumentNullException"/> will be thrown.
  257. </param>
  258. </member>
  259. <member name="P:DevExpress.Sparkline.BarSparklineView.HighlightNegativePoints">
  260. <summary>
  261. <para>Gets or sets a value specifying whether or not to highlight all sparkline points that have negative values (less than 0).
  262. </para>
  263. </summary>
  264. <value><b>true</b>, to highlight points with negative values; otherwise, <b>false</b>.
  265. </value>
  266. </member>
  267. <member name="P:DevExpress.Sparkline.BarSparklineView.Type">
  268. <summary>
  269. <para>Gets the type of the sparkline view.
  270. </para>
  271. </summary>
  272. <value>Always <see cref="F:DevExpress.Sparkline.SparklineViewType.Bar"/>.
  273. </value>
  274. </member>
  275. <member name="T:DevExpress.Sparkline.AreaSparklineView">
  276. <summary>
  277. <para>The <b>Area</b> sparkline view.
  278. </para>
  279. </summary>
  280. </member>
  281. <member name="M:DevExpress.Sparkline.AreaSparklineView.#ctor">
  282. <summary>
  283. <para>Initializes a new instance of the AreaSparklineView class with default settings.
  284. </para>
  285. </summary>
  286. </member>
  287. <member name="P:DevExpress.Sparkline.AreaSparklineView.AreaOpacity">
  288. <summary>
  289. <para>Specifies the opacity (<b>0</b>-<b>255</b>) of the area sparkline.
  290. </para>
  291. </summary>
  292. <value>A <see cref="T:System.Byte"/> value from <b>0</b> (transparent) to <b>255</b> (opaque).
  293. </value>
  294. </member>
  295. <member name="M:DevExpress.Sparkline.AreaSparklineView.Assign(DevExpress.Sparkline.SparklineViewBase)">
  296. <summary>
  297. <para>Copies all the settings from the AreaSparklineView object passed as the parameter.
  298. </para>
  299. </summary>
  300. <param name="view">
  301. A AreaSparklineView object (which is the <see cref="T:DevExpress.Sparkline.SparklineViewBase"/> descendant) whose settings are assigned to the current object. If <b>null</b> (<b>Nothing</b> in Visual Basic), then a <see cref="T:System.ArgumentNullException"/> will be thrown.
  302. </param>
  303. </member>
  304. <member name="P:DevExpress.Sparkline.AreaSparklineView.Type">
  305. <summary>
  306. <para>Gets the type of the sparkline view.
  307. </para>
  308. </summary>
  309. <value>Always <see cref="F:DevExpress.Sparkline.SparklineViewType.Area"/>.
  310. </value>
  311. </member>
  312. <member name="T:DevExpress.Sparkline.SparklineViewType">
  313. <summary>
  314. <para>Lists the values used to specify the available view types of a sparkline.
  315. </para>
  316. </summary>
  317. </member>
  318. <member name="F:DevExpress.Sparkline.SparklineViewType.Area">
  319. <summary>
  320. <para>Sparkline data points are represented as <b>area</b>.
  321. </para>
  322. </summary>
  323. </member>
  324. <member name="F:DevExpress.Sparkline.SparklineViewType.Bar">
  325. <summary>
  326. <para>Sparkline data points are represented as <b>bars</b>.
  327. </para>
  328. </summary>
  329. </member>
  330. <member name="F:DevExpress.Sparkline.SparklineViewType.Line">
  331. <summary>
  332. <para>Sparkline data points are represented as a <b>line</b>.
  333. </para>
  334. </summary>
  335. </member>
  336. <member name="F:DevExpress.Sparkline.SparklineViewType.WinLoss">
  337. <summary>
  338. <para>Sparkline data points are represented as <b>win</b> and <b>loss</b> squares.
  339. </para>
  340. </summary>
  341. </member>
  342. <member name="T:DevExpress.Sparkline.SparklineViewBase">
  343. <summary>
  344. <para>The base class for sparkline views.
  345. </para>
  346. </summary>
  347. </member>
  348. <member name="P:DevExpress.Sparkline.SparklineViewBase.ActualColor">
  349. <summary>
  350. <para>Gets the actual color of a sparkline.
  351. </para>
  352. </summary>
  353. <value>A <see cref="T:System.Drawing.Color"/> value that is the actual sparkline color.
  354. </value>
  355. </member>
  356. <member name="P:DevExpress.Sparkline.SparklineViewBase.ActualEndPointColor">
  357. <summary>
  358. <para>Gets the actual color of a sparkline end point.
  359. </para>
  360. </summary>
  361. <value>A <see cref="T:System.Drawing.Color"/> value that is the actual point color.
  362. </value>
  363. </member>
  364. <member name="P:DevExpress.Sparkline.SparklineViewBase.ActualMaxPointColor">
  365. <summary>
  366. <para>Gets the actual color of a sparkline maximum point.
  367. </para>
  368. </summary>
  369. <value>A <see cref="T:System.Drawing.Color"/> value that is the actual point color.
  370. </value>
  371. </member>
  372. <member name="P:DevExpress.Sparkline.SparklineViewBase.ActualMinPointColor">
  373. <summary>
  374. <para>Gets the actual color of a sparkline minimum point.
  375. </para>
  376. </summary>
  377. <value>A <see cref="T:System.Drawing.Color"/> value that is the actual point color.
  378. </value>
  379. </member>
  380. <member name="P:DevExpress.Sparkline.SparklineViewBase.ActualNegativePointColor">
  381. <summary>
  382. <para>Gets the actual color of sparkline negative points.
  383. </para>
  384. </summary>
  385. <value>A <see cref="T:System.Drawing.Color"/> value that is the actual point color.
  386. </value>
  387. </member>
  388. <member name="P:DevExpress.Sparkline.SparklineViewBase.ActualStartPointColor">
  389. <summary>
  390. <para>Gets the actual color of a sparkline start point.
  391. </para>
  392. </summary>
  393. <value>A <see cref="T:System.Drawing.Color"/> value that is the actual point color.
  394. </value>
  395. </member>
  396. <member name="M:DevExpress.Sparkline.SparklineViewBase.Assign(DevExpress.Sparkline.SparklineViewBase)">
  397. <summary>
  398. <para>Copies all the settings from the SparklineViewBase object passed as the parameter.
  399. </para>
  400. </summary>
  401. <param name="view">
  402. A SparklineViewBase object (which is the <see cref="T:DevExpress.Sparkline.SparklineViewBase"/> descendant) whose settings are assigned to the current object. If <b>null</b> (<b>Nothing</b> in Visual Basic), then a <see cref="T:System.ArgumentNullException"/> will be thrown.
  403. </param>
  404. </member>
  405. <member name="P:DevExpress.Sparkline.SparklineViewBase.Color">
  406. <summary>
  407. <para>Gets or sets the color to draw a sparkline.
  408. </para>
  409. </summary>
  410. <value>A <see cref="T:System.Drawing.Color"/> that defines the color to draw a sparkline.
  411. </value>
  412. </member>
  413. <member name="M:DevExpress.Sparkline.SparklineViewBase.CreateView(DevExpress.Sparkline.SparklineViewType)">
  414. <summary>
  415. <para>Creates a sparkline view of the specified type.
  416. </para>
  417. </summary>
  418. <param name="viewType">
  419. A <see cref="T:DevExpress.Sparkline.SparklineViewType"/> enumeration value specifying the type of view to create.
  420. </param>
  421. <returns>A <see cref="T:DevExpress.Sparkline.SparklineViewBase"/> class descendant.
  422. </returns>
  423. </member>
  424. <member name="P:DevExpress.Sparkline.SparklineViewBase.EndPointColor">
  425. <summary>
  426. <para>Gets or sets the color to draw the end point of a sparkline.
  427. </para>
  428. </summary>
  429. <value>A <see cref="T:System.Drawing.Color"/> that defines the color to draw the end point.
  430. </value>
  431. </member>
  432. <member name="P:DevExpress.Sparkline.SparklineViewBase.HighlightEndPoint">
  433. <summary>
  434. <para>Gets or sets a value specifying whether or not to highlight the end point of a sparkline.
  435. </para>
  436. </summary>
  437. <value><b>true</b>, to highlight the end point; otherwise, <b>false</b>.
  438. </value>
  439. </member>
  440. <member name="P:DevExpress.Sparkline.SparklineViewBase.HighlightMaxPoint">
  441. <summary>
  442. <para>Gets or sets a value specifying whether or not to highlight a sparkline point that has the highest value among all points.
  443. </para>
  444. </summary>
  445. <value><b>true</b>, to highlight a point with the maximum value; otherwise, <b>false</b>.
  446. </value>
  447. </member>
  448. <member name="P:DevExpress.Sparkline.SparklineViewBase.HighlightMinPoint">
  449. <summary>
  450. <para>Gets or sets a value specifying whether or not to highlight a sparkline point that has the lowest value among all points.
  451. </para>
  452. </summary>
  453. <value><b>true</b>, to highlight a point with the minimum value; otherwise, <b>false</b>.
  454. </value>
  455. </member>
  456. <member name="P:DevExpress.Sparkline.SparklineViewBase.HighlightStartPoint">
  457. <summary>
  458. <para>Gets or sets a value specifying whether or not to highlight the start point of a sparkline.
  459. </para>
  460. </summary>
  461. <value><b>true</b>, to highlight the start point; otherwise, <b>false</b>.
  462. </value>
  463. </member>
  464. <member name="P:DevExpress.Sparkline.SparklineViewBase.MaxPointColor">
  465. <summary>
  466. <para>Gets or sets the color to draw a sparkline point that has the highest value among all data points.
  467. </para>
  468. </summary>
  469. <value>A <see cref="T:System.Drawing.Color"/> that defines the color to draw a data point with the maximum value.
  470. </value>
  471. </member>
  472. <member name="P:DevExpress.Sparkline.SparklineViewBase.MinPointColor">
  473. <summary>
  474. <para>Gets or sets the color to draw a sparkline point that has the lowest value among all data points.
  475. </para>
  476. </summary>
  477. <value>A <see cref="T:System.Drawing.Color"/> that defines the color to draw a data point with the minimum value.
  478. </value>
  479. </member>
  480. <member name="P:DevExpress.Sparkline.SparklineViewBase.NegativePointColor">
  481. <summary>
  482. <para>Gets or sets the color to draw sparkline points that have negative values (less than 0).
  483. </para>
  484. </summary>
  485. <value>A <see cref="T:System.Drawing.Color"/> that defines the color to draw data points with negative values.
  486. </value>
  487. </member>
  488. <member name="E:DevExpress.Sparkline.SparklineViewBase.PropertiesChanged">
  489. <summary>
  490. <para>Occurs when any property of the SparklineViewBase object has changed its value.
  491. </para>
  492. </summary>
  493. </member>
  494. <member name="P:DevExpress.Sparkline.SparklineViewBase.StartPointColor">
  495. <summary>
  496. <para>Gets or sets the color to draw the start point of a sparkline.
  497. </para>
  498. </summary>
  499. <value>A <see cref="T:System.Drawing.Color"/> that defines the color to draw the start point.
  500. </value>
  501. </member>
  502. <member name="M:DevExpress.Sparkline.SparklineViewBase.ToString">
  503. <summary>
  504. <para>Returns a human-readable string that represents the SparklineViewBase object.
  505. </para>
  506. </summary>
  507. <returns>A <see cref="T:System.String"/> value that represents the SparklineViewBase object.
  508. </returns>
  509. </member>
  510. <member name="P:DevExpress.Sparkline.SparklineViewBase.Type">
  511. <summary>
  512. <para>Gets the type of the sparkline view.
  513. </para>
  514. </summary>
  515. <value>A <see cref="T:DevExpress.Sparkline.SparklineViewType"/> enumeration value specifying the view type.
  516. </value>
  517. </member>
  518. </members>
  519. </doc>