Module:ChartSelectRename/doc

Category:Module documentation#ChartSelectRename/doc

This module provides a transform for chart renderings that selects specific columns and sets titles in multiple languages.

See mw:Extension:Chart/Transforms for more documentation on this transform feature of the Charts system.

Usage

process: Select columns and set titles for multiple languages.

To use as a chart transform:

"transform": {
    "module": "ChartSelectRename",
    "function": "process",
    "args": {
        "cols": "population,année",
        "translations": "fr:Population,Année;en:Population,Year;es:Población,Año"
    }
}

To invoke as a utility function from another module:

local ChartSelectRename = require( "Module:ChartSelectRename" )
local tab = mw.ext.data.get( "Some dataset.tab" )

-- Note this may mutate the original tab object
tab = ChartSelectRename.process(tab, {
    ["cols"] = "population,année",
    ["translations"] = "fr:Population,Année;en:Population,Year"
})

Arguments:

  • cols: comma-separated list of column names to keep, otherwise returns all columns
  • translations: semicolon-separated list of language blocks in the format lang:Title1,Title2;lang2:TitleA,TitleB (sets f.title[lang] for each column)
Category:Module documentation