geomPie

class geomPie(val data: Map<*, *>? = null, val stat: StatOptions = Stat.count2d(), val position: PosOptions = positionIdentity, val showLegend: Boolean = true, val sampling: SamplingOptions? = null, val tooltips: TooltipOptions? = null, val labels: AnnotationOptions? = null, val map: SpatialDataset? = null, val mapJoin: <Error class: unknown class><Any, Any>? = null, val useCRS: String? = null, val x: Number? = null, val y: Number? = null, val slice: Number? = null, val explode: Number? = null, val size: Number? = null, val fill: Any? = null, val alpha: Number? = null, val color: Any? = null, val stroke: Number? = null, val weight: Number? = null, val hole: Number? = null, val strokeSide: String? = null, val spacerWidth: Number? = null, val spacerColor: Any? = null, val sizeUnit: String? = null, val fillBy: String? = null, val colorBy: String? = null, mapping: PieMapping.() -> Unit = {}) : Layer, PieAesthetics, PieParameters, Count2dStatAesthetics, WithSizeUnitOption, WithSpatialParameters, WithFillOption, WithColorOption

Draws pie chart.

Examples

Parameters

data

The data to be displayed in this layer. If null, the default, the data is inherited from the plot data as specified in the call to letsPlot.

stat

default = Stat.count2d(). The statistical transformation to use on the data for this layer. Supported transformations: Stat.identity, Stat.bin(), Stat.count(), etc. see Stat.

position

Position adjustment: positionIdentity, positionStack(), positionDodge(), etc. see Position.

showLegend

default = true. false - do not show legend for this layer.

sampling

Result of the call to the samplingXxx() function. To prevent any sampling for this layer pass value samplingNone. For more info see sampling.html.

tooltips

Result of the call to the layerTooltips() function. Specifies appearance, style and content.

labels

Result of the call to the layerLabels() function. Specifies style and content of the annotations.

map

Data-structure containing series of planar shapes and, optionally, associates data series (for example: names of States and their boundaries).

Supported shapes: Point and MultiPoint.

All coordinates should be encoded as decimal degrees in WGS84 coordinate reference system. Can be used with parameter mapJoin for joining data and map coordinates.

mapJoin

Pair of Names or Pair of Lists of Names. Specifies column names to join the data and the map coordinates on.

  • Pair.first: column name or list of column names in the data dataframe.

  • Pair.second: column name or list of column names in the map dataframe.

useCRS

By default, all coordinates are converted into degrees of longitude and latitude, and these map coordinates are projected onto the screen coordinates using Mercator projection. Specify useCRS = "provided" to keep the SpatialDataset's original coordinate reference system (CRS).

x

X-axis value.

y

Y-axis value.

slice

Values associated to pie sectors.

explode

Values to explode slices away from their center point, detaching it from the main pie.

size

Pie diameter.

fill

Fill color. String in the following formats:

  • RGB/RGBA (e.g. "rgb(0, 0, 255)")

  • HEX (e.g. "#0000FF")

  • color name (e.g. "red")

  • role name ("pen", "paper" or "brush")

Or an instance of the java.awt.Color class.

alpha

Transparency level of a layer. Understands numbers between 0 and 1.

color

Color of inner and outer arcs of pie sector. String in the following formats:

  • RGB/RGBA (e.g. "rgb(0, 0, 255)")

  • HEX (e.g. "#0000FF")

  • color name (e.g. "red")

  • role name ("pen", "paper" or "brush")

Or an instance of the java.awt.Color class.

stroke

Width of inner and outer arcs of pie sector.

weight

Used by Stat.count2d() stat to compute weighted sum instead of simple count.

hole

default = 0.0. A multiplicative factor applied to the pie diameter to draw donut-like chart. Understands numbers between 0 and 1.

strokeSide

default = "both" ("outer", "inner", "both"). Defines which arcs of pie sector should have a stroke.

spacerWidth

default = 0.75. Line width between sectors. Spacers are not applied to exploded sectors and to sides of adjacent sectors.

spacerColor

Color for spacers between sectors. By default, the "paper" color is used. String in the following formats:

  • RGB/RGBA (e.g. "rgb(0, 0, 255)")

  • HEX (e.g. "#0000FF")

  • color name (e.g. "red")

  • role name ("pen", "paper" or "brush")

Or an instance of the java.awt.Color class.

sizeUnit

Relates the size of the pie chart to the length of the unit step along one of the axes. Possible values: "x", "y". If not specified, no fitting is performed.

fillBy

default = "fill" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the fill aesthetic for the geometry.

colorBy

default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c"). Defines the color aesthetic for the geometry.

mapping

Set of aesthetic mappings. Aesthetic mappings describe the way that variables in the data are mapped to plot "aesthetics".

Constructors

Link copied to clipboard
constructor(data: Map<*, *>? = null, stat: StatOptions = Stat.count2d(), position: PosOptions = positionIdentity, showLegend: Boolean = true, sampling: SamplingOptions? = null, tooltips: TooltipOptions? = null, labels: AnnotationOptions? = null, map: SpatialDataset? = null, mapJoin: <Error class: unknown class><Any, Any>? = null, useCRS: String? = null, x: Number? = null, y: Number? = null, slice: Number? = null, explode: Number? = null, size: Number? = null, fill: Any? = null, alpha: Number? = null, color: Any? = null, stroke: Number? = null, weight: Number? = null, hole: Number? = null, strokeSide: String? = null, spacerWidth: Number? = null, spacerColor: Any? = null, sizeUnit: String? = null, fillBy: String? = null, colorBy: String? = null, mapping: PieMapping.() -> Unit = {})

Properties

Link copied to clipboard
open override val alpha: Number? = null
Link copied to clipboard
open override val color: Any? = null
Link copied to clipboard
open override val colorBy: String? = null
Link copied to clipboard
val data: Map<*, *>? = null
Link copied to clipboard
open override val explode: Number? = null
Link copied to clipboard
open override val fill: Any? = null
Link copied to clipboard
open override val fillBy: String? = null
Link copied to clipboard
val geom: GeomOptions
Link copied to clipboard
open override val hole: Number? = null
Link copied to clipboard
Link copied to clipboard
open override val map: SpatialDataset? = null
Link copied to clipboard
open override val mapJoin: <Error class: unknown class><Any, Any>? = null
Link copied to clipboard
val mapping: <Error class: unknown class>
Link copied to clipboard
val orientation: String? = null
Link copied to clipboard
val parameters: <Error class: unknown class>
Link copied to clipboard
val position: PosOptions?
Link copied to clipboard
val sampling: SamplingOptions? = null
Link copied to clipboard
Link copied to clipboard
open override val size: Number? = null
Link copied to clipboard
open override val sizeUnit: String? = null
Link copied to clipboard
open override val slice: Number? = null
Link copied to clipboard
open override val spacerColor: Any? = null
Link copied to clipboard
open override val spacerWidth: Number? = null
Link copied to clipboard
val stat: StatOptions
Link copied to clipboard
open override val stroke: Number? = null
Link copied to clipboard
open override val strokeSide: String? = null
Link copied to clipboard
Link copied to clipboard
open override val useCRS: String? = null
Link copied to clipboard
open override val weight: Number? = null
Link copied to clipboard
open override val x: Number? = null
Link copied to clipboard
open override val y: Number? = null