5.8.0

Aligns with Vega-Lite Version 5.21.

Additions

• paNonReact for creating a new non-reactive parameter from an existing named parameter. This provides a more concise way of using react: false introduced in VL 5.20.

• doRawExpr for explicitly setting a domainRaw expression. Used for modifying an existing domain via some expression. Typically used to set domain values based on some interaction input.

• maInvalid and associated parameter functions ivImputeMark, ivImputeDomain, ivImputePathDomain and ivBreakPaths for precise control over the filtering / imputing of invalid data when encoding marks and generating domains. This replaces the old maRemoveInvalid reflecting changes to invalid introduced in VL 5.19

• sacoInvalid for providing custom values for imputed invalid data on a channel-by-channel basis, reflecting addition in VL 5.19

Changes

• scDomainExpr now creates a Vega-Lite domain expression rather than domainRaw expression. This isn't a change to the API, but rather the Vega-Lite output it generates and is consistent with expected behaviour for VL 5.20. For cases where domainRaw is needed, use the new doRawExpr function.

Deprecations

• maRemoveInvalid now deprecated in favour of maInvalid. This reflects changes in VL5.19 allowing more precise handling of invalid data items for path marks and domains. maRemoveInvalid True should be replaced with maInvalid [] and maRemoveInvalid False replaced with maInvalid [ ivImputeMark ]

5.7.0

Aligning with Vega-Lite Version 5.18.

Additions

• dnResolve for specifying whether density transform parameters are shared between groups (VL 5.18)

Minor changes

• Updated interactive examples to use pointerOver rather than mouseOver (aligns with updated examples on VegaLite pages)

• Add examples that use pBandPosition in tests. No new API here, but now works with bars and lines since VL 5.16.

V5.6.0

Aligning with Vega-Lite Version 5.14.

Additions

• binnedTimeUnit for indicating time units have already been aggregated (VL 5.12).

• maMinBandSize for configuring the minimum width/height of a bar mark (VL 5.11).

• extent transform (VL 5.10) for storing minimum and maximum values in a data field.

• New option labelling functions inLabelledOptions, inLabelledDatumOptions and inLabelledDataOptions for attaching labels to each option in a radio or drop-down selection. Thanks to @hingew for identifying the need for this.

Changes

• When providing a domain expression with scDomainExpr, a VL domainRaw rather than domain is generated, taking advantage of VL 5.13's new domainRaw specification. Note: This may be reverted to older domain behaviour with a separate scDomainRaw function if it offers a meaningful difference to the old behaviour.

Release 5.5.0

Minor update to align with Vega-Lite release 5.9.0.

Most changes are bugfixes and enhancements in the Vega-Lite runtime that do not affect the elm-vegalite API.

Additions

• coTooltipFormat to allow tooltip-specific formatting of displayed values (VL 5.9)

API Documentation

• Minor additions to API docs with code examples.

Release 5.4.3

Minor changes to API documentation. Fixed broken links with thanks to @RalfNorthman for valuable error checking.

Release 5.4.2

Minor API documentation improvements that cross reference parent functions. This makes navigation up and down the function dependency tree easier.

Release 5.4.1

Minor API documentation improvements

Release 5.4.0

Minor changes to improve API docs and add extra configuration option added to Vega Lite 5.6.

V5.4 Additions

• fromPosixTime to allow Elm time functions to be used to generate elm-vegalite DateTime values. Thanks to @RalfNorthman for the suggestion.

• secoZero to set the default for whether zero is included in the domain of a scale (VL5.6).

Corrections

• Correct loGrouping bug that generated a single locale grouping rather than array. Thanks @hingew for spotting this.

API Documentation

• Corrected API doc for coLocale example to use correct Elm unicode escape text.

• Added reference to parent functions to some functions in the API docs. This makes it easier to see how a function is used in the context of a larger specification by navigating up the function dependency tree. Thanks to @RalfNorthman for the suggested improvement. Note: this is a work in progress and will be extended to other functions in future releases.

Deprecations

• Deprecated dtMonthNum as it was redundant (use dtMonth instead). There should be no reason to allow specification of months with numbers as this carries the risk of undefined behaviour for integers outside the range [1,12]. Thanks to @RalfNorthman for spotting this.

• AxisChoice, axX and axY deprecated as specific axis choice is specified via coAxisXFilter and coAxisYFilter. These have been redundant since elm-vegalite V2.3.0 but were inadvertently left exposed in the API.

5.3.0

Minor addition to allow multiple time formats to be specified for an axis.

• Add axTemporalFormats to allow multiple time formats for temporal axis labels depending on temporal granularity. Thanks @RalfNorthman for the suggestion.

5.2.0

Minor changes to allow custom metadata to be added to a specification.

V5.2 Additions

• Add userMeta function for attaching custom metadata objects to a JSON specification. This was part of the VL 5 spec but had been missed in the elm-vegalite implementation.