Merge branch 'doccray-master'

Author: valentijnnieman

CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.37.1] - 2018-11-07
+### Added
+- Added `clickannotation` event to `dcc.Graph`.
+See https://github.com/plotly/dash-core-components/pull/182.
+
 ## [0.37.0] - 2018-11-04
 ### Fixed
 - Some Input props weren't being picked up by React. Changed:
@@ -390,7 +395,6 @@ As part of the plotly.js upgrade:
 - Broken sourcemaps for debugging.
 ### Added
 - Testing configuration for CHROMEPATH and SERVER_PROCESSES
-
 ## [0.22.1] - 2018-04-09
 ### Fixed
 - Various bugs with the `ohlc` and `candlestick` chart type in the `dcc.Graph`

dash_core_components/Graph.py

@@ -12,6 +12,7 @@ class Graph(Component):
 in callbacks. The ID needs to be unique across all of the
 components in an app.
 - clickData (dict; optional): Data from latest click event
+- clickAnnotationData (dict; optional): Data from latest click annotation event
 - hoverData (dict; optional): Data from latest hover event
 - clear_on_unhover (boolean; optional): If True, `clear_on_unhover` will clear the `hoverData` property
 when the user "unhovers" from a point.
@@ -84,15 +85,15 @@ class Graph(Component):
 If using an Mapbox Atlas server, set this option to '',
 so that plotly.js won't attempt to authenticate to the public Mapbox server.
 
-Available events: 'click', 'hover', 'selected', 'relayout', 'unhover'"""
+Available events: 'click', 'clickannotation', 'hover', 'selected', 'relayout', 'unhover'"""
     @_explicitize_args
-    def __init__(self, id=Component.UNDEFINED, clickData=Component.UNDEFINED, hoverData=Component.UNDEFINED, clear_on_unhover=Component.UNDEFINED, selectedData=Component.UNDEFINED, relayoutData=Component.UNDEFINED, figure=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, animate=Component.UNDEFINED, animation_options=Component.UNDEFINED, config=Component.UNDEFINED, **kwargs):
-        self._prop_names = ['id', 'clickData', 'hoverData', 'clear_on_unhover', 'selectedData', 'relayoutData', 'figure', 'style', 'className', 'animate', 'animation_options', 'config']
+    def __init__(self, id=Component.UNDEFINED, clickData=Component.UNDEFINED, clickAnnotationData=Component.UNDEFINED, hoverData=Component.UNDEFINED, clear_on_unhover=Component.UNDEFINED, selectedData=Component.UNDEFINED, relayoutData=Component.UNDEFINED, figure=Component.UNDEFINED, style=Component.UNDEFINED, className=Component.UNDEFINED, animate=Component.UNDEFINED, animation_options=Component.UNDEFINED, config=Component.UNDEFINED, **kwargs):
+        self._prop_names = ['id', 'clickData', 'clickAnnotationData', 'hoverData', 'clear_on_unhover', 'selectedData', 'relayoutData', 'figure', 'style', 'className', 'animate', 'animation_options', 'config']
         self._type = 'Graph'
         self._namespace = 'dash_core_components'
         self._valid_wildcard_attributes =            []
-        self.available_events = ['click', 'hover', 'selected', 'relayout', 'unhover']
-        self.available_properties = ['id', 'clickData', 'hoverData', 'clear_on_unhover', 'selectedData', 'relayoutData', 'figure', 'style', 'className', 'animate', 'animation_options', 'config']
+        self.available_events = ['click', 'clickannotation', 'hover', 'selected', 'relayout', 'unhover']
+        self.available_properties = ['id', 'clickData', 'clickAnnotationData', 'hoverData', 'clear_on_unhover', 'selectedData', 'relayoutData', 'figure', 'style', 'className', 'animate', 'animation_options', 'config']
         self.available_wildcard_properties =            []
 
         _explicit_args = kwargs.pop('_explicit_args')

dash_core_components/dash_core_components.dev.js

@@ -1165,6 +1165,17 @@
           "computed": false
         }
       },
+      "clickAnnotationData": {
+        "type": {
+          "name": "object"
+        },
+        "required": false,
+        "description": "Data from latest click annotation event",
+        "defaultValue": {
+          "value": "null",
+          "computed": false
+        }
+      },
       "hoverData": {
         "type": {
           "name": "object"
@@ -1470,6 +1481,10 @@
               "value": "'click'",
               "computed": false
             },
+            {
+              "value": "'clickannotation'",
+              "computed": false
+            },
             {
               "value": "'hover'",
               "computed": false

dash_core_components/dash_core_components.min.js

@@ -1,6 +1,6 @@
 {
   "name": "dash-core-components",
-  "version": "0.37.0",
+  "version": "0.37.1",
   "description": "Core component suite for Dash",
   "repository": {
     "type": "git",

dash_core_components/metadata.json

@@ -1 +1 @@
-__version__ = '0.37.0'
+__version__ = '0.37.1'

dash_core_components/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dash-core-components",
-  "version": "0.37.0",
+  "version": "0.37.1",
   "description": "Core component suite for Dash",
   "repository": {
     "type": "git",

dash_core_components/version.py

@@ -1,6 +1,6 @@
 import React, {Component} from 'react';
 import PropTypes from 'prop-types';
-import {contains, filter, clone, has, isNil, type} from 'ramda';
+import {contains, filter, clone, has, isNil, type, omit} from 'ramda';
 /* global Plotly:true */
 
 const filterEventData = (gd, eventData, event) => {
@@ -109,6 +109,18 @@ export default class PlotlyGraph extends Component {
                 }
             }
         });
+        gd.on('plotly_clickannotation', eventData => {
+            const clickAnnotationData = omit(
+                ['event', 'fullAnnotation'],
+                eventData
+            );
+            if (setProps) {
+                setProps({clickAnnotationData});
+            }
+            if (fireEvent) {
+                fireEvent({event: 'clickannotation'});
+            }
+        });
         gd.on('plotly_hover', eventData => {
             const hoverData = filterEventData(gd, eventData, 'hover');
             if (!isNil(hoverData)) {
@@ -225,6 +237,11 @@ PlotlyGraph.propTypes = {
      */
     clickData: PropTypes.object,
 
+    /**
+     * Data from latest click annotation event
+     */
+    clickAnnotationData: PropTypes.object,
+
     /**
      * Data from latest hover event
      */
@@ -458,6 +475,7 @@ PlotlyGraph.propTypes = {
      */
     dashEvents: PropTypes.oneOf([
         'click',
+        'clickannotation',
         'hover',
         'selected',
         'relayout',
@@ -484,6 +502,7 @@ PlotlyGraph.defaultProps = {
             .substring(2, 7),
     /* eslint-enable no-magic-numbers */
     clickData: null,
+    clickAnnotationData: null,
     hoverData: null,
     selectedData: null,
     relayoutData: null,