org.jetbrains.kotlinx.ggdsl.dsl.scale.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ggdsl-api Show documentation

Kotlin plotting DSL.

There is a newer version: 0.4.0-dev-15

package org.jetbrains.kotlinx.ggdsl.dsl

import org.jetbrains.kotlinx.ggdsl.ir.scale.*

/**
 * Creates a new default continuous non-positional scale
 *
 * @param transform the transformation of scale
 */
fun continuous(transform: NonPositionalTransform? = null) = NonPositionalContinuousUnspecifiedScale(transform)

/**
 * Creates a new default categorical non-positional scale
 */
fun categorical() = NonPositionalCategoricalUnspecifiedScale

/**
 * Creates a new default continuous positional scale
 *
 * @param transform the transformation of scale
 */
fun continuousPos(transform: PositionalTransform? = null) = PositionalContinuousUnspecifiedScale(transform)

/**
 * Creates a new default categorical positional scale
 */
fun categoricalPos() = PositionalCategoricalUnspecifiedScale

/**
 * Creates a new continuous positional scale
 *
 * @param DomainType type of domain
 * @param limits segment defining the domain
 * @param transform the transformation of scale
 * @return new [PositionalContinuousScale] with given limits
 */
fun  continuousPos(
    limits: Pair? = null,
    transform: PositionalTransform? = null
) = PositionalContinuousScale(limits, transform)

/**
 * Creates a new continuous non-positional scale
 *
 * @param DomainType type of domain
 * @param RangeType type of range
 * @param domainLimits segment defining the domain
 * @param rangeLimits segment defining the range
 * @param transform the transformation of scale
 * @return new [NonPositionalContinuousScale] with given limits
 */
fun  continuous(
    domainLimits: Pair? = null,
    rangeLimits: Pair? = null,
    transform: NonPositionalTransform? = null
) = NonPositionalContinuousScale(domainLimits, rangeLimits, transform)

/**
 * Creates a new categorical positional scale
 *
 * @param DomainType type of domain
 * @param categories [List] defining the domain
 * @return new [PositionalCategoricalScale] with given categories
 */
fun  categoricalPos(categories: List? = null) =
    PositionalCategoricalScale(categories)

/**
 * Creates a new categorical non-positional scale
 *
 * @param DomainType type of domain
 * @param RangeType type of range
 * @param domainCategories [List] defining the domain
 * @param rangeValues [List] defining the range
 * @return new [NonPositionalCategoricalScale] with given limits
 */
fun  categorical(
    domainCategories: List? = null,
    rangeValues: List? = null,
) = NonPositionalCategoricalScale(domainCategories, rangeValues)