@cbinsights/react-d3-graph/src/components/node/node.helper.js

React component to build interactive and configurable graphs with d3 effortlessly

/**
 * @module Node/helper
 * @description
 * Some methods that help no the process of rendering a node.
 */
import {
    symbolCircle as d3SymbolCircle,
    symbolCross as d3SymbolCross,
    symbolDiamond as d3SymbolDiamond,
    symbolSquare as d3SymbolSquare,
    symbolStar as d3SymbolStar,
    symbolTriangle as d3SymbolTriangle,
    symbolWye as d3SymbolWye,
    symbol as d3Symbol
} from 'd3-shape';

import CONST from './node.const';

/**
 * Converts a string that specifies a symbol into a concrete instance
 * of d3 symbol.<br/>
 * {@link https://github.com/d3/d3-shape/blob/master/README.md#symbol}
 * @param  {string} typeName - the string that specifies the symbol type (should be one of {@link #node-symbol-type|node.symbolType}).
 * @returns {Object} concrete instance of d3 symbol (defaults to circle).
 * @memberof Node/helper
 */
function _convertTypeToD3Symbol(typeName) {
    switch (typeName) {
        case CONST.SYMBOLS.CIRCLE:
            return d3SymbolCircle;
        case CONST.SYMBOLS.CROSS:
            return d3SymbolCross;
        case CONST.SYMBOLS.DIAMOND:
            return d3SymbolDiamond;
        case CONST.SYMBOLS.SQUARE:
            return d3SymbolSquare;
        case CONST.SYMBOLS.STAR:
            return d3SymbolStar;
        case CONST.SYMBOLS.TRIANGLE:
            return d3SymbolTriangle;
        case CONST.SYMBOLS.WYE:
            return d3SymbolWye;
        default:
            return d3SymbolCircle;
    }
}

/**
 * Build a d3 svg symbol based on passed symbol and symbol type.
 * @param  {number} [size=80] - the size of the symbol.
 * @param  {string} [symbolTypeDesc='circle'] - the string containing the type of symbol that we want to build
 * (should be one of {@link #node-symbol-type|node.symbolType}).
 * @returns {Object} concrete instance of d3 symbol.
 * @memberof Node/helper
 */
function buildSvgSymbol(size = CONST.DEFAULT_NODE_SIZE, symbolTypeDesc = CONST.SYMBOLS.CIRCLE) {
    return d3Symbol()
        .size(() => size)
        .type(() => _convertTypeToD3Symbol(symbolTypeDesc))();
}

export default {
    buildSvgSymbol
};