commited for presentation.

lib/pixi/maps/map.js

@@ -54,7 +54,6 @@ export class GeoMap {
         this.onTransform = new EventHandler('transform', { listeners: onTransform })
 
         this._alpha = alpha
-        this.cover = cover
         this.debug = debug
 
         //TODO discuss if this is required here.
@@ -68,7 +67,7 @@ export class GeoMap {
         this.scalable = scalable
         this.viewport = viewport
 
-        this.mapdata = mapdata
+        this._mapdata = mapdata
         this.overlays = {}
 
         /**
@@ -92,6 +91,32 @@ export class GeoMap {
         }
     }
 
+    /**
+     * Returns the image object used by the GeoMap.
+     *
+     * @readonly
+     * @memberof GeoMap
+     */
+    get image() {
+        return this._image
+    }
+
+    /**
+     * The mapdata of the map.
+     *
+     * @member {MapData}
+     * @readonly
+     * @memberof GeoMap
+     */
+    get mapdata() {
+        return this._mapdata
+    }
+
+    /**
+     * Clears all EventHandlers.
+     *
+     * @memberof GeoMap
+     */
     flushHandlers() {
         this.onLoad.empty()
         this.onTransform.empty()
@@ -174,6 +199,7 @@ export class GeoMap {
 
     /**
      * Wrapps the display object around a scatter object.
+     * creates the image.
      *
      * @private
      * @param {DisplayObject} displayObject - Defines the display object that will be wrapped inside the scatter object.
@@ -182,7 +208,7 @@ export class GeoMap {
     load(image, renderer, frame = null, scatter = null) {
         if (this.debug) console.log('Load image: ', image, frame)
 
-        this.image = image
+        this._image = image
         if (frame) this.setFrame(frame)
 
         let scatterOpts = Object.assign({
@@ -331,15 +357,41 @@ export class GeoMap {
         this.frame = null
     }
 
+    /**
+     * The complete Triforce, or one or more components of the Triforce.
+     * @typedef {Object} Frame
+     * @property {number} x - X position of the frame.
+     * @property {number} y - Y position of the frame.
+     * @property {number} width - Width of the frame.
+     * @property {number} height - Height od the frame.
+     * @property {Point} localCenter - Local center of the map. 
+     * @property {Point} center - Global center of the map.
+
+     */
+
+    /**
+     * Sets the frame if the map.
+     *
+     * Frame is the display in which the map is shown.
+     * Normally it's the app, but it can be another element,
+     * for example when in a submap.
+     *
+     * @param {Frame} frame
+     * @memberof GeoMap
+     */
     setFrame(frame) {
-        if (this.debug) console.log('Set Frame: ', frame)
         this.frame = frame
     }
 
     /**
+     * Gets the frame if the map.
+     *
      * Frame is the display in which the map is shown.
      * Normally it's the app, but it can be another element,
      * for example when in a submap.
+     *
+     * @returns {Frame} - Returns the frame of the map.
+     * @memberof GeoMap
      */
     getFrame() {
         let frame = {
@@ -425,6 +477,7 @@ export class GeoMap {
      * for creating the maps.
      *
      * @static
+     * @private
      * @param {object} json - The object containing multiple map data sets.
      * @param {error-object} error - An object that contains an parameter message: {message = ""}. This is faking a call by reference.
      * @returns {boolean} - True if all sets were valid. False otherwise.
@@ -460,6 +513,7 @@ export class GeoMap {
      *Validates of a single data set contains the valid data for creating a map.
      *
      * @static
+     * @private
      * @param {object} json - The object containing a single set of map data.
      * @returns {boolean} - True if valid, otherwise false.
      * @memberof GeoMap
@@ -513,14 +567,13 @@ export class GeoMap {
 GeoMap.counter = 0
 
 /**
- *   The DeepZoomMap class extends the GeoMap to create
+ *  The DeepZoomMap class extends the GeoMap to create
  *   maps as deepzoom images from maptiles.
  *
- *   @extends GeoMap
- *	@class
- * 	@see {@link maps.html}
+ * @export
+ * @class DeepZoomMap
+ * @extends {GeoMap}
  */
-
 export class DeepZoomMap extends GeoMap {
     /**
      * @constructor
@@ -741,11 +794,13 @@ DeepZoomMap.tintcolors = [0xff0000, 0xff00ff, 0xffff00, 0x00ff00, 0x00ffff, 0x00
 DeepZoomMap.tintcolor = 0
 
 /**
- *
  * ImageMap extends GeoMap to display simple images
  * as maps.
+ *
+ * @export
+ * @class ImageMap
+ * @extends {GeoMap}
  */
-
 export class ImageMap extends GeoMap {
     constructor(sprite, mapdata, opts = {}) {
         super(mapdata, opts)