@patricksurry/g3/src/mixin.js

A flexible Javascript framework for building steam gauge instrument panels that display live external metrics from flight (or other) simulators like XPlane or MS FS2020

/*
various mixins that add functionality to an existing object
typically mixin(f) adds a number of setters/getters to f that adjust arguments
as well as a mixin(sel[, ...]) function that renders the mixin into sel based on the current arguments
sample usage:

    obj = ...
    stylable(obj)
    obj.class('some-class')   // add a class argument
    obj.stylable(sel)            // render the style attributes for
*/

import * as d3 from 'd3';
import { css } from '@emotion/css';

import { d3sel } from './common.js';

export const identity = v => v;


export function appendId(typ) {
    return typ + (++appendId.nextId).toString(36);
}
appendId.nextId = 0;


export function stylable(f) {
    var kls = [],
        style;

    f.stylable = function (selection) {
        if (kls.length) selection.attr('class', f.class());
        if (style) selection.attr('style', f.style());
    }
    f.css = function(_) {
        return arguments.length ? (kls.push(css(_)), f) : kls.join(' ');
    }
    f.class = function(_) {
        return arguments.length ? (kls = kls.concat(_.split(' ')), f) : kls.join(' ');
    }
    f.style = function(_) {
        return arguments.length ? (style = _, f): style;
    }
    return f;
}


export function transformable(f) {
    var x=0, y=0, scalex=1, scaley=1, rotate=0;

    f.transformable = function(selection) {
        selection.attr('transform', `translate(${x}, ${y}) rotate(${rotate}) scale(${scalex}, ${scaley})`);
    }
    f.x = function(_) {
        return arguments.length ? (x = _, f) : x;
    }
    f.y = function(_) {
        return arguments.length ? (y = _, f) : y;
    }
    f.scale = function(x, y) {
        return arguments.length ? (scalex = x, scaley = y ?? x, f) : [scalex, scaley];
    }
    f.rotate = function(_) {
        return arguments.length ? (rotate = _, f) : rotate;
    }
    return f;
}


export function interactable(f) {
    var handlers = {};

    f.interactable = function(selection, ...args) {
        Object.entries(handlers).map(([type, v]) => {
            let [handler, opts] = v;
            selection.on(type, (e) => handler(e, ...args), opts)
        })
    }
    f.on = function(type, handler, opts) {
        return arguments.length ? (handlers[type] = [handler, opts], f): handlers;
    }
    return f;
}


export function appendable(f) {
    var defs = [],
        kids = [];

    f.appendable = function(sel, g) {
        sel = d3sel(sel);
        if (defs.length) {
            let _ = d3.select(sel.node().ownerSVGElement).select('defs');
            if (_.empty()) throw "Couldn't find svg defs element"
            _.selectAll(null)
                .data(defs)
              .enter().each(function(d) { d3.select(this).call(d, g)});
        }
        sel.selectAll(null)
            .data(kids)
          .enter().each(function(d) { d3.select(this).call(d, g); });
    }
    f.defs = function(..._) {
        return arguments.length ? (defs = defs.concat(_), f) : defs;
    }
    f.append = function(..._) {
        return arguments.length ? (kids = kids.concat(_), f) : kids;
    }
    return f;
}