diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,116 @@ For the latest version of this document, please see [https://github.com/DougBurke/hvega/blob/master/hvega/CHANGELOG.md](https://github.com/DougBurke/hvega/blob/master/hvega/CHANGELOG.md). +## 0.6.0.0 + +The Vega-Lite tests are now validated against version 4.5 of the +Vega-Lite schema. + +### New functionality + +New function for use with `encoding`: `strokeDash`. The `ChStrokeDash` +constructor has been added to the `Channel` type, and `RNumberLists` +(Vega-Lite 4.4) to `ScaleRange`. + +Named styles have been added for axes as well as marks. As mentioned +below, this involves deprecating the previous constructors for naming +styles, as there are now separate configuration options: +`AxisNamedStyles` and `MarkNamedStyles`. The `AStyle` and `AxStyle` +options have been added to `AxisConfig` and `AxisProperty` +respectively. The `StyleLabel` type alias has been added to help the +documentation, but provides no extra type safety. + +### Breaking changes + +The `ConcatStyle` and `FacetStyle` constructors for +`ConfigurationProperty` now accept a common type, +`CompositionConfig`, rather than having separate +`ConcatConfig` and `FacetConfig` types with the same meaning. +So `ConcatColumns` and `FColumns` have been replaced by `CompColumns`, +and `CompSpacing` and `FSpacing` by `CompSpacing`. + +The `ViewFill` and `ViewStroke` constructors of `ViewConfig` no longer +take an optional `Color` argument. The Nothing case has been replaced +by new constructors: `ViewNoFill` and `ViewNoStroke`. + +The `VBFill` and `VBStroke` constructors of `ViewBackground` no longer +take an optional `Color` argument. The Nothing case has been replaced +by new constructors: `VBNoFill` and `VBNoStroke`. + +### New constructors + +`FacetChannel` has gained the following constructors: `FAlign`, +`FCenter`, and `FSpacing`. The last one would have collides with +the `FacetStyle` option, but this has fortuitously been renamed to +`CompSpacing`. + +`MSymbol` has been added to `MarkChannel` which can be used to make the +`shape` encoding conditional on a data or selection condition. + +The `TUStep` and `TUMaxBins` constructors have been added to `TimeUnit` +for controlling how time values are binned. + +The `MarkProperty` type has gained the `MCornerRadiusEnd` constructor, +which is used to draw rounded histogram bars, and `MTexts` for +specifying multiple text values. + +Error box and band properties (constructors in `MarkProperty`) can now +be turned off with explicit `No` variants: `MNoBorders`, `MNoBox`, +`MNoMedian`, `MNoRule`, and `MNoTicks`. These join the `MNoOutliers` +constructor. + +The `ScaleProperty` type has gained `SDomainMid`, useful for +asymmetric diverging color scales, and `SReverse` from Vega-Lite v4.5. +The `ScaleDomain` type has gained the `DUnionWith` option from +Vega-Lite v4.3. The `ScaleConfig` type has gained `SCXReverse` +from Vega-Lite v4.5. + +Labels can now be vertically aligned to their baseline with the +`AlignBaseline` constructor of the `VAlign` type. + +Headers (`HeaderProperty`) have gained the following constructors: +`HLabel`, `HLabelExpr`, `HLabelFontStyle`, `HTitleFontStyle`, +and `HTitleLineHeight`. + +Conditional axis (`ConditionalAxisProperty`) has gained the following +constructors for features added in Vega-Lite v4.2 and v4.5: +`CAxLabelOffset`, `CAxLabelPadding`, and `CAxTickSize`. + +Cursor handling has been enhanced (to match Vega-Lite 4.1): +`ViewCursor` has been added to `ViewConfig` and `SMCursor` to +`SelectionMarkProperty`. + +The legend configuration has been updated (to match Vega-Lite 4.0) +with the addition of `LeSymbolLimit`, `LeTickCount`, `LeTitleLineHeight`, +and `LeUnselectedOpacity` constructors. + +The axis configuration and property types (`AxisConfig` and +`AxisProperty`) have gained the Vega-Lite 4.4 `LabelOffset` and +`AxLabelOffset` constructors. Note that version 4.4.0 of the +Vega-Lite specification has these fields as strings but this is fixed +in version 4.5.0. + +`ConfigurationProperty` has added new constructors: `AxisDiscrete` and +`AxisPoint` from Vega-Lite 4.5, `AxisQuantitative` and `AxisTemporal` +from Vega-Lite 4.4, `BoxplotStyle`, `ErrorBandStyle`, `ErrorBarStyle`, +`FontStyle` (Vega-Lite 4.3), `HeaderColumnStyle`, `HeaderFacetStyle`, +`HeaderRowStyle`, `ImageStyle`, and `RepeatStyle`. + +### Deprecated symbols + +`ConfigurationProperty` has seen a large number of deprecations, as a +number of constructors have been renamed: + + - The `NamedStyle` and `NamedStyles` have been replaced by `MarkNamedStyles`; + + - `Autosize`, `Background`, `CountTitle`, `FieldTitle`, `Legend`, + `NumberFormat`, `Padding`, `Projection`, `Range`, `Scale`, + `TimeFormat`, and `View` constructors have been replaced by + `AutosizeStyle`, `BackgroundStyle`, `CountTitleStyle`, + `FieldTitleStyle`, `LegendStyle`, `NUmberFormatStyle`, + `PaddingStyle`, `ProjectionStyle`, `RangeStyle`, `ScaleStyle`, + `TimeFormatStyle`, `ViewStyle` respectively. + ## 0.5.0.0 Update to version 4.0 of the Vega-Lite specification (tested against diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # hvega +[![vega-lite version](https://img.shields.io/badge/Vega--Lite-v4.5-purple.svg)](https://vega.github.io/vega-lite/) + Create [Vega-Lite](https://vega.github.io/vega-lite/) visualizations in -Haskell. It targets version 4 of the Vega-Lite specification. Note that +Haskell. It targets version 4.5 of the Vega-Lite specification. Note that the module does not include a viewer for these visualizations (which are JSON files), but does provide several helper functions, such as [toHtmlFile](https://hackage.haskell.org/package/hvega/docs/Graphics-Vega-VegaLite.html#v:toHtmlFile), diff --git a/hvega.cabal b/hvega.cabal --- a/hvega.cabal +++ b/hvega.cabal @@ -1,5 +1,5 @@ name: hvega -version: 0.5.0.0 +version: 0.6.0.0 synopsis: Create Vega-Lite visualizations (version 4) in Haskell. description: This is based on the elm-vegalite package () @@ -174,6 +174,7 @@ ConditionalTests ConfigTests DataTests + EncodingTests FillStrokeTests GeoTests HyperlinkTests @@ -190,6 +191,7 @@ TimeTests TooltipTests TrailTests + TransformTests ViewCompositionTests WindowTransformTests Gallery.Advanced diff --git a/hvega.nix b/hvega.nix --- a/hvega.nix +++ b/hvega.nix @@ -3,7 +3,7 @@ }: mkDerivation { pname = "hvega"; - version = "0.5.0.0"; + version = "0.6.0.0"; src = ./.; isLibrary = true; isExecutable = true; diff --git a/src/Graphics/Vega/Tutorials/VegaLite.hs b/src/Graphics/Vega/Tutorials/VegaLite.hs --- a/src/Graphics/Vega/Tutorials/VegaLite.hs +++ b/src/Graphics/Vega/Tutorials/VegaLite.hs @@ -521,7 +521,7 @@ -- Vega-Embed PNG and SVG output, is white (in Vega-Lite version 4; -- prior to this it was transparent). In many cases this is -- perfectly fine, but an explicit color can be specified using the --- 'Background' configuration option, as shown here, or with the +-- 'BackgroundStyle' configuration option, as shown here, or with the -- 'background' function, which is used in the choropleth examples -- below ('choroplethLookupToGeo'). @@ -543,7 +543,7 @@ . position X [ PName \"plx\", PmType Quantitative ] conf = 'configure' - . 'configuration' ('Background' "rgba(0, 0, 0, 0.1)") + . 'configuration' ('BackgroundStyle' "rgba(0, 0, 0, 0.1)") in toVegaLite [ dataFromUrl \"https:\/\/raw.githubusercontent.com\/DougBurke\/hvega\/master\/hvega\/data\/gaia-aa-616-a10-table1a.no-header.tsv\" [TSV] @@ -557,7 +557,7 @@ and earlier), you would use @ -'configuration' ('Background' "rgba(0, 0, 0, 0)") +'configuration' ('BackgroundStyle' "rgba(0, 0, 0, 0)") @ -} @@ -567,7 +567,7 @@ [ dataFromUrl "https://raw.githubusercontent.com/DougBurke/hvega/master/hvega/data/gaia-aa-616-a10-table1a.no-header.tsv" [TSV] , mark Tick [] , encoding (position X [ PName "plx", PmType Quantitative ] []) - , configure (configuration (Background "rgba(0, 0, 0, 0.1)") []) + , configure (configuration (BackgroundStyle "rgba(0, 0, 0, 0.1)") []) ] @@ -2409,7 +2409,7 @@ labelSpec = asSpec [ labelEnc [], mark 'Text' [ 'MdY' (-6) ] ] cfg = configure - . configuration ('View' ['ViewStroke' Nothing]) + . configuration ('ViewStyle' ['ViewNoStroke']) in toVegaLite [ width 300 , height 250 @@ -2467,7 +2467,7 @@ labelSpec = asSpec [ labelEnc [], mark Text [ MdY (-6) ] ] cfg = configure - . configuration (View [ViewStroke Nothing]) + . configuration (ViewStyle [ViewNoStroke]) in toVegaLite [ width 300 , height 250 @@ -2897,7 +2897,7 @@ s2 = rSpec 0 \"12\" s3 = rSpec 120 \"4\" - setup = configure . configuration (View [ ViewStroke Nothing ]) + setup = configure . configuration (ViewStyle [ ViewNoStroke ]) in toVegaLite [ setup [] , gaiaData @@ -2979,7 +2979,7 @@ s2 = rSpec 0 "12" s3 = rSpec 120 "4" - setup = configure . configuration (View [ ViewStroke Nothing ]) + setup = configure . configuration (ViewStyle [ ViewNoStroke ]) in toVegaLite [ setup [] , gaiaData @@ -3671,7 +3671,7 @@ ] conf = configure - . configuration (Background "beige") + . configuration (BackgroundStyle "beige") in toVegaLite (conf [] : sel [] : @@ -3705,7 +3705,7 @@ ] conf = configure - . configuration (Background "beige") + . configuration (BackgroundStyle "beige") in toVegaLite (conf [] : sel [] : @@ -5025,7 +5025,7 @@ , vConcat allSpecs -- remove the "other" axis (e.g. top of Y, right for X) , configure - . configuration (View [ ViewStroke (Just \"transparent\") ]) + . configuration (ViewStyle [ 'ViewStroke' \"transparent\" ]) $ [] , title \"Gaia data from arXiv:1804.09378\" [ 'TAnchor' 'AMiddle' ] ] @@ -5199,7 +5199,7 @@ , vConcat allSpecs -- remove the "other" axis (e.g. top of Y, right for X) , configure - . configuration (View [ ViewStroke (Just "transparent") ]) + . configuration (ViewStyle [ ViewStroke "transparent" ]) $ [] , title "Gaia data from arXiv:1804.09378" [ TAnchor AMiddle ] ] @@ -5739,10 +5739,10 @@ aitoffConfig :: [ConfigureSpec] -> PropertySpec aitoffConfig = configure - . configuration (View [ ViewStroke Nothing ]) - . configuration (FacetStyle [ FSpacing 0 ]) + . configuration (ViewStyle [ ViewNoStroke ]) + . configuration (FacetStyle [ CompSpacing 0 ]) . configuration (HeaderStyle [ HLabelAngle 0 ]) - . configuration (Legend [ LeOrient LOBottom, LeNoTitle ]) + . configuration (LegendStyle [ LeOrient LOBottom, LeNoTitle ]) . configuration (Axis [ Domain False , Grid False , Labels False @@ -5840,10 +5840,10 @@ -- aitoffConfig :: ['ConfigureSpec'] -> 'PropertySpec' -- aitoffConfig = -- configure --- . configuration (View [ ViewStroke Nothing ]) --- . configuration ('FacetStyle' [ 'FSpacing' 0 ]) +-- . configuration (ViewStyle [ ViewNoStroke ]) +-- . configuration ('FacetStyle' [ 'CompSpacing' 0 ]) -- . configuration ('HeaderStyle' [ 'HLabelAngle' 0 ]) --- . configuration ('Legend' [ 'LeOrient' LOBottom, 'LeNoTitle' ]) +-- . configuration ('LegendStyle' [ 'LeOrient' LOBottom, 'LeNoTitle' ]) -- . configuration ('Axis' [ 'Domain' False -- , 'Grid' False -- , 'Labels' False diff --git a/src/Graphics/Vega/VegaLite.hs b/src/Graphics/Vega/VegaLite.hs --- a/src/Graphics/Vega/VegaLite.hs +++ b/src/Graphics/Vega/VegaLite.hs @@ -134,6 +134,7 @@ , VL.GradientStops , VL.Opacity , VL.SelectionLabel + , VL.StyleLabel , VL.VegaExpr , VL.ZIndex , VL.toHtml @@ -400,15 +401,16 @@ -- -- $markprops - , VL.size , VL.color , VL.fill - , VL.stroke - , VL.strokeWidth - , VL.opacity , VL.fillOpacity - , VL.strokeOpacity + , VL.opacity , VL.shape + , VL.size + , VL.stroke + , VL.strokeDash + , VL.strokeOpacity + , VL.strokeWidth -- *** Mark Channel properties @@ -640,17 +642,11 @@ , VL.APosition(..) , VL.FieldTitleProperty(..) - -- ** Facet Configuration Options - -- - -- $facetconfig - - , VL.FacetConfig(..) - - -- ** Concatenated View Configuration Options + -- ** Composition Configuration Options -- - -- $concatconfig + -- $compositionconfig - , VL.ConcatConfig(..) + , VL.CompositionConfig(..) -- * General Data types -- @@ -672,6 +668,10 @@ -- -- $update + -- ** Version 0.6 + -- + -- $update0600 + -- ** Version 0.5 -- -- $update0500 @@ -1035,13 +1035,13 @@ -- See the -- [Vega-Lite view configuration documentation](https://vega.github.io/vega-lite/docs/spec.html#config). --- $facetconfig --- See the --- [Vega-Lite facet configuration documentation](https://vega.github.io/vega-lite/docs/facet.html#facet-configuration). - --- $concatconfig --- See the --- [Vega-Lite concat configuration documentation](https://vega.github.io/vega-lite/docs/concat.html#concat-configuration). +-- $compositionconfig +-- See the Vega-Lite +-- [concat](https://vega.github.io/vega-lite/docs/concat.html#concat-configuration), +-- [facet](https://vega.github.io/vega-lite/docs/facet.html#facet-configuration), +-- and +-- [repeat](https://vega.github.io/vega-lite/docs/repeat.html#repeat-configuration) +-- configuration documentation pages. -- $generaldatatypes -- In addition to more general data types like integers and string, the following types @@ -1056,6 +1056,120 @@ -- The following section describes how to update code that used -- an older version of @hvega@. +-- $update0600 +-- The @0.6.0.0@ release updates @hvega@ to support version 4.5 of +-- the Vega-Lite schema. +-- +-- __New functionality__ +-- +-- New function for use with 'VL.encoding': 'VL.strokeDash'. The 'VL.ChStrokeDash' +-- constructor has been added to the 'VL.Channel' type, and 'VL.RNumberLists' +-- (Vega-Lite 4.4) to 'VL.ScaleRange'. +-- +-- Named styles have been added for axes as well as marks. As mentioned below, +-- this involves deprecating the previous constructors for naming styles, +-- as there are now separate configuration options: 'VL.AxisNamedStyles' +-- and 'VL.MarkNamedStyles'. The 'VL.AStyle' and 'VL.AxStyle' options have been +-- added to 'VL.AxisConfig' and 'VL.AxisProperty' respectively. +-- The `VL.StyleLabel` type alias has been added to help the documentation, but +-- provides no extra type safety. +-- +-- __Breaking Change__ +-- +-- The 'VL.ConcatStyle' and 'VL.FacetStyle' constructors for +-- 'VL.ConfigurationProperty' now accept a common type, +-- 'VL.CompositionConfig', rather than having separate +-- @ConcatConfig@ and @FacetConfig@ types with the same meaning. +-- So @ConcatColumns@ and @FColumns@ have been replaced by 'VL.CompColumns', +-- and @CompSpacing@ and @FSpacing@ by 'VL.CompSpacing'. +-- +-- The 'VL.ViewFill' and 'VL.ViewStroke' constructors of 'VL.ViewConfig' +-- no longer take an optional 'VL.Color' argument. The @Nothing@ +-- case has been replaced by new constructors: 'VL.ViewNoFill' +-- and 'VL.ViewNoStroke'. +-- +-- The 'VL.VBFill' and 'VL.VBStroke' constructors of 'VL.ViewBackground' +-- no longer take an optional 'VL.Color' argument. The @Nothing@ +-- case has been replaced by new constructors: 'VL.VBNoFill' +-- and 'VL.VBNoStroke'. +-- +-- __New constructors__: +-- +-- 'VL.FacetChannel' has gained the following constructors: +-- 'VL.FAlign', 'VL.FCenter', and 'VL.FSpacing'. The last one +-- would have collided with the @FacetStyle@ option, +-- but this has fortuitously been renamed to 'VL.CompSpacing'. +-- +-- 'VL.MSymbol' has been added to 'VL.MarkChannel' which can be +-- used to make the 'VL.shape' encoding conditional on a data +-- or selection condition. +-- +-- The 'VL.TUStep' and 'VL.TUMaxBins' constructors have been added to +-- 'VL.TimeUnit' for controlling how time values are binned. +-- +-- The 'VL.MarkProperty' type has gained the 'VL.MCornerRadiusEnd' +-- constructor, which is used to draw rounded histogram bars, and +-- 'VL.MTexts' for specifying multiple text values. +-- +-- Error box and band properties (constructors in 'VL.MarkProperty') can now +-- be turned off with explicit @No@ variants: 'VL.MNoBorders', 'VL.MNoBox', +-- 'VL.MNoMedian', 'VL.MNoRule', and 'VL.MNoTicks'. These join the 'VL.MNoOutliers' +-- constructor. +-- +-- The 'VL.ScaleProperty' type has gained 'VL.SDomainMid', useful +-- for asymmetric diverging color scales, and 'VL.SReverse' from +-- Vega-Lite v4.5. The 'VL.ScaleDomain' type has gained the +-- 'VL.DUnionWith' option from Vega-Lite v4.3. The 'VL.ScaleConfig' +-- type has gained 'VL.SCXReverse' from Vega-Lite v4.5. +-- +-- Labels can now be vertically aligned to their baseline with the +-- 'VL.AlignBaseline' constructor of the 'VL.VAlign' type. +-- +-- Headers ('VL.HeaderProperty') have gained the following constructors: +-- 'VL.HLabel', 'VL.HLabelExpr', 'VL.HLabelFontStyle', 'VL.HTitleFontStyle', +-- and 'VL.HTitleLineHeight'. +-- +-- Conditional axis ('VL.ConditionalAxisProperty') has gained the following +-- constructors for features added in Vega-Lite v4.2 and v4.5: +-- 'VL.CAxLabelOffset', 'VL.CAxLabelPadding', and 'VL.CAxTickSize'. +-- +-- Cursor handling has been enhanced (to match Vega-Lite 4.1): +-- 'VL.ViewCursor' has been added to 'VL.ViewConfig' and 'VL.SMCursor' to +-- 'VL.SelectionMarkProperty'. +-- +-- The legend configuration has been updated (to match Vega-Lite 4.0) +-- with the addition of 'VL.LeSymbolLimit', 'VL.LeTickCount', 'VL.LeTitleLineHeight', +-- and 'VL.LeUnselectedOpacity' constructors. +-- +-- The axis configuration and property types ('VL.AxisConfig' and 'VL.AxisProperty') +-- have gained the Vega-Lite 4.4 'VL.LabelOffset' and 'VL.AxLabelOffset' constructors. +-- Note that version 4.4.0 of the Vega-Lite specification has these fields +-- as strings but this is fixed in version 4.5.0. +-- +-- 'VL.ConfigurationProperty' has added new constructors: +-- 'VL.AxisDiscrete' and 'VL.AxisPoint' from Vega-Lite 4.5, +-- 'VL.AxisQuantitative' and 'VL.AxisTemporal' from Vega-Lite 4.4, +-- 'VL.BoxplotStyle', 'VL.ErrorBandStyle', 'VL.ErrorBarStyle', +-- 'VL.FontStyle' (Vega-Lite 4.3), 'VL.HeaderColumnStyle', +-- 'VL.HeaderFacetStyle', 'VL.HeaderRowStyle', +-- 'VL.ImageStyle', and 'VL.RepeatStyle'. +-- +-- __Deprecated symbols__: +-- +-- 'VL.ConfigurationProperty' has seen a large number of deprecations, +-- as a number of constructors have been renamed: +-- +-- * @NamedStyle@ and @NamedStyles@ have been replaced by 'VL.MarkNamedStyles'; +-- +-- * @Autosize@, @Background@, @CountTitle@, @FieldTitle@, +-- @Legend@, @NumberFormat@, @Padding@, @Projection@, @Range@, +-- @Scale@, @TimeFormat@, and @View@ +-- constructors have been replaced by +-- 'VL.AutosizeStyle', 'VL.BackgroundStyle', 'VL.CountTitleStyle', +-- 'VL.FieldTitleStyle', 'VL.LegendStyle', 'VL.NumberFormatStyle', +-- 'VL.PaddingStyle', 'VL.ProjectionStyle', 'VL.RangeStyle', +-- 'VL.ScaleStyle', 'VL.TimeFormatStyle', and 'VL.ViewStyle' respectively. + -- $update0500 -- The @0.5.0.0@ release now creates specifications using version 4 -- of the Vega-Lite schema (version 0.4 of @hvega@ used version 3). @@ -1080,7 +1194,7 @@ -- previous versions it was transparent. If you -- need a transparent background then add the following configuration -- to the visualization: --- @'VL.configuration' ('VL.Background' \"rgba(0,0,0,0)\")@. +-- @'VL.configuration' ('VL.BackgroundStyle' \"rgba(0,0,0,0)\")@. -- -- * Tooltips are now disabled by default. To enable, either use the -- 'VL.tooltip' channel or by setting @'VL.MTooltip' 'VL.TTEncoding'@. @@ -1178,8 +1292,8 @@ -- to @'VL.configuration' ('VL.View' ['VL.ViewStep' x])@. -- -- * The @ShortTimeLabels@, @LeShortTimeLabels@, and @MShortTImeLabels@ --- constructors have been removed from `VL.AxisConfig`, `VL.LegendConfig`, --- and `VL.MarkProperty` respectively. +-- constructors have been removed from 'VL.AxisConfig', 'VL.LegendConfig', +-- and 'VL.MarkProperty' respectively. -- -- __New constructors__: -- @@ -1474,7 +1588,8 @@ -- -- The 'VL.ConfigurationProperty' type, used with 'VL.configuration', has -- gained 'VL.ConcatStyle', 'VL.FacetStyle', 'VL.GeoshapeStyle', 'VL.HeaderStyle', --- 'VL.NamedStyles', and 'VL.TrailStyle' constructors. +-- @NamedStyles@ (renamed to 'VL.MarkNamedStyles' in 0.6.0.0), +-- and 'VL.TrailStyle' constructors. -- -- The 'VL.ConcatConfig' type was added for use with the 'VL.ConcatStyle', -- and the 'VL.FacetConfig' type for the 'VL.FacetStyle' diff --git a/src/Graphics/Vega/VegaLite/Configuration.hs b/src/Graphics/Vega/VegaLite/Configuration.hs --- a/src/Graphics/Vega/VegaLite/Configuration.hs +++ b/src/Graphics/Vega/VegaLite/Configuration.hs @@ -20,8 +20,7 @@ , FieldTitleProperty(..) , ViewConfig(..) - , FacetConfig(..) - , ConcatConfig(..) + , CompositionConfig(..) , ScaleConfig(..) , RangeConfig(..) , AxisConfig(..) @@ -41,13 +40,15 @@ import Data.Aeson ((.=), object) - import Graphics.Vega.VegaLite.Core - ( schemeProperty + ( AxisProperty + , axisProperty + , schemeProperty ) import Graphics.Vega.VegaLite.Foundation ( Angle , Color + , StyleLabel , CompositionAlignment , DashStyle , DashOffset @@ -68,6 +69,7 @@ , ZIndex , HeaderProperty , ViewBackground + , Cursor , fromColor , fromDS , splitOnNewline @@ -87,6 +89,7 @@ , paddingSpec , autosizeProperty , viewBackgroundSpec + , cursorLabel ) import Graphics.Vega.VegaLite.Geometry ( ProjectionProperty @@ -127,6 +130,26 @@ Used by 'configuration'. +In @version 0.6.0.0@: + +- the @Autosize@, @Background@, @CountTitle@, @FieldTitle@, @Legend@, + @NumberFormat@, @Padding@, @Projection@, @Range@, @Scale@. + @TimeFormat@, and @View@ + constructors have been deprecated, and should be replaced by + 'AutosizeStyle', 'BackgroundStyle', 'CountTitleStyle', 'FieldTitleStyle', + 'LegendStyle', 'NumberFormatStyle', 'PaddingStyle', 'ProjectionStyle', + 'RangeStyle', 'ScaleStyle', 'TimeFormatStyle', and 'ViewStyle' + respectively. The axis configuration options have not been updated + to this system. + +- new constructors have been added: 'AxisDiscrete', 'AxisPoint', + 'AxisQuantitative', 'AxisTemporal', 'BoxplotStyle', 'ErrorBandStyle', + 'ErrorBarStyle', 'HeaderColumnStyle', 'HeaderFacetStyle', 'HeaderRowStyle', + 'ImageStyle', and 'RepeatStyle'. + +- 'ConcatStyle' and 'FacetStyle' now take a common type, 'CompositionConfig', + rather than @ConcatConfig@ and @FacetStyle@. + In @version 0.5.0.0@: - the @RemoveInvalid@ constructor was removed, as @@ -140,102 +163,217 @@ -} --- based on schema 3.3.0 #/definitions/Config --- --- TODO: --- Bar - change to BarConfig rather than MarkProperty? --- BoxplotStyle BoxPlotConfig --- Concat CompositionConfig --- ErrorBand ErrorBandCOnfig --- ErrorBar ErrorBarCOnfig --- Facet takes CompositionConfig not FacetConfig --- HeaderColumn takes HeaderConfig, just as HeaderStyle does --- HeaderFacet ditto --- HeaderRow ditto --- LineStyle takes LineConfig not MarkConfig --- TextStyle takes TextConfig not MarkConfig --- TickStyle takes TickConfig not MarkConfig --- TrailStyle takes LineConfig not MarkConfig --- +{-# DEPRECATED Autosize "Please change Autosize to AutosizeStyle" #-} +{-# DEPRECATED Background "Please change Background to BackgroundStyle" #-} +{-# DEPRECATED CountTitle "Please change CountTitle to CountTitleStyle" #-} +{-# DEPRECATED FieldTitle "Please change FieldTitle to FieldTitleStyle" #-} +{-# DEPRECATED Legend "Please change Legend to LegendStyle" #-} +{-# DEPRECATED NumberFormat "Please change NumberFormat to NumberFormatStyle" #-} +{-# DEPRECATED Padding "Please change Padding to PaddingStyle" #-} +{-# DEPRECATED Projection "Please change Projection to ProjectionStyle" #-} +{-# DEPRECATED Range "Please change Range to RangeStyle" #-} +{-# DEPRECATED Scale "Please change Scale to ScaleStyle" #-} +{-# DEPRECATED TimeFormat "Please change TimeFormat to TimeFormatStyle" #-} +{-# DEPRECATED View "Please change View to ViewStyle" #-} +{-# DEPRECATED NamedStyle "Please change Legend to MarkNamedStyles" #-} +{-# DEPRECATED NamedStyles "Please change Legend to MarkNamedStyles" #-} + data ConfigurationProperty = AreaStyle [MarkProperty] -- ^ The default appearance of area marks. - | Autosize [Autosize] + | AutosizeStyle [Autosize] -- ^ The default sizing of visualizations. + -- + -- This was renamed from @Autosize@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 | Axis [AxisConfig] -- ^ The default appearance of axes. | AxisBand [AxisConfig] -- ^ The default appearance of axes with band scaling. + -- + -- See also 'AxisDiscrete'. | AxisBottom [AxisConfig] -- ^ The default appearance of the bottom-side axes. + | AxisDiscrete [AxisConfig] + -- ^ The default appearance of axes with point or band scales. + -- + -- See also 'AxisBand' and 'AxisPoint'. + -- + -- @since 0.6.0.0 | AxisLeft [AxisConfig] -- ^ The default appearance of the left-side axes. + | AxisPoint [AxisConfig] + -- ^ The default appearance of axes with point scales. + -- + -- See also 'AxisDiscrete'. + -- + -- @since 0.6.0.0 + | AxisQuantitative [AxisConfig] + -- ^ The default appearance of quantitative axes. + -- + -- @since 0.6.0.0 | AxisRight [AxisConfig] -- ^ The default appearance of the right-side axes. + | AxisTemporal [AxisConfig] + -- ^ The default appearance of temporal axes. + -- + -- @since 0.6.0.0 | AxisTop [AxisConfig] -- ^ The default appearance of the top-side axes. | AxisX [AxisConfig] -- ^ The default appearance of the X axes. | AxisY [AxisConfig] -- ^ The default appearance of the Y axes. - | Background Color + | AxisNamedStyles [(StyleLabel, [AxisProperty])] + -- ^ Assign a set of axis styles to a label. These labels can then be referred + -- to when configuring an axis with 'Graphics.Vega.VegaLite.AxStyle' and + -- 'AStyle'. + -- + -- @since 0.6.0.0 + | BackgroundStyle Color -- ^ The default background color of visualizations. -- -- This was changed to use the @Color@ type alias in version @0.5.0.0@. + -- + -- This was renamed from @Background@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 | BarStyle [MarkProperty] -- ^ The default appearance of bar marks. + | BoxplotStyle [MarkProperty] + -- ^ The default appearance for box plots. + -- + -- @since 0.6.0.0 | CircleStyle [MarkProperty] -- ^ The default appearance of circle marks. - | ConcatStyle [ConcatConfig] + | ConcatStyle [CompositionConfig] -- ^ The default appearance of concatenated layouts. -- + -- In @0.6.0.0@ this was changed from accepting @ConcatConfig@ to + -- 'CompositionConfig'. + -- -- @since 0.4.0.0 - | CountTitle T.Text - -- ^ The default title style for count fields. - | FacetStyle [FacetConfig] + | CountTitleStyle T.Text + -- ^ The default axis and legend title for count fields. The default is + -- @"Count of Records"@. + -- + -- This was renamed from @CountTitle@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 + | ErrorBandStyle [MarkProperty] + -- ^ The default appearance for error bands. + -- + -- @since 0.6.0.0 + | ErrorBarStyle [MarkProperty] + -- ^ The default appearance for error bars. + -- + -- @since 0.6.0.0 + | FacetStyle [CompositionConfig] -- ^ The default appearance of facet layouts. -- + -- In @0.6.0.0@ this was changed from accepting @FacetConfig@ to + -- 'CompositionConfig'. + -- -- @since 0.4.0.0 - | FieldTitle FieldTitleProperty + | FieldTitleStyle FieldTitleProperty -- ^ The default title-generation style for fields. + -- + -- This was renamed from @FieldTitle@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 + | FontStyle T.Text + -- ^ The default font for all text marks, titles, and labels. + -- + -- The naming scheme used here is somewhat unfortunate, as this + -- is for the name of the font (such as @\"serif\"@ or + -- @\"Comic Sans MS\"@), not the font-style. + -- + -- @since 0.6.0.0 | GeoshapeStyle [MarkProperty] -- ^ The default appearance of geoshape marks. -- -- @since 0.4.0.0 | HeaderStyle [HeaderProperty] - -- ^ The default appearance of facet headers. + -- ^ The default appearance of all headers. -- -- @since 0.4.0.0 - | Legend [LegendConfig] + | HeaderColumnStyle [HeaderProperty] + -- ^ The default appearance for column headers. + -- + -- @since 0.6.0.0 + | HeaderFacetStyle [HeaderProperty] + -- ^ The default appearance for non-row and non-column facet headers. + -- + -- @since 0.6.0.0 + | HeaderRowStyle [HeaderProperty] + -- ^ The default appearance for row headers. + -- + -- @since 0.6.0.0 + | ImageStyle [MarkProperty] + -- ^ The default appearance for images. + -- + -- @since 0.6.0.0 + | LegendStyle [LegendConfig] -- ^ The default appearance of legends. + -- + -- This was renamed from @Legend@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 | LineStyle [MarkProperty] -- ^ The default appearance of line marks. | MarkStyle [MarkProperty] -- ^ The default mark appearance. - | NamedStyle T.Text [MarkProperty] - -- ^ The default appearance of a single named style. - | NamedStyles [(T.Text, [MarkProperty])] - -- ^ The default appearance of a list of named styles. + | MarkNamedStyles [(StyleLabel, [MarkProperty])] + -- ^ Assign a set of mark styles to a label. These labels can then be referred + -- to when configuring a mark, such as with 'TStyle'. -- - -- @since 0.4.0.0 - | NumberFormat T.Text - -- ^ The default number formatting for axis and text labels. - | Padding Padding + -- @since 0.6.0.0 + | NumberFormatStyle T.Text + -- ^ The default number formatting for axis and text labels, using + -- [D3's number format pattern](https://github.com/d3/d3-format#locale_format). + -- + -- As an example @NumberFormatStyle "s"@ will use SI units. + -- + -- This was renamed from @NumberFormat@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 + | PaddingStyle Padding -- ^ The default padding in pixels from the edge of the of visualization -- to the data rectangle. + -- + -- This was renamed from @Padding@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 | PointStyle [MarkProperty] -- ^ The default appearance of point marks. - | Projection [ProjectionProperty] + | ProjectionStyle [ProjectionProperty] -- ^ The default style of map projections. - | Range [RangeConfig] + -- + -- This was renamed from @Projection@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 + | RangeStyle [RangeConfig] -- ^ The default range properties used when scaling. + -- + -- This was renamed from @Range@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 | RectStyle [MarkProperty] -- ^ The default appearance of rectangle marks. + | RepeatStyle [CompositionConfig] + -- ^ The default appearance for the 'Graphics.Vega.VegaLite.repeat` operator. + -- + -- @since 0.6.0.0 | RuleStyle [MarkProperty] -- ^ The default appearance of rule marks. - | Scale [ScaleConfig] -- TODO: rename ScaleStyle + | ScaleStyle [ScaleConfig] -- ^ The default properties used when scaling. + -- + -- This was renamed from @Scale@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 | SelectionStyle [(Selection, [SelectionProperty])] -- ^ The default appearance of selection marks. | SquareStyle [MarkProperty] @@ -244,69 +382,170 @@ -- ^ The default appearance of text marks. | TickStyle [MarkProperty] -- ^ The default appearance of tick marks. - | TimeFormat T.Text - -- ^ The default time format for axis and legend labels. + | TimeFormatStyle T.Text + -- ^ The default time format for raw time values (without time units) + -- in text marks, legend labels, and header labels. This does /not/ + -- control the appearance of axis labels. + -- + -- The default is @\"%b %d, %Y\"@. + -- + -- This was renamed from @TimeFormat@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 | TitleStyle [TitleConfig] -- ^ The default appearance of visualization titles. | TrailStyle [MarkProperty] -- ^ The default style of trail marks. -- -- @since 0.4.0.0 + | ViewStyle [ViewConfig] + -- ^ The default properties for + -- [single view plots](https://vega.github.io/vega-lite/docs/spec.html#single). + -- + -- This was renamed from @View@ in @0.6.0.0@. + -- + -- @since 0.6.0.0 + | Autosize [Autosize] + -- ^ As of version @0.6.0.0@ this is deprecated and 'AutosizeStyle' should be used + -- instead. + | Background Color + -- ^ As of version @0.6.0.0@ this is deprecated and 'BackgroundStyle' should be used + -- instead. + | CountTitle T.Text + -- ^ As of version @0.6.0.0@ this is deprecated and 'CountTitleStyle' should be used + -- instead. + | FieldTitle FieldTitleProperty + -- ^ As of version @0.6.0.0@ this is deprecated and 'FieldTitleStyle' should be used + -- instead. + | Legend [LegendConfig] + -- ^ As of version @0.6.0.0@ this is deprecated and 'LegendStyle' should be used + -- instead. + | NumberFormat T.Text + -- ^ As of version @0.6.0.0@ this is deprecated and 'NumberFormatStyle' should be used + -- instead. + | Padding Padding + -- ^ As of version @0.6.0.0@ this is deprecated and 'PaddingStyle' should be used + -- instead. + | Projection [ProjectionProperty] + -- ^ As of version @0.6.0.0@ this is deprecated and 'ProjectionStyle' should be used + -- instead. + | Range [RangeConfig] + -- ^ As of version @0.6.0.0@ this is deprecated and 'RangeStyle' should be used + -- instead. + | Scale [ScaleConfig] + -- ^ As of version @0.6.0.0@ this is deprecated and 'ScaleStyle' should be used + -- instead. + | TimeFormat T.Text + -- ^ As of version @0.6.0.0@ this is deprecated and 'TimeFormatStyle' should be used + -- instead. | View [ViewConfig] - -- ^ The default single view style. + -- ^ As of version @0.6.0.0@ this is deprecated and 'ViewStyle' should be used + -- instead. + | NamedStyle StyleLabel [MarkProperty] + -- ^ As of version @0.6.0.0@ this is deprecated and 'MarkNamedStyles' should be + -- used instead. + | NamedStyles [(StyleLabel, [MarkProperty])] + -- ^ As of version @0.6.0.0@ this is deprecated and 'MarkNamedStyles' should be + -- used instead. + +toAxis :: T.Text -> [AxisConfig] -> LabelledSpec +toAxis lbl acs = lbl .= object (map axisConfigProperty acs) + +aprops_ :: T.Text -> [AxisProperty] -> LabelledSpec +aprops_ f mps = f .= object (map axisProperty mps) + -- easier to turn into a ConfigSpec in config than here configProperty :: ConfigurationProperty -> LabelledSpec -configProperty (Autosize aus) = "autosize" .= object (map autosizeProperty aus) -configProperty (Background bg) = "background" .= bg -configProperty (CountTitle ttl) = "countTitle" .= ttl -configProperty (ConcatStyle cps) = "concat" .= object (map concatConfigProperty cps) -configProperty (FieldTitle ftp) = "fieldTitle" .= fieldTitleLabel ftp -configProperty (NumberFormat fmt) = "numberFormat" .= fmt -configProperty (Padding pad) = "padding" .= paddingSpec pad -configProperty (TimeFormat fmt) = "timeFormat" .= fmt -configProperty (Axis acs) = "axis" .= object (map axisConfigProperty acs) -configProperty (AxisX acs) = "axisX" .= object (map axisConfigProperty acs) -configProperty (AxisY acs) = "axisY" .= object (map axisConfigProperty acs) -configProperty (AxisLeft acs) = "axisLeft" .= object (map axisConfigProperty acs) -configProperty (AxisRight acs) = "axisRight" .= object (map axisConfigProperty acs) -configProperty (AxisTop acs) = "axisTop" .= object (map axisConfigProperty acs) -configProperty (AxisBottom acs) = "axisBottom" .= object (map axisConfigProperty acs) -configProperty (AxisBand acs) = "axisBand" .= object (map axisConfigProperty acs) -configProperty (Legend lcs) = "legend" .= object (map legendConfigProperty lcs) -configProperty (MarkStyle mps) = mprops_ "mark" mps -configProperty (Projection pps) = "projection" .= object (map projectionProperty pps) configProperty (AreaStyle mps) = mprops_ "area" mps +configProperty (AutosizeStyle aus) = "autosize" .= object (map autosizeProperty aus) +configProperty (Axis acs) = toAxis "axis" acs +configProperty (AxisBand acs) = toAxis "axisBand" acs +configProperty (AxisBottom acs) = toAxis "axisBottom" acs +configProperty (AxisDiscrete acs) = toAxis "axisDiscrete" acs +configProperty (AxisLeft acs) = toAxis "axisLeft" acs +configProperty (AxisPoint acs) = toAxis "axisPoint" acs +configProperty (AxisQuantitative acs) = toAxis "axisQuantitative" acs +configProperty (AxisRight acs) = toAxis "axisRight" acs +configProperty (AxisTemporal acs) = toAxis "axisTemporal" acs +configProperty (AxisTop acs) = toAxis "axisTop" acs +configProperty (AxisX acs) = toAxis "axisX" acs +configProperty (AxisY acs) = toAxis "axisY" acs + +-- configProperty (AxisNamedStyles [(nme, mps)]) = "style" .= object [aprops_ nme mps] +configProperty (AxisNamedStyles styles) = + let toStyle = uncurry aprops_ + in "style" .= object (map toStyle styles) + +configProperty (BackgroundStyle bg) = "background" .= bg configProperty (BarStyle mps) = mprops_ "bar" mps +configProperty (BoxplotStyle mps) = mprops_ "boxplot" mps configProperty (CircleStyle mps) = mprops_ "circle" mps -configProperty (FacetStyle fps) = "facet" .= object (map facetConfigProperty fps) +configProperty (ConcatStyle cps) = "concat" .= object (map compConfigProperty cps) +configProperty (CountTitleStyle ttl) = "countTitle" .= ttl +configProperty (ErrorBandStyle mps) = mprops_ "errorband" mps +configProperty (ErrorBarStyle mps) = mprops_ "errorbar" mps +configProperty (FacetStyle cps) = "facet" .= object (map compConfigProperty cps) +configProperty (FieldTitleStyle ftp) = "fieldTitle" .= fieldTitleLabel ftp +configProperty (FontStyle font) = "font" .= font configProperty (GeoshapeStyle mps) = mprops_ "geoshape" mps -configProperty (HeaderStyle hps) = header_ hps +configProperty (HeaderStyle hps) = header_ "" hps +configProperty (HeaderColumnStyle hps) = header_ "Column" hps +configProperty (HeaderFacetStyle hps) = header_ "Facet" hps +configProperty (HeaderRowStyle hps) = header_ "Row" hps +configProperty (ImageStyle mps) = mprops_ "image" mps +configProperty (LegendStyle lcs) = "legend" .= object (map legendConfigProperty lcs) configProperty (LineStyle mps) = mprops_ "line" mps + +configProperty (MarkStyle mps) = mprops_ "mark" mps +-- configProperty (MarkNamedStyles [(nme, mps)]) = "style" .= object [mprops_ nme mps] +configProperty (MarkNamedStyles styles) = + let toStyle = uncurry mprops_ + in "style" .= object (map toStyle styles) + +configProperty (NumberFormatStyle fmt) = "numberFormat" .= fmt +configProperty (PaddingStyle pad) = "padding" .= paddingSpec pad configProperty (PointStyle mps) = mprops_ "point" mps +configProperty (ProjectionStyle pps) = "projection" .= object (map projectionProperty pps) +configProperty (RangeStyle rcs) = "range" .= object (map rangeConfigProperty rcs) configProperty (RectStyle mps) = mprops_ "rect" mps +configProperty (RepeatStyle cps) = "repeat" .= object (map compConfigProperty cps) configProperty (RuleStyle mps) = mprops_ "rule" mps +configProperty (ScaleStyle scs) = scaleConfig_ scs +configProperty (SelectionStyle selConfig) = + let selProp (sel, sps) = selectionLabel sel .= object (concatMap selectionProperties sps) + in "selection" .= object (map selProp selConfig) configProperty (SquareStyle mps) = mprops_ "square" mps configProperty (TextStyle mps) = mprops_ "text" mps configProperty (TickStyle mps) = mprops_ "tick" mps +configProperty (TimeFormatStyle fmt) = "timeFormat" .= fmt configProperty (TitleStyle tcs) = "title" .= object (map titleConfigSpec tcs) +configProperty (TrailStyle mps) = mprops_ "trail" mps +configProperty (ViewStyle vcs) = "view" .= object (concatMap viewConfigProperties vcs) + +-- deprecated aliases +configProperty (Autosize aus) = "autosize" .= object (map autosizeProperty aus) +configProperty (Background bg) = "background" .= bg +configProperty (CountTitle ttl) = "countTitle" .= ttl +configProperty (FieldTitle ftp) = "fieldTitle" .= fieldTitleLabel ftp +configProperty (Legend lcs) = "legend" .= object (map legendConfigProperty lcs) +configProperty (NumberFormat fmt) = "numberFormat" .= fmt +configProperty (Padding pad) = "padding" .= paddingSpec pad +configProperty (Projection pps) = "projection" .= object (map projectionProperty pps) +configProperty (Range rcs) = "range" .= object (map rangeConfigProperty rcs) +configProperty (Scale scs) = scaleConfig_ scs +configProperty (TimeFormat fmt) = "timeFormat" .= fmt +configProperty (View vcs) = "view" .= object (concatMap viewConfigProperties vcs) + configProperty (NamedStyle nme mps) = "style" .= object [mprops_ nme mps] configProperty (NamedStyles styles) = let toStyle = uncurry mprops_ in "style" .= object (map toStyle styles) -configProperty (Scale scs) = scaleConfig_ scs -configProperty (Range rcs) = "range" .= object (map rangeConfigProperty rcs) -configProperty (SelectionStyle selConfig) = - let selProp (sel, sps) = selectionLabel sel .= object (concatMap selectionProperties sps) - in "selection" .= object (map selProp selConfig) -configProperty (TrailStyle mps) = mprops_ "trail" mps -configProperty (View vcs) = "view" .= object (concatMap viewConfigProperties vcs) - {-| -Scale configuration property. These are used to configure all scales. -For more details see the +Scale configuration property. These are used to configure all scales +with 'ScaleStyle'. For more details see the . Version @0.5.0.0@ removed the @SCRangeStep@ and @SCTextXRangeStep@ @@ -369,7 +608,10 @@ -- for snapping to the pixel grid. | SCUseUnaggregatedDomain Bool -- ^ Whether or not to use the source data range before aggregation. - + | SCXReverse Bool + -- ^ Reverse the X scale (useful for right-to-left charts). + -- + -- @since 0.6.0.0 scaleConfig_ :: [ScaleConfig] -> LabelledSpec -- scaleConfig_ [] = "scale" .= A.Null -- not sure here @@ -395,10 +637,16 @@ {-| -Legend configuration options, set with the 'Legend' constructor. +Legend configuration options, set with the 'LegendStyle' constructor. For more detail see the . +In @0.6.0.0@ the following constructors were added (all from Vega-Lite 4.0): +'LeSymbolLimit', 'LeTickCount', 'LeTitleLineHeight', and +'LeUnselectedOpacity'. + +In @0.5.0.0@ the @LeShortTimeLabels@ constructor was removed (Vega-Lite 4.0). + This data type has seen significant changes in the @0.4.0.0@ release: - the @EntryPadding@, @GradientHeight@, @GradientLabelBaseline@, @GradientWidth@ @@ -411,8 +659,6 @@ - and new constructors were added. -In @0.5.0.0@ the @LeShortTimeLabels@ constructor was removed. - -} -- based on schema 3.3.0 #/definitions/LegendConfig @@ -575,6 +821,11 @@ -- ^ The color of the legend symbol. -- -- @since 0.4.0.0 + | LeSymbolLimit Int -- it may be that negative entries allow you to say "drop last 2" + -- ^ The maximum number of allowed entries for a symbol legend. Any additional entries + -- will be dropped. + -- + -- @since 0.6.0.0 | LeSymbolOffset Double -- ^ The horizontal pixel offset for legend symbols. -- @@ -593,6 +844,10 @@ -- ^ The width of the symbol's stroke. | LeSymbolType Symbol -- ^ The default shape type for legend symbols. + | LeTickCount Int + -- ^ The desired number of tick values for quantitative legends + -- + -- @since0.6.0.0 | LeTitle T.Text -- ^ The legend title. -- @@ -623,6 +878,10 @@ -- ^ The font weight of the legend title. | LeTitleLimit Double -- ^ The maxmimum pixel width of the legend title. + | LeTitleLineHeight Double + -- ^ The line height, in pixels, for multi-line title text. + -- + -- @since 0.6.0.0 | LeTitleOpacity Opacity -- ^ The opacity of the legend title. -- @@ -633,7 +892,12 @@ -- @since 0.4.0.0 | LeTitlePadding Double -- ^ The padding, in pixels, between title and legend. - + | LeUnselectedOpacity Opacity + -- ^ The opacity of unselected legend entries. + -- + -- The default is 0.35. + -- + -- @since 0.6.0.0 legendConfigProperty :: LegendConfig -> LabelledSpec legendConfigProperty (LeClipHeight x) = "clipHeight" .= x @@ -683,12 +947,14 @@ legendConfigProperty (LeSymbolDashOffset x) = "symbolDashOffset" .= x legendConfigProperty (LeSymbolDirection o) = "symbolDirection" .= orientationSpec o legendConfigProperty (LeSymbolFillColor s) = "symbolFillColor" .= fromColor s +legendConfigProperty (LeSymbolLimit n) = "symbolLimit" .= n legendConfigProperty (LeSymbolOffset x) = "symbolOffset" .= x legendConfigProperty (LeSymbolOpacity x) = "symbolOpacity" .= x legendConfigProperty (LeSymbolSize x) = "symbolSize" .= x legendConfigProperty (LeSymbolStrokeColor s) = "symbolStrokeColor" .= fromColor s legendConfigProperty (LeSymbolStrokeWidth x) = "symbolStrokeWidth" .= x legendConfigProperty (LeSymbolType s) = "symbolType" .= symbolLabel s +legendConfigProperty (LeTickCount n) = "tickCount" .= n legendConfigProperty (LeTitle s) = "title" .= s legendConfigProperty LeNoTitle = "title" .= A.Null legendConfigProperty (LeTitleAlign ha) = "titleAlign" .= hAlignLabel ha @@ -700,9 +966,11 @@ legendConfigProperty (LeTitleFontStyle s) = "titleFontStyle" .= s legendConfigProperty (LeTitleFontWeight fw) = "titleFontWeight" .= fontWeightSpec fw legendConfigProperty (LeTitleLimit x) = "titleLimit" .= x +legendConfigProperty (LeTitleLineHeight x) = "titleLineHeight" .= x legendConfigProperty (LeTitleOpacity x) = "titleOpacity" .= x legendConfigProperty (LeTitleOrient orient) = "titleOrient" .= sideLabel orient legendConfigProperty (LeTitlePadding x) = "titlePadding" .= x +legendConfigProperty (LeUnselectedOpacity x) = "unselectedOpacity" .= x {-| @@ -754,15 +1022,21 @@ scaleConfigProperty (SCPointPadding x) = "pointPadding" .= x scaleConfigProperty (SCRound b) = "round" .= b scaleConfigProperty (SCUseUnaggregatedDomain b) = "useUnaggregatedDomain" .= b +scaleConfigProperty (SCXReverse b) = "xReverse" .= b {-| View configuration property. These are used to configure the style of a single -view within a visualization such as its size and default fill and stroke colors. +view within a visualization (via 'ViewStyle') such as its size and default fill and stroke colors. For further details see the . +In version @0.6.0.0@ the constructors that used to take an optional color, +namely 'ViewFill' and 'ViewStroke', were split out, so that they +now take a 'Color' argument and new constructors - 'ViewNoFill' and +'ViewNoStroke' - were added to replace the @Nothing@ versions. + In version @0.5.0.0@ the @ViewWidth@ and @ViewHeight@ constructors have been deprecated, and replaced by 'ViewContinuousWidth', 'ViewContinuousHeight', @@ -803,6 +1077,10 @@ -- The default is @0@. -- -- @since 0.4.0.0 + | ViewCursor Cursor + -- ^ The default cursor for single views. + -- + -- @since 0.6.0.0 | ViewDiscreteWidth Double -- ^ The default width of single views when the -- visualization has a discrete x field. @@ -813,10 +1091,15 @@ -- visualization has a discrete y field. -- -- @since 0.5.0.0 - | ViewFill (Maybe Color) - -- ^ The fill color. + | ViewFill Color + -- ^ The fill color. See also 'ViewNoFill'. -- - -- This was changed to use the @Color@ type alias in version @0.5.0.0@. + -- This was changed to use the @Color@ type alias in version @0.5.0.0@ + -- and removed the @Maybe@ type in version @0.6.0.0@. + | ViewNoFill + -- ^ Do not use a fill. See also 'ViewFill'. + -- + -- @since 0.6.0.0 | ViewFillOpacity Opacity -- ^ The fill opacity. | ViewOpacity Opacity @@ -834,10 +1117,15 @@ -- 'ScaleConfig'. -- -- @since 0.5.0.0 - | ViewStroke (Maybe Color) - -- ^ The stroke color. + | ViewStroke Color + -- ^ The stroke color. See also 'ViewNoStroke'. -- - -- This was changed to use the @Color@ type alias in version @0.5.0.0@. + -- This was changed to use the @Color@ type alias in version @0.5.0.0@ + -- and removed the @Maybe@ type in version @0.6.0.0@. + | ViewNoStroke + -- ^ Do not use a stroke color. See also 'ViewStroke'. + -- + -- @since 0.6.0.0 | ViewStrokeCap StrokeCap -- ^ The stroke cap for line-ending style. -- @@ -874,13 +1162,16 @@ viewConfigProperties (ViewContinuousWidth x) = ["continuousWidth" .= x] viewConfigProperties (ViewContinuousHeight x) = ["continuousHeight" .= x] viewConfigProperties (ViewCornerRadius x) = ["cornerRadius" .= x] +viewConfigProperties (ViewCursor c) = ["cursor" .= cursorLabel c] viewConfigProperties (ViewDiscreteWidth x) = ["discreteWidth" .= x] viewConfigProperties (ViewDiscreteHeight x) = ["discreteHeight" .= x] -viewConfigProperties (ViewFill ms) = ["fill" .= maybe A.Null fromColor ms] +viewConfigProperties (ViewFill ms) = ["fill" .= fromColor ms] +viewConfigProperties ViewNoFill = ["fill" .= A.Null] viewConfigProperties (ViewFillOpacity x) = ["fillOpacity" .= x] viewConfigProperties (ViewOpacity x) = ["opacity" .= x] viewConfigProperties (ViewStep x) = ["step" .= x] -viewConfigProperties (ViewStroke ms) = ["stroke" .= maybe A.Null fromColor ms] +viewConfigProperties (ViewStroke ms) = ["stroke" .= fromColor ms] +viewConfigProperties ViewNoStroke = ["stroke" .= A.Null] viewConfigProperties (ViewStrokeCap sc) = ["strokeCap" .= strokeCapLabel sc] viewConfigProperties (ViewStrokeDash xs) = ["strokeDash" .= fromDS xs] viewConfigProperties (ViewStrokeDashOffset x) = ["strokeDashOffset" .= x] @@ -898,14 +1189,19 @@ This is used by 'ConfigurationProperty'. +In @0.5.0.0@ the @ShortTimeLabels@ constructor was removed. + The @TitleMaxLength@ constructor was removed in release @0.4.0.0@. The @TitleLimit@ constructor should be used instead. -In @0.5.0.0@ the @ShortTimeLabels@ constructor was removed. - -} data AxisConfig - = BandPosition Double + = AStyle [StyleLabel] + -- ^ The named styles - generated with 'AxisNamedStyles' - to apply to the + -- axis or axes. + -- + -- @since 0.6.0.0 + | BandPosition Double -- ^ The default axis band position. | Domain Bool -- ^ Should the axis domain be displayed? @@ -1015,6 +1311,10 @@ -- @since 0.4.0.0 | LabelLimit Double -- ^ The maximum width of a label, in pixels. + | LabelOffset Double + -- ^ The pixel offset for labels, in addition to 'TickOffset'. + -- + -- @since 0.6.0.0 | LabelOpacity Opacity -- ^ The opacity of the label. -- @@ -1067,6 +1367,8 @@ | TickOffset Double -- ^ The position offset, in pixels, to apply to ticks, labels, and grid lines. -- + -- See also 'LabelOffset'. + -- -- @since 0.4.0.0 | TickOpacity Opacity -- ^ The opacity of the ticks. @@ -1125,6 +1427,9 @@ axisConfigProperty :: AxisConfig -> LabelledSpec +axisConfigProperty (AStyle [s]) = "style" .= s +axisConfigProperty (AStyle s) = "style" .= s + axisConfigProperty (BandPosition x) = "bandPosition" .= x axisConfigProperty (Domain b) = "domain" .= b axisConfigProperty (DomainColor c) = "domainColor" .= fromColor c @@ -1154,6 +1459,7 @@ axisConfigProperty (LabelFontStyle s) = "labelFontStyle" .= s axisConfigProperty (LabelFontWeight fw) = "labelFontWeight" .= fontWeightSpec fw axisConfigProperty (LabelLimit x) = "labelLimit" .= x +axisConfigProperty (LabelOffset x) = "labelOffset" .= x axisConfigProperty (LabelOpacity x) = "labelOpacity" .= x axisConfigProperty (LabelOverlap strat) = "labelOverlap" .= overlapStrategyLabel strat axisConfigProperty (LabelPadding pad) = "labelPadding" .= pad @@ -1191,28 +1497,7 @@ axisConfigProperty (TitleY x) = "titleY" .= x axisConfigProperty (TranslateOffset x) = "translate" .= x -{-| -Configuration options for faceted views, used with 'Graphics.Vega.VegaLite.FacetStyle'. - -See the -. - -@since 0.4.0.0 - --} -data FacetConfig - = FColumns Int - -- ^ The maximum number of columns to use in a faceted-flow layout. - | FSpacing Double - -- ^ The spacing in pixels between sub-views in a faceted composition. - - -facetConfigProperty :: FacetConfig -> LabelledSpec -facetConfigProperty (FColumns n) = "columns" .= n -facetConfigProperty (FSpacing x) = "spacing" .= x - - -- | Specifies how the title anchor is positioned relative to the frame. -- -- @since 0.4.0.0 @@ -1291,9 +1576,9 @@ -- ^ Default offset, in pixels, of titles relative to the chart body. | TOrient Side -- ^ Default placement of titles relative to the chart body. - | TStyle [T.Text] + | TStyle [StyleLabel] -- ^ A list of named styles to apply. A named style can be specified - -- via 'Graphics.Vega.VegaLite.NamedStyle' or 'Graphics.Vega.VegaLite.NamedStyles'. Later styles in the list will + -- via 'Graphics.Vega.VegaLite.MarkNamedStyles'. Later styles in the list will -- override earlier ones if there is a conflict in any of the -- properties. -- @@ -1358,7 +1643,7 @@ titleConfigSpec (TLineHeight x) = "lineHeight" .= x titleConfigSpec (TOffset x) = "offset" .= x titleConfigSpec (TOrient sd) = "orient" .= sideLabel sd -titleConfigSpec (TStyle [style]) = "style" .= style -- not really needed +titleConfigSpec (TStyle [style]) = "style" .= style -- minor simplification titleConfigSpec (TStyle styles) = "style" .= styles titleConfigSpec (TSubtitle s) = "subtitle" .= splitOnNewline s titleConfigSpec (TSubtitleColor s) = "subtitleColor" .= fromColor s @@ -1373,21 +1658,31 @@ {-| -Configuration options for concatenated views, used with 'Graphics.Vega.VegaLite.ConcatStyle'. +Configuration options for composition views, used with +'ConcatStyle', 'FacetStyle', and 'RepeatStyle'. -@since 0.4.0.0 +Prior to @0.6.0.0@ this information was made available in +two types - @ConcatConfig@ and @FacetConfig@ - which had +the same meaning. +@since 0.6.0.0 + -} -data ConcatConfig - = ConcatColumns Int - -- ^ The maximum number of columns to use in a concatenated flow layout. - | ConcatSpacing Double - -- ^ The spacing in pixels between sub-views in a concatenated view. +data CompositionConfig + = CompColumns Int + -- ^ The number of columns to use. The default is to use a single + -- row (an infinite number of columns). + -- + -- Prior to @0.6.0.0@ this was either @ConcatColumns@ or @FColumns@. + | CompSpacing Double + -- ^ The spacing in pixels between sub-views. The default is 20. + -- + -- Prior to @0.6.0.0@ this was either @ConcatSpacing@ or @FSpacing@. -concatConfigProperty :: ConcatConfig -> LabelledSpec -concatConfigProperty (ConcatColumns n) = "columns" .= n -concatConfigProperty (ConcatSpacing x) = "spacing" .= x +compConfigProperty :: CompositionConfig -> LabelledSpec +compConfigProperty (CompColumns n) = "columns" .= n +compConfigProperty (CompSpacing x) = "spacing" .= x {-| diff --git a/src/Graphics/Vega/VegaLite/Core.hs b/src/Graphics/Vega/VegaLite/Core.hs --- a/src/Graphics/Vega/VegaLite/Core.hs +++ b/src/Graphics/Vega/VegaLite/Core.hs @@ -80,15 +80,16 @@ , AxisProperty(..) , ConditionalAxisProperty(..) - , size , color , fill - , stroke - , strokeWidth - , opacity , fillOpacity - , strokeOpacity + , opacity , shape + , size + , stroke + , strokeDash + , strokeOpacity + , strokeWidth , MarkChannel(..) @@ -158,9 +159,10 @@ , configure -- not for external export - , schemeProperty , autosizeProperty + , axisProperty , paddingSpec + , schemeProperty ) where @@ -194,6 +196,7 @@ , DashOffset , FieldName , Opacity + , StyleLabel , VegaExpr , ZIndex , FontWeight @@ -219,6 +222,7 @@ , CInterpolate , ViewBackground , HeaderProperty + , Symbol , fromT , fromColor , fromDS @@ -249,6 +253,7 @@ , repeatFieldsProperty , cInterpolateSpec , viewBackgroundSpec + , symbolLabel ) import Graphics.Vega.VegaLite.Input ( Data @@ -287,9 +292,8 @@ import Graphics.Vega.VegaLite.Time ( DateTime , TimeUnit - , timeUnit_ , dateTimeProperty - , timeUnitLabel + , timeUnitSpec ) import Graphics.Vega.VegaLite.Transform ( Operation(Count) @@ -335,6 +339,9 @@ mtype_ :: Measurement -> LabelledSpec mtype_ m = "type" .= measurementLabel m +timeUnit_ :: TimeUnit -> LabelledSpec +timeUnit_ tu = "timeUnit" .= timeUnitSpec tu + -- The assumption at the moment is that it's always correct to -- replace the empty list by null. -- @@ -530,6 +537,21 @@ -- ^ Literal string value when encoding with a mark property channel. | MBoolean Bool -- ^ Boolean value when encoding with a mark property channel. + | MSymbol Symbol + -- ^ A symbol literal. This can be useful when making a symbol dependent on some data or + -- selection condition (e.g. 'MDataCondition' or 'MSelectionCondition'). + -- + -- For example: + -- + -- @ + -- 'encoding' + -- . 'position' 'Graphics.Vega.VegaLite.X' [ 'PName' "to", 'PmType' 'Graphics.Vega.VegaLite.Quantitative', 'PAxis' [] ] + -- . 'shape' ['MDataCondition' + -- [('Expr' "datum.to > 100", [MSymbol 'Graphics.Vega.VegaLite.SymTriangleRight'])] + -- [MSymbol 'Graphics.Vega.VegaLite.SymTriangleLeft'] + -- @ + -- + -- @since 0.6.0.0 markChannelProperty :: MarkChannel -> [LabelledSpec] markChannelProperty (MName s) = [field_ s] @@ -550,6 +572,7 @@ markChannelProperty (MNumber x) = ["value" .= x] markChannelProperty (MString s) = ["value" .= s] markChannelProperty (MBoolean b) = ["value" .= b] +markChannelProperty (MSymbol s) = ["value" .= symbolLabel s] markChannelProperty (MTitle s) = ["title" .= splitOnNewline s] markChannelProperty MNoTitle = ["title" .= A.Null] @@ -573,7 +596,7 @@ The supported encodings are: 'color', 'column', 'detail', 'fill', 'fillOpacity', 'hyperlink', 'opacity', 'order', 'position', 'row', 'shape', 'size', -'stroke', 'strokeOpacity', 'strokeWidth', 'text', 'tooltip', +'stroke', 'strokeDash', 'strokeOpacity', 'strokeWidth', 'text', 'tooltip', 'tooltips', and 'url'. There is currently no support for encoding by @@ -700,6 +723,10 @@ -- @since 0.4.0.0 | SDomain ScaleDomain -- ^ Custom scaling domain. + | SDomainMid Double + -- ^ Set the mid-point of a continuous diverging domain. + -- + -- @since 0.6.0.0 | SExponent Double -- ^ The exponent to use for power scaling ('Graphics.Vega.VegaLite.ScPow'). -- @@ -716,6 +743,10 @@ -- ^ Outer padding to apply to a band scaling. | SRange ScaleRange -- ^ Range of a scaling. The type of range depends on the encoding channel. + | SReverse Bool + -- ^ Should the order of the scale range be reversed? + -- + -- @since 0.6.0.0 | SRound Bool -- ^ Are numeric values in a scaling are rounded to integers? -- @@ -745,6 +776,7 @@ scaleProperty (SClamp b) = "clamp" .= b scaleProperty (SConstant x) = "constant" .= x scaleProperty (SDomain sdType) = "domain" .= scaleDomainSpec sdType +scaleProperty (SDomainMid x) = "domainMid" .= x scaleProperty (SExponent x) = "exponent" .= x scaleProperty (SInterpolate interp) = "interpolate" .= cInterpolateSpec interp scaleProperty (SNice ni) = "nice" .= scaleNiceSpec ni @@ -752,8 +784,10 @@ scaleProperty (SPaddingInner x) = "paddingInner" .= x scaleProperty (SPaddingOuter x) = "paddingOuter" .= x scaleProperty (SRange (RNumbers xs)) = "range" .= xs +scaleProperty (SRange (RNumberLists xss)) = "range" .= xss scaleProperty (SRange (RStrings ss)) = "range" .= ss scaleProperty (SRange (RName s)) = "range" .= s +scaleProperty (SReverse b) = "reverse" .= b scaleProperty (SRound b) = "round" .= b scaleProperty (SScheme nme extent) = schemeProperty nme extent scaleProperty (SZero b) = "zero" .= b @@ -1279,6 +1313,10 @@ -- ^ The maximum width of a label, in pixels. -- -- @since 0.4.0.0 + | AxLabelOffset Double + -- ^ The pixel offset for labels, in addition to 'AxTickOffset'. + -- + -- @since 0.6.0.0 | AxLabelOpacity Opacity -- ^ The opacity of the label. -- @@ -1306,6 +1344,11 @@ -- ^ The orientation of the axis. | AxPosition Double -- ^ The anchor position of the axis in pixels. + | AxStyle [StyleLabel] + -- ^ The named styles - generated with 'Graphics.Vega.VegaLite.AxisNamedStyles' - + -- to apply to the axis. + -- + -- @since 0.6.0.0 | AxTicks Bool -- ^ Should tick marks be drawn on an axis? | AxTickBand BandAlign @@ -1344,6 +1387,8 @@ | AxTickOffset Double -- ^ The position offset, in pixels, to apply to ticks, labels, and grid lines. -- + -- See also 'AxLabelOffset'. + -- -- @since 0.4.0.0 | AxTickOpacity Opacity -- ^ The opacity of the ticks. @@ -1451,6 +1496,9 @@ axisProperty :: AxisProperty -> LabelledSpec +axisProperty (AxStyle [s]) = "style" .= s +axisProperty (AxStyle s) = "style" .= s + axisProperty (AxBandPosition x) = "bandPosition" .= x axisProperty (AxDataCondition predicate cap) = let (ifAxProp, elseAxProp) = conditionalAxisProperty cap @@ -1493,6 +1541,7 @@ axisProperty (AxLabelFontStyle s) = "labelFontStyle" .= s axisProperty (AxLabelFontWeight fw) = "labelFontWeight" .= fontWeightSpec fw axisProperty (AxLabelLimit x) = "labelLimit" .= x +axisProperty (AxLabelOffset x) = "labelOffset" .= x axisProperty (AxLabelOpacity x) = "labelOpacity" .= x axisProperty (AxLabelOverlap s) = "labelOverlap" .= overlapStrategyLabel s axisProperty (AxLabelPadding x) = "labelPadding" .= x @@ -1544,17 +1593,12 @@ which can be conditioned on their position (or label). The constuctor determines the axis property (a label, tick, or -grid element), the second is the value to set if the condition -is 'True', and the third is the value for when it is 'False'. +grid element), and the two arguments are the value to set if the condition +is 'True' (first), and for when it is 'False' (second). @since 0.5.0.0 -} --- The 4.0.2 Vega Lite spec does not correctly map the conditional --- label align, so that CAxLabelAlign will generate an invalid JSON --- file. This has been fixed (presumably for 4.0.3); see --- https://github.com/vega/vega-lite/issues/5717 - data ConditionalAxisProperty = CAxGridColor Color Color -- ^ The color for the axis grid. @@ -1580,8 +1624,16 @@ -- ^ Axis label font style. | CAxLabelFontWeight FontWeight FontWeight -- ^ Axis label font weight. + | CAxLabelOffset Double Double + -- ^ Axis label offset. + -- + -- @since 0.6.0.0 | CAxLabelOpacity Opacity Opacity -- ^ Axis label opacity. + | CAxLabelPadding Double Double + -- ^ Axis label padding. + -- + -- @since 0.6.0.0 | CAxTickColor T.Text T.Text -- ^ Tick color for the axis. | CAxTickDash DashStyle DashStyle @@ -1590,8 +1642,12 @@ -- ^ The offset for the dash pattern. | CAxTickOpacity Opacity Opacity -- ^ Opacity of the axis tick marks. + | CAxTickSize Double Double + -- ^ Size, in pixels, of the axis tick marks. + -- + -- @since 0.6.0.0 | CAxTickWidth Double Double - -- ^ Width of the axis tick marks. + -- ^ Width, in pixels, of the axis tick marks. conditionalAxisProperty :: ConditionalAxisProperty -> (AxisProperty, AxisProperty) @@ -1607,11 +1663,14 @@ conditionalAxisProperty (CAxLabelFontSize t f) = (AxLabelFontSize t, AxLabelFontSize f) conditionalAxisProperty (CAxLabelFontStyle t f) = (AxLabelFontStyle t, AxLabelFontStyle f) conditionalAxisProperty (CAxLabelFontWeight t f) = (AxLabelFontWeight t, AxLabelFontWeight f) +conditionalAxisProperty (CAxLabelOffset t f) = (AxLabelOffset t, AxLabelOffset f) conditionalAxisProperty (CAxLabelOpacity t f) = (AxLabelOpacity t, AxLabelOpacity f) +conditionalAxisProperty (CAxLabelPadding t f) = (AxLabelPadding t, AxLabelPadding f) conditionalAxisProperty (CAxTickColor t f) = (AxTickColor t, AxTickColor f) conditionalAxisProperty (CAxTickDash t f) = (AxTickDash t, AxTickDash f) conditionalAxisProperty (CAxTickDashOffset t f) = (AxTickDashOffset t, AxTickDashOffset f) conditionalAxisProperty (CAxTickOpacity t f) = (AxTickOpacity t, AxTickOpacity f) +conditionalAxisProperty (CAxTickSize t f) = (AxTickSize t, AxTickSize f) conditionalAxisProperty (CAxTickWidth t f) = (AxTickWidth t, AxTickWidth f) @@ -2000,7 +2059,9 @@ -} -- based on schema 3.3.0 #/definitions/FacetFieldDef +-- although it's a bit different now (maybe RowColumnEncodingFieldDef in 4.2.0) + data FacetChannel = FName FieldName -- ^ The name of the field from which to pull a data value. @@ -2008,15 +2069,32 @@ -- ^ The encoded field's type of measurement. | FAggregate Operation -- ^ Aggregation function for the field. + | FAlign CompositionAlignment + -- ^ The alignment to apply to the row- or column- facet's subplot. + -- + -- @since 0.6.0.0 | FBin [BinProperty] -- ^ Describe how to bin quantitative fields, or whether the -- channels are already binned. + | FCenter Bool + -- ^ Should sub-views be centered relative to their respective rows or + -- columns. + -- + -- @since 0.6.0.0 | FHeader [HeaderProperty] -- ^ The properties of a facet's header. | FSort [SortProperty] -- ^ Sort order for the encoded field. -- -- @since 0.4.0.0 + | FSpacing Double + -- ^ The pixel spacing between sub-views. + -- + -- If you have code from a version of @hvega@ before @0.6.0.0@ that + -- uses @FSpacing@ (with 'Graphics.Vega.VegaLite.FacetStyle'), please + -- use 'Graphics.Vega.VegaLite.CompSpacing' as a replacement. + -- + -- @since 0.6.0.0 | FTimeUnit TimeUnit -- ^ The time-unit for a temporal field. | FTitle T.Text @@ -2031,10 +2109,13 @@ facetChannelProperty :: FacetChannel -> LabelledSpec facetChannelProperty (FName s) = field_ s facetChannelProperty (FmType measure) = mtype_ measure +facetChannelProperty (FAlign algn) = "align" .= compositionAlignmentSpec algn facetChannelProperty (FAggregate op) = aggregate_ op facetChannelProperty (FBin bps) = bin bps -facetChannelProperty (FHeader hps) = header_ hps +facetChannelProperty (FCenter b) = "center" .= b +facetChannelProperty (FHeader hps) = header_ "" hps facetChannelProperty (FSort sps) = sort_ sps +facetChannelProperty (FSpacing x) = "spacing" .= x facetChannelProperty (FTitle s) = "title" .= s facetChannelProperty FNoTitle = "title" .= A.Null facetChannelProperty (FTimeUnit tu) = timeUnit_ tu @@ -2227,7 +2308,7 @@ config = 'configure' . 'Graphics.Vega.VegaLite.configuration' ('Graphics.Vega.VegaLite.Axis' [ 'Graphics.Vega.VegaLite.DomainWidth' 1 ]) - . 'Graphics.Vega.VegaLite.configuration' ('Graphics.Vega.VegaLite.View' [ 'Graphics.Vega.VegaLite.ViewStroke' (Just "transparent") ]) + . 'Graphics.Vega.VegaLite.configuration' ('Graphics.Vega.VegaLite.ViewStyle' [ 'Graphics.Vega.VegaLite.ViewStroke' "transparent" ]) . 'Graphics.Vega.VegaLite.configuration' ('Graphics.Vega.VegaLite.SelectionStyle' [ ( 'Graphics.Vega.VegaLite.Single', [ 'Graphics.Vega.VegaLite.On' \"dblclick\" ] ) ]) @ -} @@ -4402,6 +4483,54 @@ {-| +Encode a stroke-dash channel. + +The following will use a different dash style for each value in the +\"symbol" field (a multi-series line chart): + +@ +'Graphics.Vega.VegaLite.toVegaLite' [ 'Graphics.Vega.VegaLite.dataFromUrl' \"data/stocks.csv\" [] + , 'mark' 'Graphics.Vega.VegaLite.Line' [] + , 'encoding' + . 'position' 'Graphics.Vega.VegaLite.X' [ 'PName' \"date\", 'PmType' 'Graphics.Vega.VegaLite.Temporal' ] + . 'position' 'Graphics.Vega.VegaLite.Y' [ 'PName' \"price\", 'PmType' 'Graphics.Vega.VegaLite.Quantitative' ] + . strokeDash [ 'MName' \"symbol\", 'MmType' 'Graphics.Vega.VegaLite.Nominal' ] + $ [] + ] +@ + +It can also be used to change the line style for connected +points (e.g. to indicate where the data changes its \"predicted\" +value, noting that there are two points at @\"a\"@ equal to @\"E\"@): + +@ +'Graphics.Vega.VegaLite.toVegaLite' [ 'Graphics.Vega.VegaLite.dataFromColumns' [] + . 'Graphics.Vega.VegaLite.dataColumn' \"a\" ('Strings' [ \"A\", \"B\", \"D\", \"E\", \"E\", \"G\", \"H\"]) + . 'Graphics.Vega.VegaLite.dataColumn' \"b\" ('Numbers' [ 28, 55, 91, 81, 81, 19, 87 ]) + . 'Graphics.Vega.VegaLite.dataColumn' \"predicted\" ('Booleans' [False, False, False, False, True, True, True]) + $ [] + , 'mark' 'Graphics.Vega.VegaLite.Line' [] + , 'encoding' + . 'position' 'Graphics.Vega.VegaLite.X' [ 'PName' \"a\", 'PmType' 'Graphics.Vega.VegaLite.Ordinal' ] + . 'position' 'Graphics.Vega.VegaLite.Y' [ 'PName' \"b\", 'PmType' 'Graphics.Vega.VegaLite.Quantitative' ] + . strokeDash [ 'MName' \"predicted\", 'MmType' 'Graphics.Vega.VegaLite.Nominal' ] + $ [] + ] +@ + +@since 0.6.0.0 + +-} + +strokeDash :: + [MarkChannel] + -- ^ What data values are used to control the stoke opacity parameters of the mark. + -> BuildEncodingSpecs +strokeDash markProps ols = mchan_ "strokeDash" markProps : ols + + +{-| + Encode a stroke opacity channel. This acts in a similar way to encoding by 'opacity' but only affects the exterior boundary of marks. If both 'opacity' and @strokeOpacity@ are specified, @strokeOpacity@ takes precedence for stroke encoding. @@ -4486,7 +4615,7 @@ -- ^ The name of the binned data created by this routine. -> BuildTransformSpecs timeUnitAs tu field label ols = - let fields = [ "timeUnit" .= timeUnitLabel tu + let fields = [ "timeUnit" .= timeUnitSpec tu , "field" .= field , "as" .= label ] in TS (object fields) : ols diff --git a/src/Graphics/Vega/VegaLite/Foundation.hs b/src/Graphics/Vega/VegaLite/Foundation.hs --- a/src/Graphics/Vega/VegaLite/Foundation.hs +++ b/src/Graphics/Vega/VegaLite/Foundation.hs @@ -1,3 +1,4 @@ +{-# LANGUAGE CPP #-} {-# LANGUAGE OverloadedStrings #-} {-| @@ -7,7 +8,7 @@ Maintainer : dburke.gw@gmail.com Stability : unstable -Portability : OverloadedStrings +Portability : CPP, OverloadedStrings Basic types that are used throughout VegaLite. Would it make sense to break this up into @@ -22,6 +23,7 @@ , DashOffset , FieldName , Opacity + , StyleLabel , VegaExpr , ZIndex @@ -118,6 +120,9 @@ import Data.Aeson ((.=), object, toJSON) +#if !(MIN_VERSION_base(4, 12, 0)) +import Data.Monoid ((<>)) +#endif -- added in base 4.8.0.0 / ghc 7.10.1 import Numeric.Natural (Natural) @@ -133,8 +138,8 @@ field_ :: FieldName -> LabelledSpec field_ f = "field" .= f -header_ :: [HeaderProperty] -> LabelledSpec -header_ hps = "header" .= object (map headerProperty hps) +header_ :: T.Text -> [HeaderProperty] -> LabelledSpec +header_ extra hps = ("header" <> extra) .= object (map headerProperty hps) -- could restrict to ascending/descending order_ :: T.Text -> LabelledSpec @@ -250,6 +255,23 @@ {-| +Convenience type-annotation to indicate a name, or label, that represents +a set of mark or axis styles. The styles are generated with +'Graphics.Vega.VegaLite.AxisNamedStyles' and +'Graphics.Vega.VegaLite.MarkNamedStyles', +and used with constructs such as +'Graphics.Vega.VegaLite.AStyle', +'Graphics.Vega.VegaLite.AxStyle', +'Graphics.Vega.VegaLite.MStyle', and +'Graphics.Vega.VegaLite.TStyle'. + +@since 0.6.0.0 +-} + +type StyleLabel = T.Text + +{-| + Convenience type-annotation label to indicate an angle, which is measured in degrees from the horizontal (so anti-clockwise). @@ -558,21 +580,29 @@ data VAlign = AlignTop + -- ^ The position refers to the top of the text. | AlignMiddle + -- ^ The middle of the text. | AlignBottom - + -- ^ The position refers to the bottom of the text, including + -- descenders, like g. + | AlignBaseline + -- ^ The position refers to the baseline of the text (so it does + -- not include descenders). This maps to the Vega-Lite + -- @\"alphabetic\"@ value. + -- + -- @since 0.6.0.0 hAlignLabel :: HAlign -> T.Text hAlignLabel AlignLeft = "left" hAlignLabel AlignCenter = "center" hAlignLabel AlignRight = "right" - vAlignLabel :: VAlign -> T.Text vAlignLabel AlignTop = "top" vAlignLabel AlignMiddle = "middle" vAlignLabel AlignBottom = "bottom" - +vAlignLabel AlignBaseline = "alphabetic" {-| @@ -1021,6 +1051,11 @@ -- | Indicates a channel type to be used in a resolution specification. +-- +-- Used with the 'Resolve' type and the +-- 'Graphics.Vega.VegaLite.BLChannel', 'Graphics.Vega.VegaLite.BLChannelEvent', +-- 'Graphics.Vega.VegaLite.ByChannel', and 'Graphics.Vega.VegaLite.Encodings' +-- constructors. -- assuming this is based on schema 3.3.0 #/definitions/SingleDefUnitChannel @@ -1046,15 +1081,17 @@ -- ^ @since 0.4.0.0 | ChKey -- ^ @since 0.4.0.0 + | ChOpacity + | ChShape + | ChSize | ChStroke -- ^ @since 0.3.0.0 + | ChStrokeDash + -- ^ @since 0.6.0.0 | ChStrokeOpacity -- ^ @since 0.4.0.0 | ChStrokeWidth -- ^ @since 0.4.0.0 - | ChOpacity - | ChShape - | ChSize | ChText -- ^ @since 0.4.0.0 | ChTooltip @@ -1072,17 +1109,18 @@ channelLabel ChLatitude2 = "latitude2" channelLabel ChColor = "color" channelLabel ChFill = "fill" -channelLabel ChStroke = "stroke" -channelLabel ChStrokeWidth = "strokeWidth" +channelLabel ChFillOpacity = "fillOpacity" +channelLabel ChHref = "href" +channelLabel ChKey = "key" +channelLabel ChOpacity = "opacity" channelLabel ChShape = "shape" channelLabel ChSize = "size" -channelLabel ChFillOpacity = "fillOpacity" +channelLabel ChStroke = "stroke" +channelLabel ChStrokeDash = "strokeDash" +channelLabel ChStrokeWidth = "strokeWidth" channelLabel ChStrokeOpacity = "strokeOpacity" -channelLabel ChOpacity = "opacity" channelLabel ChText = "text" channelLabel ChTooltip = "tooltip" -channelLabel ChHref = "href" -channelLabel ChKey = "key" {-| @@ -1149,7 +1187,9 @@ -- | Specifies the alignment of compositions. It is used with: --- 'Graphics.Vega.VegaLite.align', 'Graphics.Vega.VegaLite.alignRC', 'Graphics.Vega.VegaLite.LeGridAlign', and 'Graphics.Vega.VegaLite.LGridAlign'. +-- 'Graphics.Vega.VegaLite.align', 'Graphics.Vega.VegaLite.alignRC', +-- 'Graphics.Vega.VegaLite.LeGridAlign', 'Graphics.Vega.VegaLite.LGridAlign', +-- and 'Graphics.Vega.VegaLite.FAlign'. -- -- @since 0.4.0.0 @@ -1303,34 +1343,50 @@ cInterpolateSpec (CubeHelixLong gamma) = object [pairT "type" "cubehelix-long", "gamma" .= gamma] --- | The properties for a single view or layer background. --- --- Used with 'Graphics.Vega.VegaLite.viewBackground' and --- 'Graphics.Vega.VegaLite.ViewBackgroundStyle'. --- --- @since 0.4.0.0 +{-| The properties for a single view or layer background. +Used with 'Graphics.Vega.VegaLite.viewBackground' and +'Graphics.Vega.VegaLite.ViewBackgroundStyle'. + +In version @0.6.0.0@ the constructors that used to take an optional color, +namely 'VBFill' and 'VBStroke', were split out, so that they +now take a 'Color' argument and new constructors - 'VBNoFill' and +'VBNoStroke' - were added to replace the @Nothing@ versions. + +@since 0.4.0.0 + +-} + data ViewBackground - = VBStyle [T.Text] + = VBStyle [StyleLabel] -- ^ A list of named styles to apply. A named style can be specified - -- via 'Graphics.Vega.VegaLite.NamedStyle' or 'Graphics.Vega.VegaLite.NamedStyles'. Later styles in the list will + -- via 'Graphics.Vega.VegaLite.MarkNamedStyles'. Later styles in the list will -- override earlier ones if there is a conflict in any of the mark -- properties. | VBCornerRadius Double -- ^ The radius in pixels of rounded corners. - | VBFill (Maybe Color) - -- ^ Fill color. + | VBFill Color + -- ^ Fill color. See also 'VBNoFill'. -- - -- This was changed to use the @Color@ type alias in version @0.5.0.0@. + -- This was changed to use the @Color@ type alias in version @0.5.0.0@ + -- and removed the @Maybe@ type in version @0.6.0.0@. + | VBNoFill + -- ^ Do not use a fill. See also 'VBFill'. + -- + -- @since 0.6.0.0 | VBFillOpacity Opacity -- ^ Fill opacity. | VBOpacity Opacity -- ^ Overall opacity. - | VBStroke (Maybe Color) - -- ^ The stroke color for a line around the background. If @Nothing@ then - -- no line is drawn. + | VBStroke Color + -- ^ The stroke color for a line around the background. See also 'VBNoStroke'. -- - -- This was changed to use the @Color@ type alias in version @0.5.0.0@. + -- This was changed to use the @Color@ type alias in version @0.5.0.0@ + -- and removed the @Maybe@ type in version @0.6.0.0@. + | VBNoStroke + -- ^ Do not use a stroke. See also 'VBStroke'. + -- + -- @since 0.6.0.0 | VBStrokeOpacity Opacity -- ^ The opacity of the line around the background, if drawn. | VBStrokeWidth Double @@ -1351,12 +1407,12 @@ viewBackgroundSpec (VBStyle [style]) = "style" .= style -- special case singleton viewBackgroundSpec (VBStyle styles) = "style" .= styles viewBackgroundSpec (VBCornerRadius r) = "cornerRadius" .= r -viewBackgroundSpec (VBFill (Just s)) = "fill" .= s -viewBackgroundSpec (VBFill Nothing) = "fill" .= A.Null +viewBackgroundSpec (VBFill s) = "fill" .= s +viewBackgroundSpec VBNoFill = "fill" .= A.Null viewBackgroundSpec (VBFillOpacity x) = "fillOpacity" .= x viewBackgroundSpec (VBOpacity x) = "opacity" .= x -viewBackgroundSpec (VBStroke (Just s)) = "stroke" .= s -viewBackgroundSpec (VBStroke Nothing) = "stroke" .= A.Null +viewBackgroundSpec (VBStroke s) = "stroke" .= s +viewBackgroundSpec VBNoStroke = "stroke" .= A.Null viewBackgroundSpec (VBStrokeOpacity x) = "strokeOpacity" .= x viewBackgroundSpec (VBStrokeCap cap) = "strokeCap" .= strokeCapLabel cap viewBackgroundSpec (VBStrokeJoin jn) = "strokeJoin" .= strokeJoinLabel jn @@ -1376,9 +1432,16 @@ -} --- TODO: should there be a HLabelBaseline, HTitleFontStyle, ...? --- However, the following covers the vega-lite 3.3.0 schema +{- +In 4.2.0 this represents both + HeaderConfig + Header + +which have the same keys. + +-} + data HeaderProperty = HFormat T.Text -- ^ [Formatting pattern](https://vega.github.io/vega-lite/docs/format.html) for @@ -1396,12 +1459,10 @@ -- with 'HFormat'. -- -- @since 0.4.0.0 - | HTitle T.Text - -- ^ The title for the facets. - | HNoTitle - -- ^ Draw no title for the facets. + | HLabel Bool + -- ^ Should labels be included as part of the header. The default is @True@. -- - -- @since 0.4.0.0 + -- @since 0.6.0.0 | HLabelAlign HAlign -- ^ The horizontal alignment of the labels. -- @@ -1411,13 +1472,21 @@ -- -- @since 0.4.0.0 | HLabelAngle Angle - -- ^ The angle to draw the labels. + -- ^ The angle to draw the labels. The default is 0 for column headers + -- and -90 for row headers. -- - -- @since 0.4.0.0 + -- @since 0.4.0.0 | HLabelColor Color -- ^ The color of the labels. -- -- @since 0.4.0.0 + | HLabelExpr VegaExpr + -- ^ The expression used to generate header labels. + -- + -- The expression can use @datum.value@ and @datum.label@ to access + -- the data value and default label text respectively. + -- + -- @since 0.6.0.0 | HLabelFont T.Text -- ^ The font for the labels. -- @@ -1426,6 +1495,10 @@ -- ^ The font size for the labels. -- -- @since 0.4.0.0 + | HLabelFontStyle T.Text + -- ^ The font style for the labels. + -- + -- @since 0.6.0.0 | HLabelLimit Double -- ^ The maximum length of each label. -- @@ -1438,6 +1511,12 @@ -- ^ The spacing in pixels between the label and its sub-plot. -- -- @since 0.4.0.0 + | HTitle T.Text + -- ^ The title for the facets. + | HNoTitle + -- ^ Draw no title for the facets. + -- + -- @since 0.4.0.0 | HTitleAlign HAlign -- ^ The horizontal alignment of the title. -- @@ -1466,6 +1545,10 @@ -- ^ The font size for the title. -- -- @since 0.4.0.0 + | HTitleFontStyle T.Text + -- ^ The font style for the title. + -- + -- @since 0.6.0.0 | HTitleFontWeight T.Text -- ^ The font weight for the title. -- @@ -1474,6 +1557,10 @@ -- ^ The maximum length of the title. -- -- @since 0.4.0.0 + | HTitleLineHeight Double + -- ^ The line height, in pixels, for multi-line title text. + -- + -- @since 0.6.0.0 | HTitleOrient Side -- ^ The position of the title relative to the sub-plots. -- @@ -1490,12 +1577,15 @@ headerProperty HFormatAsTemporal = "formatType" .= fromT "time" headerProperty (HTitle ttl) = "title" .= splitOnNewline ttl headerProperty HNoTitle = "title" .= A.Null +headerProperty (HLabel b) = "labels" .= b headerProperty (HLabelAlign ha) = "labelAlign" .= hAlignLabel ha headerProperty (HLabelAnchor a) = "labelAnchor" .= anchorLabel a headerProperty (HLabelAngle x) = "labelAngle" .= x headerProperty (HLabelColor s) = "labelColor" .= fromColor s +headerProperty (HLabelExpr s) = "labelExpr" .= s headerProperty (HLabelFont s) = "labelFont" .= s headerProperty (HLabelFontSize x) = "labelFontSize" .= x +headerProperty (HLabelFontStyle s) = "labelFontStyle" .= s headerProperty (HLabelLimit x) = "labelLimit" .= x headerProperty (HLabelOrient orient) = "labelOrient" .= sideLabel orient headerProperty (HLabelPadding x) = "labelPadding" .= x @@ -1507,6 +1597,8 @@ headerProperty (HTitleFont s) = "titleFont" .= s headerProperty (HTitleFontWeight s) = "titleFontWeight" .= s headerProperty (HTitleFontSize x) = "titleFontSize" .= x +headerProperty (HTitleFontStyle s) = "titleFontStyle" .= s headerProperty (HTitleLimit x) = "titleLimit" .= x +headerProperty (HTitleLineHeight x) = "titleLineHeight" .= x headerProperty (HTitleOrient orient) = "titleOrient" .= sideLabel orient headerProperty (HTitlePadding x) = "titlePadding" .= x diff --git a/src/Graphics/Vega/VegaLite/Mark.hs b/src/Graphics/Vega/VegaLite/Mark.hs --- a/src/Graphics/Vega/VegaLite/Mark.hs +++ b/src/Graphics/Vega/VegaLite/Mark.hs @@ -50,6 +50,7 @@ , Cursor , FontWeight , Opacity + , StyleLabel , Orientation , StrokeCap , StrokeJoin @@ -75,8 +76,9 @@ ) --- TODO: should this turn an empty list into true? +-- As of version 0.6.0.0, an empty list is mapped to True mprops_ :: T.Text -> [MarkProperty] -> LabelledSpec +mprops_ f [] = f .= True mprops_ f mps = f .= object (map markProperty mps) @@ -203,9 +205,9 @@ Not all properties are valid for each mark type. -The Vega-Lite specification supports setting those properties that take -@['MarkProperty']@ also to a boolean value. This is currently not -supported in @hvega@. +Some properties which take a list - such as 'MBox' - will +create a @true@ value if the list is empty, and @false@ if the +@\"No\"@ variant of the constructor is used (e.g. 'MNoBox'). In @version 0.5.0.0@ the 'MRemoveInvalid' constructor was added, which replaces the @RemoveInvalid@ constructor of @@ -242,13 +244,21 @@ -- The ideal value for this is either @0@ (preferred by statisticians) -- or @1@ (the Vega-Lite default value, D3 example style). | MBorders [MarkProperty] - -- ^ Border properties for an 'ErrorBand' mark. + -- ^ Border properties for an 'ErrorBand' mark. See also 'MNoBorders'. -- -- @since 0.4.0.0 + | MNoBorders + -- ^ Do not draw a border for an 'ErrorBand' mark. + -- + -- @since 0.6.0.0 | MBox [MarkProperty] - -- ^ Box-symbol properties for a 'Boxplot' mark. + -- ^ Box-symbol properties for a 'Boxplot' mark. See also 'MNoBox'. -- -- @since 0.4.0.0 + | MNoBox + -- ^ Do not draw outliers with the 'Boxplot' mark. + -- + -- @since 0.6.0.0 | MClip Bool -- ^ Should a mark be clipped to the enclosing group's dimensions. | MColor Color @@ -276,6 +286,15 @@ -- or 'MCornerRadiusBR'. -- -- @since 0.5.0.0 + | MCornerRadiusEnd Double + -- ^ The radius used for bars, in pixels. For vertical bars it + -- defines the top-left and top-right radius, and for + -- horizontal bars it is the top-right and bottom-right. + -- + -- For an example, see the + -- . + -- + -- @since 0.6.0.0 | MCornerRadiusTL Double -- ^ Top-left corner radius of a rectangular mark, in pixels. -- @@ -398,9 +417,13 @@ -- -- @since 0.5.0.0 | MMedian [MarkProperty] - -- ^ Median-line properties for the 'Boxplot' mark. + -- ^ Median-line properties for the 'Boxplot' mark. See also 'MNoMedian'. -- -- @since 0.4.0.0 + | MNoMedian + -- ^ Do not draw the median of the 'Boxplot' mark. + -- + -- @since 0.6.0.0 | MOpacity Opacity -- ^ Overall opacity of a mark in the range 0 to 1. | MOrder Bool @@ -412,7 +435,7 @@ | MOrient Orientation -- ^ Orientation of a non-stacked bar, tick, area or line mark. | MOutliers [MarkProperty] - -- ^ Outlier symbol properties for the 'Boxplot' mark. + -- ^ Outlier symbol properties for the 'Boxplot' mark. See also 'MNoOutliers'. -- -- @since 0.4.0.0 | MNoOutliers @@ -436,9 +459,13 @@ -- -- @since 0.5.0.0 | MRule [MarkProperty] - -- ^ Rule (main line) properties for the 'ErrorBar' and 'Boxplot' marks. + -- ^ Rule (main line) properties for the 'ErrorBar' and 'Boxplot' marks. See also 'MNoRule'. -- -- @since 0.4.0.0 + | MNoRule + -- ^ Do not draw the rule for 'ErrorBar' and 'Boxplot' marks. + -- + -- @since 0.6.0.0 | MShape Symbol -- ^ Shape of a point mark. | MSize Double @@ -482,13 +509,22 @@ -- ^ Stroke opacity of a mark in the range 0 to 1. | MStrokeWidth Double -- ^ Stroke width of a mark in pixels. - | MStyle [T.Text] + | MStyle [StyleLabel] -- ^ Names of custom styles to apply to a mark. Each should refer to a named style - -- defined in a separate style configuration. + -- defined in a separate style configuration (using + -- 'Graphics.Vega.VegaLite.MarkNamedStyles'). | MTension Double -- ^ Interpolation tension used when interpolating line and area marks. | MText T.Text -- ^ Placeholder text for a text mark for when a text channel is not specified. + -- + -- See 'MTexts' for supplying an array of text values. + | MTexts [T.Text] + -- ^ Placeholder text for a text mark for when a text channel is not specified. + -- + -- See 'MText' for supplying a single text value. + -- + -- @since 0.6.0.0 | MTheta Double -- ^ Polar coordinate angle (clockwise from north in radians) -- of a text mark from the origin (determined by its @@ -496,9 +532,18 @@ | MThickness Double -- ^ Thickness of a tick mark. | MTicks [MarkProperty] - -- ^ Tick properties for the 'ErrorBar' or 'Boxplot' mark. + -- ^ Tick properties for the 'ErrorBar' or 'Boxplot' mark. See also 'MNoTicks'. -- -- @since 0.4.0.0 + | MNoTicks + -- ^ Do not draw ticks for 'ErrorBar' or 'Boxplot' marks. + -- + -- The default behavior for ticks is for them to not be drawn, so @MNoTicks@ + -- is only needed if the visualization contains something like: + -- + -- @'Graphics.Vega.VegaLite.configure' ('Graphics.Vega.VegaLite.configuration' ('Graphics.Vega.VegaLite.BoxplotStyle' ['MTicks' []] []))@ + -- + -- @since 0.6.0.0 | MTimeUnitBand Double -- ^ The default relative band size for a time unit. -- @@ -517,14 +562,6 @@ -- ^ The tooltip content for a mark. -- -- @since 0.4.0.0 - {- Not clear this adds anything with the current hvega design, - since the mark function adds this field, and other places that - MarkProperty can be used do not accept a type option - | MType Mark - -- ^ The mark type. - -- - -- @since 0.5.0.0 - -} | MWidth Double -- ^ Explicitly set the width of a mark (e.g. the bar width). See also -- 'MHeight'. @@ -591,14 +628,17 @@ markProperty (MBinSpacing x) = "binSpacing" .= x -- only available in ErrorBand[Config|Def], PartsMixins +markProperty MNoBorders = "borders" .= False markProperty (MBorders mps) = mprops_ "borders" mps -- BoxPlot[Config|Deg], PartsMixins +markProperty MNoBox = "box" .= False markProperty (MBox mps) = mprops_ "box" mps markProperty (MClip b) = "clip" .= b markProperty (MColor col) = "color" .= fromColor col markProperty (MCornerRadius x) = "cornerRadius" .= x +markProperty (MCornerRadiusEnd x) = "cornerRadiusEnd" .= x markProperty (MCornerRadiusTL x) = "cornerRadiusTopLeft" .= x markProperty (MCornerRadiusTR x) = "cornerRadiusTopRight" .= x markProperty (MCornerRadiusBL x) = "cornerRadiusBottomLeft" .= x @@ -629,6 +669,7 @@ markProperty (MLineHeight x) = "lineHeight" .= x -- BoxPlot[Config|Def] possibly others +markProperty MNoMedian = "median" .= False markProperty (MMedian mps) = mprops_ "median" mps markProperty (MOpacity x) = "opacity" .= x @@ -636,14 +677,14 @@ markProperty (MOrient orient) = "orient" .= orientationSpec orient -- what uses this? -markProperty (MOutliers []) = "outliers" .= True -- TODO: should mprops_ do this? -markProperty (MOutliers mps) = mprops_ "outliers" mps markProperty MNoOutliers = "outliers" .= False +markProperty (MOutliers mps) = mprops_ "outliers" mps markProperty (MPoint pm) = "point" .= pointMarkerSpec pm markProperty (MRadius x) = "radius" .= x -- what uses this? +markProperty MNoRule = "rule" .= False markProperty (MRule mps) = mprops_ "rule" mps markProperty (MShape sym) = "shape" .= symbolLabel sym @@ -659,20 +700,19 @@ markProperty (MStyle [style]) = "style" .= style -- special case singleton markProperty (MStyle styles) = "style" .= styles markProperty (MTension x) = "tension" .= x -markProperty (MText txt) = "text" .= txt +markProperty (MText t) = "text" .= t +markProperty (MTexts ts) = "text" .= ts markProperty (MTheta x) = "theta" .= x markProperty (MThickness x) = "thickness" .= x -- what uses this? +markProperty MNoTicks = "ticks" .= False markProperty (MTicks mps) = mprops_ "ticks" mps markProperty (MTimeUnitBand x) = "timeUnitBand" .= x markProperty (MTimeUnitBandPosition x) = "timeUnitBandPosition" .= x markProperty (MTooltip TTNone) = "tooltip" .= A.Null markProperty (MTooltip tc) = "tooltip" .= object ["content" .= ttContentLabel tc] -{- -markProperty (MType m) = "type" .= markLabel m --} markProperty (MWidth x) = "width" .= x markProperty (MX x) = "x" .= x markProperty (MY x) = "y" .= x diff --git a/src/Graphics/Vega/VegaLite/Scale.hs b/src/Graphics/Vega/VegaLite/Scale.hs --- a/src/Graphics/Vega/VegaLite/Scale.hs +++ b/src/Graphics/Vega/VegaLite/Scale.hs @@ -2,7 +2,7 @@ {-| Module : Graphics.Vega.VegaLite.Scale -Copyright : (c) Douglas Burke, 2018-2019 +Copyright : (c) Douglas Burke, 2018-2020 License : BSD3 Maintainer : dburke.gw@gmail.com @@ -38,7 +38,7 @@ ( DateTime , TimeUnit , dateTimeProperty - , timeUnitLabel + , timeUnitSpec ) @@ -57,14 +57,29 @@ -- ^ Date-time values that define a scale domain. | DSelection T.Text -- ^ Scale domain based on a named interactive selection. + | DUnionWith ScaleDomain + -- ^ Combine the domain of the data with the provided domain. + -- + -- The following example will use a range of at least 0 to 100, + -- but this will be increased if the data (either initially or + -- via any updates to the Vege-Lite visualization) exceeds this: + -- + -- @'Graphics.Vega.VegaLite.PScale' ['Graphics.Vega.VegaLite.SDomain' (DUnionWith ('DNumbers' [0, 100]))]@ + -- + -- Note that 'DUnionWith' should not be nested, but this + -- is not enforced by @hvega@. + -- + -- @since 0.6.0.0 | Unaggregated - -- ^ Specify an unaggregated scale domain (type of data in scale). + -- ^ Indicate that a domain of aggregated data should be scaled to + -- the domain of the data prior to aggregation. scaleDomainSpec :: ScaleDomain -> VLSpec scaleDomainSpec (DNumbers nums) = toJSON (map toJSON nums) scaleDomainSpec (DDateTimes dts) = toJSON (map (object . map dateTimeProperty) dts) scaleDomainSpec (DStrings cats) = toJSON (map toJSON cats) scaleDomainSpec (DSelection selName) = object ["selection" .= selName] +scaleDomainSpec (DUnionWith sd) = object ["unionWith" .= scaleDomainSpec sd] scaleDomainSpec Unaggregated = "unaggregated" @@ -108,7 +123,7 @@ scaleNiceSpec NMonth = fromT "month" scaleNiceSpec NYear = fromT "year" scaleNiceSpec (NInterval tu step) = - object ["interval" .= timeUnitLabel tu, "step" .= step] + object ["interval" .= timeUnitSpec tu, "step" .= step] scaleNiceSpec (IsNice b) = toJSON b scaleNiceSpec (NTickCount n) = toJSON n @@ -134,8 +149,21 @@ -- a two-element array indicating minimum and maximum values, or an array with more than -- two entries for specifying a -- [piecewise scale](https://vega.github.io/vega-lite/docs/scale.html#piecewise). + | RNumberLists [[Double]] + -- ^ A scale range comprising of numeric lists, such as custom dash styles for + -- the 'Graphics.Vega.VegaLite.strokeDash' channel encoding. + -- + -- @since 0.6.0.0 | RStrings [T.Text] -- ^ Text scale range for discrete scales. | RName T.Text -- ^ Name of a [pre-defined named scale range](https://vega.github.io/vega-lite/docs/scale.html#range-config) -- (e.g. \"symbol\" or \"diverging\"). + +{- + +TODO: + +* TickCount accepts number or TimeInterval but this is a subset of ScaleNice + +-} diff --git a/src/Graphics/Vega/VegaLite/Selection.hs b/src/Graphics/Vega/VegaLite/Selection.hs --- a/src/Graphics/Vega/VegaLite/Selection.hs +++ b/src/Graphics/Vega/VegaLite/Selection.hs @@ -49,10 +49,12 @@ , FieldName , Opacity , Channel + , Cursor , channelLabel , fromT , fromColor , fromDS + , cursorLabel ) import Graphics.Vega.VegaLite.Specification ( VLProperty(VLSelection) @@ -298,7 +300,12 @@ -} data SelectionMarkProperty - = SMFill Color + = SMCursor Cursor + -- ^ Cursor type to appear when pointer is over an interval selection mark + -- (dragged rectangular area). + -- + -- @since 0.6.0.0 + | SMFill Color -- ^ Fill color. | SMFillOpacity Opacity -- ^ Fill opacity. @@ -315,6 +322,7 @@ selectionMarkProperty :: SelectionMarkProperty -> LabelledSpec +selectionMarkProperty (SMCursor c) = "cursor" .= cursorLabel c selectionMarkProperty (SMFill colour) = "fill" .= fromColor colour selectionMarkProperty (SMFillOpacity x) = "fillOpacity" .= x selectionMarkProperty (SMStroke colour) = "stroke" .= fromColor colour diff --git a/src/Graphics/Vega/VegaLite/Time.hs b/src/Graphics/Vega/VegaLite/Time.hs --- a/src/Graphics/Vega/VegaLite/Time.hs +++ b/src/Graphics/Vega/VegaLite/Time.hs @@ -21,28 +21,23 @@ , TimeUnit(..) -- not for external export - , timeUnit_ - , dateTimeProperty - -- , dayLabel - -- , monthNameLabel - , timeUnitLabel + , timeUnitSpec ) where import qualified Data.Text as T -import Data.Aeson ((.=)) +import Data.Aeson ((.=), object) #if !(MIN_VERSION_base(4, 12, 0)) import Data.Monoid ((<>)) #endif -import Graphics.Vega.VegaLite.Specification (LabelledSpec) - +-- added in base 4.8.0.0 / ghc 7.10.1 +import Numeric.Natural (Natural) -timeUnit_ :: TimeUnit -> LabelledSpec -timeUnit_ tu = "timeUnit" .= timeUnitLabel tu +import Graphics.Vega.VegaLite.Specification (LabelledSpec, VLSpec) {-| @@ -127,6 +122,32 @@ @ -} +-- Vega-Lite 4.4.0 has +-- LocalMultiTimeUnit which is yearquarter, yearquartermonth, ,secondsmilliseconds +-- LocalSingleTimeUnit year, quarter, ..., milliseconds +-- and +-- UtcMultiTimeUnit which is utc <> LocalMultiTimeUnit +-- UtcSingleTimeUnit utc <> LocalSingleTimeUnit +-- +-- TimeUnit is either of SingleTimeUnit or MultiTimeUnit +-- SingleTimeUnut is either of LocalSingleTimeUnit or UtcSingleTimeUnit +-- MultiTimeUnit is either of LocalMultiTieUnit or UtcMultiTimeUnit +-- +-- "timeUnit" settings are TimeUnit or TimeUnitParams +-- +-- TimeUnitParams is an object with fields +-- maxbins - number +-- step - number +-- unit - this is TimeUnit +-- utc - boolean +-- +-- So, could be something like "TU