vis.js is a dynamic, browser-based visualization library
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

439 lines
13 KiB

9 years ago
9 years ago
  1. var util = require('../../../util');
  2. import Label from './shared/Label'
  3. import Box from './nodes/shapes/Box'
  4. import Circle from './nodes/shapes/Circle'
  5. import CircularImage from './nodes/shapes/CircularImage'
  6. import Database from './nodes/shapes/Database'
  7. import Diamond from './nodes/shapes/Diamond'
  8. import Dot from './nodes/shapes/Dot'
  9. import Ellipse from './nodes/shapes/Ellipse'
  10. import Icon from './nodes/shapes/Icon'
  11. import Image from './nodes/shapes/Image'
  12. import Square from './nodes/shapes/Square'
  13. import Star from './nodes/shapes/Star'
  14. import Text from './nodes/shapes/Text'
  15. import Triangle from './nodes/shapes/Triangle'
  16. import TriangleDown from './nodes/shapes/TriangleDown'
  17. import Validator from "../../../shared/Validator";
  18. import {printStyle} from "../../../shared/Validator";
  19. /**
  20. * @class Node
  21. * A node. A node can be connected to other nodes via one or multiple edges.
  22. * @param {object} options An object containing options for the node. All
  23. * options are optional, except for the id.
  24. * {number} id Id of the node. Required
  25. * {string} label Text label for the node
  26. * {number} x Horizontal position of the node
  27. * {number} y Vertical position of the node
  28. * {string} shape Node shape, available:
  29. * "database", "circle", "ellipse",
  30. * "box", "image", "text", "dot",
  31. * "star", "triangle", "triangleDown",
  32. * "square", "icon"
  33. * {string} image An image url
  34. * {string} title An title text, can be HTML
  35. * {anytype} group A group name or number
  36. * @param {Network.Images} imagelist A list with images. Only needed
  37. * when the node has an image
  38. * @param {Network.Groups} grouplist A list with groups. Needed for
  39. * retrieving group options
  40. * @param {Object} constants An object with default values for
  41. * example for the color
  42. *
  43. */
  44. class Node {
  45. constructor(options, body, imagelist, grouplist, globalOptions) {
  46. this.options = util.bridgeObject(globalOptions);
  47. this.body = body;
  48. this.edges = []; // all edges connected to this node
  49. // set defaults for the options
  50. this.id = undefined;
  51. this.imagelist = imagelist;
  52. this.grouplist = grouplist;
  53. // state options
  54. this.x = undefined;
  55. this.y = undefined;
  56. this.baseSize = this.options.size;
  57. this.baseFontSize = this.options.font.size;
  58. this.predefinedPosition = false; // used to check if initial fit should just take the range or approximate
  59. this.selected = false;
  60. this.hover = false;
  61. this.labelModule = new Label(this.body, this.options);
  62. this.setOptions(options);
  63. }
  64. /**
  65. * Attach a edge to the node
  66. * @param {Edge} edge
  67. */
  68. attachEdge(edge) {
  69. if (this.edges.indexOf(edge) === -1) {
  70. this.edges.push(edge);
  71. }
  72. }
  73. /**
  74. * Detach a edge from the node
  75. * @param {Edge} edge
  76. */
  77. detachEdge(edge) {
  78. var index = this.edges.indexOf(edge);
  79. if (index != -1) {
  80. this.edges.splice(index, 1);
  81. }
  82. }
  83. /**
  84. * Enable or disable the physics.
  85. * @param status
  86. */
  87. togglePhysics(status) {
  88. this.options.physics = status;
  89. }
  90. /**
  91. * Set or overwrite options for the node
  92. * @param {Object} options an object with options
  93. * @param {Object} constants and object with default, global options
  94. */
  95. setOptions(options) {
  96. if (!options) {
  97. return;
  98. }
  99. // basic options
  100. if (options.id !== undefined) {this.id = options.id;}
  101. if (this.id === undefined) {
  102. throw "Node must have an id";
  103. }
  104. // set these options locally
  105. if (options.x !== undefined) {this.x = parseInt(options.x); this.predefinedPosition = true;}
  106. if (options.y !== undefined) {this.y = parseInt(options.y); this.predefinedPosition = true;}
  107. if (options.size !== undefined) {this.baseSize = options.size;}
  108. if (options.value !== undefined) {options.value = parseFloat(options.value);}
  109. // copy group options
  110. if (typeof options.group === 'number' || (typeof options.group === 'string' && options.group != '')) {
  111. var groupObj = this.grouplist.get(options.group);
  112. util.deepExtend(this.options, groupObj);
  113. // the color object needs to be completely defined. Since groups can partially overwrite the colors, we parse it again, just in case.
  114. this.options.color = util.parseColor(this.options.color);
  115. }
  116. // this transforms all shorthands into fully defined options
  117. Node.parseOptions(this.options, options, true);
  118. // load the images
  119. if (this.options.image !== undefined) {
  120. if (this.imagelist) {
  121. this.imageObj = this.imagelist.load(this.options.image, this.options.brokenImage, this.id);
  122. }
  123. else {
  124. throw "No imagelist provided";
  125. }
  126. }
  127. this.updateShape();
  128. this.updateLabelModule();
  129. // reset the size of the node, this can be changed
  130. this._reset();
  131. if (options.hidden !== undefined || options.physics !== undefined) {
  132. return true;
  133. }
  134. return false;
  135. }
  136. /**
  137. * This process all possible shorthands in the new options and makes sure that the parentOptions are fully defined.
  138. * Static so it can also be used by the handler.
  139. * @param parentOptions
  140. * @param newOptions
  141. */
  142. static parseOptions(parentOptions, newOptions, allowDeletion = false) {
  143. var fields = [
  144. 'color',
  145. 'font',
  146. 'fixed',
  147. 'shadow'
  148. ];
  149. util.selectiveNotDeepExtend(fields, parentOptions, newOptions, allowDeletion);
  150. // merge the shadow options into the parent.
  151. util.mergeOptions(parentOptions, newOptions, 'shadow');
  152. // individual shape newOptions
  153. if (newOptions.color !== undefined && newOptions.color !== null) {
  154. let parsedColor = util.parseColor(newOptions.color);
  155. util.fillIfDefined(parentOptions.color, parsedColor);
  156. }
  157. else if (allowDeletion === true && newOptions.color === null) {
  158. parentOptions.color = undefined;
  159. delete parentOptions.color;
  160. }
  161. // handle the fixed options
  162. if (newOptions.fixed !== undefined && newOptions.fixed !== null) {
  163. if (typeof newOptions.fixed === 'boolean') {
  164. parentOptions.fixed.x = newOptions.fixed;
  165. parentOptions.fixed.y = newOptions.fixed;
  166. }
  167. else {
  168. if (newOptions.fixed.x !== undefined && typeof newOptions.fixed.x === 'boolean') {
  169. parentOptions.fixed.x = newOptions.fixed.x;
  170. }
  171. if (newOptions.fixed.y !== undefined && typeof newOptions.fixed.y === 'boolean') {
  172. parentOptions.fixed.y = newOptions.fixed.y;
  173. }
  174. }
  175. }
  176. // handle the font options
  177. if (newOptions.font !== undefined) {
  178. Label.parseOptions(parentOptions.font, newOptions);
  179. }
  180. // handle the scaling options, specifically the label part
  181. if (newOptions.scaling !== undefined) {
  182. util.mergeOptions(parentOptions.scaling, newOptions.scaling, 'label');
  183. }
  184. }
  185. updateLabelModule() {
  186. if (this.options.label === undefined || this.options.label === null) {
  187. this.options.label = '';
  188. }
  189. this.labelModule.setOptions(this.options, true);
  190. if (this.labelModule.baseSize !== undefined) {
  191. this.baseFontSize = this.labelModule.baseSize;
  192. }
  193. }
  194. updateShape() {
  195. // choose draw method depending on the shape
  196. switch (this.options.shape) {
  197. case 'box':
  198. this.shape = new Box(this.options, this.body, this.labelModule);
  199. break;
  200. case 'circle':
  201. this.shape = new Circle(this.options, this.body, this.labelModule);
  202. break;
  203. case 'circularImage':
  204. this.shape = new CircularImage(this.options, this.body, this.labelModule, this.imageObj);
  205. break;
  206. case 'database':
  207. this.shape = new Database(this.options, this.body, this.labelModule);
  208. break;
  209. case 'diamond':
  210. this.shape = new Diamond(this.options, this.body, this.labelModule);
  211. break;
  212. case 'dot':
  213. this.shape = new Dot(this.options, this.body, this.labelModule);
  214. break;
  215. case 'ellipse':
  216. this.shape = new Ellipse(this.options, this.body, this.labelModule);
  217. break;
  218. case 'icon':
  219. this.shape = new Icon(this.options, this.body, this.labelModule);
  220. break;
  221. case 'image':
  222. this.shape = new Image(this.options, this.body, this.labelModule, this.imageObj);
  223. break;
  224. case 'square':
  225. this.shape = new Square(this.options, this.body, this.labelModule);
  226. break;
  227. case 'star':
  228. this.shape = new Star(this.options, this.body, this.labelModule);
  229. break;
  230. case 'text':
  231. this.shape = new Text(this.options, this.body, this.labelModule);
  232. break;
  233. case 'triangle':
  234. this.shape = new Triangle(this.options, this.body, this.labelModule);
  235. break;
  236. case 'triangleDown':
  237. this.shape = new TriangleDown(this.options, this.body, this.labelModule);
  238. break;
  239. default:
  240. this.shape = new Ellipse(this.options, this.body, this.labelModule);
  241. break;
  242. }
  243. this._reset();
  244. }
  245. /**
  246. * select this node
  247. */
  248. select() {
  249. this.selected = true;
  250. this._reset();
  251. }
  252. /**
  253. * unselect this node
  254. */
  255. unselect() {
  256. this.selected = false;
  257. this._reset();
  258. }
  259. /**
  260. * Reset the calculated size of the node, forces it to recalculate its size
  261. * @private
  262. */
  263. _reset() {
  264. this.shape.width = undefined;
  265. this.shape.height = undefined;
  266. }
  267. /**
  268. * get the title of this node.
  269. * @return {string} title The title of the node, or undefined when no title
  270. * has been set.
  271. */
  272. getTitle() {
  273. return this.options.title;
  274. }
  275. /**
  276. * Calculate the distance to the border of the Node
  277. * @param {CanvasRenderingContext2D} ctx
  278. * @param {Number} angle Angle in radians
  279. * @returns {number} distance Distance to the border in pixels
  280. */
  281. distanceToBorder(ctx, angle) {
  282. return this.shape.distanceToBorder(ctx,angle);
  283. }
  284. /**
  285. * Check if this node has a fixed x and y position
  286. * @return {boolean} true if fixed, false if not
  287. */
  288. isFixed() {
  289. return (this.options.fixed.x && this.options.fixed.y);
  290. }
  291. /**
  292. * check if this node is selecte
  293. * @return {boolean} selected True if node is selected, else false
  294. */
  295. isSelected() {
  296. return this.selected;
  297. }
  298. /**
  299. * Retrieve the value of the node. Can be undefined
  300. * @return {Number} value
  301. */
  302. getValue() {
  303. return this.options.value;
  304. }
  305. /**
  306. * Adjust the value range of the node. The node will adjust it's size
  307. * based on its value.
  308. * @param {Number} min
  309. * @param {Number} max
  310. */
  311. setValueRange(min, max, total) {
  312. if (this.options.value !== undefined) {
  313. var scale = this.options.scaling.customScalingFunction(min, max, total, this.options.value);
  314. var sizeDiff = this.options.scaling.max - this.options.scaling.min;
  315. if (this.options.scaling.label.enabled === true) {
  316. var fontDiff = this.options.scaling.label.max - this.options.scaling.label.min;
  317. this.options.font.size = this.options.scaling.label.min + scale * fontDiff;
  318. }
  319. this.options.size = this.options.scaling.min + scale * sizeDiff;
  320. }
  321. else {
  322. this.options.size = this.baseSize;
  323. this.options.font.size = this.baseFontSize;
  324. }
  325. }
  326. /**
  327. * Draw this node in the given canvas
  328. * The 2d context of a HTML canvas can be retrieved by canvas.getContext("2d");
  329. * @param {CanvasRenderingContext2D} ctx
  330. */
  331. draw(ctx) {
  332. this.shape.draw(ctx, this.x, this.y, this.selected, this.hover);
  333. }
  334. /**
  335. * Update the bounding box of the shape
  336. */
  337. updateBoundingBox(ctx) {
  338. this.shape.updateBoundingBox(this.x,this.y,ctx);
  339. }
  340. /**
  341. * Recalculate the size of this node in the given canvas
  342. * The 2d context of a HTML canvas can be retrieved by canvas.getContext("2d");
  343. * @param {CanvasRenderingContext2D} ctx
  344. */
  345. resize(ctx) {
  346. this.shape.resize(ctx, this.selected);
  347. }
  348. /**
  349. * Check if this object is overlapping with the provided object
  350. * @param {Object} obj an object with parameters left, top, right, bottom
  351. * @return {boolean} True if location is located on node
  352. */
  353. isOverlappingWith(obj) {
  354. return (
  355. this.shape.left < obj.right &&
  356. this.shape.left + this.shape.width > obj.left &&
  357. this.shape.top < obj.bottom &&
  358. this.shape.top + this.shape.height > obj.top
  359. );
  360. }
  361. /**
  362. * Check if this object is overlapping with the provided object
  363. * @param {Object} obj an object with parameters left, top, right, bottom
  364. * @return {boolean} True if location is located on node
  365. */
  366. isBoundingBoxOverlappingWith(obj) {
  367. return (
  368. this.shape.boundingBox.left < obj.right &&
  369. this.shape.boundingBox.right > obj.left &&
  370. this.shape.boundingBox.top < obj.bottom &&
  371. this.shape.boundingBox.bottom > obj.top
  372. );
  373. }
  374. }
  375. export default Node;