I recently came across a situation with redux that I had not considered before. I had created an autocomplete component that was using redux to store its internal state. This was all well and good when there was only one autocomplete component per page but when I have multiple autocomplete components on a given page then a change to one component was reflected in every component as you can see in the screen shot below where selecting a value in one component instance is reflected in all component instances:
The problem is that every component is reading and writing to the same redux store state element.
If you look at the code below that uses combineReducers, there is only one key for the autocomplete state on line 7:
For the record, I am now firmly of the opinion that using redux to store a component’s internal state is actually a bad idea. If I was to code the autocomplete component again then I would store the state internally in the component. I still think there is a place though for an instance reducer.
My autocomplete reducer was working as I would expect with one component so I just needed to ensure that any code change would work with multiple components without changing the working reducer code. I also wanted to make this reusable for other situations. I just needed some layers of indirection in my mapStateToProps and any redux reducer that I wanted to ensure was segrating its global state by instance.
The steps I needed to complete this task would be:
Ensure that any connected component subscribing to redux store state change events had its own unique id.
mapStateToProps subscribes a component to redux store updates. I would create a mapStateToProps that would retrieve the relevant state that would be tagged with the unique identifier mentioned in step 1.
mapDispatchToProps wraps action creators in a dispatch function which sends an action to a reducer and updates the global store. I could hijack this functionality to send a component identifier with each dispatched action.
I would need some capability to wrap any reducer and only mark the state in the store by the unique identifier mentioned in step 1.
For the above requirements, I would create a custom connect function that would call the real connect and add some code to ensure that state was retrived by unique identifier. I would also need a function that added some functionality around calling a reducer.
connectconnects a component to the redux store. It does this by returning a higher order component which abstracts away the internals of subscribing to store updates. Higher order components are one of the many things I love about react.
Below is the function that is returned from what I ended up calling instanceConnect that in turn calls react-redux’s connect.
The above code is what is returned from my instanceConnect function, I will supply the full listing later in the post or you can view it all here.
Line 3 calls the react-redux connect function with a modified mapStateToProps and mapDispatchToProps, I will discuss this later. The returned function accepts a component as an argument which will be the component that receives store update notifications. This connected component which is assigned to the finalWrappedComponent variable will be used in the render function of the higher order component.
Lines 4 - 20 define a component class named InstanceComponent that will be the result of calling instanceConnect.
The main reason for being of the InstanceComponent class is to add a unique id to each instance and also to return the connected component that is constructed on line 3.
An instance id is generated using lodash’s uniqueId utility.
An instanceId property is assigned to a member variable in the constructor on line 9 and this is added to the props on line 18 of the render funtion of the InstanceComponent.
InstanceComponent renders the connected component with the instanceId appended to the props on line 18.
Now that I can identify each component instance with an instanceId property that now exists in the props, I somehow need to communicate this unique id to the reducer so I can only pull back the state that is relevant to each component instance.
Below is my modified mapDispatchToProps that will call the passed in user supplied mapDispatchToProps that wraps each action creator with dispatch:
Lines 6 - 23 iterates over each key in the supplied object and lines 14 - 22 create a modified version of the action creator.
When the action creator is called by the client code, the instanceId is appended to the meta property of the action on lines 17 and 19. The meta property of an action is just a plain object where additional properties can be added without polluting the original payload.
The newly appended action is dispatched on line 21.
Now that I can identify a component instance from the action, I need to use this identifier to pull the relevant redux store state information when state changes are published via mapStateToProps. Below is the modified mapStateToProps that pulls out the instance state information:
The reducerName argument should marry up to the value you give to the key that is supplied to combineReducers.
The instanceId is pulled from the props on line 2.
The observant of you will will notice that I am using immutablejs to store the state.
Lines 4 - 5 use the getIn function of the immutablejs Map which is excellent for dealing with nested values in a state hash. The state either returns the state for that instance if one exists or tries to retrieve data for a property named initialState for this particular slice of the store state pie.
The reducerName property on lines 4 -5 is passed in as an argument from the instanceConnect function that returns the higher order component, you can see the full listing here:
The modified mapStateToProps and mapDispatchToProps are passed to react-redux’s connect.
All that needs to be done is provide a function that can wrap a reducer with some indirection that ensures the state is modified with respect to the instanceId.
Below is the reducer that accepts another reducer as an argument and ensures that the new version of the state is marked with the instanceId.
The instanceId property is retrieved from the meta property that was appended with the instanceId in the modified mapDispatchToProps.
Lines 5 - 9 handles the case when redux invokes the @@init action. There will be no state at this stage and so we call the reducer with undefined on line 6, this will give the reducer the opportunity to supply some initial state. We then append this to a property we will name initialState. This property can then be retrieved in our modified mapStateToProps when there is no instance state.
Lines 11 - 13 simply return the state when there is no instanceId in the props.
Line 15 retrieves any instance state.
Line 17 calls the reducer and passes in any instance state that might already exist. The fact that a reducer is a pure function is critical to this working correctly.
Line 19 updates the state hash with respect to the instanceId by calling the immutablejs setIn function. This update only happens if the state has actually changed.
Usage
With the instanceConnect function ready to use, then it is simply a matter of calling it like so:
I think what is missing would be to remove the component’s state when the component is unmounted and you could also create the slice when the component is mounted. I’ll possibly look at adding that.
If you disagree or agree with any of the above then please leave a comment below.
Here is a full listing of the code file that contains both the reducerByInstance and instanceConnect functions.
Here is a test I wrote to drive out the functionality.
Dealing with asynchronicity in nodejs has been a challenge from day one due to its non blocking nature. The evolution has been slow and the node world has moved from callback hell to promises and from promises to generators.
Transpilers such as babel allow developers to use tomorrow’s unratified features of javascript today and ecmascript7’sasync and await could prove to be a game changer.
I’ve used async and await in c# where its addition is still great but its impact is not quite as dramatic.
With async and await, you can write asynchronous code that for all intensive purposes looks synchronous by marking functions as async and and prefixing function invocations with await to indicate execution will be deferred until a promise is returned from the function call after await.
Below is a very simple async function:
async.js
1234567891011
asyncdoSomethingAsync(){letresult;try{result=awaitgetJSON('/controller/action.json');}catch(e){console.dir(e);}// do something with result}
The function is marked as async with the async keyword on line 1. Any function that will await on the result of a function that returns a promise must be marked as async.
The await keyword allows you to await on the result of a promise. The getJSON function that is called on line 5 returns a promise and any function that is called with await must return a promise to ensure execution is returned to the calling code in the event of a resolved promise just as if the function had been called synchronously. In the event of a promise rejection, the rejection is thrown allowing you to deal with it just like you would with a normal catch handler. This is as close as javascript has ever become to having normal looking code for non blocking asynchronous function calls.
It is worth pointing out that promises are the glue that makes all this possilbe and they are still one of the most important primitives in node.
Setup
Babel transpiles function calls marked with await in async functions to generators.
In order to transpile async and await to javascript generators, you will need to npm install the babel-plugin-transform-async-to-generator package and add a reference to the package in your .babelrc.
Below is my .babelrc that allows me to use async await and other features:
I recently wrote this csv parser that applies transformations from a csv file input to a destination database table using the excellent knexjs query builder package.
The package uses csv-parse which transforms the csv file of delimitted rows and columns into arrays or objects. CSV-Parse implements the node stream.Transform API.
Csv-parse creates a readable stream that emits data events each time it encouters a chunk of data. CSV-Parse allows me to bind to a readable event that gets passed a row of a csv file for each row in that particular file.
The package I wrote allows the user to specify transformations from a source csv file to a destination table. Some of these transformations might involve one or more asynchronous actions that could end up as some pretty messy code if I just used promises so async and await seemed like a great fit. I will post the original code at the end of the post that used promises and it is very hard to follow and deeply nested.
Below is the code that hooks up the csv-parse stream events to member functions in the class that will handle the events:
Line 6 specifies that the onReadable is bound to the readable event of the stream.
My first attempt at using async and await with the stream is below where I marked the onReadable function that gets rows of csv data passed to it as an async function:
The code calls createObjectFrom on line 12 which is itself an async method that returns a promise and adds it to the this.records array that will be used to persist the transformed values to the database.
Below is a scaled down version createObjectFrom which transforms the csv record into a JavaScript hash of values:
The code loops over an array of transformations, one of which might be an async call to knex on line 9 to retrieve a value from the database.
A promise is returned on line 23 to allow this function to be called with async and await.
I wrote a test to test this function in isolation and I was buoyed when it passed but when running the code for real with stream readable events being raised, the this.records array was empty when it the end event of the stream was reached:
stream.js
123
onEnd(){console.dir(this.records);// []}
This is because the onReadable function is not being called async from the csv-parse module that raises the evnets.
After much head scratching the answer was to return a promise from createObjectFrom. But the interesting part of this solution was that I was able to mark the function that gets passed to the Promise constructor as async on line 2 of the code below:
On line 2, I mark the anonyous function that gets passed to the Promise constructor as async and this allows me to invoke functions with await and only resolve the promise on line 24 when all the processing has finished.
The onReadable event that calls this function now looks like this and is no longer async:
This works nicely and is much better than the Promise handling code at the bottom of this post.
async and await in tests
Async and await can also be utilised to make your testing code much simpler and synchronous looking.
Below is my test to ensure that the records are being inserted into the database:
test1.js
1234567891011121314151617181920
describe('transformer',()=>{it('transforms the data, imports the csv file and creates the records',async()=>{constignoreIf=(data)=>data[3]!=='Liverpool'&&data[4]!=='Liverpool';constopts={table:'results',file:__dirname+'/fixtures/test.csv',encoding:'utf8',transformers,ignoreIf:ignoreIf};awaitseeder(opts)(knex,Promise);constresults=awaitknex('results');expect(results.length).to.equal(2);constfirstResult=results[0];constteam_id=awaitknex('teams').where({name:'Wimbledon'}).select('id');expect(team_id[0].id).to.equal(results[0].team_id);expect(manager_id).to.equal(results[0].manager_id);});});
Normally when testing promises from mocha, you have to return a promise from the mocha it function in order for execution to wait until the promise has resolved but as I have marked the anonymous function on line 2 as async, I can simply await (line 6) for the asynchoronous csv parsing code to finish before testing the results.
I can also make further asynchronous calls in the anonymous function like I am on line 14 and await their results before asserting expectations.
This is flatter and synchronous looking code that we all know well.
Below is the code I mentioned previously which used promises instead of async await and is pretty damn nasty.
Below is the end result of this post or you can see a live demo here. This will not work for IE11 or before.
The sass/css of this post can be found on github here.
In the dark ages of at least 4 years ago, jQuery used to be the defacto way of creating smooth transitions between elements but now css animations and their promise of hardware accelaration are becoming a standard in all modern browsers. Vendor prefixed css rules are now disappearing into the ether with the usual exception of internet explorer as the standard becomes ratified.
I’ve only just recently discovered the 3D qualities of css3 and I found it pretty easy to cobble together this rotating cube. You can find the css/sass here.
I then created a hexagon which was pretty similar. Here is the sass.
I then tried to create the pyramid in the screenshot above which took me considerably longer to acheive the end result.
CSS Coordinate System
Before diving into the code, it is important to realise that the coordinate system used by css transforms to position elements is slightly different than the 3D coordinate system you may have previously learned in geometry. In the css coordinate system, the y-axis and the z-axis are the positioned the other way round from what I learned in maths with the y-axis acting as the vertical axis and the z-axis acting as the guage to slide elements forwards or backwards from the user.
Pyramid Container
The pyramid will be constructed of five divs with four divs making up the triangular faces and a rectangular div for the base.
Line 6 contains the opening tag for the pyramid-parent div that will act as a container for the pyramid structure.
The css for the pyramid-parent is below:
parent.css
123
.pyramid-parent{perspective:800px;}
The perspective rule on line 2 defines how the depth of the 3D scene is rendered. Think of perspective as a distance from the viewer to the object. If you apply 3D transforms without setting the perspective, elements appear flattened.
The pyramid-parent element encloses a further div with an id of pyramid that has the following css rules assigned to it:
pyramid.css
123
#pyramid{transform-style:preserve-3d;}
The transofrm-style rule on line 6 specifies how the children of an element are positioned in 3D space or are simply flattened. The default is flat and a value of preserve-3d instructs the browser to position the elements in 3D-space. Without this property set, the pyramid would appear as a 2d triangle. The screenshot below shows how the pyramid looks without the preserve-3d value set:
CSS Triangles
The first challenge was how to create triangles using only css. Some slight of hand and a bit of css skullduggery is required to create an equilateral triangle like below:
Below is the css that creates the effect:
skullduggery.css
123456789
.skullduggery{width:0;height:0;border-left:200pxsolidtransparent;/* left arrow slant */border-right:200pxsolidtransparent;/* right arrow slant */border-bottom:200pxsolid#2f2f2f;/* bottom, add background color here */font-size:0;line-height:0;}
The secret to these triangles is creating giant borders to the two perpendicular sides to the direction you would like the triangle to point. Make the opposite side’s border the same size and background colour. The larger the border, the larger the triangle.
Pyramid Maths
Unsurprisingly, positioning elements in 3D is considerably more difficult than in 2D and thankfully, the trigonomic ratios came to the rescue to correctly judge both the length of the elements and the angles of the pyramid.
Below is an image that labels the important parts of the pyramid:
All positioning takes place around the yellow right angle triangle in the above diagram. I first of all determined that I would like an angle of 60Â° for the slant angle of the triangle or the angle between the apothem and the base. The apothem is the slant height of a lateral face of the pyramid. With this angle and assigining a width to the base of the triangle, I could work out both the height of pyramid and the apothem height.
Once I know this, I can determine the lengths:
apothem = (½ Base) / cos(Î±)
height = (½ Base) * tan(Î±)
apex angle = 180 - 90 - Î±
Where Î± = 60Â° and I took the Base = 270px.
One of the nice features of sass is that we can use variables like you would in a normal programming language to stop repeating the same values in css and also mean I can calculate other values from existing variables, something very lacking in current css.
I am using node-sass and I could not find a way of using the trig functions in the sass. This is possible with compass in ruby sass but I don’t know of a way in node-sass of achieving this so I had to calculate the value of the apothem height in a calculator first.
What I wanted to achieve with these vaiables was to be able to only set the $base width variable and every other value would be derived from that. Sadly as I cannot reference the trigonomic cosine trig function from the sass, I had to manually set the $apothem or slant height variable.
The $apex-angle on line 4 is the angle each triangle will be rotated along the x axis in order to tilt each triangle into the centre or apex.
Constructing the pyramid
I will now break down the steps I took to arrange the base and four sides of the pyramid. I will omit the many wrong turns I took in getting here.
Below is another view of the markup that makes up the pyramid:
The width and height of the div are set on lines 3 and 4 and the transform property on line 6 is arguably the most important css3 property when it comes to positioning elements in the 3D space. This property allows you to rotate or move elements in each of the x, y or z 3D coordinate axes. With the base div, I use rotateX to rotate the element 90Â° along the x or horizontal axis axis to give the impression the div is lying flat and viewed at an angle.
The translate3d property is also used to move the div along the z axis. The translate3d property takes 3 values that can be used to move the element along the x, y or z axis respectively. In this example I am using the $base-move variable that was derived from the base div width to shift the div away from the user along the z axis.
This shifts the div along the z axis or appears to move the div away from the user. This value is important when it comes to positioning the four bases of the triangle divs. Below is how the base looks with these rules applied:
The following generic rules are applied to the triangle divs:
traingles.scss
12345678
#pyramiddiv:not(.base){position:absolute;border-left:$half-basesolidtransparent;border-right:$half-basesolidtransparent;border-bottom:$apothemsolid;transform-origin:$half-base$apothem0;/* bottom of trangle (1/2 Base, Apothem) */opacity:.5;}
The transform-origin property on line 6 provides a convenient way to control the origin about which transforms using the css transform are applied.
Below is how the front face of the pyramid looks without the transform-origin property set:
And below is a screenshot with it set:
Each face will be moved along the x or horizontal axis by half the base width and will be moved down the y axis by the apothem or slant height. transform-origin must be used with the transform property as it only changes the positioning of transformed elements.
Each triangle will be rotated by a multiple of 90Â° to orient each triangle for a different face of the pyramid (respctively 0Â°, 90Â°, 180Â°, 270Â°).
With this in mind, each triangle will have its own rules to set this, in the case of the front face, the following css properties are set:
The keyFrames rules allows you to gradually change one set of css rules for another which is specified in the from and to properties in the code below:
In the above code the a gradual rotation around the y axis is specified by starting at 0 degrees and completing at 360 degrees. Once the keyframes rules are specified you then need to associate it with an element via the animation property.
animation.scss
123
#pyramid{animation:spin8sinfinitelinear;}
The name of the keyframes animation is specified along with the length of the animation. The infinite values states that the animation will continue infinitely and linear specifies that the animation speed is constant throughout the animation.
Following up from my last post, I have created yet another sine wave animation (YASWA) and I want to blog about how I achieved a smooth animation for the svg path shapes and arcs with d3.js.
I am not going to go over how to set up the basic shapes in the animation, you can find out how that is done by referring to my last post.
The 3 path shapes that I found challenging to animate are the red sine wave that is progressively added and removed from the document as the unit circle rotates along the x axis and the two blue angled arcs that form the small angled arc at the centre of the centre of the larger circle and the blue arc that expands around the circumference of the larger unit circle.
The first step is to append the paths to an svg group element. Their initial position is not important at this stage.
There is a state object (line 1) that is used as a container to hold a reference to all the svg shapes that will be transformed on each tick of the animation. The shapes are added as properties of the state object. The sine curve path shape is added to the state object on line 10 and the two path shapes that will render the arcs are bound as properties of the state object on lines 13 and 17 repectively.
Line 3 creates a d3.js line function that will be used to generate the rather cryptic svg path mini language instructions for the d attriute of the svg path shape that will plot the points of the sine curve.
A sineData array is initialised on line 8 and the line function will be executed for every element in the array and the x and y accessor functions on lines 5 and 6 will be executed exactly once for each element in the array. Obviously as the array is initially empty, these functions will not be invoked until there actually is some data.
Now that the the svg shapes are on the document, the next step is to kick off the animation function:
line 3 initialises a state.time variable that will be incremented on each tick of the animation. This variable is central to all calculations that will be used to position.
The body of the animate function that is called on line 5 of the above code snippit takes the following form:
animate.js
123456789101112131415161718192021
animate(state,direction){if(direction.forward){state.time+=state.increase;}else{state.time-=state.increase;}// position shapesif(direction.forward&&state.time>(Math.PI*2)){direction={backwards:true};}if(direction.backwards&&state.time<0){state.time=0;direction={forward:true};}requestAnimationFrame(this.animate.bind(this,state,direction));}
The state.time counter is either incremented or decremented on each tick of the animation depending on whether the animation is moving forwards or backwards.
Lnes 11 to 18 make a simple check of whether the time is greater than 2Ï€, in which case it is time to start animating backwards or if the animation is moving backwards and time is less than 0 then the shapes need to move forward. The current direction is passed into the animate function with each call to requestAnimationFrame.
My first attempt at incrementally drawing the sine wave was to add and remove the sinewave on each call to animate but this led to a very jerky horrible visual effect as the browser struggled to recreate the curve each time from the origin.
The solution was incredibly simple and I simply make a call to a function called progressSineGraph that is listed below:
The state object that contains references to all the shapes and properties that are needed to perform the animation is passed into the function along with the direction argument that specifies whether the shapes are animating forwards or backwards.
The code between lines 2 and 6 either adds the current value of the time variable to the sineData array if the animation is progressing forward or removes the current head of the array if the animation is moving backwards. The elements of this array will be used to plot the sine graph.
On line 8 the d attribute of the path shape is set to the state.sine function that is listed below. As mentioned earlier, the d attribute contains the mini language instructions to plot the curve. The line function will generate the instructions by calling the function below for each element in the array:
The line function will be called for each element int the array and x and y coordinates will be created by calling the x and y accessor functions that accept the current element as an argument.
I was pretty amazed how easy this technique is to animate shapes progressing or regressing.
The d3.js line function is a great abstraction and you can see what the generated output of the line function looks like below. The state.sine function has created the d attribute of the path shape that contains the instructions to draw the sine curve. I know which I would rather work with:
It is also worth noting that montone interpolation is set to ensure a smooth curve is drawn.
Animating the Arcs
All of the shapes in the animation are interlinked in some certain way and all the calculations of where to place the shapes on each tick of the animation are based on the incrementing state.time counter.
The black line that rotates from the centre of the circle to the circumference can be thought of as the hypotenuse of a right angle triangle. The hypotenuse in this document is an svg line shape with x1, y1, x2 and y2 properties that are set using cartesian coordinates to position the shape.
The two arcs that form the angle at the centre of the circle and at the circumference will also use the hypotenuse coordinates once they have been calculated.
Below is the code that positions the svg line shape on each tick of the animation:
Once the x1, y1, x2 and y2 corrdinates have been calculated, they are bound as properties of a hypotenuseCoords object that can be referrenced later. Lines 15 to 18 positions the shape.
We can now use basic trigonometry and the d3.js arc function to create the arcs. The arc function is also a to the d3.js svg line function as it also generates instructions for the path shape’s d attribute but it also has some additional properties such as the innerRadius, outerRadius, startAngle and endAngle properties that are specific to generating arcs.
Below is the code that sets the properties pf the two arcs:
The main calculation takes place between lines 1 and 10 and I would love somebody to tell me there is a better way than this. I always find that if I have used let to declare a variable and later reassign the variable after initialisation, this usually tells to me that I have got something wrong or I have taken the wrong path.
In order to set the angle each time, I need a to give the d3.svg.arc function a startAngle and an endAngle each time the function is called.
The startAngle properties of the 2 arcs are set on lines 15 and 20 and I am using a static value of PI \ 2 which is 90 degrees in radians. This is because a startAngle of 0 will position the startAngle at 12 o’clock on the circle and I want it to be at 3 o’clock or 90 degrees.
On line 1 the atan2 function is called to find the angle that the hypotenuse makes with the startAngle of the arc or 0 on the y axis property.
Arctan2 is different than arctan because it takes 2 arguments and returns an angle in the correct quadrant. If you are unfamiliar with the 4 trigonometric quadrants, you can read about it here.
The atan2 function takes into the account the two signs of the arguments that are passed in and places the angle in the correct quadrant. In this example the angle of the hypotenuse is found by subracting the y2 and y1 properties and subtracting x2 and x1 of the hypotenuse and passing them into atan2. atan2 returns the angle in radians between Ï€ and -Ï€. Thus, atan2(1, 1) = Ï€/4 and atan2(âˆ’1, âˆ’1) = âˆ’3Ï€/4.
My first attempt at drawing the arcs did not contain the readjustment of the angle variable below;
angle.js
123
if(angle>0){angle=(-2*(Math.PI)+angle);}
Without this readjustment, the arcs where being rendered like this:
This is because atan2 returns the angles between Ï€ and -Ï€ and the angle was being calculated correctly for rays in quadrant 1 and 2 but not what was required for quadrants 3 and 4. The readjustment of (-2 * (Math.PI) + angle) gives same ray but in the correct direction when in quadrants 3 and 4 by adding the angle onto -2Ï€.
Epilogue
I am very happy with the end result. If you can suggest a better way for any of the above then please a comment below.
I have spent the last year learning some of the maths I should have learned about 27 years ago. One of the things that I have found interesting while learning maths is the relationship between the unit circle and a sine wave graph of y = sin(x).
A sine wave is a mathmatical curve that describes a smooth repetitive oscillation and the unit circle is a circle of radius 1 centred at the origin (0, 0). The unit circle can be used to find special trigonometric ratios as well as aid in graphing. There is also a real number line wrapped around the circle that serves as the input value when evaluating trig functions such as sine and cosine.
A sine wave is a periodic function or a function that repeats itself at regular intervals. The most important examples of periodic functions are the trigonometric functions that repeat themselves over intervals of 2Ï€. One journey around the unit circle is 360 degrees or 2Ï€ in radians. A sine wave shows the excursion around the circle happening in time and is ultimately a circle expressed in time. I have used d3.js to illlustrate how the journey around the circle corresponds to the sine wave movement over time.
There are a number of concepts that I wanted to capture in the animation:
Illustrate where the input value of the unit circle corresponds to the (x, y) coordinate on the horizontal axis of the sine wave.
Demonstrate how the right angle is formed by the angle of the radius moving counter-clockwise around the unit circle.
Show the number scale of the unit circle in radians as ratios in proper mathmatical notation in the browser in both the unit circle and the x axis of the sine graph. MathJax appears to be the only show in town that fits this requiremnt.
This process of creating graphs from the unit circle is often called unwrapping the unit circle.
Unit Circle Setup
The first step is to create the basic shapes that will illustrate the unit circle and use cartesian coordinates to position them. D3.js has an excelent scale abstraction that allows you to deal in a finer grained scale than pixels. I can now think of the dimensions of the svg document as a 20 x 20 grid which makes positioning things easier to reason about.
On lines 6 and 10 of the above code, horizontal x and vertical y scales are created and bound to two variables. These d3 scale functions take the input domain of 0 to 20 and map it to an output range of either the viewport width for the horizontal x axis or the viewport height for the vertical y axis. It is much easier to think of cartesian coordinates ranging from 0 to 20 than the very fine grained pixel scale.
With the scales in place, it is much easier to start positioning the elements:
An svg group element or a g element is created on line 5. All elements will be added to this group or container. Transformations applied to an svg group or g element are applied to all elements in the group which makes it extremely useful.
The three lines that will form the right angle triangle are created and bound to the adjacent, opposite and hypotenuse variables using the d3.js svg line shape. The initial values of the triangle line’s x1, x2, y1 and y2 coordinates are irrelevant at this stage, they will be set on each tick of the animation. It is just important to get them onto the document during the initialisation phase.
The larger unit circle is created and appended onto the group on line 10 of the above snippet and another smaller circle is added on line 38 which will be positioned counter-clockwise around the large circle by setting its cx and cy coordinates on each tick of the animation. This will give the impression that the small circle is rotating around the larger circle.
Below is how things look so far:
The next stage is to add the number line in radians of the unit circle:
Number Scale
In order to divide the circle into 8 lines and position the labels, I can kill two birds with one stone by creating an array of objects which have label and angle properties that I can iterate over and create the lines and labels:
Lines 2 to 11 define the array of objects to iterate over. Each object contains a val property that can be thought of as an angle to move counter-clockwise around the unit circle for each element in the array. There is also a label property which is the text of the angle in radians. The cryptic syntax of the label is written in LaTex, which allows you to define mathmatical notation that can be displayed in the browser. Mathjax will later parse these labels into authentic looking math symbols in the browser. More on my difficulties with MathJax at the end of the post.
On lines 12 and 13 the x and y coordinates are determined for each angle value in the array. By finding the cos(x) * radius and sin(x) * radius of each angle in the iteration of objects, I can ascertain the (x, y) coordinates of the point on the circumference of where to position the radian label and of where do draw the dividing line that will show the number scale on my unit circle.
Lines 15 to 16 add offset values for each x and y coordinate to ensure the labels all appear outside of the circle and not flush on the circumference.
Line 18 adds a new svg group element and the textual label is added to this newly created group.
Line 24 simply adds a line from the centre of the circle to the x and y coordinates on the circumference.
Before MathJax does the parsing, the circle looks like this:
A similar approach is used to create the sine graph axis but instead of iterating over an array, a pair of d3.js axis are created and latex syntax is used for the tickValues of the x-axis.
My first step is to create a hash of values that I have unimaginatively called state that serves as a container for all the elements and dimensions that I am going to need to transform the svg elements on the documents. I am going to pass this state object into the animation function that will set the new position of the elements on each tick of the animation. After that, the animation is kicked off with a call to drawGraph:
Arguably the most important value in the above is the time property on line 15 which will provide the x value of the horizontal value of the sine graph. This will be incremented on each tick of the animation.
Every time the drawGraph function is called, the time property of the state variable is incremented by roughly 1 degree on line 4 to simulate time moving along the x axis. I do the same on line 5 for the circle that travels along the x axis. I have a separate counter as I need to reset it to zero each time the xIncrement variable exceeds 2Ï€.
Line 7 calls the drawSine function that draws the sine wave on each tick of the animation. More on this later.
Lines 9 to 17 positions the small circle that traverses along the horizontal x. The counter for this coordinate is reset each time it exceeds 2Ï€.
The rest of the code in this function takes care of finding and positoning the shapes on the unit circle to simulate the small circle rotating counter-clockwise on the unit circle and constructing the right angle triangle.
Lines 19 and 20 find the next x and y coordinates of the next point on the circumference to position the small circle that rotates the larger circle and bind them to the variables dy and dx. I use minus in the expression radius * -Math.sin(state.time) because we want to simultate rotating back counter-clockwise. Once we have this coordintate it is easy to position the three lines that make up the right angled triangle on lines 26 to 38.
Line 49 calls requestAnimationFrame which tells the browser that you wish to perform an animation and requests the browser call a specific function, drawGraph in this instance, before the next browser repaint.
I am also using a lesser known overload of bind on line 37 that creates a new partially applied function with some or all of the arguments already bound each time it is called. I have blogged about this previously here. In this case, the state hash will be bound every time the function is called because I am passing it into bind as an extra argument after this. I use this technique a lot in javascript land.
Animating the Sine wave
Now to the meat and potato of the piece, namely animating a smooth sine wave. The sine wave is mathmatically a very simple curve and a very simple graph. It is a simple x-y plot with the x-axis representing time and the y-axis representing angular displacement around the unit circle.
Below is the drawSineWave function that is called on each tick of the animation:
The upper bound of the array which is 53 is chosen to fill the available width in the viewport
I will come back to why the calculation on line 5 is needed but on line 6 I do a further map of the array that was initialised on line 4 to create an x and y coordinate for each element in the array that can be used to plot the sine wave. The x coordinate is simply the element of the array and y is calculated by getting the negative sine of x because we are simulating the sine wave moving counter-clockwise. For each tick of the animation we simply subtract the state.time variable that we have used previously from x. If you look at the animation, you can see how the small circle in the middle of the unit circle moves up and down at exactly the same rate. Maths in action!
Below is how the sine wave looks without the transformation .map(x => x * 10 / 84) applied to the original array:
If we just use integers to plot the points we get the rough sine wave but if we use floats, we get a much smoother flowing sine wave. I multiply each value by 10 to space it out across the width and then divide by 84 to ensure I get a float back. 84 was arrived at by trial and error to ensure the wave spans across the graph.
Once I have my coordinates to plot the curve, the following code takes care of creating the curve on each animation tick:
Lines 7 to 10 define a d3 line function that will be used by the svg path element on lines 12 to 15. The d3 line function can be thought of as a path generator for a line or in this case a curve as the interpolation mode is set to montone interpolation in order to create a smooth curve for the sine wave. The line function will take the data array (sineData) and convert it into the rather cryptic svg path mini language instructions that the svg path element on lines 12 to 15 will use to construct the curve. We define accessor functions on lines 9 and 10 that will be called for every x and y coordinate of the sineData array on line 1. A monotone interpolation will then be performed by the path function for each point. Every x and y is mapped to the correct scale on lines 3 and 4.
Lines 12 to 15 attach the path element and sets its data via the datum attribute. The d attribute sets the path data or the mini language of path commands that the line function on line 7 will generate. The x and y accessors of the line function are invoked exactly once for each element in the array.
MathJax
All that remains is to tell MathJax to parse the latex into math symbols. I cannot believe how hard I found this. Below is how the code ended up after a lot of coffee, profanity and self doubt:
First of all MathJax did not seem to play nicely with react, I have to use a wait function to suspend execution until the MathJax is available. On lines 12 to 18 can best be desribed as extreme hackery. I have tagged any element on the svg document that contains latex with the tick css class. I add a hook to mathjax that is called whenever it has done its first parse, I then remove the svg element that was added by MathJax and re-add it again. This causes MathJax to reparse the markup and the symbols are rendered correctly. I don’t know if it was the fact that this is a react site that made this so difficult but it really did not play well with this site.
I am available for work right now, if you are interested then email me directly.
Following on from my last post on axes positioning, I have added the functionality to add a tangent to the curve on mousemove. You can see a working example here by dragging the mouse over the svg document.
Below is a screenshot of the end result:
The first steps are to create the elements that I will use to display the tangent indicator and also to hook up an event listener for mousemove on the svg document:
The above creates a circle to indicate where on the curve the mouse is relative to the x axis. A label is created to display the coordinate that the mouse is currently on with respect to the curve and lastly I create a line that will display the tangent.
Line 19 adds a mousemove handler to the svg element that has been previously created with the code below:
With this, I can use mathematical differential calculus to work out the tangent line. If I was to perform these steps with pen and paper, I would take the following steps:
Find the derivative of the curve
Substitute the x retreived from the mousemove event into the derivative to calculate the gradient (or slope for the US listeners) of the line.
Substitute the gradient of the tangent and the coordinates of the given point into the equation of the line in the format y = mx + c.
Solve the equation of the line for y.
What was surprising and enjoyable for me was that the steps on paper transferred into machine instructions quite well which is not always the case.
Before I plot the line, I want to position my circle and label onto the curve. I am already using the excellent mathjs library to get the coordinates to draw the curve:
Line 2 of the above code uses mathjs’s parse function to create an expression from the string input of the form:
Once I have the expression, I can evaluate it with different values. Lines 5 and line 9 evaluates the expression for each x value in a predetermined range of values. Line 19 plots the line.
As I know what x is from the mouse event, I can use mathjs to parse my expression with respect to x and get the y coordinate to position my label on the curve:
Lines 2 and 4 retrive x from the mouse event and line 6 evaluates y by parsing and evaluating the equation of the curve with respect to x. I then use the x and y coordinates to position my label elements.
Mathjs does not come with its own differentiation module to work out the derivative of the user entered expression but I found this plugin that seems to work out well for this task.
Armed with this module, it was plain sailing to create an equation for the tangent line that I could use to find out y values for the tangent.
constderivative=math.diff(math.parse(me.props.expression),"x");constgradient=derivative.eval({x:point.x});constyIntercept=getYIntercept(point,gradient);constlineEquation=math.parse("m * x + c");constgetTangentPoint=(delta)=>{constdeltaX=xScale.invert(x+delta);consttangentPoint={x:deltaX,y:lineEquation.eval({m:gradient,x:deltaX,c:yIntercept})};returntangentPoint;};constlength=xScale(200);consttangentPoint1=getTangentPoint(+length);consttangentPoint2=getTangentPoint(-length);g.select('.tangent').attr('x1',xScale(tangentPoint1.x)).attr('y1',yScale(tangentPoint1.y)).attr('x2',xScale(tangentPoint2.x)).attr('y2',yScale(tangentPoint2.y));
Line 1 creates a derivative function from the equation of the curve.
The derivative function is evaluted to get the gradient or slope for the US viewers on line 3.
The c constant or y-intercept of the equation of the line y = mx + c is retrieved on line 5.
Mathjs is employed to create an expression in the format of y = mx + c.
A getTangentPoint function is created that will be used to get the points at either end of the function.
Lines 24 - 26 create 2 points for x that will be far off the length and height of the svg document to give the impression of stretching off to infinity.
Each point gets its y value by calling the getTangentPoint funtion on line 9 that in turn will solve for x for the equation of the line function previously created on line 7.
Once we have the pair of points, the line can be plotted on lines 29 - 33.
I am available for work right now, if you are interested then email me directly.
Up until now when I have been dealing with d3.js’s axes components, I have always kept the axes positive, i.e. both the x and y axes where showing values greater than 0.
I have been hacking around with this fun side project that takes the input of an algebraic expression and plots a graph for a sample range of values for x. You can checkout the source code here if you are interested.
Below is a screenshot of the end result:
It quickly became apparent that in order to show the curve of the expression properly, I would need to construct negative and positive x and y axes.
I have the following function below that constructs the data of x and y coordinates to plot the curve against which uses the excellent mathjs library to transform the string algebraic expression into a javascript function (line 2). I then create a sample range for x values ranging from -10 to 11 and evaluate the y coordinate for each item in the range by applying the function on line 5 to each item:
The domain function of d3 allows you to specify a minimum and maximum value as the range of values that we can use for a particular axis.
Below I am using d3’s extent function that returns the minum and maximum values of an array and is equivalent to calling d3.min and d3.max simultaneously.
As I am supplying the values for the range of x values in the code above, I know that I will always have negative x values and positive x values.
The y coordinates are different depending on the function generated from the algebraic expression. Depending on the expression, there are basically 3 conditions I want to capture when displaying a curve.
The first case is when there are only positive y values:
The next case is when there are both negative and positive y values;
Lastly, only negative y values:
With this in mind, the code below creates a domain based on the minimum values of y and the maximum values of y:
I either start my domain at 0 or use d3.extent again to get the maximum and minimum values for y like I did before for x.
The last problem to solve was to position the x axis. In the 3 code samples below, I am capturing the domain for y and the x axis position for each condition.
This is easy if I only have negative or positive values for y. I can simply place the x axis at the bottom for only positive values:
The interesting case was when I have both positive and negative values for y.
What I ended up doing was selecting all the ticks or labels from the y axis and finding the label that had 0 against it and from that I could use d3 to to select its position and then use that for my x axis position.
In the code above, I filter out all the other ticks apart from the 0 label. The zero tick is then passed into the map function which selects the transform attribute of the tick which might look something like this translate(0,280). The second value of translate, 280 in this instance gives me the position of the 0 label in the y axis. I can use this value to position my x axis.
Once I have the position of 0 in the y axis, I can position the axis to the document:
You can change the current triangle effects by changing the radio buttons at the top. You can also drag and drop the triangle vertices by dragging the red circles at each triangle endpoint or vertex. This led to an interesting problem, which was how to how to maintain the current state or coordinates of all the shapes when the user selects a new effect from the radio buttons.
Another, more challening problem was to make sure that everything resized to the current ratio or scale if the browser window is resized. If you go to this url and resize the browser, you can see that everything re-renders nicely to scale. This does not happen out of the box. You need to code for this eventuality.
The bulk of the work takes place in the render method below:
The render function as you might expect, creates the svg document and renders all the shapes onto their specific coordinates as I outlined in the previous blog posts here and here. I use this function to both initially draw the shapes and also as the function that is attached to the resize event.
Below is the end of the render function that creates a hash that will keep track of the current state of the document or the coordinates of the all the shapes at any given time.
Lines 1 to 3 create a the hash and assign the xScale and yScaled3 scale objects that allow you to deal with a finer granuated scale than pixels. The x and y axis in the documment were created using these scale objects and you can think in terms of placing these objects at coordinates on these scales, e.g. (1, 1).
Lines 6 to 29 assign properties to this area hash such as the vertices of the triangle that will be used to read and write to when drawing the shapes. I pass this structure into most functions.
Line 31 uses the lesser known partial application properties of the bind function to create a new version of the render function. This partial function when called, will always be called with the area hash as an argument, that contains all the information we need to reconstruct the document. Line 33 adds this function to the hash, we will use this to remove the event listener each time it is called or else there will be a memory leak. LIne 35 creates an event listener for the resize event and assigns the new version of render to this event.
The beginning of the render function below uses the new es6 default paramaters feature to allow render to be called with no arguments or called from the resize event with an argument. If it is called in response to a resize event then there will be a state argument. Lines 2 to 5 remove the event listener each time it is called.
If we have a state hash then the invert method of the scale objects is used to get the value in pixels before using the scale to recreate the new x and y coordinates that are in scale with the new browser dimensions.
I also use partial application when adding the drag and drop event to the red circles at the vertices of the triangle on line 22 of the below:
Following up from my last post on how to draw the altitude of a side of a triangle through a vertex, I wanted to draw the 3 perpendicular bisectors of a triangle and the circumcircle of the triangle.
Let us get some definitions for these terms, the perpendicular bisectors of a circle are described as:
the lines passing through the midpoint of each side of which are perpendicular to the given side.
Below is a triangle with one perpendicular bisector running through side AB
.
The circumcircle of a triangle is:
The point of concurrency of the 3 perpendicular bisectors of each side of the triangle.
The centre point of the circumcircle is the point of intersection of all the perpendicular bisectors of a triangle.
Below is a triangle with all 3 perpendicular bisectors and the circumcircle drawn with d3.js.
The first step was to draw one perpendicular bisector of a triangle.
I chose 3 arbitary points for the vertices of the triangle.
This is all the information I need, to calculate the perpendicular bisectors and the circumcircle.
If I wanted to find the perpendicular bisector of AB using pen and paper, I would perform the following steps:
I would find the gradient or slope (for US readers) of the point AB.
I would then find the perpendicular gradient or slope which would give me the ratio of rise over run that the perpendicular line flows through. If lines are perpendicular then M_{1} x M_{2} = -1.
I would find the midpoint of the line using the distance formula ((x_{1} + x_{2} / 2), (y_{1} + y_{2} / 2)).
I could then plug these values into the equation of a line which takes the form of y = mx + c.
I have blogged previously in this post about how to set up the graduated x and y axis and a more managable scale for positioning vertices etc.
My first step was to find the perpendicular bisector of the line AB.
Below are two helper functions that take javascript point objects as arguments with x and y properties that map to coordinates and return either a gradient/slope or the perpendicular gradient/slope that occurrs between the 2 coordinates:
The x-intercept on line 5 is again re-arranging the equation of the line formula y = mx + c to solve for x.
The finshed function looks like this and there are a number of if statements I had to add for the conditions when the slope or gradient function might end up undefined or equalling infinity when it encounters horizontal or vertical values that have catches with the formula. I would love to know if there is an algorithm that will avoid such checks:
In order to find the centre of the circumcirle or the point of intersection of the perpendicular bisectors, the function takes two arguments lineA and lineB which are two of the perpendicular bisectors of the traingle. The function then arranges these line objects into y = mx + c format on lines 6 to 11 of the above. I then solve these equations simulataneously using matrices and specifically using cramer’s rule to find the point where the line intersect.
Once I have the 2x2 matrix assembled on lines 13-16, I then pass it to the solveMatrix function with the 2 y-intercept values that will apply cramer’s rule:
I now have the point of intersection of the perpendicular bisectors. All I need to know now is the radius of the circle. The calculation I used is to use the distance formula. From the point of intersection we just found to one of the vertices of the triangle.
Below is a helper function for the distance formuala:
I’m back at college learning the maths that I should have learned a long time ago. I am also trying to kill 2 birds with one stone by using what I’ve learned to help me learn d3.js at the same time. The task I set myself this week was to draw the altitude of a triangle through a point.
In geometry, an altitude of a triangle is a line segment through a vertex (point) and perpendicular (i.e. forming a right angle with) a line containing the base (the opposite side of the triangle). This line containing the opposite side is called the extended base of the altitude.
My first steps are to create a scale that is of much lower resolution than the finely grained pixels and below is the code that creates both the scale and the axis. I blogged about scales in more detail in my last blog post:
This is effectively a DSL or mini-language for drawing shapes.
I’ll add a translation for each line:
'M ' + a.x +' '+ a.y + - This means place a point at the x and y coordinates of the point I previously created with var a = {x: xScale(1), y: yScale(1)}. This is analgous to the starting point where you might place your pen.
' L' + b.x + ' ' + b.y + - This means draw a line created from the point created above to the point b that was declared like this b = {x: xScale(6), y: yScale(18)}. Because we are using scales, we can pick nice friendly points like (6,18) rather than the harshness of pixels.
' L' + c.x + ' ' + c.y + - draw a line to the c point
the z command closes the path.
I really like the path function as it is how a human would draw a triangle with pen and paper and is very easy to grok.
With the easy bit done, I now wanted to draw the altitude through point A that would be perpendicular to line BC.
If I was doing this with pen and paper, I would perform the following steps:
I would find the gradient (or slope for those of you from the US) of the line BC.
I would use this gradient/slope to create the equation of the line in y = mx + c format.
I would find the perpendicular gradient/slope of BCthat I can use to create an equation of the line that will go through point A and will be perpendicular to point C in y = mx + c format.
I would then solve these simultaneously to find the point of intersection from point A to the point on BC that was perpendicular to point A.
What I quickly found out was that transfering pen to paper calculations to machine instructions or javascript was extremelly difficult and different. Here are the steps I took:
Like in the pen and paper version, I found the grandient of BC and created this function:
In order to get both line equations into y = mx + c, I needed a function that would take a point and a gradient and give me the y-intercept or the point where the line cuts the y-axis:
I would use the substitution method or the addition method to solve a series of equations with pen in paper but writing it in code was a different matter and matrices seemed like the obvious fit. Please write a comment below if there is a more efficient way. There is cramer’s law which seemed ideal for my needs. I needed to get my vars into the following format:
matrix.js
12
[x1,y1][x]=[c1][x2,y2][y]=[c2]
Below is my altitude function that gets the values into matrices before passing to a function that will use cramer’s law to find the point of intersection.
I want to add drag and drop to rotate the triangle so I’ll probably need to put checks in for vertical and horizontal values for x and y but this will do for now.
Below is the end result of my troubles with the altitudes of all three vertices shown.
The hardest part was to solve the simultaneous equations and I belive there is a better and more efficient way that uses vectors to work this out but I have not covered this with my course as yet.