objects_Text.js.html 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Source: objects/Text.js</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Source: objects/Text.js</h1>
  17. <section>
  18. <article>
  19. <pre class="prettyprint source linenums"><code>import {Object2D} from "../Object2D.js";
  20. import {ColorStyle} from "./style/ColorStyle";
  21. /**
  22. * Text element, used to draw single line text into the canvas.
  23. *
  24. * For multi line text with support for line break check {MultiLineText} object.
  25. *
  26. * @class
  27. * @extends {Object2D}
  28. */
  29. function Text()
  30. {
  31. Object2D.call(this);
  32. /**
  33. * Text value displayed by this element.
  34. *
  35. * @type {string}
  36. */
  37. this.text = "";
  38. /**
  39. * Font of the text.
  40. *
  41. * @type {string}
  42. */
  43. this.font = "16px Arial";
  44. /**
  45. * Style of the object border line. If set null it is ignored.
  46. *
  47. * @type {Style}
  48. */
  49. this.strokeStyle = null;
  50. /**
  51. * Line width, only used if a valid strokeStyle is defined.
  52. *
  53. * @type {number}
  54. */
  55. this.lineWidth = 1;
  56. /**
  57. * CSS background color of the box. If set null it is ignored.
  58. *
  59. * @type {Style}
  60. */
  61. this.fillStyle = new ColorStyle("#000000");
  62. /**
  63. * Text align property. Same values as used for canvas text applies
  64. *
  65. * Check documentation at https://developer.mozilla.org/en-US/docs/Web/CSS/text-align for mode details about this property.
  66. *
  67. * @type {string}
  68. */
  69. this.textAlign = "center";
  70. /**
  71. * Text baseline defines the vertical position of the text relative to the imaginary line Y position. Same values as used for canvas text applies
  72. *
  73. * Check documentation at https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textBaseline for mode details about this property.
  74. *
  75. * @type {string}
  76. */
  77. this.textBaseline = "middle";
  78. }
  79. Text.prototype = Object.create(Object2D.prototype);
  80. Text.prototype.constructor = Text;
  81. Text.prototype.type = "Text";
  82. Object2D.register(Text, "Text");
  83. Text.prototype.draw = function(context, viewport, canvas)
  84. {
  85. context.font = this.font;
  86. context.textAlign = this.textAlign;
  87. context.textBaseline = this.textBaseline;
  88. if(this.fillStyle !== null)
  89. {
  90. context.fillStyle = this.fillStyle.get(context);
  91. context.fillText(this.text, 0, 0);
  92. }
  93. if(this.strokeStyle !== null)
  94. {
  95. context.strokeStyle = this.strokeStyle.get(context);
  96. context.strokeText(this.text, 0, 0);
  97. }
  98. };
  99. Text.prototype.serialize = function(recursive)
  100. {
  101. var data = Object2D.prototype.serialize.call(this, recursive);
  102. data.text = this.text;
  103. data.font = this.font;
  104. data.strokeStyle = this.strokeStyle !== null ? this.strokeStyle.serialize() : null;
  105. data.lineWidth = this.lineWidth;
  106. data.fillStyle = this.fillStyle !== null ? this.fillStyle.serialize() : null;
  107. data.textAlign = this.textAlign;
  108. data.textBaseline = this.textBaseline;
  109. return data;
  110. };
  111. Text.prototype.parse = function(data, root)
  112. {
  113. Object2D.prototype.parse.call(this, data, root);
  114. this.text = data.text;
  115. this.font = data.font;
  116. this.strokeStyle = data.strokeStyle !== null ? Style.parse(data.strokeStyle) : null;
  117. this.lineWidth = data.lineWidth;
  118. this.fillStyle = data.fillStyle !== null ? Style.parse(data.fillStyle) : null;
  119. this.textAlign = data.textAlign;
  120. this.textBaseline = data.textBaseline;
  121. };
  122. export {Text};
  123. </code></pre>
  124. </article>
  125. </section>
  126. </div>
  127. <nav>
  128. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnimationTimer.html">AnimationTimer</a></li><li><a href="BarGraph.html">BarGraph</a></li><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="ColorStyle.html">ColorStyle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="FileUtils.html">FileUtils</a></li><li><a href="Gauge.html">Gauge</a></li><li><a href="GradientColorStop.html">GradientColorStop</a></li><li><a href="GradientStyle.html">GradientStyle</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="LinearGradientStyle.html">LinearGradientStyle</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="MultiLineText.html">MultiLineText</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeConnector.html">NodeConnector</a></li><li><a href="NodeGraph.html">NodeGraph</a></li><li><a href="NodeSocket.html">NodeSocket</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Path.html">Path</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="PatternStyle.html">PatternStyle</a></li><li><a href="PieChart.html">PieChart</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="QuadraticCurve.html">QuadraticCurve</a></li><li><a href="RadialGradientStyle.html">RadialGradientStyle</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="RoundedBox.html">RoundedBox</a></li><li><a href="ScatterGraph.html">ScatterGraph</a></li><li><a href="Style.html">Style</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul><h3>Global</h3><ul><li><a href="global.html#writeFile">writeFile</a></li></ul>
  129. </nav>
  130. <br class="clear">
  131. <footer>
  132. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sat Sep 17 2022 14:24:36 GMT+0100 (Hora de verão da Europa Ocidental)
  133. </footer>
  134. <script> prettyPrint(); </script>
  135. <script src="scripts/linenumber.js"> </script>
  136. </body>
  137. </html>