org.jetbrains.kotlinx.ggdsl.letsplot.position.Position.kt Maven / Gradle / Ivy

Go to download

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

Kotlin plotting DSL.

There is a newer version: 0.4.0-dev-15

/*
* Copyright 2020-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/

package org.jetbrains.kotlinx.ggdsl.letsplot.position

import kotlinx.serialization.Serializable
import org.jetbrains.kotlinx.ggdsl.ir.feature.FeatureName
import org.jetbrains.kotlinx.ggdsl.ir.feature.LayerFeature

/**
 * The relative arrangement of groups within a layer. TODO grouping
 */
@Serializable
public sealed class Position private constructor(public val name: String) : LayerFeature {
    override val featureName: FeatureName = FEATURE_NAME

    public companion object {
        public val FEATURE_NAME: FeatureName = FeatureName("POSITION")
    }

    /**
     * Don't adjust position.
     */
    @Serializable
    public object Identity : Position("identity")

    /**
     * Stack overlapping objects on top of each another
     */
    @Serializable
    public object Stack : Position("stack")

    /**
     * Dodge overlapping objects side-to-side.
     *
     * @param width the dodging width, when different to the width of the individual elements.
     */
    @Serializable
    public data class Dodge(val width: Double? = null) : Position("dodge")

    /**
     * Jitter points to avoid overplotting.
     *
     * @param width the amount of vertical jitter.
     * The jitter is added in both positive and negative directions,
     * so the total spread is twice the value specified here.
     * @param height the amount of horizontal jitter.
     * The jitter is added in both positive and negative directions,
     * so the total spread is twice the value specified here.
     */
    @Serializable
    public data class Jitter(val width: Double? = null, val height: Double? = null) : Position("jitter")

    /**
     * Nudge points a fixed distance.
     *
     * @param x the amount of vertical distance to move.
     * @param y the amount of horizontal distance to move.
     */
    @Serializable
    public data class Nudge(val x: Double? = null, val y: Double? = null) : Position("nudge")

    /**
     * Simultaneously, dodge and jitter.
     *
     * @param dodgeWidth the amount to dodge in the x direction.
     * @param jitterWidth the degree of jitter in the x direction.
     * @param jitterHeight the degree of jitter in the y direction.
     */
    @Serializable
    public data class JitterDodge(
        val dodgeWidth: Double? = null,
        val jitterWidth: Double? = null,
        val jitterHeight: Double? = null,
    ) : Position("jitter_dodge")
}