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.
/*
* Copyright (c) 2021. JetBrains s.r.o.
* Use of this source code is governed by the MIT license that can be found in the LICENSE file.
*/
package org.jetbrains.letsPlot.scale
import org.jetbrains.letsPlot.core.spec.Option
import org.jetbrains.letsPlot.core.plot.base.Aes
import org.jetbrains.letsPlot.intern.Options
import org.jetbrains.letsPlot.intern.Scale
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can handle directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: List of Strings containing
* - names of colors (i.e. "green")
* - hex codes of colors (i.e "x00ff00")
* - css colors (i.e "rgb(0,255,0)")
*
* @param aesthetic Aesthetic or a list of aesthetics that this scale works with.
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide Guide to use for this scale, default = "none".
* It can either be a string ("colorbar", "legend") or a call to a guide function (`guideColorbar()`, `guideLegend()`)
* specifying additional arguments.
* "none" will hide the guide.
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
fun scaleIdentity(
aesthetic: Any,
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Any? = null,
format: String? = null,
guide: Any? = "none"
) = Scale(
aesthetic = aesthetic,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide,
otherOptions = Options(
mapOf(
Option.Scale.SCALE_MAPPER_KIND to "identity"
)
)
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can handle directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: List of Strings containing
* - names of colors (i.e. "green")
* - hex codes of colors (i.e "x00ff00")
* - css colors (i.e "rgb(0,255,0)")
*
* @param name The name of the scale - used as the axis label or the legend title. If null, the default, the name of the scale
* is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale. and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide Guide to use for this scale, default = "none".
* It can either be a string ("colorbar", "legend") or a call to a guide function (`guideColorbar()`, `guideLegend()`)
* specifying additional arguments.
* "none" will hide the guide.
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
fun scaleColorIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Any? = null,
format: String? = null,
guide: Any? = "none"
) = scaleIdentity(
aesthetic = Aes.COLOR,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can handle directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: List of Strings containing
* - names of colors (i.e. "green")
* - hex codes of colors (i.e "x00ff00")
* - css colors (i.e "rgb(0,255,0)")
*
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide Guide to use for this scale, default = "none".
* It can either be a string ("colorbar", "legend") or a call to a guide function (`guideColorbar()`, `guideLegend()`)
* specifying additional arguments.
* "none" will hide the guide.
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
fun scaleFillIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Any? = null,
format: String? = null,
guide: Any? = "none"
) = scaleIdentity(
aesthetic = Aes.FILL,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can handle directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: Numeric codes of shapes.
*
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide A result returned by `guideLegend()` function or "none" to hide the guide, default = "none".
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
fun scaleShapeIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Any? = null,
format: String? = null,
guide: Any? = "none"
) = Scale(
aesthetic = Aes.SHAPE,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide,
otherOptions = Options(
mapOf(
Option.Scale.SCALE_MAPPER_KIND to "identity",
Option.Scale.DISCRETE_DOMAIN to true
)
)
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can handle directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: Numeric codes or names of line types (i.e "dotdash").
* The codes are: 0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash".
*
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide A result returned by `guideLegend()` function or "none" to hide the guide, default = "none".
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
@Suppress("SpellCheckingInspection")
fun scaleLinetypeIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Any? = null,
format: String? = null,
guide: Any? = "none"
) = Scale(
aesthetic = Aes.LINETYPE,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide,
otherOptions = Options(
mapOf(
Option.Scale.SCALE_MAPPER_KIND to "identity",
Option.Scale.DISCRETE_DOMAIN to true
)
)
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can handle directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: Numeric values in range `[0..1]`.
*
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide A result returned by `guideLegend()` function or "none" to hide the guide, default = "none".
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
fun scaleAlphaIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Number? = null,
format: String? = null,
guide: Any? = "none"
) = scaleIdentity(
aesthetic = Aes.ALPHA,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can handle directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: positive Numeric values.
*
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide A result returned by `guideLegend()` function or "none" to hide the guide, default = "none".
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
fun scaleSizeIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Number? = null,
format: String? = null,
guide: Any? = "none"
) = scaleIdentity(
aesthetic = Aes.SIZE,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can be handled directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: positive Numeric values.
*
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide A result returned by `guideLegend()` function or "none" to hide the guide, default = "none".
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
@Suppress("SpellCheckingInspection")
fun scaleLinewidthIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Number? = null,
format: String? = null,
guide: Any? = "none"
) = scaleIdentity(
aesthetic = Aes.LINEWIDTH,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide
)
/**
* Use this scale when your data has already been scaled.
* I.e. it already represents aesthetic values that can be handled directly.
* This will not produce a legend unless you also supply the breaks and labels.
*
* Input data expected: positive Numeric values.
*
* @param name The name of the scale - used as the axis label or the legend title.
* If null, the default, the name of the scale is taken from the first mapping used for that aesthetic.
* @param breaks A list of data values specifying the positions of ticks,
* or a dictionary which maps the tick labels to the breaks values.
* @param labels A list of labels on ticks, or a dictionary which maps the breaks values to the tick labels.
* @param lablim The maximum label length (in characters) before trimming is applied.
* @param limits Continuous scale: a numeric vector of length two providing limits of the scale.
* Discrete scale: a vector specifying the data range for the scale and the default order of their display in guides.
* @param naValue An aesthetic value which is used when data in not available.
* @param format Specifies the format pattern for labels on the scale.
* @param guide A result returned by `guideLegend()` function or "none" to hide the guide, default = "none".
*
* Format patterns in the `format` parameter can be just a number format (like "d") or
* a string template where number format is surrounded by curly braces: "{d} cylinders".
* Note: the "$" must be escaped as "\$".
* For more info see: [formats.md](https://github.com/JetBrains/lets-plot-kotlin/blob/master/docs/formats.md)
*
* Examples:
* - ".2f" -> "12.45"
* - "Score: {.2f}" -> "Score: 12.45"
* - "Score: {}" -> "Score: 12.454789"
*
*/
fun scaleStrokeIdentity(
name: String? = null,
breaks: Any? = null,
labels: Any? = null,
lablim: Int? = null,
limits: List? = null,
naValue: Number? = null,
format: String? = null,
guide: Any? = "none"
) = scaleIdentity(
aesthetic = Aes.STROKE,
name = name,
breaks = breaks,
labels = labels,
lablim = lablim,
limits = limits,
naValue = naValue,
format = format,
guide = guide
)
