charts/shared/dataTools.mjs

/* dataTools module
  - parsing logic for data
*/

const COLOR_SCHEME = "colorScheme"
const COLOR_LINEAR_RANGE = "colorLinearRange"
const COLOR_MAX = "colorMax"

// dropdown properties
const COLOR = "Color"
const KEY_CATEGORY = "keyCategory"
const checkDropdownProperty = (key) => {
  return key !== COLOR && key !== KEY_CATEGORY
}

const dataTools = {
  /**
    return dropdown if available, otherwise generate dropdown arr from existing keys
  *******/
  getDropdown(dropdown, keys) {
    if (dropdown && dropdown.length > 0) {
      return dropdown
    }

    const arr = []

    // generate dropdown based on keys
    keys.forEach((key, i) => {
      if (i !== 0 && checkDropdownProperty(key)) {
        // ignore first key as it's usually for the yAxis
        arr.push({
          data: key,
          display: key
        })
      }
    })

    return arr
  },

  /**
    create a html id to be used as chartId
  *******/
  getId(str) {
    return str.replace(/ |-|\(|\)/g, "_")
  },

  /**
    colorKeysRanges: object that provides the key/color pair
    maxValue (optional): use this max if provided, otherwise find the max in array.
    returns an array of values 
  *******/
  getColorDomainRangeMax(option) {
    const hasProp = (p) => option && option[p]
    const isArray = Array.isArray(option[COLOR_LINEAR_RANGE])

    // if option is an array, the domain are the Object.values
    const domain = hasProp(COLOR_LINEAR_RANGE)
      ? isArray
        ? Object.values(option[COLOR_LINEAR_RANGE])
        : Object.keys(option[COLOR_LINEAR_RANGE]).map((k) => parseInt(k))
      : []

    // if option is an array, the range are empty
    const range = hasProp(COLOR_LINEAR_RANGE)
      ? isArray
        ? []
        : Object.values(option[COLOR_LINEAR_RANGE])
      : []

    // if option is an array, the range are empty
    const colorScheme = option[COLOR_SCHEME]

    const max = option[COLOR_MAX] || d3.max(domain)

    return {
      colorDomain: domain.map((d) => d / max),
      colorRange: range && range.length > 0 ? range : colorScheme,
      colorMax: max
    }
  },

  getUserDefinedKeysColors(userDefined) {
    const keys = []
    const colors = []
    //console.log("userDefined", userDefined)
    userDefined.forEach((d) => {
      // key name is "key" in bar charts but "keyName" in line charts
      keys.push( (d.key) ? d.key : d.keyName )
      colors.push(d.colour)
    })

    return {
      keys,
      colors
    }
  },

  getKeysColors({ keys, userKey, option }) {
    let obj = {
      keys
    }

    //console.log("obj", obj)
    // userKey takes precedence over option.colorScheme
    if (userKey.length >= 1) {
      //console.log("key",userKey)
      obj = this.getUserDefinedKeysColors(userKey)
    } else if (option[COLOR_SCHEME]) {
      obj.colors = option[COLOR_SCHEME]
    }

    //console.log("obj",obj)
    return obj
  },

  chartlines(settings) {

    return (settings.dropdown.length == 0) ? settings.keys : [ settings.xColumn, ...settings.dropdown[0].values.split(',').map(d => d.trim()) ] // d.trim()

  },

  stackedhorizontal(settings) {

    return (settings.dropdown.length == 0) ? settings.keys.filter(d => d != settings.yColumn ) : settings.dropdown[0].values.split(',').map(d => d.trim())

  },

  stackedbars(settings) {

    return (settings.dropdown.length == 0) ? settings.keys.filter(d => d != settings.xColumn ) : settings.dropdown[0].values.split(',').map(d => d.trim())

  },

  smallmultiples(settings) {

    return (settings.dropdown.length == 0) ? settings.keys : [ settings.xColumn, settings.groupBy, ...settings.dropdown[0].values.split(',').map(d => d.trim()) ]

  }

}

export default dataTools