• Home
• org.jetbrains.kotlinx
• kandy-lets-plot
• 0.8.0-dev-57
• source code
• plotXYextensions.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.jetbrains.kotlinx.kandy.letsplot.plotXYextensions.kt Maven / Gradle / Ivy

/*
* Copyright 2020-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
@file:Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER")

package org.jetbrains.kotlinx.kandy.letsplot

import org.jetbrains.kotlinx.dataframe.DataColumn
import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
import org.jetbrains.kotlinx.kandy.dsl.internal.PlotBuilder
import org.jetbrains.kotlinx.kandy.dsl.internal.bindingHandler
import org.jetbrains.kotlinx.kandy.dsl.internal.dataframe.addPositionalMapping
import org.jetbrains.kotlinx.kandy.ir.bindings.PositionalMapping
import org.jetbrains.kotlinx.kandy.ir.scale.PositionalFreeScale
import org.jetbrains.kotlinx.kandy.letsplot.internal.LetsPlotPositionalMappingParametersContinuous
import org.jetbrains.kotlinx.kandy.letsplot.internal.X
import org.jetbrains.kotlinx.kandy.letsplot.internal.Y
import org.jetbrains.kotlinx.kandy.letsplot.scales.guide.model.AxisParametersWithSetter

/**
 * Maps the `x` aesthetic to a data column by [ColumnReference].
 *
 * @param column the data column to map to the x-coordinate.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun  PlotBuilder.x(
    column: ColumnReference,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        X,
        column.name(),
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Maps the `x` aesthetic to iterable of values.
 *
 * @param values the iterable containing the x-coordinate values.
 * @param name optional name for this aesthetic mapping.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun  PlotBuilder.x(
    values: Iterable,
    name: String? = null,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        X,
        values.toList(),
        name,
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Maps the `x` aesthetic to a data column by [String].
 *
 * @param column the data column to map to the x-coordinate.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun PlotBuilder.x(
    column: String,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        X,
        column,
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Maps the `x` aesthetic to a data column.
 *
 * @param values the data column to map to the x-coordinate.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun  PlotBuilder.x(
    values: DataColumn,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        X,
        values,
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Provides a mechanism for setting or retrieving x-axis parameters.
 *
 * @property x an [AxisParametersWithSetter] object for x-axis configuration.
 */
@Suppress("UNCHECKED_CAST")
public val PlotBuilder.x: AxisParametersWithSetter
    get() {
        @Suppress("INVISIBLE_MEMBER")
        return AxisParametersWithSetter(bindingHandler.bindingCollector.freeScales.getOrPut(X) {
            PositionalFreeScale(X, LetsPlotPositionalMappingParametersContinuous())
        }.parameters as LetsPlotPositionalMappingParametersContinuous, X, bindingHandler)
    }

/**
 * Applies configurations to x-axis parameters.
 *
 * @param parameters the configurations to apply to the x-axis parameters.
 */
public fun PlotBuilder.x(parameters: AxisParametersWithSetter.() -> Unit = {}) {
    x.apply(parameters)
}

/**
 * Maps the `y` aesthetic to a data column by [ColumnReference].
 *
 * @param column the data column to map to the y-coordinate.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun  PlotBuilder.y(
    column: ColumnReference,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        Y,
        column.name(),
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Maps the `y` aesthetic to iterable of values.
 *
 * @param values the iterable containing the y-coordinate values.
 * @param name optional name for this aesthetic mapping.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun  PlotBuilder.y(
    values: Iterable,
    name: String? = null,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        Y,
        values.toList(),
        name,
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Maps the `y` aesthetic to a data column by [String].
 *
 * @param column the data column to map to the y-coordinate.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun PlotBuilder.y(
    column: String,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        Y,
        column,
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Maps the `y` aesthetic to a data column.
 *
 * @param values the data column to map to the y-coordinate.
 * @param parameters additional mapping parameters.
 * @return a [PositionalMapping] object representing the mapping.
 */
public fun  PlotBuilder.y(
    values: DataColumn,
    parameters: LetsPlotPositionalMappingParametersContinuous.() -> Unit = {}
): PositionalMapping {
    @Suppress("INVISIBLE_MEMBER")
    return bindingHandler.addPositionalMapping(
        Y,
        values,
        LetsPlotPositionalMappingParametersContinuous().apply(parameters)
    )
}

/**
 * Provides a mechanism for setting or retrieving y-axis parameters.
 *
 * @property y an [AxisParametersWithSetter] object for y-axis configuration.
 */
@Suppress("UNCHECKED_CAST")
public val PlotBuilder.y: AxisParametersWithSetter
    get() {
        @Suppress("INVISIBLE_MEMBER")
        return AxisParametersWithSetter(bindingHandler.bindingCollector.freeScales.getOrPut(Y) {
            PositionalFreeScale(Y, LetsPlotPositionalMappingParametersContinuous())
        }.parameters as LetsPlotPositionalMappingParametersContinuous, Y, bindingHandler)
    }

/**
 * Applies configurations to y-axis parameters.
 *
 * @param parameters the configurations to apply to the y-axis parameters.
 */
public fun PlotBuilder.y(parameters: AxisParametersWithSetter.() -> Unit = {}) {
    y.apply(parameters)
}