Module:TabUtils/doc

This subpage contains documentation, categories, or other content that is not part of the module.
To view the module page itself, see Module:TabUtils.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ +/−

Category:Module documentation#TabUtils/doc

This module provides utility functions for transforming tabular data sets in chart renderings.

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

Usage

select: subset a data set by column reference or comparison on row values

To use as a chart transform:

"transform": {
    "module": "TabUtils",
    "function": "select",
    "args": {
        "where": "date",
        "lte": "2000"
    }
}

To invoke as a utility function from another module:

local TabUtils = require( "Module:TabUtils" )
local tab = mw.ext.data.get( "Sample weekly temperature dataset.tab" )

-- Note this may mutate the original tab object
tab = TabUtils.select(tab, {
    ["where"] = "date",
    ["lte"] = "2000"
})


Arguments:

  • cols: comma-separated list of column names to keep, otherwise returns all cols
  • where: column name to match on, otherwise returns all rows
  • eq, ne, gt, lt, gte, lte: value to compare against to keep rows
  • sort: column name to sort on
  • order: sort order "asc" or "desc", defaults to "asc"
  • decimate: keep only every nth row

Todo

  • support sort on multiple columns
  • allow combining multiple gt/gte/lt/lte to allow ranges
Category:Module documentation