Skip to content

Improve user experience for plot editing. #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vandenman wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve user experience for plot editing. #205

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 39 additions & 13 deletions R/common.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,20 @@ loadJaspResults <- function(name) {
create_cpp_jaspResults(name, .retrieveState())
}

finishJaspResults <- function(jaspResultsCPP, calledFromAnalysis = TRUE) {
finishJaspResults <- function(jaspResultsCPP, calledFromAnalysis = TRUE, saveState = TRUE) {

jaspResultsCPP$prepareForWriting()
if (saveState) {

newState <- list(
figures = jaspResultsCPP$getPlotObjectsForState(),
other = jaspResultsCPP$getOtherObjectsForState()
)
jaspResultsCPP$prepareForWriting()

newState <- list(
figures = jaspResultsCPP$getPlotObjectsForState(),
other = jaspResultsCPP$getOtherObjectsForState()
)

jaspResultsCPP$relativePathKeep <- .saveState(newState)$relativePath
jaspResultsCPP$relativePathKeep <- .saveState(newState)$relativePath

}

returnThis <- NULL
if (calledFromAnalysis) {
Expand Down Expand Up @@ -1111,11 +1115,29 @@ editImage <- function(name, optionsJson) {
# copy plot and check if we edit it
newPlot <- ggplot2:::plot_clone(plot)

newOpts <- optionsList[["editOptions"]]
oldOpts <- jaspGraphs::plotEditingOptions(plot)
newOpts$xAxis <- list(type = oldOpts$xAxis$type, settings = newOpts$xAxis$settings[names(newOpts$xAxis$settings) != "type"])
newOpts$yAxis <- list(type = oldOpts$yAxis$type, settings = newOpts$yAxis$settings[names(newOpts$yAxis$settings) != "type"])
newPlot <- jaspGraphs::plotEditing(newPlot, newOpts)
newOpts <- optionsList[["editOptions"]]

# Read axis types from the C++ JSON instead of calling
# plotEditingOptions(plot) which would trigger an expensive
# ggplot_build() just to extract the types.
xType <- newOpts[["xAxis"]][["type"]]
yType <- newOpts[["yAxis"]][["type"]]

# If types are missing from the JSON (shouldn't happen in normal
# operation), fall back to the old behaviour.
if (is.null(xType) || is.null(yType) || !nzchar(xType) || !nzchar(yType)) {
oldOpts <- jaspGraphs::plotEditingOptions(plot)
xType <- oldOpts[["xAxis"]][["type"]]
yType <- oldOpts[["yAxis"]][["type"]]
}

newOpts$xAxis <- list(type = xType, settings = newOpts$xAxis$settings[names(newOpts$xAxis$settings) != "type"])
newOpts$yAxis <- list(type = yType, settings = newOpts$yAxis$settings[names(newOpts$yAxis$settings) != "type"])

# Build the plot once and pass the result to plotEditing so that
# ggplot_build() is called exactly once instead of twice.
ggbuild <- ggplot2::ggplot_build(newPlot)
newPlot <- jaspGraphs::plotEditing(newPlot, newOpts, ggbuild = ggbuild)

# plot editing did nothing or was canceled
if (!identical(plot, newPlot))
Expand All @@ -1125,7 +1147,11 @@ editImage <- function(name, optionsJson) {
interactiveJsonData <- jaspPlotCPP$interactiveJsonData
revision <- jaspPlotCPP$revision

finishJaspResults(jaspResultsCPP, calledFromAnalysis = FALSE)
# Debounced (intermediate) edits skip the state save: the edits are
# applied from scratch each time using the JSON options, so persisting
# state after every preview is unnecessary overhead.
intermediate <- isTRUE(optionsList[["intermediate"]])
finishJaspResults(jaspResultsCPP, calledFromAnalysis = FALSE, saveState = !intermediate)

})

Expand Down
Loading