rectangles
Properties
xMin
Required Positional
Iterable Column String Any
The xMin
aesthetic is essential for defining the starting point of rectangles in various plots, particularly in creating rectangle plots. It specifies the minimum x-coordinate for each rectangle, effectively determining where each rectangle begins along the x-axis. This aesthetic is crucial for accurately positioning rectangles to represent data ranges, distributions, or categories within a plot.
Setting
xMin.constant(Any)
: applies a fixed starting x-coordinate for all rectangles in the plot, useful for aligning rectangles or setting a uniform baseline across the plot. Example:xMin.constant(0.3
) sets the starting x-coordinate of all rectangles to 0.3.
Mapping
xMin(Iterable)
: links each rectangle's starting x-coordinate to a value from an iterable collection, enabling variable starting points for rectangles based on the iterable's values.xMin(ColumnReference | KProperty | DataColumn)
: dynamically associates the starting x-coordinate of rectangles with a DataFrame column, allowing for the visualization of data-driven starting points.xMin(String)
: connects the starting x-coordinate of rectangles to data based on the column name in the DataFrame or by key in a Map, offering flexibility in representing data ranges or distributions.
xMax
Required Positional
Iterable Column String Any
The xMax
aesthetic is crucial for specifying the endpoint of rectangles in plots, particularly useful in creating rectangle plots. It defines the maximum x-coordinate for each rectangle, effectively determining the endpoint along the x-axis. This aesthetic is key to accurately representing data ranges, distributions, or categories within a plot by setting where each rectangle concludes.
Setting
xMax.constant(Any)
: applies a fixed ending x-coordinate for all rectangles within the plot, useful for standardizing the width of rectangles or ensuring uniform endpoints across the plot. Example:xMax.constant(0.7)
uniformly sets the endpoint x-coordinate of all rectangles to 0.7.
Mapping
xMax(Iterable)
: associates each rectangle's endpoint x-coordinate with a value from an iterable collection, enabling varied endpoints for rectangles based on the iterable's values.xMax(ColumnReference | KProperty | DataColumn)
: dynamically links the endpoint x-coordinate of rectangles to a DataFrame column, allowing for the visualization of data-driven endpoints.xMax(String)
: connects the endpoint x-coordinate of rectangles to data based on the column name in the DataFrame or by key in a Map, offering flexibility in representing data ranges or distributions.
yMin
Required Positional
Iterable Column String Any
The yMin
aesthetic specifies the minimum y-coordinate for elements within plots, crucial for defining the vertical lower bounds of elements such as boxes, crossbars, error bars, line ranges, point ranges, rectangles, and ribbons. This aesthetic is fundamental in accurately portraying the lower limits of data within these types of visualizations.
Setting
yMax.constant(Any)
: sets a uniform minimum y-coordinate across all relevant elements within a layer, ideal for establishing a fixed lower limit. For example,yMin.constant(0.1)
uniformly sets the lower boundary of elements to a y-coordinate of 0.1.
Mapping
yMax(Iterable)
: each element's minimum y-coordinate is linked to a value from an iterable collection, allowing for the depiction of varying lower boundaries within a layer to represent different data points or ranges.yMax(ColumnReference | KProperty | DataColumn)
: associates the minimum y-coordinate of elements with a DataFrame column, facilitating the visualization of data-driven lower boundaries.yMax(String)
: ties the minimum y-coordinate of elements to data based on the column name in the DataFrame or by key in a Map, offering adaptability in representing lower limits through y-coordinates.
Characteristics of the y
aesthetic
Scaling — The flexibility to map
yMin
to data or define it as a constant value affords extensive customization opportunities, allowing for precise tailoring of the visual representation of lower data boundaries.
yMax
Required Positional
Iterable Column String Any
The yMax
aesthetic specifies the maximum y-coordinate for elements within plots, playing a critical role in defining the vertical extent of elements such as boxes
, crossBars
, errorBars, lineRanges
, pointRanges
, rectangles
, and ribbons
. This aesthetic is essential for accurately representing the upper boundaries of data within these plot types.
Setting
yMax.constant(Any)
: establishes a uniform maximum y-coordinate across all applicable elements within a layer, useful for setting a fixed upper limit. Example usage:yMax.constant(0.9)
uniformly sets the upper boundary of elements to a y-coordinate of 0.9.
Mapping
yMax(Iterable)
: associates each element's maximum y-coordinate with a value from an iterable collection, allowing for varied upper boundaries within a single layer to represent different data points or ranges.yMax(ColumnReference | KProperty | DataColumn)
: links the maximum y-coordinate of elements to a DataFrame column, enabling the visualization of data-driven upper boundaries.yMax(String)
: connects the maximum y-coordinate of elements to data based on the column name in the DataFrame or by a key in a Map, offering flexibility in representing upper limits through y-coordinates.
Characteristics of the y
aesthetic
Scaling — Mapping
yMax
to data or setting it as a constant value provides extensive customization options, enabling precise control over the representation of upper data boundaries.
alpha
Optional NonPositional
Iterable Column String Double
The alpha aesthetic controls the transparency of elements in a plot. It provides a means to adjust the visual prominence of elements, ranging from fully transparent (0.0) to fully opaque (1.0).
Setting
alpha = Double
: applies a uniform transparency level to all elements within a layer. The Double value should be within the range of 0.0 (completely transparent) to 1.0 (completely opaque).
Mapping
alpha(Iterable)
: associates the transparency of each element with a value from an iterable collection.alpha(ColumnReference | KProperty | DataColumn)
: links transparency with data from a specified DataFrame column.alpha(String)
: transparency is associated with data from a DataFrame column specified by its name or with data from a Map by key.
Characteristics of the alpha
aesthetic
Value range — It is crucial to ensure that all alpha values are within the 0.0 to 1.0 range. Values outside this range will trigger an
IllegalArgumentException
.Scaling and validation — When mapping
alpha
to data, additional scaling adjustments and value validation ensure proper representation of transparency.
fillColor
Optional NonPositional
Iterable Column String Color
The fillColor
aesthetic plays a crucial role in defining the visual representation of plot elements by setting their fill color. It allows for both uniform color application and data-driven color variations.
Setting
fillColor = Color
: provides a uniform fill color to all elements within a layer, applicable for creating visually cohesive plot elements. The value can be a predefinedColor
constant likeColor.RED
or a custom color defined byColor.hex("#ff0000")
.
Mapping
fillColor(Iterable)
: associates the fill color of each element with a value from an iterable collection, allowing for a variety of fill colors within a single layer.fillColor(ColumnReference | KProperty | DataColumn)
: links element fill colors with a column in the DataFrame, enabling the visualization of data-driven color variations.fillColor(String)
: connects fill colors to data based on the column name in the DataFrame or by key in a Map, offering flexibility in data representation through color.
Characteristics of the fillColor
aesthetic
Versatility in data representation — The
fillColor
aesthetic can be used to represent different categories, intensities, or other data dimensions, providing a rich layer of information in visualizations.Scaling and validation — When mapping
fillColor
to data, you can customize the color scale and adjust the mapping to fit specific visualization needs.
borderLine
The borderLine
group of aesthetics provides a comprehensive way to customize the appearance of borders around plot elements such as boxes, bars, and other geometries that support border customization. This set of aesthetics allows you to adjust the color, line type, and width of the borderlines to enhance the visual appeal and clarity of your plots.
Available aesthetics within borderLine
:
borderLine.color
— Specifies the color of the borderline.borderLine.type
— Determines the style of the borderline.borderLine.width
— Controls the thickness of the borderline.
borderLine.color
Optional NonPositional
Iterable Column String Color
The color aesthetic is a key feature in data visualization, allowing you to set the color of plot elements to enhance the interpretability and visual appeal of your graphs. This aesthetic facilitates both the differentiation of data points and the conveyance of additional data dimensions through color.
Setting
color = Color
: assigns a uniform color to all elements within a layer. The value can be a predefinedColor
constant likeColor.RED
or a custom color defined byColor.hex("#ff0000")
.
Mapping
color(Iterable)
: links the color of each element to a value from an iterable collection, allowing for varied color assignments within a layer.color(ColumnReference | KProperty | DataColumn)
: associates element colors with a column in the DataFrame, enabling data-driven color variations.color(String)
: connects colors to data based on the column name in the DataFrame or by key in a Map, offering flexibility in data representation.
Characteristics of the color
aesthetic
Versatility in data representation — The
color
aesthetic can be used to represent different categories, intensities, or other data dimensions, providing a rich layer of information in visualizations.Scaling and validation — When mapping
color
to data, you can customize the color scale and adjust the mapping to fit specific visualization needs.
borderLine.type
Optional NonPositional
Iterable Column String LineType
The type aesthetic is used to specify the style of lines in a plot, allowing for a diverse range of visual representations. This aesthetic enables the customization of line styles, providing clarity and distinction in data visualizations.
Setting
type = LineType
: applies a specific line style to lines within a layer. The value can be one of the predefinedLineType
constants:LineType.BLANK
LineType.SOLID
LineType.DASHED
LineType.DOTTED
LineType.DOTDASH
LineType.LONGDASH
LineType.TWODASH
Mapping
type(Iterable)
: links the line style of each element to a value from an iterable collection, allowing for various line styles within a single layer.type(ColumnReference | KProperty | DataColumn)
: associates line styles with a column in the DataFrame, facilitating data-driven line style variations.type(String)
: connects line styles to data based on the column name in the DataFrame or by key in a Map, offering flexibility in line style representation.
borderLine.width
Optional NonPositional
Iterable Column String Double
The width
aesthetic is crucial for adjusting the width of visual elements across various plot types, including bars
, boxes
, crossBars
, errorBars
, and tiles
.
Setting
width = Double
: Provides a uniform width to all applicable elements within a layer. The Double value is representation of width, for instance,width = 0.9
would set the width of elements to 0.9 units.
Mapping
width(Iterable)
: each element's width is associated with a value from an iterable collection, allowing for the representation of data variations through width differences.width(ColumnReference | KProperty | DataColumn)
: element widths are linked to a DataFrame column, enabling visualization of data-driven width variations.width(String)
: connects widths to data based on the column name in the DataFrame or by a key in a Map, providing flexibility in representing data through width.
Free Scales
x
Optional
AxisParameters
The Free Scale X
aesthetic provides advanced customization for the x-axis in plots, offering a flexible approach to setting axis parameters beyond the standard positional aesthetics.
Modifying Axis Parameters
x { ... }
— Directly manipulates the x-axis parameters through a lambda function, providing a straightforward way to apply custom configurations to the x-axis. The free scalex
allows for detailed customization of the x-axis, including but not limited to setting axis limits and adjusting axis appearance.
y
Optional
AxisParameters
The Free Scale Y
aesthetic provides advanced customization for the y-axis in plots, offering a flexible approach to setting axis parameters beyond the standard positional aesthetics.
Modifying Axis Parameters
y { ... }
— Directly manipulates the y-axis parameters through a lambda function, providing a straightforward way to apply custom configurations to the y-axis. The free scaley
allows for detailed customization of the y-axis, including but not limited to setting axis limits and adjusting axis appearance.