Vega 4.3 'require' option for linkPath transform

gicentre · Oct 12, 2018 · 68e973f · 68e973f
1 parent 5ef0e38
commit 68e973f
Show file tree

Hide file tree

Showing 23 changed files with 250 additions and 4 deletions.
diff --git a/docs/api/documentation.json b/docs/api/documentation.json
diff --git a/examples/js/barchart.js b/examples/js/barchart.js
diff --git a/examples/js/helloWorld.js b/examples/js/helloWorld.js
diff --git a/examples/js/voronoi.js b/examples/js/voronoi.js
diff --git a/src/Vega.elm b/src/Vega.elm
@@ -268,6 +268,7 @@ module Vega exposing
     , lpTargetY
     , lpOrient
     , lpShape
+    , lpRequire
     , lpAs
     , lsLine
     , lsArc
@@ -1647,6 +1648,7 @@ See the
 @docs lpTargetY
 @docs lpOrient
 @docs lpShape
+@docs lpRequire
 @docs lpAs
 @docs lsLine
 @docs lsArc
@@ -3685,9 +3687,8 @@ type LegendType
     | LegendTypeSignal String
 
 
-{-| Generated by [lpSourceY](#lpSourceY),
-[lpTargetX](#lpTargetX), [lpTargetY](#lpTargetY), [lpOrient](#lpOrient),
-[lpShape](#lpShape) and [lpAs](#lpAs).
+{-| Generated by [lpSourceY](#lpSourceY), [lpTargetX](#lpTargetX), [lpTargetY](#lpTargetY),
+[lpOrient](#lpOrient), [lpShape](#lpShape), [lpRequire](#lpRequire) and [lpAs](#lpAs).
 -}
 type LinkPathProperty
     = LPSourceX Field
@@ -3696,6 +3697,7 @@ type LinkPathProperty
     | LPTargetY Field
     | LPOrient Orientation
     | LPShape LinkShape
+    | LPRequire String
     | LPAs String
 
 
@@ -8840,6 +8842,16 @@ lpOrient =
     LPOrient
 
 
+{-| A required signal that a linkpath transform depends upon. This is needed if
+source or target coordinates are set as a non-propagating side-effect of a transform
+in a different stream such as a force transform. In such cases the upstream transform
+should be bound to a signal and required with this function.
+-}
+lpRequire : String -> LinkPathProperty
+lpRequire =
+    LPRequire
+
+
 {-| Shape of a link path in a linkPath transformation.
 -}
 lpShape : LinkShape -> LinkPathProperty
@@ -15146,6 +15158,9 @@ linkPathProperty lpProp =
         LPShape ls ->
             ( "shape", linkShapeSpec ls )
 
+        LPRequire sig ->
+            ( "require", JE.object [ ( "signal", JE.string sig ) ] )
+
         LPAs s ->
             ( "as", JE.string s )
 

diff --git a/test-gallery/js/galleryBar.js b/test-gallery/js/galleryBar.js
diff --git a/test-gallery/js/galleryCustom.js b/test-gallery/js/galleryCustom.js
diff --git a/test-gallery/js/galleryDist.js b/test-gallery/js/galleryDist.js
diff --git a/test-gallery/js/galleryGeo.js b/test-gallery/js/galleryGeo.js
diff --git a/test-gallery/js/galleryInteraction.js b/test-gallery/js/galleryInteraction.js
diff --git a/test-gallery/js/galleryLineArea.js b/test-gallery/js/galleryLineArea.js
diff --git a/test-gallery/js/galleryNetwork.js b/test-gallery/js/galleryNetwork.js
diff --git a/test-gallery/js/galleryOther.js b/test-gallery/js/galleryOther.js
diff --git a/test-gallery/js/galleryRadial.js b/test-gallery/js/galleryRadial.js
diff --git a/test-gallery/js/galleryScatter.js b/test-gallery/js/galleryScatter.js
diff --git a/test-gallery/js/galleryTree.js b/test-gallery/js/galleryTree.js
diff --git a/tests/js/eventTests.js b/tests/js/eventTests.js
diff --git a/tests/js/geoTests.js b/tests/js/geoTests.js
diff --git a/tests/js/helloWorld.js b/tests/js/helloWorld.js
diff --git a/tests/js/markTests.js b/tests/js/markTests.js