tri.covid19.coda.charts.TimeSeriesChart.kt Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * coda-app
 * --
 * Copyright (C) 2020 - 2021 Elisha Peterson
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package tri.covid19.coda.charts

import javafx.event.EventTarget
import javafx.scene.chart.LineChart
import javafx.scene.chart.NumberAxis
import javafx.scene.layout.Priority
import tornadofx.attachTo
import tornadofx.gridpaneConstraints
import tri.covid19.coda.utils.*
import tri.covid19.coda.utils.chartContextMenu
import tri.util.DateRange

/** Displays time series as quantity vs. time. */
class TimeSeriesChart(logScale: Boolean = false) : LineChart(NumberAxis(), if (logScale) LogAxis() else NumberAxis()) {

    init {
        gridpaneConstraints { vhGrow = Priority.ALWAYS }
        animated = false
        createSymbols = false
        isLegendVisible = false
        chartContextMenu()
    }

    /**
     * Updates chart data using given range of dates and data.
     * @param domain domain, including the date indicated by "0" in x values
     * @param series data to display
     */
    fun setTimeSeries(domain: DateRange, series: List) {
        dataSeries = series
        (xAxis as NumberAxis).tickLabelFormatter = axisLabeler(domain.start)
    }
}

/** Creates line chart. */
fun EventTarget.timeserieschart(title: String, xTitle: String, yTitle: String, log: Boolean = false, op: TimeSeriesChart.() -> Unit = {}) = TimeSeriesChart(log)
        .attachTo(this, op) {
            it.title = title
            it.xAxis.label = xTitle
            it.yAxis.label = yTitle
        }