doc/decoration.js.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: decoration.js</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Source: decoration.js</h1>

    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>import uuid from "uuid";

/**
 * The base Decoration class. Decorations are elements in the figure that can update but don't map directly
 * to nodes and branches.
 */


export class Decoration {
    constructor() {
        this._created = false;
        this._title={
            text:"",
            xPadding:0,
            yPadding:0,
            rotation:0
        };
        this._id= `s${uuid.v4()}`;
        this._interactions=[];
    }
    /**
     * Get or set svg layer elements will be added to.
     * @param l
     * @return {BaubleManager|*}
     */
    figure(f = null) {
        if (f === null) {
            return this._figure;
        } else {
            this._figure = f;
            return this;
        }
    }
    /**
     * Get or set the figtree instance this manager works for. This allows the manager to access the figure's scale ect.
     * @param f
     * @return {BaubleManager|*}
     */
    layer(l=null){
        if(l===null){
            return this._layer
        }else{
            this._layer=l;
            return this
        }
    }

    /**{
     * Getter, setter for Decoration title. The options are below and are passed to the d3 text element.
     * @param options
     * @return {Decoration|{rotation: number, text: string, xPadding: number, yPadding: number}}
     */
    title(options = null) {
        if (!options) {
            return this._title;
        } else {
            this._title = {...this._title, ...options};
            return this;
        }
    }

    /**
     * Set a call back to be fired when the event listener is triggered.
     * @param eventListener - a string that defines the event listener
     * @param value -  call back that will be passed d,i,n
     * @return {Decoration}
     */
    on(string, value) {
        this._interactions[string] = value;
        return this;
    }

    /**
     * Get or set the transition duration and ease. Defualts to the figtree instance.
     * @param t - {Object} [t={tranmsissionDuration: transmissionEase:}]
     * @return {Bauble|BaubleManager|*|Bauble}
     */
    transitions(t = null) {
        if (t === null) {
            if (this._transitions) {
                return this._transitions;
            } else {
                return this.figure().transitions();
            }

        } else {
            this._transitions = t;
            return this;
        }
    }
    /**
     * Get or set the scales used in the element defaults to the figtree instance.
     * @param scales
     * @return {Bauble.scales|*}
     */
    scales(scales = null) {
        if (scales) {
            this._scales = scales
        } else {
            if (this._scales) {
                return this._scales;
            } else {
                return this.figure().scales
            }
        }
    }

    /**
     * Decorations have a create method which enters them onto a selection and an updateCycle method
     * that updated the already existing object. These are all handled by the update method which
     * @param selection
     */
    create(selection) {
        throw new Error("Don't call the base class method")
    };
    /**
     * Decorations have a create method which enters them onto a selection and an updateCycle method
     * that updated the already existing object. These are all handled by the update method which
     * @param selection
     */
    update(selection) {
        if (!this._created) {
            this.create(selection);
            this._created = true;
        }
        this.updateCycle();
    }
    /**
     * Decorations have a create method which enters them onto a selection and an updateCycle method
     * that updated the already existing object. These are all handled by the update method which
     * @param selection
     */
    updateCycle(selection) {
        throw new Error("Don't call the base class method")
    }

    /**
     * get or set the x position for the decorations
     * @param d
     * @return {*|Decoration}
     */
    x(d = null) {
        if (d !== null) {
            this._x = d;
            return this;
        } else {
            return this._x;
        }
    }
    /**
     * get or set the y position for the decorations
     * @param d
     * @return {*|Decoration}
     */
    y(d = null) {
        if (d !== null) {
            this._y = d;
            return this;
        } else {
            return this._y;
        }
    }
}

</code></pre>
        </article>
    </section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Decoration.html">Decoration</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Mar 18 2020 15:03:28 GMT+0000 (Greenwich Mean Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>