Merge pull request #231 from azavea/feature/awf/cleanup-time-agg-para…

…m#212

Feature/awf/cleanup time agg param#212

src/app/charts/chart.component.ts

@@ -17,9 +17,10 @@ import { Chart } from '../models/chart.model';
 import { ChartData } from '../models/chart-data.model';
 import { City } from '../models/city.model';
 import { ClimateModel } from '../models/climate-model.model';
-import { IndicatorQueryOpts } from '../models/indicator-query-opts.model';
-import { ThresholdIndicatorQueryOpts } from '../models/threshold-indicator-query-opts.model';
+import { IndicatorRequestOpts } from '../models/indicator-request-opts.model';
+import { IndicatorQueryParams } from '../models/indicator-query-params.model';
 import { Scenario } from '../models/scenario.model';
+import { TimeAggParam } from '../models/time-agg-param.enum';
 
 import { AuthService } from '../auth/auth.service';
 import { ChartService } from '../services/chart.service';
@@ -42,14 +43,14 @@ import * as _ from 'lodash';
 export class ChartComponent implements OnChanges, OnDestroy, AfterViewInit {
 
     @Output() onRemoveChart = new EventEmitter<Chart>();
-    @Output() onExtraParamsChanged = new EventEmitter<any>();
+    @Output() onExtraParamsChanged = new EventEmitter<IndicatorQueryParams>();
 
     @Input() chart: Chart;
     @Input() scenario: Scenario;
     @Input() models: ClimateModel[];
     @Input() city: City;
     @Input() unit: string;
-    @Input() extraParams;
+    @Input() extraParams: IndicatorQueryParams;
 
     private processedData: ChartData[];
     public chartData: ChartData[];
@@ -116,23 +117,20 @@ export class ChartComponent implements OnChanges, OnDestroy, AfterViewInit {
         this.cancelDataRequest();
     }
 
-    updateChart(extraParams: any) {
+    updateChart(extraParams: IndicatorQueryParams) {
         this.cancelDataRequest();
         this.chartData = [];
         this.rawChartData = [];
 
-        let params = {
+        let params: IndicatorQueryParams = {
             climateModels: this.models,
             unit: this.unit || this.chart.indicator.default_units,
-            // TODO: #212
-            // As a temporary solution, the time agg defaults to the 1st valid option.
-            // Really, this should a user selectable option
-            time_aggregation: this.chart.indicator.valid_aggregations[0]
+            time_aggregation: TimeAggParam.Yearly
         }
 
         params = _.extend(params, this.extraParams);
 
-        const queryOpts: IndicatorQueryOpts = {
+        const queryOpts: IndicatorRequestOpts = {
             indicator: this.chart.indicator,
             scenario: this.scenario,
             city: this.city,
@@ -185,9 +183,8 @@ export class ChartComponent implements OnChanges, OnDestroy, AfterViewInit {
         this.imageExportService.downloadAsPNG(this.chart.indicator.name, fileName);
     }
 
-    public onThresholdSelected($event) {
-        const thresholdParams = $event.data as ThresholdIndicatorQueryOpts;
-        this.extraParams = thresholdParams;
+    public onThresholdSelected(params: IndicatorQueryParams) {
+        this.extraParams = params;
         this.onExtraParamsChanged.emit(this.extraParams);
         this.updateChart(this.extraParams);
     }

src/app/charts/extra-params-components/threshold.component.ts

@@ -2,6 +2,7 @@ import { AfterViewInit, Component, EventEmitter, Input, Output, OnInit } from '@
 import { FormBuilder, FormGroup, Validators } from '@angular/forms';
 
 import { Indicator } from '../../models/indicator.model';
+import { ThresholdIndicatorQueryParams } from '../../models/threshold-indicator-query-params.model';
 
 import * as _ from 'lodash';
 
@@ -16,7 +17,8 @@ import * as _ from 'lodash';
 export class ThresholdComponent implements AfterViewInit, OnInit {
 
     @Input() indicator: Indicator;
-    @Input() extraParams: any;
+    @Input() extraParams: ThresholdIndicatorQueryParams;
+    @Output() thresholdParamSelected = new EventEmitter<ThresholdIndicatorQueryParams>();
 
     thresholdForm: FormGroup;
 
@@ -50,8 +52,6 @@ export class ThresholdComponent implements AfterViewInit, OnInit {
 
     @Input() thresholdUnits: any[] = this.thresholdTemperatureUnits;
 
-    @Output() thresholdParamSelected = new EventEmitter<any>();
-
     constructor(private formBuilder: FormBuilder) {}
 
     ngOnInit() {
@@ -62,11 +62,11 @@ export class ThresholdComponent implements AfterViewInit, OnInit {
     ngAfterViewInit() {
         // Since valueChanges triggers initially before parent is ready, wait until
         // parent is ready here and trigger it to draw chart with extra parameters.
-        this.thresholdParamSelected.emit({data: {
+        this.thresholdParamSelected.emit({
             'threshold_comparator': this.thresholdForm.controls.comparatorCtl.value,
             'threshold': this.thresholdForm.controls.thresholdCtl.value,
             'threshold_units': this.thresholdForm.controls.thresholdUnitCtl.value
-        }});
+        });
     }
 
     createForm() {
@@ -78,12 +78,11 @@ export class ThresholdComponent implements AfterViewInit, OnInit {
         });
 
         this.thresholdForm.valueChanges.debounceTime(700).subscribe(form => {
-            this.thresholdParamSelected.emit({data: {
-                'event': event,
+            this.thresholdParamSelected.emit({
                 'threshold_comparator': form.comparatorCtl,
                 'threshold': form.thresholdCtl,
                 'threshold_units': form.thresholdUnitCtl
-            }});
+            });
         });
     }
 

src/app/lab/lab.component.ts

@@ -14,6 +14,7 @@ import { ProjectService } from '../services/project.service';
 
 import { Chart } from '../models/chart.model';
 import { Indicator } from '../models/indicator.model';
+import { IndicatorQueryParams } from '../models/indicator-query-params.model';
 import { Project } from '../models/project.model';
 
 
@@ -81,7 +82,7 @@ export class LabComponent implements OnInit, OnDestroy {
         this.indicator = null;
     }
 
-    public saveExtraParams(params: any) {
+    public saveExtraParams(params: IndicatorQueryParams) {
         this.project.project_data.extraParams = params;
     }
 

src/app/models/chart-data.model.ts

@@ -3,12 +3,13 @@ import { Indicator } from './indicator.model';
 import { City } from './city.model';
 import { ClimateModel } from './climate-model.model';
 import { Scenario } from './scenario.model';
+import { TimeAggParam } from './time-agg-param.enum';
 
 /* tslint:disable:variable-name */
 export class ChartData {
   indicator: Indicator;
   data: MultiDataPoint[];
-  time_aggregation: string;
+  time_aggregation: TimeAggParam;
   time_format: string;
   city?: City;
   climate_models?: ClimateModel[];

src/app/models/indicator-query-params.model.ts

@@ -0,0 +1,10 @@
+import { ClimateModel } from './climate-model.model';
+import { TimeAggParam } from './time-agg-param.enum';
+
+export interface IndicatorQueryParams {
+    climateModels?: ClimateModel[];
+    years?: string[];
+    time_aggregation?: TimeAggParam;
+    agg?: string;
+    unit?: string;
+}

src/app/models/indicator-query-opts.model.ts → src/app/models/indicator-request-opts.model.ts

@@ -1,16 +1,12 @@
 import { City } from './city.model';
 import { Indicator } from './indicator.model';
+import { IndicatorQueryParams } from './indicator-query-params.model';
 import { ClimateModel } from './climate-model.model';
 import { Scenario } from './scenario.model';
 
-export interface IndicatorQueryOpts {
+export interface IndicatorRequestOpts {
     indicator: Indicator;
     city: City;
     scenario: Scenario;
-    params: {
-        climateModels?: ClimateModel[];
-        years?: string[];
-        time_aggregation?: string;
-        unit?: string;
-    }
+    params: IndicatorQueryParams;
 }

src/app/models/threshold-indicator-query-params.model.ts

@@ -0,0 +1,7 @@
+import { IndicatorQueryParams } from './indicator-query-params.model';
+
+export interface ThresholdIndicatorQueryParams extends IndicatorQueryParams {
+    threshold: Number;
+    threshold_units: string;
+    threshold_comparator: string;
+}

src/app/models/time-agg-param.enum.ts

@@ -0,0 +1,6 @@
+
+export enum TimeAggParam {
+    Yearly = 'yearly',
+    Quarterly = 'quarterly',
+    Monthly = 'monthly'
+}

src/app/services/chart.service.ts

@@ -17,7 +17,6 @@ export class ChartService {
 
     private timeOptions = {
           'yearly': '%Y',
-          'daily': '%Y-%m-%d',
           'monthly': '%Y-%m'
         };
 

src/app/services/indicator.service.ts

@@ -5,8 +5,8 @@ import 'rxjs/add/observable/of';
 import 'rxjs/Rx';
 
 import { Indicator } from '../models/indicator.model';
-import { IndicatorQueryOpts } from '../models/indicator-query-opts.model';
-import { ThresholdIndicatorQueryOpts } from '../models/threshold-indicator-query-opts.model';
+import { IndicatorRequestOpts } from '../models/indicator-request-opts.model';
+import { ThresholdIndicatorQueryParams } from '../models/threshold-indicator-query-params.model';
 import { ApiHttp } from '../auth/api-http.service';
 import { apiHost } from '../constants';
 
@@ -20,7 +20,7 @@ import { isThresholdIndicator } from '../charts/extra-params-components/extra-pa
 export class IndicatorService {
     constructor(private apiHttp: ApiHttp) {}
 
-    public getData(options: IndicatorQueryOpts) {
+    public getData(options: IndicatorRequestOpts) {
 
         const url = `${apiHost}/api/climate-data/${options.city.id}/${options.scenario.name}` +
                          `/indicator/${options.indicator.name}/`;
@@ -30,14 +30,14 @@ export class IndicatorService {
 
         // append extra parameters, if needed
         if (isThresholdIndicator(options.indicator.name)) {
-            const thresholdOpts: ThresholdIndicatorQueryOpts = <ThresholdIndicatorQueryOpts> options;
+            const thresholdParams = options.params as ThresholdIndicatorQueryParams;
             // abort request if chart is in flux (these parameters are required)
-            if (!thresholdOpts.params.threshold) {
+            if (!thresholdParams.threshold) {
                 return Observable.of({url: ''});
             }
-            searchParams.append('threshold', thresholdOpts.params.threshold.toString());
-            searchParams.append('threshold_units', thresholdOpts.params.threshold_units);
-            searchParams.append('threshold_comparator', thresholdOpts.params.threshold_comparator);
+            searchParams.append('threshold', thresholdParams.threshold.toString());
+            searchParams.append('threshold_units', thresholdParams.threshold_units);
+            searchParams.append('threshold_comparator', thresholdParams.threshold_comparator);
         }
 
         if (options.params.years) {