Api demos #2

codejaeger · 2021-06-13T13:34:49Z

PR Checklist

If you are contributing to Javis.jl, please make sure you are able to check off each item on this list:

Did I update CHANGELOG.md with whatever changes/features I added with this PR?
Did I make sure to only change the part of the file where I introduced a new change/feature?
Did I cover all corner cases to be close to 100% test coverage (if applicable)?
Did I properly add Javis dependencies to the Project.toml + set an upper bound of the dependency (if applicable)?
Did I properly add test dependencies to the test directory (if applicable)?
Did I check relevant tutorials that may be affected by changes in this PR?
Did I clearly articulate why this PR was made the way it was and how it was made?

Link to relevant issue(s)
Closes #
Examples for Graph animation demos

How did you address these issues with this PR? What methods did you use?

Wikunia

In general it looks like a good first step to me. Maybe you can clarify the small comments I made throughout for now and we can discuss this further on Tuesday.

Wikunia · 2021-06-13T15:16:57Z

examples/graph_animations/example1.md

+
+**Node registration**
+```julia
+nodes = [Object(@Frames(prev_start()+5, stop=100), GraphNode(i, drawNode; animate_on=:scale, fill_color="yellow", border_color="black", text=string(i), text_valign=:middle, text_halign=:center)) for i in range(1, 8; step=1)]


It's not clear how this is linked to ga

In general what does ga do if I need to create the graph nodes and edges myself?

I thought of keeping a reference internally to the currently active graph, like the way there is a CURRENT_VIDEO. This however is not completely free of problems and restricts the way nodes can be added to graphs. I can change it to GraphNode(ga, i, drawNode); ...).

When adding a node, the first important thing it needs to do is generate a new layout. This however, is not done if the mode is static in which case it is generated only once when the whole layout is known.
The second thing, an ordering is kept in the graph object as to which node/edge appeared first. This helps in the utility functions like animate_neighbors where instead of placing actions on all neighboring nodes in the same frame range this ordering can be used to organize them sequentially.

I'm just wondering what ga does with the graph object itself when one has to add the edges and nodes later anyway and what would happen if I add more nodes than in my graph ?

And yeah I prefer GraphNode(ga, i, drawNode and optionally remove the i when one adds them in order anyway.

Wikunia · 2021-06-13T15:19:06Z

examples/graph_animations/example1.md

+```julia
+enqueue!(Q, 1)
+# The frames argument is optional here.
+changeNodeProperty!(ga, 1, :fill_color, "green")


does this increase some kind of global frame counter?

Yes, that will be the case for now. This will create an action on the node based on the last animation created on the graph through the utility functions.
In the future, when it is possible to specify frames for an action based on an action from a different object, this counter would not be required anymore.

Wikunia · 2021-06-13T15:21:39Z

examples/graph_animations/example2.md

+```julia
+removeNode!(ag, 2)
+addNode!(ag, 7)
+addEdge!(ag, 1, 7)


we might want to think about other names here to make clear that this has something to do with Javis. Maybe even just Javis.add_edge!

Wikunia · 2021-06-13T15:24:37Z

examples/graph_animations/example2.md

+Animating neighboring nodes and edges can be simplified by using the `animate_neighbors` utlity function
+
+```julia
+animate_neighbors(ag, 1; animate_node_on=(:fill_color, "green"), animate_edge_on=(:color, "red"))


can we have something like (fill_color = "green", color = "red") to provide several different things?

Yes, I see no problem with that. But the drawing properties specified would be required to be used in the drawing function otherwise animation on that property won't show up.

Wikunia · 2021-06-13T15:25:25Z

examples/graph_animations/example2.md

+
+```julia
+# change back the graph to its original form
+changeNodeProperty!(ag, (node)->true, :fill_color, "white")


the (node)->true syntax is quite weird. What does that do?

Here we might be able to also specify several changes like above?

It is just a function with a fixed signature applying that property change to all nodes matching the criteria.

Then maybe make it the default but that's good to know

Regarding that you might want to create the function declarations and docstrings next 😉

Wikunia · 2021-06-13T15:27:00Z

examples/graph_animations/example3.md

+**Register graph in Javis**
+```julia
+wg = GraphAnimation(g, false, 300, 300, O; 
+                    node_attribute_fn=(g, node, attr) -> n(g, node, attr),


unclear to me what this does

Since the type of graph used is not known in this example, to fetch node properties like weight from the input graph this function will be used. These weights are then mapped to a certain drawing property like radius.

I was wondering why this doesn't return the normal inf instead of the string as well but that's good to know.

Add graph animation api demos

898a7f3

codejaeger force-pushed the api-demos branch from 995f009 to 898a7f3 Compare June 13, 2021 13:43

Add full code at bottom

def01ae

Wikunia reviewed Jun 13, 2021

View reviewed changes

codejaeger and others added 5 commits June 14, 2021 22:28

Add new example idea

f63d770

Add weekly updates

551c58e

Update 29th June

82324ef

Add weekly updates

f5a58a1

Update plan for 13/07-20/07

41a5292

Api demos #2

Are you sure you want to change the base?

Api demos #2

Uh oh!

Conversation

codejaeger commented Jun 13, 2021

PR Checklist

Uh oh!

Wikunia left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codejaeger Jun 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codejaeger Jun 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codejaeger Jun 13, 2021 •

edited

Loading

codejaeger Jun 13, 2021 •

edited

Loading