org.jetbrains.kotlinx.ggdsl.letsplot.facet.facet.kt Maven / Gradle / Ivy

Go to download
package org.jetbrains.kotlinx.ggdsl.letsplot.facet

import org.jetbrains.kotlinx.ggdsl.dsl.PlotContext
import org.jetbrains.kotlinx.ggdsl.ir.data.DataSource
import org.jetbrains.kotlinx.ggdsl.ir.feature.FeatureName
import org.jetbrains.kotlinx.ggdsl.ir.feature.PlotFeature


data class OrderDirection internal constructor(val value: Int) {
    companion object {
        val ASCENDING = OrderDirection(1)
        val DESCENDING = OrderDirection(-1)
    }
}

data class Direction internal constructor(val name: String) {
    companion object {
        val VERTICAL = Direction("v")
        val HORIZONTAL = Direction("h")
    }
}

data class ScalesSharing internal constructor(val name: String) {
    companion object {
        val FIXED = ScalesSharing("fixed")
        val FREE = ScalesSharing("free")
        val FREE_X = ScalesSharing("free_x")
        val FREE_Y = ScalesSharing("free_y")
    }
}

data class FacetGridFeature(
    val x: String? = null,
    val y: String? = null,
    val scalesSharing: ScalesSharing? = null,
    val xOrder: OrderDirection = OrderDirection.ASCENDING,
    val yOrder: OrderDirection = OrderDirection.ASCENDING,
    val xFormat: String? = null,
    val yFormat: String? = null
) : PlotFeature {
    override val featureName: FeatureName = FEATURE_NAME

    companion object {
        val FEATURE_NAME = FeatureName("FACET_GRID_FEATURE")
    }

}

data class FacetWrapFeature(
    val facets: List,
    var nCol: Int? = null,
    var nRow: Int? = null,
    var order: OrderDirection = OrderDirection.ASCENDING,
    val scalesSharing: ScalesSharing = ScalesSharing.FIXED,
    val direction: Direction = Direction.HORIZONTAL,
    val format: String? = null
) : PlotFeature {
    override val featureName: FeatureName = FEATURE_NAME


    companion object {
        val FEATURE_NAME = FeatureName("FACET_WRAP_FEATURE")
    }

}


/**
 * Splits data by one or two faceting variables. For each data subset creates
 * a plot panel and lays out panels as grid.
 * The grid columns are defined by X faceting variable
 * and rows are defined by Y faceting variable.
 *
 * ```
 * facetGrid(
 *    source("type"),
 *    source("number of hands"),
 *    yOrder = OrderDirection.DESCENDING
 * )
 * ```
 * TODO params
 * @see org.jetbrains.letsPlot.facet.facetGrid
 */
fun PlotContext.facetGrid(
    x: DataSource<*>? = null,
    y: DataSource<*>? = null,
    scalesSharing: ScalesSharing? = null,
    xOrder: OrderDirection = OrderDirection.ASCENDING,
    yOrder: OrderDirection = OrderDirection.ASCENDING,
    xFormat: String? = null,
    yFormat: String? = null
) {

    features[FacetGridFeature.FEATURE_NAME] =
        FacetGridFeature(x?.id, y?.id, scalesSharing, xOrder, yOrder, xFormat, yFormat)


}

/**
 * Splits data by one or more faceting variables.
 * For each data subset creates a plot panel and lays out panels according to the `nCol`, `nRow` and `direction` settings.
 *
 * TODO params
 * @see org.jetbrains.letsPlot.facet.facetWrap
 */
fun PlotContext.facetWrap(
    vararg facets: DataSource<*>,
    nCol: Int? = null,
    nRow: Int? = null,
    order: OrderDirection = OrderDirection.ASCENDING,
    scalesSharing: ScalesSharing = ScalesSharing.FIXED,
    direction: Direction = Direction.HORIZONTAL
) {
    features[FacetWrapFeature.FEATURE_NAME] =
        FacetWrapFeature(
            facets.map { it.id }, nCol, nRow, order, scalesSharing, direction
        )

}