Merge pull request #560 from contactashish13/issue-214

add support for annotation and other roles

Author: contactashish13

classes/Visualizer/Render/Sidebar/Google.php

@@ -83,5 +83,29 @@ public static function enqueue_assets( $deps = array() ) {
 		return 'visualizer-render-google-lib';
 	}
 
-
+	/**
+	 * Renders the role field.
+	 *
+	 * @since 3.4.0
+	 *
+	 * @access protected
+	 */
+	protected function _renderRoleField( $index ) {
+		self::_renderSelectItem(
+			esc_html__( 'Special Role', 'visualizer' ),
+			'series[' . $index . '][role]',
+			isset( $this->series[ $index ]['role'] ) ? $this->series[ $index ]['role'] : '',
+			array(
+				''  => esc_html__( 'Default (Data)', 'visualizer' ),
+				'annotation'  => esc_html__( 'Annotation', 'visualizer' ),
+				'annotationText' => esc_html__( 'Annotation Text', 'visualizer' ),
+				'certainty' => esc_html__( 'Certainty', 'visualizer' ),
+				'emphasis' => esc_html__( 'Emphasis', 'visualizer' ),
+				'scope' => esc_html__( 'Scope', 'visualizer' ),
+				'style' => esc_html__( 'Style', 'visualizer' ),
+				'tooltip' => esc_html__( 'Tooltip', 'visualizer' ),
+			),
+			sprintf( esc_html__( 'Determines whether the series has to be used for a special role as mentioned in %1$shere%2$s. You can view a few examples %3$shere%4$s.', 'visualizer' ), '<a href="https://developers.google.com/chart/interactive/docs/roles#what-roles-are-available" target="_blank">', '</a>', '<a href="https://docs.themeisle.com/article/1160-roles-for-series-visualizer" target="_blank">', '</a>' )
+		);
+	}
 }

classes/Visualizer/Render/Sidebar/Graph.php

@@ -422,6 +422,9 @@ protected function _renderSeries( $index ) {
 			isset( $this->series[ $index ]['color'] ) ? $this->series[ $index ]['color'] : null,
 			null
 		);
+
+		$this->_renderRoleField( $index );
+
 	}
 
 	/**

classes/Visualizer/Render/Sidebar/Linear.php

@@ -289,6 +289,9 @@ protected function _renderSeries( $index ) {
 			isset( $this->series[ $index ]['color'] ) ? $this->series[ $index ]['color'] : null,
 			null
 		);
+
+		$this->_renderRoleField( $index );
+
 	}
 
 }

js/render-facade.js

@@ -81,6 +81,16 @@
     }
 
     $(document).ready(function(){
+        // facade loads twice in the library, so all charts are also loaded twice
+        // this will ensure that even if it loaded twice, it initializes all charts only once.
+        // fixed as part of the issue to add annotations.
+        if(visualizer.page_type === 'library'){
+            if(localStorage.getItem( 'viz-facade-loaded' ) === '1'){
+                localStorage.removeItem( 'viz-facade-loaded' );
+                return;
+            }
+            localStorage.setItem( 'viz-facade-loaded', '1');
+        }
         $('body').trigger('visualizer:render:chart:start', visualizer);
         initActionsButtons(visualizer);
         registerDefaultActions();

js/render-google.js

@@ -55,6 +55,27 @@ var __visualizer_chart_images   = [];
             settings['animation']['duration'] = parseInt(settings['animation']['duration']);
         }
 
+        // mark roles for series that have specified a role
+        // and then remove them from future processing
+        // and also adjust the indices of the series array so that
+        // the ones with a role are ignored
+        // e.g. if there are 6 columns (0-5) out of which 1, 3 and 5 are annotations
+        // the final series will only include 0, 2, 4 (reindexed as 0, 1, 2)
+        if (settings.series) {
+            var adjusted_series = [];
+            for (i = 0; i < settings.series.length; i++) {
+                if (!series[i + 1] || typeof settings.series[i] === 'undefined') {
+                    continue;
+                }
+                if(typeof settings.series[i].role !== 'undefined'){
+                    table.setColumnProperty(i + 1, 'role', settings.series[i].role);
+                    if(settings.series[i].role === '') {
+                        adjusted_series.push(settings.series[i]);
+                    }
+                }
+            }
+            settings.series = adjusted_series;
+        }
         if ( settings['explorer_enabled'] && settings['explorer_enabled'] == 'true' ) { // jshint ignore:line
             var $explorer = {};
             $explorer['keepInBounds'] = true;
@@ -217,7 +238,7 @@ var __visualizer_chart_images   = [];
                     break;
                 default:
                     for (i = 0; i < settings.series.length; i++) {
-                        if (!series[i + 1]) {
+                        if (!series[i + 1] || typeof settings.series[i] === 'undefined') {
                             continue;
                         }
                         format_data(id, table, series[i + 1].type, settings.series[i].format, i + 1);
@@ -228,7 +249,6 @@ var __visualizer_chart_images   = [];
             format_data(id, table, 'number', settings.format, 1);
         }
 
-
         if(settings.hAxis) {
        	    format_data(id, table, series[0].type, settings.hAxis.format, 0);
         }