Merge pull request #453 from plotly/graph-fig-docs

Graph fig docs

Author: alexcjohnson

R/coreChecklist.R

@@ -11,6 +11,6 @@ coreChecklist <- function(id=NULL, options=NULL, values=NULL, className=NULL, st
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreConfirmDialog.R

@@ -11,6 +11,6 @@ coreConfirmDialog <- function(id=NULL, message=NULL, submit_n_clicks=NULL, submi
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreConfirmDialogProvider.R

@@ -11,6 +11,6 @@ coreConfirmDialogProvider <- function(children=NULL, id=NULL, message=NULL, subm
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreDatePickerRange.R

@@ -11,6 +11,6 @@ coreDatePickerRange <- function(id=NULL, start_date=NULL, end_date=NULL, min_dat
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreDatePickerSingle.R

@@ -11,6 +11,6 @@ coreDatePickerSingle <- function(id=NULL, date=NULL, min_date_allowed=NULL, max_
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreDropdown.R

@@ -11,6 +11,6 @@ coreDropdown <- function(id=NULL, options=NULL, value=NULL, className=NULL, clea
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreGraph.R

@@ -11,6 +11,6 @@ coreGraph <- function(id=NULL, clickData=NULL, clickAnnotationData=NULL, hoverDa
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreInput.R

@@ -11,6 +11,6 @@ coreInput <- function(id=NULL, value=NULL, style=NULL, className=NULL, debounce=
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreInterval.R

@@ -11,6 +11,6 @@ coreInterval <- function(id=NULL, interval=NULL, disabled=NULL, n_intervals=NULL
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreLink.R

@@ -11,6 +11,6 @@ coreLink <- function(children=NULL, href=NULL, refresh=NULL, className=NULL, sty
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreLocation.R

@@ -11,6 +11,6 @@ coreLocation <- function(id=NULL, pathname=NULL, search=NULL, hash=NULL, href=NU
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreLogoutButton.R

@@ -11,6 +11,6 @@ coreLogoutButton <- function(id=NULL, label=NULL, logout_url=NULL, style=NULL, m
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreMarkdown.R

@@ -11,6 +11,6 @@ coreMarkdown <- function(children=NULL, id=NULL, className=NULL, containerProps=
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreRadioItems.R

@@ -11,6 +11,6 @@ coreRadioItems <- function(id=NULL, options=NULL, value=NULL, style=NULL, classN
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreRangeSlider.R

@@ -11,6 +11,6 @@ coreRangeSlider <- function(id=NULL, marks=NULL, value=NULL, allowCross=NULL, cl
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreSlider.R

@@ -11,6 +11,6 @@ coreSlider <- function(id=NULL, marks=NULL, value=NULL, className=NULL, disabled
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreStore.R

@@ -11,6 +11,6 @@ coreStore <- function(id=NULL, storage_type=NULL, data=NULL, clear_data=NULL, mo
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreSyntaxHighlighter.R

@@ -11,6 +11,6 @@ coreSyntaxHighlighter <- function(children=NULL, id=NULL, language=NULL, theme=N
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreTab.R

@@ -11,6 +11,6 @@ coreTab <- function(children=NULL, id=NULL, label=NULL, value=NULL, disabled=NUL
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreTabs.R

@@ -11,6 +11,6 @@ coreTabs <- function(children=NULL, id=NULL, value=NULL, className=NULL, content
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreTextarea.R

@@ -11,6 +11,6 @@ coreTextarea <- function(id=NULL, value=NULL, autoFocus=NULL, cols=NULL, disable
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

R/coreUpload.R

@@ -11,6 +11,6 @@ coreUpload <- function(children=NULL, id=NULL, contents=NULL, filename=NULL, las
         )
 
     component$props <- filter_null(component$props)
-    
-    structure(component, class = c('dash_component', 'list'))    
+
+    structure(component, class = c('dash_component', 'list'))
 }

dash_core_components/Graph.py

@@ -23,6 +23,9 @@ class Graph(Component):
 when the user zooms or pans on the plot
 - figure (dict; optional): Plotly `figure` object. See schema:
 https://plot.ly/javascript/reference
+Only supports `data` array and `layout` object.
+`config` is set separately by the `config` property,
+and `frames` is not supported.
 - style (dict; optional): Generic style overrides on the plot div
 - className (string; optional): className of the parent div
 - animate (boolean; optional): Beta: If true, animate between updates using

dash_core_components/dash_core_components.dev.js

@@ -35,7 +35,10 @@ data from the last point that was hovered over.}
 when the user zooms or pans on the plot}
 
 \item{figure}{Plotly `figure` object. See schema:
-https://plot.ly/javascript/reference}
+https://plot.ly/javascript/reference
+Only supports `data` array and `layout` object.
+`config` is set separately by the `config` property,
+and `frames` is not supported.}
 
 \item{style}{Generic style overrides on the plot div}
 

dash_core_components/dash_core_components.dev.js.map

@@ -264,6 +264,9 @@ const graphPropTypes = {
     /**
      * Plotly `figure` object. See schema:
      * https://plot.ly/javascript/reference
+     * Only supports `data` array and `layout` object.
+     * `config` is set separately by the `config` property,
+     * and `frames` is not supported.
      */
     figure: PropTypes.object,
 

dash_core_components/dash_core_components.min.js

@@ -1555,9 +1555,8 @@ def update_output(value):
         self.assertEqual(
             call_count.value,
             # an initial call to retrieve the first value
-            1 +
-            # one for each hello world character  # noqa: W504
-            len('hello world')
+            # plus one for each hello world character
+            1 + len('hello world')
         )
 
     def test_store_type_updates(self):