Skip to content

5.0.0
Compare
Choose a tag to compare
@jwoLondon jwoLondon released this 07 Jan 12:43
· 97 commits to main since this release
5.0.0
65b02f2

While this is a 'major' release, this is largely to remove deprecated functions that relate to an older Vega-Lite interaction model and to longhand measurement type functions that have had shorthand equivalents for several years. The main addition is to support Vega-Lite's new offset channels for modifying position encoding.

V5.0 Breaking Changes

  • Removed deprecated functions and types:

    • Binding and associated functions iCheckbox, iColor, iDate, iDateTimeLocal, iMonth, iNumber, iRadio, iRange, iSelect, iTel, iText, iTime, iWeek and seBind.
    • BindLegendProperty and associated functions blChannel, blEvent,blField and seBindLegend
    • hDataCondition, hSelectionCondition, mDataCondition, mSelectionCondition, oDataCondition and oSelectionCondition
    • pBand
    • seBindScales, seEmpty, seInit, seInitInterval, seMulti and seSingle
    • select, selection and selectionName.

    These mostly relate to the old interaction model superseded in Vega-Lite 5 / elm-Vegalite 4 (see 'Deprecations' in change document for elm-Vegalite 4 for details on updating any legacy interaction functions that follow the old Vega-Lite interaction model).

  • New Position types to support Vega-Lite 5.2's new offset channel: XOffset and YOffset. While technically a breaking change as it extends the Position custom type variants, these additions are unlikely to break any existing code.

  • Remove exposed Measurement type and associated functions pMType, mMType, tMType, hMType, dMType, oMType, fMType and kMType. Since elm-vegaLite V2, the preferred way to declare a measurement type has been through the more concise functions pQuant, pGeo, pTemporal, mQuant etc.

V5.0 Additions

  • Support for the new offset channel (VL 5.2) with position XOffset and position YOffset along with channel identifiers chXOffset and chYOffset, useful for grouped bar charts and jitter-plots.

  • widthStepOffset and heightStepOffset for specifying discrete step sizes (e.g. bars) for groups with a common offset. Only has an effect when specification uses a position offset channel (VL 5.2).

  • pRepeatDatum for use with position offsets and repeated encoding of multiple data fields (VL 5.2).

  • leLabelExpr for customising legend labels.

V5.0 Other Changes

  • Added further examples to gallery and tests.
Assets 2