Releases: gicentre/elm-vega
5.0.0
Updates to align with Vega 5.3.
Breaking Changes
These reflect breaking changes from Vega 4 -> Vega 5
scBinLinear
removed. UsescLinear
with the newscBins
instead.leStrokeWidth
now takes the name of scale for mapping legend stroke width rather than a numeric literal. For legend border configuration, use the newleBorderStrokeWidth
.leTitlePadding
,leOffset
andlePadding
now take a number rather than value (for consistency with other legend numeric parameters).- While not an API change, continuous color schemes no longer support discrete variants as part of the scheme name. Where previously
raScheme (str "blues-7") []
was valid, you should now useraScheme (str "blues") [csCount (num 7)]
Additions
scBins
for specifying the bin boundaries for a bin scaling. Associated functionsbsBins
,bsNums
andbsSignal
for customising bin boundaries.scSymLog
andscConstant
for symmetrical log scaling of data that may contain zero or negative values.symTriangle
,symArrow
andsymWedge
directional symbol types useful for new support for angle encoding of symbols.symStroke
for legend symbols- New axis configurations (
axDomainDash
,axDomainDashOffset
,axFormatAsNum
,axFormatAsTemporal
,axGridDashOffset
,axLabelFontStyle
,axLabelSeparation
,axTickDash
,axTickDashOffset
,axTickMinStep
,axTitleAnchor
andaxTitleFontStyle
.) - New legend configurations (
leBorderStrokeWidth
,leFormatAsNum
,leFormatAsTemporal
,leLabelFontStyle
,leLabelSeparation
,leSymbolDash
,leSymbolDashOffset
,leTickMinStep
,leTitleAnchor
,leTitleFontStyle
andleTitleOrient
.)
Documentation / Asset Changes
- Wind vector example added to test-gallery
- Other examples updated to reflect latest API
Patch release
Improved scalability of programmatic data column generation.
No changes to the API, documentation or examples.
4.3.0
Minor changes to add missing function to trContour
Additions
cnWeight
function added totrContour
to allow weighting of values when computing a density surface through KDE.
Documentation / Asset Changes
- Added Hypothetical Outcome Plot (HOP) example to test gallery (in distributions examples).
- Minor: Added missing
html
tags to some test pages.
4.2.0
Minor changes to bring in line with the release of Vega 4.4.0.
Additions
siInit
function for creating signal initialisation expressions (mutually exclusive alternative tosiUpdate
that performs one-off initialisation rather than dynamic update).
Documentation Changes
- Minor: Added Vega version badge to front page.
4.1.0
Minor changes to bring in line with the release of Vega 4.3.
Additions
-
teSeparation
flag added to control how 'sibling' and 'cousin' nodes are spaced in a tree layout. -
lpRequire
added as an option when creating link path transforms (see the Vega linkPath documentation)
Documentation Changes
- Typos corrected in API documentation.
Patch release
Minor changes to documentation. No changes to the API.
Release for Elm 0.19
For Elm 0.19 and above this release of elm-vega supports Vega only. For Vega-Lite support, see the now separate package elm-vegalite. No functionality has been lost in splitting the elmVega and elmVegaLite modules into separate packages, but the assets for each are now considerably smaller.
Changes to the API since the previous version are just in replacing all remaining custom type constructors (like Orthographic
, and Albers
) with consistently named functions (orthographic
and albers
). This provides greater future-proofing as Vega evolves.
When updating legacy code, the Elm compiler should highlight which type constructors require replacing with their function equivalent. You can always find the mapping from types to functions in the Type Reference section at the end of the API documentation.
3.0.0
Fully supports:
- Vega 4.2.0
- Vega-Lite 3.0.0 (release-candidate 2)
Breaking change (with respect to elm-vega 2.3)
-
renamed
windowAs
towindow
.
What was previouslywindowAs "cumulativeCount" [ wiAggregateOp Count, wiField "count" ]
is now
window [ ( [ wiAggregateOp Count, wiField "count" ], "cumulativeCount" ) ]
This allows multiple window field definitions to be specified, such as
window [ ( [ wiAggregateOp Min, wiField "stack_count_Origin1" ], "x" ) , ( [ wiAggregateOp Max, wiField "stack_count_Origin2" ], "x2" ) ] [ wiFrame Nothing Nothing, wiGroupBy [ "Origin" ] ]
Additions
Mostly to support Vega-Lite 3.0 enhancements:
- New header properties for faceted views
- New discrete scales (quantize, quantile and threshold)
- New legend encoding and configuration properties
- New axis encoding and configuration properties
- New
stack
transform. - New
impute
transform and encoding. - New
flatten
andflattenAs
transforms. - New
fold
andfoldAs
transforms.
Misc:
- More compact API documentation in order to comply with Elm package server file size limit (512kB)
- Additional tests and example gallery entries
3.0.0beta
Major Release
- elm-vega now has full Vega support (currently Vega 4.2.0)!
- Full Vega-Lite support (currently Vega-Lite 2.6.0)
Breaking Changes
There are a few minor breaking changes for Vega-Lite support:
- Previously deprecated access to type constructors now fully removed. Use their equivalent function calls instead (see release notes for elm-vega 2.3.0 for details).
mDataCondition
andtDataCondition
now take a list of (condition,encoding) tuples instead of condition trueEncoding falseEncoding. This allows mutliple conditions to be specified. For example, the old encoding:
color
[ mDataCondition ( expr "datum.myField === null")
[ mStr "grey" ]
[ mstr "black" ]
]
is now specified as
color
[ mDataCondition [ ( expr "datum.myField === null", [ mStr "grey" ] ) ]
[ mStr "black" ]
]
- Determining whether or not a scale should use 'nice' rounded numbers is now specified with
NTrue
orNFalse
rather thanscIsNice True
andscIsNice False
. This simplifies the API and is more consistent with its Vega equivalent.
Changes:
The main addtions have been to provide full Vega coverage. See the Vega
tutorials in the docs
folder for guidance and the rich set of examples in the vTest-gallery
.
Misc:
- API documentation improvements with a richer set of examples and better structuring of content.
- Additional tests