• Home
• org.jetbrains.kotlinx
• kandy-lets-plot
• 0.8.0-dev-57
• source code
• plotGrid.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.multiplot.plotGrid.kt Maven / Gradle / Ivy

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

package org.jetbrains.kotlinx.kandy.letsplot.multiplot

import org.jetbrains.kotlinx.kandy.ir.Plot
import org.jetbrains.kotlinx.kandy.letsplot.multiplot.model.PlotGrid

/**
 *  Combines several plots on one figure, organized in a regular grid.

 *  @param plots Collection of plots.
 *          Use Null-value to fill in empty cells in the grid.
 *  @param nCol Number of columns in grid.
 *          If not specified, shows plots horizontally, in one row.
 *  @param widths Relative width of each column of the grid, left to right.
 *  @param heights Relative height of each row of grid, top-down.
 *  @param hspace Cell horizontal spacing in px. Default: 4px.
 *  @param vspace Cell vertical spacing in px. Default: 4px.
 *  @param fit Default: true.
 *          Whether to stretch each plot to match the aspect ratio of its cell (`fit=true`),
 *          or to preserve the original aspect ratio of plots (`fit=false`).
 *  @param align Default: false.
 *          If `true`, align inner areas (i.e. "geom" bounds) of plots.
 *          However, cells containing other (sub)grids are not participating in the plot "inner areas" layouting.
 *
 *  @return PlotGrid with given plots.
 */
public fun plotGrid(
    plots: List,
    nCol: Int? = null,
    widths: List? = null,
    heights: List? = null,
    hspace: Number? = null,
    vspace: Number? = null,
    fit: Boolean = true,
    align: Boolean = false,
): PlotGrid = PlotGrid(
    plots, nCol, widths, heights, hspace, vspace, fit, align
)