1 /* 2 Copyright 2008-2025 3 Matthias Ehmann, 4 Michael Gerhaeuser, 5 Carsten Miller, 6 Bianca Valentin, 7 Alfred Wassermann, 8 Peter Wilfahrt 9 10 This file is part of JSXGraph. 11 12 JSXGraph is free software dual licensed under the GNU LGPL or MIT License. 13 14 You can redistribute it and/or modify it under the terms of the 15 16 * GNU Lesser General Public License as published by 17 the Free Software Foundation, either version 3 of the License, or 18 (at your option) any later version 19 OR 20 * MIT License: https://github.com/jsxgraph/jsxgraph/blob/master/LICENSE.MIT 21 22 JSXGraph is distributed in the hope that it will be useful, 23 but WITHOUT ANY WARRANTY; without even the implied warranty of 24 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 25 GNU Lesser General Public License for more details. 26 27 You should have received a copy of the GNU Lesser General Public License and 28 the MIT License along with JSXGraph. If not, see <https://www.gnu.org/licenses/> 29 and <https://opensource.org/licenses/MIT/>. 30 */ 31 32 /*global JXG: true, define: true*/ 33 /*jslint nomen: true, plusplus: true, unparam: true*/ 34 35 import JXG from "../jxg.js"; 36 import Const from "./constants.js"; 37 import Coords from "./coords.js"; 38 import Mat from "../math/math.js"; 39 import Statistics from "../math/statistics.js"; 40 import Options from "../options.js"; 41 import EventEmitter from "../utils/event.js"; 42 import Color from "../utils/color.js"; 43 import Type from "../utils/type.js"; 44 45 /** 46 * Constructs a new GeometryElement object. 47 * @class This is the parent class for all geometry elements like points, circles, lines, curves... 48 * @constructor 49 * @param {JXG.Board} board Reference to the board the element is constructed on. 50 * @param {Object} attributes Hash of attributes and their values. 51 * @param {Number} type Element type (a <tt>JXG.OBJECT_TYPE_</tt> value). 52 * @param {Number} oclass The element's class (a <tt>JXG.OBJECT_CLASS_</tt> value). 53 * @borrows JXG.EventEmitter#on as this.on 54 * @borrows JXG.EventEmitter#off as this.off 55 * @borrows JXG.EventEmitter#triggerEventHandlers as this.triggerEventHandlers 56 * @borrows JXG.EventEmitter#eventHandlers as this.eventHandlers 57 */ 58 JXG.GeometryElement = function (board, attributes, type, oclass) { 59 var name, key, attr; 60 61 /** 62 * Controls if updates are necessary 63 * @type Boolean 64 * @default true 65 */ 66 this.needsUpdate = true; 67 68 /** 69 * Controls if this element can be dragged. In GEONExT only 70 * free points and gliders can be dragged. 71 * @type Boolean 72 * @default false 73 */ 74 this.isDraggable = false; 75 76 /** 77 * If element is in two dimensional real space this is true, else false. 78 * @type Boolean 79 * @default true 80 */ 81 this.isReal = true; 82 83 /** 84 * Stores all dependent objects to be updated when this point is moved. 85 * @type Object 86 */ 87 this.childElements = {}; 88 89 /** 90 * If element has a label subelement then this property will be set to true. 91 * @type Boolean 92 * @default false 93 */ 94 this.hasLabel = false; 95 96 /** 97 * True, if the element is currently highlighted. 98 * @type Boolean 99 * @default false 100 */ 101 this.highlighted = false; 102 103 /** 104 * Stores all Intersection Objects which in this moment are not real and 105 * so hide this element. 106 * @type Object 107 */ 108 this.notExistingParents = {}; 109 110 /** 111 * Keeps track of all objects drawn as part of the trace of the element. 112 * @see JXG.GeometryElement#clearTrace 113 * @see JXG.GeometryElement#numTraces 114 * @type Object 115 */ 116 this.traces = {}; 117 118 /** 119 * Counts the number of objects drawn as part of the trace of the element. 120 * @see JXG.GeometryElement#clearTrace 121 * @see JXG.GeometryElement#traces 122 * @type Number 123 */ 124 this.numTraces = 0; 125 126 /** 127 * Stores the transformations which are applied during update in an array 128 * @type Array 129 * @see JXG.Transformation 130 */ 131 this.transformations = []; 132 133 /** 134 * @type JXG.GeometryElement 135 * @default null 136 * @private 137 */ 138 this.baseElement = null; 139 140 /** 141 * Elements depending on this element are stored here. 142 * @type Object 143 */ 144 this.descendants = {}; 145 146 /** 147 * Elements on which this element depends on are stored here. 148 * @type Object 149 */ 150 this.ancestors = {}; 151 152 /** 153 * Ids of elements on which this element depends directly are stored here. 154 * @type Object 155 */ 156 this.parents = []; 157 158 /** 159 * Stores variables for symbolic computations 160 * @type Object 161 */ 162 this.symbolic = {}; 163 164 /** 165 * Stores the SVG (or VML) rendering node for the element. This enables low-level 166 * access to SVG nodes. The properties of such an SVG node can then be changed 167 * by calling setAttribute(). Note that there are a few elements which consist 168 * of more than one SVG nodes: 169 * <ul> 170 * <li> Elements with arrow tail or head: rendNodeTriangleStart, rendNodeTriangleEnd 171 * <li> SVG (or VML) texts: rendNodeText 172 * <li> Button: rendNodeForm, rendNodeButton, rendNodeTag 173 * <li> Checkbox: rendNodeForm, rendNodeCheckbox, rendNodeLabel, rendNodeTag 174 * <li> Input: rendNodeForm, rendNodeInput, rendNodeLabel, rendNodeTag 175 * </ul> 176 * 177 * Here is are two examples: The first example shows how to access the SVG node, 178 * the second example demonstrates how to change SVG attributes. 179 * @example 180 * var p1 = board.create('point', [0, 0]); 181 * console.log(p1.rendNode); 182 * // returns the full SVG node details of the point p1, something like: 183 * // <ellipse id='box_jxgBoard1P6' stroke='#ff0000' stroke-opacity='1' stroke-width='2px' 184 * // fill='#ff0000' fill-opacity='1' cx='250' cy='250' rx='4' ry='4' 185 * // style='position: absolute;'> 186 * // </ellipse> 187 * 188 * @example 189 * var s = board.create('segment', [p1, p2], {strokeWidth: 60}); 190 * s.rendNode.setAttribute('stroke-linecap', 'round'); 191 * 192 * @type Object 193 */ 194 this.rendNode = null; 195 196 /** 197 * The string used with {@link JXG.Board#create} 198 * @type String 199 */ 200 this.elType = ""; 201 202 /** 203 * The element is saved with an explicit entry in the file (<tt>true</tt>) or implicitly 204 * via a composition. 205 * @type Boolean 206 * @default true 207 */ 208 this.dump = true; 209 210 /** 211 * Subs contains the subelements, created during the create method. 212 * @type Object 213 */ 214 this.subs = {}; 215 216 /** 217 * Inherits contains the subelements, which may have an attribute 218 * (in particular the attribute "visible") having value 'inherit'. 219 * @type Object 220 */ 221 this.inherits = []; 222 223 /** 224 * The position of this element inside the {@link JXG.Board#objectsList}. 225 * @type Number 226 * @default -1 227 * @private 228 */ 229 this._pos = -1; 230 231 /** 232 * [c, b0, b1, a, k, r, q0, q1] 233 * 234 * See 235 * A.E. Middleditch, T.W. Stacey, and S.B. Tor: 236 * "Intersection Algorithms for Lines and Circles", 237 * ACM Transactions on Graphics, Vol. 8, 1, 1989, pp 25-40. 238 * 239 * The meaning of the parameters is: 240 * Circle: points p=[p0, p1] on the circle fulfill 241 * a<p, p> + <b, p> + c = 0 242 * For convenience we also store 243 * r: radius 244 * k: discriminant = sqrt(<b,b>-4ac) 245 * q=[q0, q1] center 246 * 247 * Points have radius = 0. 248 * Lines have radius = infinity. 249 * b: normalized vector, representing the direction of the line. 250 * 251 * Should be put into Coords, when all elements possess Coords. 252 * @type Array 253 * @default [1, 0, 0, 0, 1, 1, 0, 0] 254 */ 255 this.stdform = [1, 0, 0, 0, 1, 1, 0, 0]; 256 257 /** 258 * The methodMap determines which methods can be called from within JessieCode and under which name it 259 * can be used. The map is saved in an object, the name of a property is the name of the method used in JessieCode, 260 * the value of a property is the name of the method in JavaScript. 261 * @type Object 262 */ 263 this.methodMap = { 264 setLabel: "setLabel", 265 label: "label", 266 setName: "setName", 267 getName: "getName", 268 Name: "getName", 269 addTransform: "addTransform", 270 setProperty: "setAttribute", 271 setAttribute: "setAttribute", 272 addChild: "addChild", 273 animate: "animate", 274 on: "on", 275 off: "off", 276 trigger: "trigger", 277 addTicks: "addTicks", 278 removeTicks: "removeTicks", 279 removeAllTicks: "removeAllTicks", 280 Bounds: "bounds" 281 }; 282 283 /** 284 * Quadratic form representation of circles (and conics) 285 * @type Array 286 * @default [[1,0,0],[0,1,0],[0,0,1]] 287 */ 288 this.quadraticform = [ 289 [1, 0, 0], 290 [0, 1, 0], 291 [0, 0, 1] 292 ]; 293 294 /** 295 * An associative array containing all visual properties. 296 * @type Object 297 * @default empty object 298 */ 299 this.visProp = {}; 300 301 /** 302 * An associative array containing visual properties which are calculated from 303 * the attribute values (i.e. visProp) and from other constraints. 304 * An example: if an intersection point does not have real coordinates, 305 * visPropCalc.visible is set to false. 306 * Additionally, the user can control visibility with the attribute "visible", 307 * even by supplying a functions as value. 308 * 309 * @type Object 310 * @default empty object 311 */ 312 this.visPropCalc = { 313 visible: false 314 }; 315 316 EventEmitter.eventify(this); 317 318 /** 319 * Is the mouse over this element? 320 * @type Boolean 321 * @default false 322 */ 323 this.mouseover = false; 324 325 /** 326 * Time stamp containing the last time this element has been dragged. 327 * @type Date 328 * @default creation time 329 */ 330 this.lastDragTime = new Date(); 331 332 this.view = null; 333 334 if (arguments.length > 0) { 335 /** 336 * Reference to the board associated with the element. 337 * @type JXG.Board 338 */ 339 this.board = board; 340 341 /** 342 * Type of the element. 343 * @constant 344 * @type Number 345 */ 346 this.type = type; 347 348 /** 349 * Original type of the element at construction time. Used for removing glider property. 350 * @constant 351 * @type Number 352 */ 353 this._org_type = type; 354 355 /** 356 * The element's class. 357 * @constant 358 * @type Number 359 */ 360 this.elementClass = oclass || Const.OBJECT_CLASS_OTHER; 361 362 /** 363 * Unique identifier for the element. Equivalent to id-attribute of renderer element. 364 * @type String 365 */ 366 this.id = attributes.id; 367 368 name = attributes.name; 369 /* If name is not set or null or even undefined, generate an unique name for this object */ 370 if (!Type.exists(name)) { 371 name = this.board.generateName(this); 372 } 373 374 if (name !== "") { 375 this.board.elementsByName[name] = this; 376 } 377 378 /** 379 * Not necessarily unique name for the element. 380 * @type String 381 * @default Name generated by {@link JXG.Board#generateName}. 382 * @see JXG.Board#generateName 383 */ 384 this.name = name; 385 386 this.needsRegularUpdate = attributes.needsregularupdate; 387 388 // create this.visPropOld and set default values 389 Type.clearVisPropOld(this); 390 391 attr = this.resolveShortcuts(attributes); 392 for (key in attr) { 393 if (attr.hasOwnProperty(key)) { 394 this._set(key, attr[key]); 395 } 396 } 397 398 this.visProp.draft = attr.draft && attr.draft.draft; 399 //this.visProp.gradientangle = '270'; 400 // this.visProp.gradientsecondopacity = this.evalVisProp('fillopacity'); 401 //this.visProp.gradientpositionx = 0.5; 402 //this.visProp.gradientpositiony = 0.5; 403 } 404 }; 405 406 JXG.extend( 407 JXG.GeometryElement.prototype, 408 /** @lends JXG.GeometryElement.prototype */ { 409 /** 410 * Add an element as a child to the current element. Can be used to model dependencies between geometry elements. 411 * @param {JXG.GeometryElement} obj The dependent object. 412 */ 413 addChild: function (obj) { 414 var el, el2; 415 416 this.childElements[obj.id] = obj; 417 this.addDescendants(obj); // TODO TomBerend removed this. Check if it is possible. 418 obj.ancestors[this.id] = this; 419 420 for (el in this.descendants) { 421 if (this.descendants.hasOwnProperty(el)) { 422 this.descendants[el].ancestors[this.id] = this; 423 424 for (el2 in this.ancestors) { 425 if (this.ancestors.hasOwnProperty(el2)) { 426 this.descendants[el].ancestors[this.ancestors[el2].id] = 427 this.ancestors[el2]; 428 } 429 } 430 } 431 } 432 433 for (el in this.ancestors) { 434 if (this.ancestors.hasOwnProperty(el)) { 435 for (el2 in this.descendants) { 436 if (this.descendants.hasOwnProperty(el2)) { 437 this.ancestors[el].descendants[this.descendants[el2].id] = 438 this.descendants[el2]; 439 } 440 } 441 } 442 } 443 return this; 444 }, 445 446 /** 447 * @param {JXG.GeometryElement} obj The element that is to be added to the descendants list. 448 * @private 449 * @return this 450 */ 451 // Adds the given object to the descendants list of this object and all its child objects. 452 addDescendants: function (obj) { 453 var el; 454 455 this.descendants[obj.id] = obj; 456 for (el in obj.childElements) { 457 if (obj.childElements.hasOwnProperty(el)) { 458 this.addDescendants(obj.childElements[el]); 459 } 460 } 461 return this; 462 }, 463 464 /** 465 * Adds ids of elements to the array this.parents. This method needs to be called if some dependencies 466 * can not be detected automatically by JSXGraph. For example if a function graph is given by a function 467 * which refers to coordinates of a point, calling addParents() is necessary. 468 * 469 * @param {Array} parents Array of elements or ids of elements. 470 * Alternatively, one can give a list of objects as parameters. 471 * @returns {JXG.Object} reference to the object itself. 472 * 473 * @example 474 * // Movable function graph 475 * var A = board.create('point', [1, 0], {name:'A'}), 476 * B = board.create('point', [3, 1], {name:'B'}), 477 * f = board.create('functiongraph', function(x) { 478 * var ax = A.X(), 479 * ay = A.Y(), 480 * bx = B.X(), 481 * by = B.Y(), 482 * a = (by - ay) / ( (bx - ax) * (bx - ax) ); 483 * return a * (x - ax) * (x - ax) + ay; 484 * }, {fixed: false}); 485 * f.addParents([A, B]); 486 * </pre><div class="jxgbox" id="JXG7c91d4d2-986c-4378-8135-24505027f251" style="width: 400px; height: 400px;"></div> 487 * <script type="text/javascript"> 488 * (function() { 489 * var board = JXG.JSXGraph.initBoard('JXG7c91d4d2-986c-4378-8135-24505027f251', {boundingbox: [-1, 9, 9, -1], axis: true, showcopyright: false, shownavigation: false}); 490 * var A = board.create('point', [1, 0], {name:'A'}), 491 * B = board.create('point', [3, 1], {name:'B'}), 492 * f = board.create('functiongraph', function(x) { 493 * var ax = A.X(), 494 * ay = A.Y(), 495 * bx = B.X(), 496 * by = B.Y(), 497 * a = (by - ay) / ( (bx - ax) * (bx - ax) ); 498 * return a * (x - ax) * (x - ax) + ay; 499 * }, {fixed: false}); 500 * f.addParents([A, B]); 501 * })(); 502 * </script><pre> 503 * 504 **/ 505 addParents: function (parents) { 506 var i, len, par; 507 508 if (Type.isArray(parents)) { 509 par = parents; 510 } else { 511 par = arguments; 512 } 513 514 len = par.length; 515 for (i = 0; i < len; ++i) { 516 if (!Type.exists(par[i])) { 517 continue; 518 } 519 if (Type.isId(this.board, par[i])) { 520 this.parents.push(par[i]); 521 } else if (Type.exists(par[i].id)) { 522 this.parents.push(par[i].id); 523 } 524 } 525 this.parents = Type.uniqueArray(this.parents); 526 }, 527 528 /** 529 * Sets ids of elements to the array this.parents. 530 * First, this.parents is cleared. See {@link JXG.GeometryElement#addParents}. 531 * @param {Array} parents Array of elements or ids of elements. 532 * Alternatively, one can give a list of objects as parameters. 533 * @returns {JXG.Object} reference to the object itself. 534 **/ 535 setParents: function (parents) { 536 this.parents = []; 537 this.addParents(parents); 538 }, 539 540 /** 541 * Add dependence on elements in JessieCode functions. 542 * @param {Array} function_array Array of functions containing potential properties "deps" with 543 * elements the function depends on. 544 * @returns {JXG.Object} reference to the object itself 545 * @private 546 */ 547 addParentsFromJCFunctions: function (function_array) { 548 var i, e, obj; 549 for (i = 0; i < function_array.length; i++) { 550 for (e in function_array[i].deps) { 551 obj = function_array[i].deps[e]; 552 this.addParents(obj); 553 obj.addChild(this); 554 } 555 } 556 return this; 557 }, 558 559 /** 560 * Remove an element as a child from the current element. 561 * @param {JXG.GeometryElement} obj The dependent object. 562 * @returns {JXG.Object} reference to the object itself 563 */ 564 removeChild: function (obj) { 565 //var el, el2; 566 567 delete this.childElements[obj.id]; 568 this.removeDescendants(obj); 569 delete obj.ancestors[this.id]; 570 571 /* 572 // I do not know if these addDescendants stuff has to be adapted to removeChild. A.W. 573 for (el in this.descendants) { 574 if (this.descendants.hasOwnProperty(el)) { 575 delete this.descendants[el].ancestors[this.id]; 576 577 for (el2 in this.ancestors) { 578 if (this.ancestors.hasOwnProperty(el2)) { 579 this.descendants[el].ancestors[this.ancestors[el2].id] = this.ancestors[el2]; 580 } 581 } 582 } 583 } 584 585 for (el in this.ancestors) { 586 if (this.ancestors.hasOwnProperty(el)) { 587 for (el2 in this.descendants) { 588 if (this.descendants.hasOwnProperty(el2)) { 589 this.ancestors[el].descendants[this.descendants[el2].id] = this.descendants[el2]; 590 } 591 } 592 } 593 } 594 */ 595 return this; 596 }, 597 598 /** 599 * Removes the given object from the descendants list of this object and all its child objects. 600 * @param {JXG.GeometryElement} obj The element that is to be removed from the descendants list. 601 * @private 602 * @returns {JXG.Object} reference to the object itself 603 */ 604 removeDescendants: function (obj) { 605 var el; 606 607 delete this.descendants[obj.id]; 608 for (el in obj.childElements) { 609 if (obj.childElements.hasOwnProperty(el)) { 610 this.removeDescendants(obj.childElements[el]); 611 } 612 } 613 return this; 614 }, 615 616 /** 617 * Counts the direct children of an object without counting labels. 618 * @private 619 * @returns {number} Number of children 620 */ 621 countChildren: function () { 622 var prop, 623 d, 624 s = 0; 625 626 d = this.childElements; 627 for (prop in d) { 628 if (d.hasOwnProperty(prop) && prop.indexOf("Label") < 0) { 629 s++; 630 } 631 } 632 return s; 633 }, 634 635 /** 636 * Returns the elements name. Used in JessieCode. 637 * @returns {String} 638 */ 639 getName: function () { 640 return this.name; 641 }, 642 643 /** 644 * Add transformations to this element. 645 * @param {JXG.Transformation|Array} transform Either one {@link JXG.Transformation} 646 * or an array of {@link JXG.Transformation}s. 647 * @returns {JXG.GeometryElement} Reference to the element. 648 */ 649 addTransform: function (transform) { 650 return this; 651 }, 652 653 /** 654 * Decides whether an element can be dragged. This is used in 655 * {@link JXG.GeometryElement#setPositionDirectly} methods 656 * where all parent elements are checked if they may be dragged, too. 657 * @private 658 * @returns {boolean} 659 */ 660 draggable: function () { 661 return ( 662 this.isDraggable && 663 !this.evalVisProp('fixed') && 664 // !this.visProp.frozen && 665 this.type !== Const.OBJECT_TYPE_GLIDER 666 ); 667 }, 668 669 /** 670 * Translates the object by <tt>(x, y)</tt>. In case the element is defined by points, the defining points are 671 * translated, e.g. a circle constructed by a center point and a point on the circle line. 672 * @param {Number} method The type of coordinates used here. 673 * Possible values are {@link JXG.COORDS_BY_USER} and {@link JXG.COORDS_BY_SCREEN}. 674 * @param {Array} coords array of translation vector. 675 * @returns {JXG.GeometryElement} Reference to the element object. 676 * 677 * @see JXG.GeometryElement3D#setPosition2D 678 */ 679 setPosition: function (method, coords) { 680 var parents = [], 681 el, 682 i, len, t; 683 684 if (!Type.exists(this.parents)) { 685 return this; 686 } 687 688 len = this.parents.length; 689 for (i = 0; i < len; ++i) { 690 el = this.board.select(this.parents[i]); 691 if (Type.isPoint(el)) { 692 if (!el.draggable()) { 693 return this; 694 } 695 parents.push(el); 696 } 697 } 698 699 if (coords.length === 3) { 700 coords = coords.slice(1); 701 } 702 703 t = this.board.create("transform", coords, { type: "translate" }); 704 705 // We distinguish two cases: 706 // 1) elements which depend on free elements, i.e. arcs and sectors 707 // 2) other elements 708 // 709 // In the first case we simply transform the parents elements 710 // In the second case we add a transform to the element. 711 // 712 len = parents.length; 713 if (len > 0) { 714 t.applyOnce(parents); 715 716 // Handle dragging of a 3D element 717 if (Type.exists(this.view) && this.view.elType === 'view3d') { 718 for (i = 0; i < this.parents.length; ++i) { 719 // Search for the parent 3D element 720 el = this.view.select(this.parents[i]); 721 if (Type.exists(el.setPosition2D)) { 722 el.setPosition2D(t); 723 } 724 } 725 } 726 727 } else { 728 if ( 729 this.transformations.length > 0 && 730 this.transformations[this.transformations.length - 1].isNumericMatrix 731 ) { 732 this.transformations[this.transformations.length - 1].melt(t); 733 } else { 734 this.addTransform(t); 735 } 736 } 737 738 /* 739 * If - against the default configuration - defining gliders are marked as 740 * draggable, then their position has to be updated now. 741 */ 742 for (i = 0; i < len; ++i) { 743 if (parents[i].type === Const.OBJECT_TYPE_GLIDER) { 744 parents[i].updateGlider(); 745 } 746 } 747 748 return this; 749 }, 750 751 /** 752 * Moves an element by the difference of two coordinates. 753 * @param {Number} method The type of coordinates used here. 754 * Possible values are {@link JXG.COORDS_BY_USER} and {@link JXG.COORDS_BY_SCREEN}. 755 * @param {Array} coords coordinates in screen/user units 756 * @param {Array} oldcoords previous coordinates in screen/user units 757 * @returns {JXG.GeometryElement} this element 758 */ 759 setPositionDirectly: function (method, coords, oldcoords) { 760 var c = new Coords(method, coords, this.board, false), 761 oldc = new Coords(method, oldcoords, this.board, false), 762 dc = Statistics.subtract(c.usrCoords, oldc.usrCoords); 763 764 this.setPosition(Const.COORDS_BY_USER, dc); 765 766 return this; 767 }, 768 769 /** 770 * Array of strings containing the polynomials defining the element. 771 * Used for determining geometric loci the groebner way. 772 * @returns {Array} An array containing polynomials describing the locus of the current object. 773 * @public 774 */ 775 generatePolynomial: function () { 776 return []; 777 }, 778 779 /** 780 * Animates properties for that object like stroke or fill color, opacity and maybe 781 * even more later. 782 * @param {Object} hash Object containing properties with target values for the animation. 783 * @param {number} time Number of milliseconds to complete the animation. 784 * @param {Object} [options] Optional settings for the animation:<ul><li>callback: A function that is called as soon as the animation is finished.</li></ul> 785 * @returns {JXG.GeometryElement} A reference to the object 786 */ 787 animate: function (hash, time, options) { 788 options = options || {}; 789 var r, 790 p, 791 i, 792 delay = this.board.attr.animationdelay, 793 steps = Math.ceil(time / delay), 794 self = this, 795 animateColor = function (startRGB, endRGB, property) { 796 var hsv1, hsv2, sh, ss, sv; 797 hsv1 = Color.rgb2hsv(startRGB); 798 hsv2 = Color.rgb2hsv(endRGB); 799 800 sh = (hsv2[0] - hsv1[0]) / steps; 801 ss = (hsv2[1] - hsv1[1]) / steps; 802 sv = (hsv2[2] - hsv1[2]) / steps; 803 self.animationData[property] = []; 804 805 for (i = 0; i < steps; i++) { 806 self.animationData[property][steps - i - 1] = Color.hsv2rgb( 807 hsv1[0] + (i + 1) * sh, 808 hsv1[1] + (i + 1) * ss, 809 hsv1[2] + (i + 1) * sv 810 ); 811 } 812 }, 813 animateFloat = function (start, end, property, round) { 814 var tmp, s; 815 816 start = parseFloat(start); 817 end = parseFloat(end); 818 819 // we can't animate without having valid numbers. 820 // And parseFloat returns NaN if the given string doesn't contain 821 // a valid float number. 822 if (isNaN(start) || isNaN(end)) { 823 return; 824 } 825 826 s = (end - start) / steps; 827 self.animationData[property] = []; 828 829 for (i = 0; i < steps; i++) { 830 tmp = start + (i + 1) * s; 831 self.animationData[property][steps - i - 1] = round 832 ? Math.floor(tmp) 833 : tmp; 834 } 835 }; 836 837 this.animationData = {}; 838 839 for (r in hash) { 840 if (hash.hasOwnProperty(r)) { 841 p = r.toLowerCase(); 842 843 switch (p) { 844 case "strokecolor": 845 case "fillcolor": 846 animateColor(this.visProp[p], hash[r], p); 847 break; 848 case "size": 849 if (!Type.isPoint(this)) { 850 break; 851 } 852 animateFloat(this.visProp[p], hash[r], p, true); 853 break; 854 case "strokeopacity": 855 case "strokewidth": 856 case "fillopacity": 857 animateFloat(this.visProp[p], hash[r], p, false); 858 break; 859 } 860 } 861 } 862 863 this.animationCallback = options.callback; 864 this.board.addAnimation(this); 865 return this; 866 }, 867 868 /** 869 * General update method. Should be overwritten by the element itself. 870 * Can be used sometimes to commit changes to the object. 871 * @return {JXG.GeometryElement} Reference to the element 872 */ 873 update: function () { 874 if (this.evalVisProp('trace')) { 875 this.cloneToBackground(); 876 } 877 return this; 878 }, 879 880 /** 881 * Provide updateRenderer method. 882 * @return {JXG.GeometryElement} Reference to the element 883 * @private 884 */ 885 updateRenderer: function () { 886 return this; 887 }, 888 889 /** 890 * Run through the full update chain of an element. 891 * @param {Boolean} visible Set visibility in case the elements attribute value is 'inherit'. null is allowed. 892 * @return {JXG.GeometryElement} Reference to the element 893 * @private 894 */ 895 fullUpdate: function (visible) { 896 return this.prepareUpdate().update().updateVisibility(visible).updateRenderer(); 897 }, 898 899 /** 900 * Show the element or hide it. If hidden, it will still exist but not be 901 * visible on the board. 902 * <p> 903 * Sets also the display of the inherits elements. These can be 904 * JSXGraph elements or arrays of JSXGraph elements. 905 * However, deeper nesting than this is not supported. 906 * 907 * @param {Boolean} val true: show the element, false: hide the element 908 * @return {JXG.GeometryElement} Reference to the element 909 * @private 910 */ 911 setDisplayRendNode: function (val) { 912 var i, len, s, len_s, obj; 913 914 if (val === undefined) { 915 val = this.visPropCalc.visible; 916 } 917 918 if (val === this.visPropOld.visible) { 919 return this; 920 } 921 922 // Set display of the element itself 923 this.board.renderer.display(this, val); 924 925 // Set the visibility of elements which inherit the attribute 'visible' 926 len = this.inherits.length; 927 for (s = 0; s < len; s++) { 928 obj = this.inherits[s]; 929 if (Type.isArray(obj)) { 930 len_s = obj.length; 931 for (i = 0; i < len_s; i++) { 932 if ( 933 Type.exists(obj[i]) && 934 Type.exists(obj[i].rendNode) && 935 obj[i].evalVisProp('visible') === 'inherit' 936 ) { 937 obj[i].setDisplayRendNode(val); 938 } 939 } 940 } else { 941 if ( 942 Type.exists(obj) && 943 Type.exists(obj.rendNode) && 944 obj.evalVisProp('visible') === 'inherit' 945 ) { 946 obj.setDisplayRendNode(val); 947 } 948 } 949 } 950 951 // Set the visibility of the label if it inherits the attribute 'visible' 952 if (this.hasLabel && Type.exists(this.label) && Type.exists(this.label.rendNode)) { 953 if (this.label.evalVisProp('visible') === "inherit") { 954 this.label.setDisplayRendNode(val); 955 } 956 } 957 958 return this; 959 }, 960 961 /** 962 * Hide the element. It will still exist but not be visible on the board. 963 * Alias for "element.setAttribute({visible: false});" 964 * @return {JXG.GeometryElement} Reference to the element 965 */ 966 hide: function () { 967 this.setAttribute({ visible: false }); 968 return this; 969 }, 970 971 /** 972 * Hide the element. It will still exist but not be visible on the board. 973 * Alias for {@link JXG.GeometryElement#hide} 974 * @returns {JXG.GeometryElement} Reference to the element 975 */ 976 hideElement: function () { 977 this.hide(); 978 return this; 979 }, 980 981 /** 982 * Make the element visible. 983 * Alias for "element.setAttribute({visible: true});" 984 * @return {JXG.GeometryElement} Reference to the element 985 */ 986 show: function () { 987 this.setAttribute({ visible: true }); 988 return this; 989 }, 990 991 /** 992 * Make the element visible. 993 * Alias for {@link JXG.GeometryElement#show} 994 * @returns {JXG.GeometryElement} Reference to the element 995 */ 996 showElement: function () { 997 this.show(); 998 return this; 999 }, 1000 1001 /** 1002 * Set the visibility of an element. The visibility is influenced by 1003 * (listed in ascending priority): 1004 * <ol> 1005 * <li> The value of the element's attribute 'visible' 1006 * <li> The visibility of a parent element. (Example: label) 1007 * This overrules the value of the element's attribute value only if 1008 * this attribute value of the element is 'inherit'. 1009 * <li> being inside of the canvas 1010 * </ol> 1011 * <p> 1012 * This method is called three times for most elements: 1013 * <ol> 1014 * <li> between {@link JXG.GeometryElement#update} 1015 * and {@link JXG.GeometryElement#updateRenderer}. In case the value is 'inherit', nothing is done. 1016 * <li> Recursively, called by itself for child elements. Here, 'inherit' is overruled by the parent's value. 1017 * <li> In {@link JXG.GeometryElement#updateRenderer}, if the element is outside of the canvas. 1018 * </ol> 1019 * 1020 * @param {Boolean} parent_val Visibility of the parent element. 1021 * @return {JXG.GeometryElement} Reference to the element. 1022 * @private 1023 */ 1024 updateVisibility: function (parent_val) { 1025 var i, len, s, len_s, obj, val; 1026 1027 if (this.needsUpdate) { 1028 if (Type.exists(this.view) && this.view.evalVisProp('visible') === false) { 1029 // Handle hiding of view3d 1030 this.visPropCalc.visible = false; 1031 1032 } else { 1033 // Handle the element 1034 if (parent_val !== undefined) { 1035 this.visPropCalc.visible = parent_val; 1036 } else { 1037 val = this.evalVisProp('visible'); 1038 1039 // infobox uses hiddenByParent 1040 if (Type.exists(this.hiddenByParent) && this.hiddenByParent) { 1041 val = false; 1042 } 1043 if (val !== "inherit") { 1044 this.visPropCalc.visible = val; 1045 } 1046 } 1047 1048 // Handle elements which inherit the visibility 1049 len = this.inherits.length; 1050 for (s = 0; s < len; s++) { 1051 obj = this.inherits[s]; 1052 if (Type.isArray(obj)) { 1053 len_s = obj.length; 1054 for (i = 0; i < len_s; i++) { 1055 if ( 1056 Type.exists(obj[i]) /*&& Type.exists(obj[i].rendNode)*/ && 1057 obj[i].evalVisProp('visible') === "inherit" 1058 ) { 1059 obj[i] 1060 .prepareUpdate() 1061 .updateVisibility(this.visPropCalc.visible); 1062 } 1063 } 1064 } else { 1065 if ( 1066 Type.exists(obj) /*&& Type.exists(obj.rendNode)*/ && 1067 obj.evalVisProp('visible') === "inherit" 1068 ) { 1069 obj.prepareUpdate().updateVisibility(this.visPropCalc.visible); 1070 } 1071 } 1072 } 1073 } 1074 1075 // Handle the label if it inherits the visibility 1076 if ( 1077 Type.exists(this.label) && 1078 Type.exists(this.label.visProp) && 1079 this.label.evalVisProp('visible') 1080 ) { 1081 this.label.prepareUpdate().updateVisibility(this.visPropCalc.visible); 1082 } 1083 } 1084 return this; 1085 }, 1086 1087 /** 1088 * Sets the value of attribute <tt>key</tt> to <tt>value</tt>. 1089 * Here, mainly hex strings for rga(a) colors are parsed and values of type object get a special treatment. 1090 * Other values are just set to the key. 1091 * 1092 * @param {String} key The attribute's name. 1093 * @param value The new value 1094 * @private 1095 */ 1096 _set: function (key, value) { 1097 var el; 1098 1099 key = key.toLocaleLowerCase(); 1100 1101 // Search for entries in visProp with "color" as part of the key name 1102 // and containing a RGBA string 1103 if ( 1104 this.visProp.hasOwnProperty(key) && 1105 key.indexOf("color") >= 0 && 1106 Type.isString(value) && 1107 value.length === 9 && 1108 value.charAt(0) === "#" 1109 ) { 1110 value = Color.rgba2rgbo(value); 1111 this.visProp[key] = value[0]; 1112 // Previously: *=. But then, we can only decrease opacity. 1113 this.visProp[key.replace("color", "opacity")] = value[1]; 1114 } else { 1115 if ( 1116 value !== null && 1117 Type.isObject(value) && 1118 !Type.exists(value.id) && 1119 !Type.exists(value.name) 1120 ) { 1121 // value is of type {prop: val, prop: val,...} 1122 // Convert these attributes to lowercase, too 1123 this.visProp[key] = {}; 1124 for (el in value) { 1125 if (value.hasOwnProperty(el)) { 1126 this.visProp[key][el.toLocaleLowerCase()] = value[el]; 1127 } 1128 } 1129 } else { 1130 this.visProp[key] = value; 1131 } 1132 } 1133 }, 1134 1135 /** 1136 * Resolves attribute shortcuts like <tt>color</tt> and expands them, e.g. <tt>strokeColor</tt> and <tt>fillColor</tt>. 1137 * Writes the expanded attributes back to the given <tt>attributes</tt>. 1138 * @param {Object} attributes object 1139 * @returns {Object} The given attributes object with shortcuts expanded. 1140 * @private 1141 */ 1142 resolveShortcuts: function (attributes) { 1143 var key, i, j, 1144 subattr = ["traceattributes", "traceAttributes"]; 1145 1146 for (key in Options.shortcuts) { 1147 if (Options.shortcuts.hasOwnProperty(key)) { 1148 if (Type.exists(attributes[key])) { 1149 for (i = 0; i < Options.shortcuts[key].length; i++) { 1150 if (!Type.exists(attributes[Options.shortcuts[key][i]])) { 1151 attributes[Options.shortcuts[key][i]] = attributes[key]; 1152 } 1153 } 1154 delete attributes[key]; // Remove shortcut 1155 } 1156 for (j = 0; j < subattr.length; j++) { 1157 if (Type.isObject(attributes[subattr[j]])) { 1158 attributes[subattr[j]] = this.resolveShortcuts(attributes[subattr[j]]); 1159 } 1160 } 1161 } 1162 } 1163 return attributes; 1164 }, 1165 1166 /** 1167 * Sets a label and its text 1168 * If label doesn't exist, it creates one 1169 * @param {String} str 1170 */ 1171 setLabel: function (str) { 1172 if (!this.hasLabel) { 1173 this.setAttribute({ withlabel: true }); 1174 } 1175 this.setLabelText(str); 1176 }, 1177 1178 /** 1179 * Updates the element's label text, strips all html. 1180 * @param {String} str 1181 */ 1182 setLabelText: function (str) { 1183 if (Type.exists(this.label)) { 1184 str = str.replace(/</g, "<").replace(/>/g, ">"); 1185 this.label.setText(str); 1186 } 1187 1188 return this; 1189 }, 1190 1191 /** 1192 * Updates the element's label text and the element's attribute "name", strips all html. 1193 * @param {String} str 1194 */ 1195 setName: function (str) { 1196 str = str.replace(/</g, "<").replace(/>/g, ">"); 1197 if (this.elType !== "slider") { 1198 this.setLabelText(str); 1199 } 1200 this.setAttribute({ name: str }); 1201 }, 1202 1203 /** 1204 * Deprecated alias for {@link JXG.GeometryElement#setAttribute}. 1205 * @deprecated Use {@link JXG.GeometryElement#setAttribute}. 1206 */ 1207 setProperty: function () { 1208 JXG.deprecated("setProperty()", "setAttribute()"); 1209 this.setAttribute.apply(this, arguments); 1210 }, 1211 1212 /** 1213 * Sets an arbitrary number of attributes. This method has one or more 1214 * parameters of the following types: 1215 * <ul> 1216 * <li> object: {key1:value1,key2:value2,...} 1217 * <li> string: 'key:value' 1218 * <li> array: ['key', value] 1219 * </ul> 1220 * @param {Object} attributes An object with attributes. 1221 * @returns {JXG.GeometryElement} A reference to the element. 1222 * 1223 * @function 1224 * @example 1225 * // Set attribute directly on creation of an element using the attributes object parameter 1226 * var board = JXG.JSXGraph.initBoard('jxgbox', {boundingbox: [-1, 5, 5, 1]}; 1227 * var p = board.create('point', [2, 2], {visible: false}); 1228 * 1229 * // Now make this point visible and fixed: 1230 * p.setAttribute({ 1231 * fixed: true, 1232 * visible: true 1233 * }); 1234 */ 1235 setAttribute: function (attr) { 1236 var i, j, le, key, value, arg, 1237 opacity, pair, oldvalue, 1238 attributes = {}; 1239 1240 // Normalize the user input 1241 for (i = 0; i < arguments.length; i++) { 1242 arg = arguments[i]; 1243 if (Type.isString(arg)) { 1244 // pairRaw is string of the form 'key:value' 1245 pair = arg.split(":"); 1246 attributes[Type.trim(pair[0])] = Type.trim(pair[1]); 1247 } else if (!Type.isArray(arg)) { 1248 // pairRaw consists of objects of the form {key1:value1,key2:value2,...} 1249 JXG.extend(attributes, arg); 1250 } else { 1251 // pairRaw consists of array [key,value] 1252 attributes[arg[0]] = arg[1]; 1253 } 1254 } 1255 1256 // Handle shortcuts 1257 attributes = this.resolveShortcuts(attributes); 1258 1259 for (i in attributes) { 1260 if (attributes.hasOwnProperty(i)) { 1261 key = i.replace(/\s+/g, "").toLowerCase(); 1262 value = attributes[i]; 1263 1264 // This handles the subobjects, if the key:value pairs are contained in an object. 1265 // Example: 1266 // ticks.setAttribute({ 1267 // strokeColor: 'blue', 1268 // label: { 1269 // visible: false 1270 // } 1271 // }) 1272 // Now, only the supplied label attributes are overwritten. 1273 // Otherwise, the value of label would be {visible:false} only. 1274 if (Type.isObject(value) && Type.exists(this.visProp[key])) { 1275 // this.visProp[key] = Type.merge(this.visProp[key], value); 1276 if (!Type.isObject(this.visProp[key]) && Type.isObject(value)) { 1277 // Handle cases like key=firstarrow and 1278 // firstarrow==false and value = { type:1 }. 1279 // That is a primitive type is replaced by an object. 1280 this.visProp[key] = {}; 1281 } 1282 Type.mergeAttr(this.visProp[key], value); 1283 1284 // First, handle the special case 1285 // ticks.setAttribute({label: {anchorX: "right", ..., visible: true}); 1286 if (this.type === Const.OBJECT_TYPE_TICKS && Type.exists(this.labels)) { 1287 le = this.labels.length; 1288 for (j = 0; j < le; j++) { 1289 this.labels[j].setAttribute(value); 1290 } 1291 } else if (Type.exists(this[key])) { 1292 // Attribute looks like: point1: {...} 1293 // Handle this in the sub-element: this.point1.setAttribute({...}) 1294 if (Type.isArray(this[key])) { 1295 for (j = 0; j < this[key].length; j++) { 1296 this[key][j].setAttribute(value); 1297 } 1298 } else { 1299 this[key].setAttribute(value); 1300 } 1301 } else { 1302 // Cases like firstarrow: {...} 1303 oldvalue = null; 1304 this.triggerEventHandlers(["attribute:" + key], [oldvalue, value, this]); 1305 } 1306 continue; 1307 } 1308 1309 oldvalue = this.visProp[key]; 1310 switch (key) { 1311 case "checked": 1312 // checkbox Is not available on initial call. 1313 if (Type.exists(this.rendNodeTag)) { 1314 this.rendNodeCheckbox.checked = !!value; 1315 } 1316 break; 1317 case "disabled": 1318 // button, checkbox, input. Is not available on initial call. 1319 if (Type.exists(this.rendNodeTag)) { 1320 this.rendNodeTag.disabled = !!value; 1321 } 1322 break; 1323 case "face": 1324 if (Type.isPoint(this)) { 1325 this.visProp.face = value; 1326 this.board.renderer.changePointStyle(this); 1327 } 1328 break; 1329 case "generatelabelvalue": 1330 if ( 1331 this.type === Const.OBJECT_TYPE_TICKS && 1332 Type.isFunction(value) 1333 ) { 1334 this.generateLabelValue = value; 1335 } 1336 break; 1337 case "gradient": 1338 this.visProp.gradient = value; 1339 this.board.renderer.setGradient(this); 1340 break; 1341 case "gradientsecondcolor": 1342 value = Color.rgba2rgbo(value); 1343 this.visProp.gradientsecondcolor = value[0]; 1344 this.visProp.gradientsecondopacity = value[1]; 1345 this.board.renderer.updateGradient(this); 1346 break; 1347 case "gradientsecondopacity": 1348 this.visProp.gradientsecondopacity = value; 1349 this.board.renderer.updateGradient(this); 1350 break; 1351 case "infoboxtext": 1352 if (Type.isString(value)) { 1353 this.infoboxText = value; 1354 } else { 1355 this.infoboxText = false; 1356 } 1357 break; 1358 case "labelcolor": 1359 value = Color.rgba2rgbo(value); 1360 opacity = value[1]; 1361 value = value[0]; 1362 if (opacity === 0) { 1363 if (Type.exists(this.label) && this.hasLabel) { 1364 this.label.hideElement(); 1365 } 1366 } 1367 if (Type.exists(this.label) && this.hasLabel) { 1368 this.label.visProp.strokecolor = value; 1369 this.board.renderer.setObjectStrokeColor( 1370 this.label, 1371 value, 1372 opacity 1373 ); 1374 } 1375 if (this.elementClass === Const.OBJECT_CLASS_TEXT) { 1376 this.visProp.strokecolor = value; 1377 this.visProp.strokeopacity = opacity; 1378 this.board.renderer.setObjectStrokeColor(this, value, opacity); 1379 } 1380 break; 1381 case "layer": 1382 this.board.renderer.setLayer(this, this.eval(value)); 1383 this._set(key, value); 1384 break; 1385 case "maxlength": 1386 // input. Is not available on initial call. 1387 if (Type.exists(this.rendNodeTag)) { 1388 this.rendNodeTag.maxlength = !!value; 1389 } 1390 break; 1391 case "name": 1392 oldvalue = this.name; 1393 delete this.board.elementsByName[this.name]; 1394 this.name = value; 1395 this.board.elementsByName[this.name] = this; 1396 break; 1397 case "needsregularupdate": 1398 this.needsRegularUpdate = !(value === "false" || value === false); 1399 this.board.renderer.setBuffering( 1400 this, 1401 this.needsRegularUpdate ? "auto" : "static" 1402 ); 1403 break; 1404 case "onpolygon": 1405 if (this.type === Const.OBJECT_TYPE_GLIDER) { 1406 this.onPolygon = !!value; 1407 } 1408 break; 1409 case "radius": 1410 if ( 1411 this.type === Const.OBJECT_TYPE_ANGLE || 1412 this.type === Const.OBJECT_TYPE_SECTOR 1413 ) { 1414 this.setRadius(value); 1415 } 1416 break; 1417 case "rotate": 1418 if ( 1419 (this.elementClass === Const.OBJECT_CLASS_TEXT && 1420 this.evalVisProp('display') === "internal") || 1421 this.type === Const.OBJECT_TYPE_IMAGE 1422 ) { 1423 this.addRotation(value); 1424 } 1425 break; 1426 case "tabindex": 1427 if (Type.exists(this.rendNode)) { 1428 this.rendNode.setAttribute("tabindex", value); 1429 this._set(key, value); 1430 } 1431 break; 1432 // case "ticksdistance": 1433 // if (this.type === Const.OBJECT_TYPE_TICKS && Type.isNumber(value)) { 1434 // this.ticksFunction = this.makeTicksFunction(value); 1435 // } 1436 // break; 1437 case "trace": 1438 if (value === "false" || value === false) { 1439 this.clearTrace(); 1440 this.visProp.trace = false; 1441 } else if (value === "pause") { 1442 this.visProp.trace = false; 1443 } else { 1444 this.visProp.trace = true; 1445 } 1446 break; 1447 case "visible": 1448 if (value === "false") { 1449 this.visProp.visible = false; 1450 } else if (value === "true") { 1451 this.visProp.visible = true; 1452 } else { 1453 this.visProp.visible = value; 1454 } 1455 1456 this.setDisplayRendNode(this.evalVisProp('visible')); 1457 if ( 1458 this.evalVisProp('visible') && 1459 Type.exists(this.updateSize) 1460 ) { 1461 this.updateSize(); 1462 } 1463 1464 break; 1465 case "withlabel": 1466 this.visProp.withlabel = value; 1467 if (!this.evalVisProp('withlabel')) { 1468 if (this.label && this.hasLabel) { 1469 //this.label.hideElement(); 1470 this.label.setAttribute({ visible: false }); 1471 } 1472 } else { 1473 if (!this.label) { 1474 this.createLabel(); 1475 } 1476 //this.label.showElement(); 1477 this.label.setAttribute({ visible: "inherit" }); 1478 //this.label.setDisplayRendNode(this.evalVisProp('visible')); 1479 } 1480 this.hasLabel = value; 1481 break; 1482 case "straightfirst": 1483 case "straightlast": 1484 this._set(key, value); 1485 for (j in this.childElements) { 1486 if (this.childElements.hasOwnProperty(j) && this.childElements[j].elType === 'glider') { 1487 this.childElements[j].fullUpdate(); 1488 } 1489 } 1490 break; 1491 default: 1492 if (Type.exists(this.visProp[key]) && 1493 (!JXG.Validator[key] || // No validator for this key => OK 1494 (JXG.Validator[key] && JXG.Validator[key](value)) || // Value passes the validator => OK 1495 (JXG.Validator[key] && // Value is function, function value passes the validator => OK 1496 Type.isFunction(value) && JXG.Validator[key](value(this)) 1497 ) 1498 ) 1499 ) { 1500 value = (value.toLowerCase && value.toLowerCase() === "false") 1501 ? false 1502 : value; 1503 this._set(key, value); 1504 } else { 1505 JXG.warn("attribute '" + key + "' does not accept type '" + (typeof value) + "' of value " + value + "."); 1506 } 1507 break; 1508 } 1509 this.triggerEventHandlers(["attribute:" + key], [oldvalue, value, this]); 1510 } 1511 } 1512 1513 this.triggerEventHandlers(["attribute"], [attributes, this]); 1514 1515 if (!this.evalVisProp('needsregularupdate')) { 1516 this.board.fullUpdate(); 1517 } else { 1518 this.board.update(this); 1519 } 1520 if (this.elementClass === Const.OBJECT_CLASS_TEXT) { 1521 this.updateSize(); 1522 } 1523 1524 return this; 1525 }, 1526 1527 /** 1528 * Deprecated alias for {@link JXG.GeometryElement#getAttribute}. 1529 * @deprecated Use {@link JXG.GeometryElement#getAttribute}. 1530 */ 1531 getProperty: function () { 1532 JXG.deprecated("getProperty()", "getAttribute()"); 1533 this.getProperty.apply(this, arguments); 1534 }, 1535 1536 /** 1537 * Get the value of the property <tt>key</tt>. 1538 * @param {String} key The name of the property you are looking for 1539 * @returns The value of the property 1540 */ 1541 getAttribute: function (key) { 1542 var result; 1543 key = key.toLowerCase(); 1544 1545 switch (key) { 1546 case "needsregularupdate": 1547 result = this.needsRegularUpdate; 1548 break; 1549 case "labelcolor": 1550 result = this.label.visProp.strokecolor; 1551 break; 1552 case "infoboxtext": 1553 result = this.infoboxText; 1554 break; 1555 case "withlabel": 1556 result = this.hasLabel; 1557 break; 1558 default: 1559 result = this.visProp[key]; 1560 break; 1561 } 1562 1563 return result; 1564 }, 1565 1566 /** 1567 * Get value of an attribute. If the value that attribute is a function, call the function and return its value. 1568 * In that case, the function is called with the GeometryElement as (only) parameter. For label elements (i.e. 1569 * if the attribute "islabel" is true), the anchor element is supplied. The label element can be accessed as 1570 * sub-object "label". 1571 * If the attribute does not exist, undefined will be returned. 1572 * 1573 * @param {String} key Attribute key 1574 * @returns {String|Number|Boolean} value of attribute "key" (evaluated in case of a function) or undefined 1575 * 1576 * @see GeometryElement#eval 1577 * @see JXG#evaluate 1578 */ 1579 evalVisProp: function (key) { 1580 var val, arr, i, le; 1581 1582 key = key.toLowerCase(); 1583 if (key.indexOf('.') === -1) { 1584 // e.g. 'visible' 1585 val = this.visProp[key]; 1586 } else { 1587 // e.g. label.visible 1588 arr = key.split('.'); 1589 le = arr.length; 1590 val = this.visProp; 1591 for (i = 0; i < le; i++) { 1592 val = val[arr[i]]; 1593 } 1594 } 1595 1596 if (JXG.isFunction(val)) { 1597 // For labels supply the anchor element as parameter. 1598 if (this.visProp.islabel === true && Type.exists(this.visProp.anchor)) { 1599 // 3D: supply the 3D element 1600 if (this.visProp.anchor.visProp.element3d !== null) { 1601 return val(this.visProp.anchor.visProp.element3d); 1602 } 1603 // 2D: supply the 2D element 1604 return val(this.visProp.anchor); 1605 } 1606 // For 2D elements representing 3D elements, return the 3D element. 1607 if (JXG.exists(this.visProp.element3d)) { 1608 return val(this.visProp.element3d); 1609 } 1610 // In all other cases, return the element itself 1611 return val(this); 1612 } 1613 // val is not of type function 1614 return val; 1615 }, 1616 1617 /** 1618 * Get value of a parameter. If the parameter is a function, call the function and return its value. 1619 * In that case, the function is called with the GeometryElement as (only) parameter. For label elements (i.e. 1620 * if the attribute "islabel" is true), the anchor element is supplied. The label of an element can be accessed as 1621 * sub-object "label" then. 1622 * 1623 * @param {String|Number|Function|Object} val If not a function, it will be returned as is. If function it will be evaluated, where the GeometryElement is 1624 * supplied as the (only) parameter of that function. 1625 * @returns {String|Number|Object} 1626 * 1627 * @see GeometryElement#evalVisProp 1628 * @see JXG#evaluate 1629 */ 1630 eval: function(val) { 1631 if (JXG.isFunction(val)) { 1632 // For labels supply the anchor element as parameter. 1633 if (this.visProp.islabel === true && Type.exists(this.visProp.anchor)) { 1634 // 3D: supply the 3D element 1635 if (this.visProp.anchor.visProp.element3d !== null) { 1636 return val(this.visProp.anchor.visProp.element3d); 1637 } 1638 // 2D: supply the 2D element 1639 return val(this.visProp.anchor); 1640 } 1641 // For 2D elements representing 3D elements, return the 3D element. 1642 if (this.visProp.element3d !== null) { 1643 return val(this.visProp.element3d); 1644 } 1645 // In all other cases, return the element itself 1646 return val(this); 1647 } 1648 // val is not of type function 1649 return val; 1650 }, 1651 1652 /** 1653 * Set the dash style of an object. See {@link JXG.GeometryElement#dash} 1654 * for a list of available dash styles. 1655 * You should use {@link JXG.GeometryElement#setAttribute} instead of this method. 1656 * 1657 * @param {number} dash Indicates the new dash style 1658 * @private 1659 */ 1660 setDash: function (dash) { 1661 this.setAttribute({ dash: dash }); 1662 return this; 1663 }, 1664 1665 /** 1666 * Notify all child elements for updates. 1667 * @private 1668 */ 1669 prepareUpdate: function () { 1670 this.needsUpdate = true; 1671 return this; 1672 }, 1673 1674 /** 1675 * Removes the element from the construction. This only removes the SVG or VML node of the element and its label (if available) from 1676 * the renderer, to remove the element completely you should use {@link JXG.Board#removeObject}. 1677 */ 1678 remove: function () { 1679 // this.board.renderer.remove(this.board.renderer.getElementById(this.id)); 1680 this.board.renderer.remove(this.rendNode); 1681 1682 if (this.hasLabel) { 1683 this.board.renderer.remove(this.board.renderer.getElementById(this.label.id)); 1684 } 1685 return this; 1686 }, 1687 1688 /** 1689 * Returns the coords object where a text that is bound to the element shall be drawn. 1690 * Differs in some cases from the values that getLabelAnchor returns. 1691 * @returns {JXG.Coords} JXG.Coords Place where the text shall be drawn. 1692 * @see JXG.GeometryElement#getLabelAnchor 1693 */ 1694 getTextAnchor: function () { 1695 return new Coords(Const.COORDS_BY_USER, [0, 0], this.board); 1696 }, 1697 1698 /** 1699 * Returns the coords object where the label of the element shall be drawn. 1700 * Differs in some cases from the values that getTextAnchor returns. 1701 * @returns {JXG.Coords} JXG.Coords Place where the text shall be drawn. 1702 * @see JXG.GeometryElement#getTextAnchor 1703 */ 1704 getLabelAnchor: function () { 1705 return new Coords(Const.COORDS_BY_USER, [0, 0], this.board); 1706 }, 1707 1708 /** 1709 * Determines whether the element has arrows at start or end of the arc. 1710 * If it is set to be a "typical" vector, ie lastArrow == true, 1711 * then the element.type is set to VECTOR. 1712 * @param {Boolean} firstArrow True if there is an arrow at the start of the arc, false otherwise. 1713 * @param {Boolean} lastArrow True if there is an arrow at the end of the arc, false otherwise. 1714 */ 1715 setArrow: function (firstArrow, lastArrow) { 1716 this.visProp.firstarrow = firstArrow; 1717 this.visProp.lastarrow = lastArrow; 1718 if (lastArrow) { 1719 this.type = Const.OBJECT_TYPE_VECTOR; 1720 this.elType = "arrow"; 1721 } 1722 1723 this.prepareUpdate().update().updateVisibility().updateRenderer(); 1724 return this; 1725 }, 1726 1727 /** 1728 * Creates a gradient nodes in the renderer. 1729 * @see JXG.SVGRenderer#setGradient 1730 * @private 1731 */ 1732 createGradient: function () { 1733 var ev_g = this.evalVisProp('gradient'); 1734 if (ev_g === "linear" || ev_g === "radial") { 1735 this.board.renderer.setGradient(this); 1736 } 1737 }, 1738 1739 /** 1740 * Creates a label element for this geometry element. 1741 * @see JXG.GeometryElement#addLabelToElement 1742 */ 1743 createLabel: function () { 1744 var attr, 1745 that = this; 1746 1747 // this is a dirty hack to resolve the text-dependency. If there is no text element available, 1748 // just don't create a label. This method is usually not called by a user, so we won't throw 1749 // an exception here and simply output a warning via JXG.debug. 1750 if (JXG.elements.text) { 1751 attr = Type.deepCopy(this.visProp.label, null); 1752 attr.id = this.id + "Label"; 1753 attr.isLabel = true; 1754 attr.anchor = this; 1755 attr.priv = this.visProp.priv; 1756 1757 if (this.visProp.withlabel) { 1758 this.label = JXG.elements.text( 1759 this.board, 1760 [ 1761 0, 1762 0, 1763 function () { 1764 if (Type.isFunction(that.name)) { 1765 return that.name(that); 1766 } 1767 return that.name; 1768 } 1769 ], 1770 attr 1771 ); 1772 this.label.needsUpdate = true; 1773 this.label.dump = false; 1774 this.label.fullUpdate(); 1775 1776 this.hasLabel = true; 1777 } 1778 } else { 1779 JXG.debug( 1780 "JSXGraph: Can't create label: text element is not available. Make sure you include base/text" 1781 ); 1782 } 1783 1784 return this; 1785 }, 1786 1787 /** 1788 * Highlights the element. 1789 * @private 1790 * @param {Boolean} [force=false] Force the highlighting 1791 * @returns {JXG.Board} 1792 */ 1793 highlight: function (force) { 1794 force = Type.def(force, false); 1795 // I know, we have the JXG.Board.highlightedObjects AND JXG.GeometryElement.highlighted and YES we need both. 1796 // Board.highlightedObjects is for the internal highlighting and GeometryElement.highlighted is for user highlighting 1797 // initiated by the user, e.g. through custom DOM events. We can't just pick one because this would break user 1798 // defined highlighting in many ways: 1799 // * if overriding the highlight() methods the user had to handle the highlightedObjects stuff, otherwise he'd break 1800 // everything (e.g. the pie chart example https://jsxgraph.org/wiki/index.php/Pie_chart (not exactly 1801 // user defined but for this type of chart the highlight method was overridden and not adjusted to the changes in here) 1802 // where it just kept highlighting until the radius of the pie was far beyond infinity... 1803 // * user defined highlighting would get pointless, everytime the user highlights something using .highlight(), it would get 1804 // dehighlighted immediately, because highlight puts the element into highlightedObjects and from there it gets dehighlighted 1805 // through dehighlightAll. 1806 1807 // highlight only if not highlighted 1808 if (this.evalVisProp('highlight') && (!this.highlighted || force)) { 1809 this.highlighted = true; 1810 this.board.highlightedObjects[this.id] = this; 1811 this.board.renderer.highlight(this); 1812 } 1813 return this; 1814 }, 1815 1816 /** 1817 * Uses the "normal" properties of the element. 1818 * @returns {JXG.Board} 1819 */ 1820 noHighlight: function () { 1821 // see comment in JXG.GeometryElement.highlight() 1822 1823 // dehighlight only if not highlighted 1824 if (this.highlighted) { 1825 this.highlighted = false; 1826 delete this.board.highlightedObjects[this.id]; 1827 this.board.renderer.noHighlight(this); 1828 } 1829 return this; 1830 }, 1831 1832 /** 1833 * Removes all objects generated by the trace function. 1834 */ 1835 clearTrace: function () { 1836 var obj; 1837 1838 for (obj in this.traces) { 1839 if (this.traces.hasOwnProperty(obj)) { 1840 this.board.renderer.remove(this.traces[obj]); 1841 } 1842 } 1843 1844 this.numTraces = 0; 1845 return this; 1846 }, 1847 1848 /** 1849 * Copy the element to background. This is used for tracing elements. 1850 * @returns {JXG.GeometryElement} A reference to the element 1851 */ 1852 cloneToBackground: function () { 1853 return this; 1854 }, 1855 1856 /** 1857 * Dimensions of the smallest rectangle enclosing the element. 1858 * @returns {Array} The coordinates of the enclosing rectangle in a format 1859 * like the bounding box in {@link JXG.Board#setBoundingBox}. 1860 * 1861 * @returns {Array} similar to {@link JXG.Board#setBoundingBox}. 1862 */ 1863 bounds: function () { 1864 return [0, 0, 0, 0]; 1865 }, 1866 1867 /** 1868 * Normalize the element's standard form. 1869 * @private 1870 */ 1871 normalize: function () { 1872 this.stdform = Mat.normalize(this.stdform); 1873 return this; 1874 }, 1875 1876 /** 1877 * EXPERIMENTAL. Generate JSON object code of visProp and other properties. 1878 * @type String 1879 * @private 1880 * @ignore 1881 * @deprecated 1882 * @returns JSON string containing element's properties. 1883 */ 1884 toJSON: function () { 1885 var vis, 1886 key, 1887 json = ['{"name":', this.name]; 1888 1889 json.push(", " + '"id":' + this.id); 1890 1891 vis = []; 1892 for (key in this.visProp) { 1893 if (this.visProp.hasOwnProperty(key)) { 1894 if (Type.exists(this.visProp[key])) { 1895 vis.push('"' + key + '":' + this.visProp[key]); 1896 } 1897 } 1898 } 1899 json.push(', "visProp":{' + vis.toString() + "}"); 1900 json.push("}"); 1901 1902 return json.join(""); 1903 }, 1904 1905 /** 1906 * Rotate texts or images by a given degree. 1907 * @param {number} angle The degree of the rotation (90 means vertical text). 1908 * @see JXG.GeometryElement#rotate 1909 */ 1910 addRotation: function (angle) { 1911 var tOffInv, 1912 tOff, 1913 tS, 1914 tSInv, 1915 tRot, 1916 that = this; 1917 1918 if ( 1919 (this.elementClass === Const.OBJECT_CLASS_TEXT || 1920 this.type === Const.OBJECT_TYPE_IMAGE) && 1921 angle !== 0 1922 ) { 1923 tOffInv = this.board.create( 1924 "transform", 1925 [ 1926 function () { 1927 return -that.X(); 1928 }, 1929 function () { 1930 return -that.Y(); 1931 } 1932 ], 1933 { type: "translate" } 1934 ); 1935 1936 tOff = this.board.create( 1937 "transform", 1938 [ 1939 function () { 1940 return that.X(); 1941 }, 1942 function () { 1943 return that.Y(); 1944 } 1945 ], 1946 { type: "translate" } 1947 ); 1948 1949 tS = this.board.create( 1950 "transform", 1951 [ 1952 function () { 1953 return that.board.unitX / that.board.unitY; 1954 }, 1955 function () { 1956 return 1; 1957 } 1958 ], 1959 { type: "scale" } 1960 ); 1961 1962 tSInv = this.board.create( 1963 "transform", 1964 [ 1965 function () { 1966 return that.board.unitY / that.board.unitX; 1967 }, 1968 function () { 1969 return 1; 1970 } 1971 ], 1972 { type: "scale" } 1973 ); 1974 1975 tRot = this.board.create( 1976 "transform", 1977 [ 1978 function () { 1979 return (that.eval(angle) * Math.PI) / 180; 1980 } 1981 ], 1982 { type: "rotate" } 1983 ); 1984 1985 tOffInv.bindTo(this); 1986 tS.bindTo(this); 1987 tRot.bindTo(this); 1988 tSInv.bindTo(this); 1989 tOff.bindTo(this); 1990 } 1991 1992 return this; 1993 }, 1994 1995 /** 1996 * Set the highlightStrokeColor of an element 1997 * @ignore 1998 * @name JXG.GeometryElement#highlightStrokeColorMethod 1999 * @param {String} sColor String which determines the stroke color of an object when its highlighted. 2000 * @see JXG.GeometryElement#highlightStrokeColor 2001 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2002 */ 2003 highlightStrokeColor: function (sColor) { 2004 JXG.deprecated("highlightStrokeColor()", "setAttribute()"); 2005 this.setAttribute({ highlightStrokeColor: sColor }); 2006 return this; 2007 }, 2008 2009 /** 2010 * Set the strokeColor of an element 2011 * @ignore 2012 * @name JXG.GeometryElement#strokeColorMethod 2013 * @param {String} sColor String which determines the stroke color of an object. 2014 * @see JXG.GeometryElement#strokeColor 2015 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2016 */ 2017 strokeColor: function (sColor) { 2018 JXG.deprecated("strokeColor()", "setAttribute()"); 2019 this.setAttribute({ strokeColor: sColor }); 2020 return this; 2021 }, 2022 2023 /** 2024 * Set the strokeWidth of an element 2025 * @ignore 2026 * @name JXG.GeometryElement#strokeWidthMethod 2027 * @param {Number} width Integer which determines the stroke width of an outline. 2028 * @see JXG.GeometryElement#strokeWidth 2029 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2030 */ 2031 strokeWidth: function (width) { 2032 JXG.deprecated("strokeWidth()", "setAttribute()"); 2033 this.setAttribute({ strokeWidth: width }); 2034 return this; 2035 }, 2036 2037 /** 2038 * Set the fillColor of an element 2039 * @ignore 2040 * @name JXG.GeometryElement#fillColorMethod 2041 * @param {String} fColor String which determines the fill color of an object. 2042 * @see JXG.GeometryElement#fillColor 2043 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2044 */ 2045 fillColor: function (fColor) { 2046 JXG.deprecated("fillColor()", "setAttribute()"); 2047 this.setAttribute({ fillColor: fColor }); 2048 return this; 2049 }, 2050 2051 /** 2052 * Set the highlightFillColor of an element 2053 * @ignore 2054 * @name JXG.GeometryElement#highlightFillColorMethod 2055 * @param {String} fColor String which determines the fill color of an object when its highlighted. 2056 * @see JXG.GeometryElement#highlightFillColor 2057 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2058 */ 2059 highlightFillColor: function (fColor) { 2060 JXG.deprecated("highlightFillColor()", "setAttribute()"); 2061 this.setAttribute({ highlightFillColor: fColor }); 2062 return this; 2063 }, 2064 2065 /** 2066 * Set the labelColor of an element 2067 * @ignore 2068 * @param {String} lColor String which determines the text color of an object's label. 2069 * @see JXG.GeometryElement#labelColor 2070 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2071 */ 2072 labelColor: function (lColor) { 2073 JXG.deprecated("labelColor()", "setAttribute()"); 2074 this.setAttribute({ labelColor: lColor }); 2075 return this; 2076 }, 2077 2078 /** 2079 * Set the dash type of an element 2080 * @ignore 2081 * @name JXG.GeometryElement#dashMethod 2082 * @param {Number} d Integer which determines the way of dashing an element's outline. 2083 * @see JXG.GeometryElement#dash 2084 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2085 */ 2086 dash: function (d) { 2087 JXG.deprecated("dash()", "setAttribute()"); 2088 this.setAttribute({ dash: d }); 2089 return this; 2090 }, 2091 2092 /** 2093 * Set the visibility of an element 2094 * @ignore 2095 * @name JXG.GeometryElement#visibleMethod 2096 * @param {Boolean} v Boolean which determines whether the element is drawn. 2097 * @see JXG.GeometryElement#visible 2098 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2099 */ 2100 visible: function (v) { 2101 JXG.deprecated("visible()", "setAttribute()"); 2102 this.setAttribute({ visible: v }); 2103 return this; 2104 }, 2105 2106 /** 2107 * Set the shadow of an element 2108 * @ignore 2109 * @name JXG.GeometryElement#shadowMethod 2110 * @param {Boolean} s Boolean which determines whether the element has a shadow or not. 2111 * @see JXG.GeometryElement#shadow 2112 * @deprecated Use {@link JXG.GeometryElement#setAttribute} 2113 */ 2114 shadow: function (s) { 2115 JXG.deprecated("shadow()", "setAttribute()"); 2116 this.setAttribute({ shadow: s }); 2117 return this; 2118 }, 2119 2120 /** 2121 * The type of the element as used in {@link JXG.Board#create}. 2122 * @returns {String} 2123 */ 2124 getType: function () { 2125 return this.elType; 2126 }, 2127 2128 /** 2129 * List of the element ids resp. values used as parents in {@link JXG.Board#create}. 2130 * @returns {Array} 2131 */ 2132 getParents: function () { 2133 return Type.isArray(this.parents) ? this.parents : []; 2134 }, 2135 2136 /** 2137 * @ignore 2138 * Snaps the element to the grid. Only works for points, lines and circles. Points will snap to the grid 2139 * as defined in their properties {@link JXG.Point#snapSizeX} and {@link JXG.Point#snapSizeY}. Lines and circles 2140 * will snap their parent points to the grid, if they have {@link JXG.Point#snapToGrid} set to true. 2141 * @private 2142 * @returns {JXG.GeometryElement} Reference to the element. 2143 */ 2144 snapToGrid: function () { 2145 return this; 2146 }, 2147 2148 /** 2149 * Snaps the element to points. Only works for points. Points will snap to the next point 2150 * as defined in their properties {@link JXG.Point#attractorDistance} and {@link JXG.Point#attractorUnit}. 2151 * Lines and circles 2152 * will snap their parent points to points. 2153 * @private 2154 * @returns {JXG.GeometryElement} Reference to the element. 2155 */ 2156 snapToPoints: function () { 2157 return this; 2158 }, 2159 2160 /** 2161 * Retrieve a copy of the current visProp. 2162 * @returns {Object} 2163 */ 2164 getAttributes: function () { 2165 var attributes = Type.deepCopy(this.visProp), 2166 /* 2167 cleanThis = ['attractors', 'snatchdistance', 'traceattributes', 'frozen', 2168 'shadow', 'gradientangle', 'gradientsecondopacity', 'gradientpositionx', 'gradientpositiony', 2169 'needsregularupdate', 'zoom', 'layer', 'offset'], 2170 */ 2171 cleanThis = [], 2172 i, 2173 len = cleanThis.length; 2174 2175 attributes.id = this.id; 2176 attributes.name = this.name; 2177 2178 for (i = 0; i < len; i++) { 2179 delete attributes[cleanThis[i]]; 2180 } 2181 2182 return attributes; 2183 }, 2184 2185 /** 2186 * Checks whether (x,y) is near the element. 2187 * @param {Number} x Coordinate in x direction, screen coordinates. 2188 * @param {Number} y Coordinate in y direction, screen coordinates. 2189 * @returns {Boolean} True if (x,y) is near the element, False otherwise. 2190 */ 2191 hasPoint: function (x, y) { 2192 return false; 2193 }, 2194 2195 /** 2196 * Adds ticks to this line or curve. Ticks can be added to a curve or any kind of line: line, arrow, and axis. 2197 * @param {JXG.Ticks} ticks Reference to a ticks object which is describing the ticks (color, distance, how many, etc.). 2198 * @returns {String} Id of the ticks object. 2199 */ 2200 addTicks: function (ticks) { 2201 if (ticks.id === "" || !Type.exists(ticks.id)) { 2202 ticks.id = this.id + "_ticks_" + (this.ticks.length + 1); 2203 } 2204 2205 this.board.renderer.drawTicks(ticks); 2206 this.ticks.push(ticks); 2207 2208 return ticks.id; 2209 }, 2210 2211 /** 2212 * Removes all ticks from a line or curve. 2213 */ 2214 removeAllTicks: function () { 2215 var t; 2216 if (Type.exists(this.ticks)) { 2217 for (t = this.ticks.length - 1; t >= 0; t--) { 2218 this.removeTicks(this.ticks[t]); 2219 } 2220 this.ticks = []; 2221 this.board.update(); 2222 } 2223 }, 2224 2225 /** 2226 * Removes ticks identified by parameter named tick from this line or curve. 2227 * @param {JXG.Ticks} tick Reference to tick object to remove. 2228 */ 2229 removeTicks: function (tick) { 2230 var t, j; 2231 2232 if (Type.exists(this.defaultTicks) && this.defaultTicks === tick) { 2233 this.defaultTicks = null; 2234 } 2235 2236 if (Type.exists(this.ticks)) { 2237 for (t = this.ticks.length - 1; t >= 0; t--) { 2238 if (this.ticks[t] === tick) { 2239 this.board.removeObject(this.ticks[t]); 2240 2241 if (this.ticks[t].ticks) { 2242 for (j = 0; j < this.ticks[t].ticks.length; j++) { 2243 if (Type.exists(this.ticks[t].labels[j])) { 2244 this.board.removeObject(this.ticks[t].labels[j]); 2245 } 2246 } 2247 } 2248 2249 delete this.ticks[t]; 2250 break; 2251 } 2252 } 2253 } 2254 }, 2255 2256 /** 2257 * Determine values of snapSizeX and snapSizeY. If the attributes 2258 * snapSizex and snapSizeY are greater than zero, these values are taken. 2259 * Otherwise, determine the distance between major ticks of the 2260 * default axes. 2261 * @returns {Array} containing the snap sizes for x and y direction. 2262 * @private 2263 */ 2264 getSnapSizes: function () { 2265 var sX, sY, ticks; 2266 2267 sX = this.evalVisProp('snapsizex'); 2268 sY = this.evalVisProp('snapsizey'); 2269 2270 if (sX <= 0 && this.board.defaultAxes && this.board.defaultAxes.x.defaultTicks) { 2271 ticks = this.board.defaultAxes.x.defaultTicks; 2272 sX = ticks.ticksDelta * (ticks.evalVisProp('minorticks') + 1); 2273 } 2274 2275 if (sY <= 0 && this.board.defaultAxes && this.board.defaultAxes.y.defaultTicks) { 2276 ticks = this.board.defaultAxes.y.defaultTicks; 2277 sY = ticks.ticksDelta * (ticks.evalVisProp('minorticks') + 1); 2278 } 2279 2280 return [sX, sY]; 2281 }, 2282 2283 /** 2284 * Move an element to its nearest grid point. 2285 * The function uses the coords object of the element as 2286 * its actual position. If there is no coords object or if the object is fixed, nothing is done. 2287 * @param {Boolean} force force snapping independent from what the snaptogrid attribute says 2288 * @param {Boolean} fromParent True if the drag comes from a child element. This is the case if a line 2289 * through two points is dragged. In this case we do not try to force the points to stay inside of 2290 * the visible board, but the distance between the two points stays constant. 2291 * @returns {JXG.GeometryElement} Reference to this element 2292 */ 2293 handleSnapToGrid: function (force, fromParent) { 2294 var x, y, rx, ry, rcoords, 2295 mi, ma, 2296 boardBB, res, sX, sY, 2297 needsSnapToGrid = false, 2298 attractToGrid = this.evalVisProp('attracttogrid'), 2299 ev_au = this.evalVisProp('attractorunit'), 2300 ev_ad = this.evalVisProp('attractordistance'); 2301 2302 if (!Type.exists(this.coords) || this.evalVisProp('fixed')) { 2303 return this; 2304 } 2305 2306 needsSnapToGrid = 2307 this.evalVisProp('snaptogrid') || attractToGrid || force === true; 2308 2309 if (needsSnapToGrid) { 2310 x = this.coords.usrCoords[1]; 2311 y = this.coords.usrCoords[2]; 2312 res = this.getSnapSizes(); 2313 sX = res[0]; 2314 sY = res[1]; 2315 2316 // If no valid snap sizes are available, don't change the coords. 2317 if (sX > 0 && sY > 0) { 2318 boardBB = this.board.getBoundingBox(); 2319 rx = Math.round(x / sX) * sX; 2320 ry = Math.round(y / sY) * sY; 2321 2322 rcoords = new JXG.Coords(Const.COORDS_BY_USER, [rx, ry], this.board); 2323 if ( 2324 !attractToGrid || 2325 rcoords.distance( 2326 ev_au === "screen" ? Const.COORDS_BY_SCREEN : Const.COORDS_BY_USER, 2327 this.coords 2328 ) < ev_ad 2329 ) { 2330 x = rx; 2331 y = ry; 2332 // Checking whether x and y are still within boundingBox. 2333 // If not, adjust them to remain within the board. 2334 // Otherwise a point may become invisible. 2335 if (!fromParent) { 2336 mi = Math.min(boardBB[0], boardBB[2]); 2337 ma = Math.max(boardBB[0], boardBB[2]); 2338 if (x < mi && x > mi - sX) { 2339 x += sX; 2340 } else if (x > ma && x < ma + sX) { 2341 x -= sX; 2342 } 2343 2344 mi = Math.min(boardBB[1], boardBB[3]); 2345 ma = Math.max(boardBB[1], boardBB[3]); 2346 if (y < mi && y > mi - sY) { 2347 y += sY; 2348 } else if (y > ma && y < ma + sY) { 2349 y -= sY; 2350 } 2351 } 2352 this.coords.setCoordinates(Const.COORDS_BY_USER, [x, y]); 2353 } 2354 } 2355 } 2356 return this; 2357 }, 2358 2359 getBoundingBox: function () { 2360 var i, le, v, 2361 x, y, r, 2362 bb = [Infinity, Infinity, -Infinity, -Infinity]; 2363 2364 if (this.type === Const.OBJECT_TYPE_POLYGON) { 2365 le = this.vertices.length - 1; 2366 if (le <= 0) { 2367 return bb; 2368 } 2369 for (i = 0; i < le; i++) { 2370 v = this.vertices[i].X(); 2371 bb[0] = v < bb[0] ? v : bb[0]; 2372 bb[2] = v > bb[2] ? v : bb[2]; 2373 v = this.vertices[i].Y(); 2374 bb[1] = v < bb[1] ? v : bb[1]; 2375 bb[3] = v > bb[3] ? v : bb[3]; 2376 } 2377 } else if (this.elementClass === Const.OBJECT_CLASS_CIRCLE) { 2378 x = this.center.X(); 2379 y = this.center.Y(); 2380 bb = [x - this.radius, y + this.radius, x + this.radius, y - this.radius]; 2381 } else if (this.elementClass === Const.OBJECT_CLASS_CURVE) { 2382 le = this.points.length; 2383 if (le === 0) { 2384 return bb; 2385 } 2386 for (i = 0; i < le; i++) { 2387 v = this.points[i].usrCoords[1]; 2388 bb[0] = v < bb[0] ? v : bb[0]; 2389 bb[2] = v > bb[2] ? v : bb[2]; 2390 v = this.points[i].usrCoords[1]; 2391 bb[1] = v < bb[1] ? v : bb[1]; 2392 bb[3] = v > bb[3] ? v : bb[3]; 2393 } 2394 } else if (this.elementClass === Const.OBJECT_CLASS_POINT) { 2395 x = this.X(); 2396 y = this.Y(); 2397 r = this.evalVisProp('size'); 2398 bb = [x - r / this.board.unitX, y - r / this.board.unitY, x + r / this.board.unitX, y + r / this.board.unitY]; 2399 } 2400 2401 return bb; 2402 }, 2403 2404 /** 2405 * Alias of {@link JXG.EventEmitter.on}. 2406 * 2407 * @name addEvent 2408 * @memberof JXG.GeometryElement 2409 * @function 2410 */ 2411 addEvent: JXG.shortcut(JXG.GeometryElement.prototype, 'on'), 2412 2413 /** 2414 * Alias of {@link JXG.EventEmitter.off}. 2415 * 2416 * @name removeEvent 2417 * @memberof JXG.GeometryElement 2418 * @function 2419 */ 2420 removeEvent: JXG.shortcut(JXG.GeometryElement.prototype, 'off'), 2421 2422 /** 2423 * Format a number according to the locale set in the attribute "intl". 2424 * If in the options of the intl-attribute "maximumFractionDigits" is not set, 2425 * the optional parameter digits is used instead. 2426 * See <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat">https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat</a> 2427 * for more information about internationalization. 2428 * 2429 * @param {Number} value Number to be formatted 2430 * @param {Number} [digits=undefined] Optional number of digits 2431 * @returns {String|Number} string containing the formatted number according to the locale 2432 * or the number itself of the formatting is not possible. 2433 */ 2434 formatNumberLocale: function (value, digits) { 2435 var loc, opt, key, 2436 optCalc = {}, 2437 // These options are case sensitive: 2438 translate = { 2439 maximumfractiondigits: 'maximumFractionDigits', 2440 minimumfractiondigits: 'minimumFractionDigits', 2441 compactdisplay: 'compactDisplay', 2442 currencydisplay: 'currencyDisplay', 2443 currencysign: 'currencySign', 2444 localematcher: 'localeMatcher', 2445 numberingsystem: 'numberingSystem', 2446 signdisplay: 'signDisplay', 2447 unitdisplay: 'unitDisplay', 2448 usegrouping: 'useGrouping', 2449 roundingmode: 'roundingMode', 2450 roundingpriority: 'roundingPriority', 2451 roundingincrement: 'roundingIncrement', 2452 trailingzerodisplay: 'trailingZeroDisplay', 2453 minimumintegerdigits: 'minimumIntegerDigits', 2454 minimumsignificantdigits: 'minimumSignificantDigits', 2455 maximumsignificantdigits: 'maximumSignificantDigits' 2456 }; 2457 2458 if (Type.exists(Intl) && 2459 this.useLocale()) { 2460 2461 loc = this.evalVisProp('intl.locale') || 2462 this.eval(this.board.attr.intl.locale); 2463 opt = this.evalVisProp('intl.options') || {}; 2464 2465 // Transfer back to camel case if necessary and evaluate 2466 for (key in opt) { 2467 if (opt.hasOwnProperty(key)) { 2468 if (translate.hasOwnProperty(key)) { 2469 optCalc[translate[key]] = this.eval(opt[key]); 2470 } else { 2471 optCalc[key] = this.eval(opt[key]); 2472 } 2473 } 2474 } 2475 2476 // If maximumfractiondigits is not set, 2477 // the value of the attribute "digits" is taken instead. 2478 key = 'maximumfractiondigits'; 2479 if (!Type.exists(opt[key])) { 2480 optCalc[translate[key]] = digits; 2481 2482 // key = 'minimumfractiondigits'; 2483 // if (!this.eval(opt[key]) || this.eval(opt[key]) > digits) { 2484 // optCalc[translate[key]] = digits; 2485 // } 2486 } 2487 2488 return Intl.NumberFormat(loc, optCalc).format(value); 2489 } 2490 2491 return value; 2492 }, 2493 2494 /** 2495 * Checks if locale is enabled in the attribute. This may be in the attributes of the board, 2496 * or in the attributes of the text. The latter has higher priority. The board attribute is taken if 2497 * attribute "intl.enabled" of the text element is set to 'inherit'. 2498 * 2499 * @returns {Boolean} if locale can be used for number formatting. 2500 */ 2501 useLocale: function () { 2502 var val; 2503 2504 // Check if element supports intl 2505 if (!Type.exists(this.visProp.intl) || 2506 !Type.exists(this.visProp.intl.enabled)) { 2507 return false; 2508 } 2509 2510 // Check if intl is supported explicitly enabled for this element 2511 val = this.evalVisProp('intl.enabled'); 2512 2513 if (val === true) { 2514 return true; 2515 } 2516 2517 // Check intl attribute of the board 2518 if (val === 'inherit') { 2519 if (this.eval(this.board.attr.intl.enabled) === true) { 2520 return true; 2521 } 2522 } 2523 2524 return false; 2525 }, 2526 2527 /* ************************** 2528 * EVENT DEFINITION 2529 * for documentation purposes 2530 * ************************** */ 2531 2532 //region Event handler documentation 2533 /** 2534 * @event 2535 * @description This event is fired whenever the user is hovering over an element. 2536 * @name JXG.GeometryElement#over 2537 * @param {Event} e The browser's event object. 2538 */ 2539 __evt__over: function (e) { }, 2540 2541 /** 2542 * @event 2543 * @description This event is fired whenever the user puts the mouse over an element. 2544 * @name JXG.GeometryElement#mouseover 2545 * @param {Event} e The browser's event object. 2546 */ 2547 __evt__mouseover: function (e) { }, 2548 2549 /** 2550 * @event 2551 * @description This event is fired whenever the user is leaving an element. 2552 * @name JXG.GeometryElement#out 2553 * @param {Event} e The browser's event object. 2554 */ 2555 __evt__out: function (e) { }, 2556 2557 /** 2558 * @event 2559 * @description This event is fired whenever the user puts the mouse away from an element. 2560 * @name JXG.GeometryElement#mouseout 2561 * @param {Event} e The browser's event object. 2562 */ 2563 __evt__mouseout: function (e) { }, 2564 2565 /** 2566 * @event 2567 * @description This event is fired whenever the user is moving over an element. 2568 * @name JXG.GeometryElement#move 2569 * @param {Event} e The browser's event object. 2570 */ 2571 __evt__move: function (e) { }, 2572 2573 /** 2574 * @event 2575 * @description This event is fired whenever the user is moving the mouse over an element. 2576 * @name JXG.GeometryElement#mousemove 2577 * @param {Event} e The browser's event object. 2578 */ 2579 __evt__mousemove: function (e) { }, 2580 2581 /** 2582 * @event 2583 * @description This event is fired whenever the user drags an element. 2584 * @name JXG.GeometryElement#drag 2585 * @param {Event} e The browser's event object. 2586 */ 2587 __evt__drag: function (e) { }, 2588 2589 /** 2590 * @event 2591 * @description This event is fired whenever the user drags the element with a mouse. 2592 * @name JXG.GeometryElement#mousedrag 2593 * @param {Event} e The browser's event object. 2594 */ 2595 __evt__mousedrag: function (e) { }, 2596 2597 /** 2598 * @event 2599 * @description This event is fired whenever the user drags the element with a pen. 2600 * @name JXG.GeometryElement#pendrag 2601 * @param {Event} e The browser's event object. 2602 */ 2603 __evt__pendrag: function (e) { }, 2604 2605 /** 2606 * @event 2607 * @description This event is fired whenever the user drags the element on a touch device. 2608 * @name JXG.GeometryElement#touchdrag 2609 * @param {Event} e The browser's event object. 2610 */ 2611 __evt__touchdrag: function (e) { }, 2612 2613 /** 2614 * @event 2615 * @description This event is fired whenever the user drags the element by pressing arrow keys 2616 * on the keyboard. 2617 * @name JXG.GeometryElement#keydrag 2618 * @param {Event} e The browser's event object. 2619 */ 2620 __evt__keydrag: function (e) { }, 2621 2622 /** 2623 * @event 2624 * @description Whenever the user starts to touch or click an element. 2625 * @name JXG.GeometryElement#down 2626 * @param {Event} e The browser's event object. 2627 */ 2628 __evt__down: function (e) { }, 2629 2630 /** 2631 * @event 2632 * @description Whenever the user starts to click an element. 2633 * @name JXG.GeometryElement#mousedown 2634 * @param {Event} e The browser's event object. 2635 */ 2636 __evt__mousedown: function (e) { }, 2637 2638 /** 2639 * @event 2640 * @description Whenever the user taps an element with the pen. 2641 * @name JXG.GeometryElement#pendown 2642 * @param {Event} e The browser's event object. 2643 */ 2644 __evt__pendown: function (e) { }, 2645 2646 /** 2647 * @event 2648 * @description Whenever the user starts to touch an element. 2649 * @name JXG.GeometryElement#touchdown 2650 * @param {Event} e The browser's event object. 2651 */ 2652 __evt__touchdown: function (e) { }, 2653 2654 /** 2655 * @event 2656 * @description Whenever the user clicks on an element. 2657 * @name JXG.Board#click 2658 * @param {Event} e The browser's event object. 2659 */ 2660 __evt__click: function (e) { }, 2661 2662 /** 2663 * @event 2664 * @description Whenever the user double clicks on an element. 2665 * This event works on desktop browser, but is undefined 2666 * on mobile browsers. 2667 * @name JXG.Board#dblclick 2668 * @param {Event} e The browser's event object. 2669 * @see JXG.Board#clickDelay 2670 * @see JXG.Board#dblClickSuppressClick 2671 */ 2672 __evt__dblclick: function (e) { }, 2673 2674 /** 2675 * @event 2676 * @description Whenever the user clicks on an element with a mouse device. 2677 * @name JXG.Board#mouseclick 2678 * @param {Event} e The browser's event object. 2679 */ 2680 __evt__mouseclick: function (e) { }, 2681 2682 /** 2683 * @event 2684 * @description Whenever the user double clicks on an element with a mouse device. 2685 * @name JXG.Board#mousedblclick 2686 * @param {Event} e The browser's event object. 2687 */ 2688 __evt__mousedblclick: function (e) { }, 2689 2690 /** 2691 * @event 2692 * @description Whenever the user clicks on an element with a pointer device. 2693 * @name JXG.Board#pointerclick 2694 * @param {Event} e The browser's event object. 2695 */ 2696 __evt__pointerclick: function (e) { }, 2697 2698 /** 2699 * @event 2700 * @description Whenever the user double clicks on an element with a pointer device. 2701 * This event works on desktop browser, but is undefined 2702 * on mobile browsers. 2703 * @name JXG.Board#pointerdblclick 2704 * @param {Event} e The browser's event object. 2705 */ 2706 __evt__pointerdblclick: function (e) { }, 2707 2708 /** 2709 * @event 2710 * @description Whenever the user stops to touch or click an element. 2711 * @name JXG.GeometryElement#up 2712 * @param {Event} e The browser's event object. 2713 */ 2714 __evt__up: function (e) { }, 2715 2716 /** 2717 * @event 2718 * @description Whenever the user releases the mousebutton over an element. 2719 * @name JXG.GeometryElement#mouseup 2720 * @param {Event} e The browser's event object. 2721 */ 2722 __evt__mouseup: function (e) { }, 2723 2724 /** 2725 * @event 2726 * @description Whenever the user lifts the pen over an element. 2727 * @name JXG.GeometryElement#penup 2728 * @param {Event} e The browser's event object. 2729 */ 2730 __evt__penup: function (e) { }, 2731 2732 /** 2733 * @event 2734 * @description Whenever the user stops touching an element. 2735 * @name JXG.GeometryElement#touchup 2736 * @param {Event} e The browser's event object. 2737 */ 2738 __evt__touchup: function (e) { }, 2739 2740 /** 2741 * @event 2742 * @description Notify every time an attribute is changed. 2743 * @name JXG.GeometryElement#attribute 2744 * @param {Object} o A list of changed attributes and their new value. 2745 * @param {Object} el Reference to the element 2746 */ 2747 __evt__attribute: function (o, el) { }, 2748 2749 /** 2750 * @event 2751 * @description This is a generic event handler. It exists for every possible attribute that can be set for 2752 * any element, e.g. if you want to be notified everytime an element's strokecolor is changed, is the event 2753 * <tt>attribute:strokecolor</tt>. 2754 * @name JXG.GeometryElement#attribute:key 2755 * @param val The old value. 2756 * @param nval The new value 2757 * @param {Object} el Reference to the element 2758 */ 2759 __evt__attribute_: function (val, nval, el) { }, 2760 2761 /** 2762 * @ignore 2763 */ 2764 __evt: function () { } 2765 //endregion 2766 } 2767 ); 2768 2769 export default JXG.GeometryElement; 2770 // const GeometryElement = JXG.GeometryElement; 2771 // export { GeometryElement as default, GeometryElement }; 2772