Package io.data2viz.charts.core

Types

Bandwidth
Link copied to clipboard
common
enum Bandwidth : Enum<Bandwidth>
The "bandwidth" of discrete axes, enable it for marks that require bandwidth (bars...), or disable it for marks that don't (area, lines...).
ChartDSL
Link copied to clipboard
common
annotation class ChartDSL
DOCUMENTATION WIP: this element may change or be deprecated soon.
CircleZone
Link copied to clipboard
common
data class CircleZone(center: Point, radius: Double) : Zone
A Zone shaped as a circle, used to indicate interactive zones in a Chart.
CursorType
Link copied to clipboard
common
enum CursorType : Enum<CursorType>
Cursor type: change cursor appearance and behavior depending on your chart.
Dataset
Link copied to clipboard
common
class Dataset<DOMAIN>
Container for the Chart data, gives access to various properties.
Datum
Link copied to clipboard
common
data class Datum<DOMAIN>(dataset: Dataset<DOMAIN>, domain: DOMAIN, indexInData: Int)
Decorate a <DOMAIN> object with several information.
DirectedZoom
Link copied to clipboard
common
data class DirectedZoom(ratio: Double, offset: Double)
A Zoom on a specific direction (it could be x, y, radial).
DoubleFormatters
Link copied to clipboard
common
object DoubleFormatters
List of formatters for Double.
Font
Link copied to clipboard
common
interface Font
All the font properties needed to draw text.
GridPosition
Link copied to clipboard
common
enum GridPosition : Enum<GridPosition>
The display of an element relative to a point, in 9 different positions.
HighlightMode
Link copied to clipboard
common
enum HighlightMode : Enum<HighlightMode>
Highlighting behaviors, define how to handle the highlight of Mark.
InstantFormatters
Link copied to clipboard
common
object InstantFormatters
List of formatters for Double.
Labelled
Link copied to clipboard
common
interface Labelled
Implements the Labelled interface in your business objects so Charts-kt will format them automatically.
LayoutPosition
Link copied to clipboard
common
enum LayoutPosition : Enum<LayoutPosition>
The display position of an element relative to the main charting zone.
LegendLayout
Link copied to clipboard
common
enum LegendLayout : Enum<LegendLayout>
Internal layout of a Legend box.
LegendPosition
Link copied to clipboard
common
enum LegendPosition : Enum<LegendPosition>
External layout of a Legend box, where it will be placed on screen.
LegendVisibility
Link copied to clipboard
common
enum LegendVisibility : Enum<LegendVisibility>
Visibility of the Legend component.
MarkLabel
Link copied to clipboard
common
enum MarkLabel : Enum<MarkLabel>
Display X/Y information for a given Mark sign.
Orientation
Link copied to clipboard
common
enum Orientation : Enum<Orientation>
Orientation of a visual component.
Padding
Link copied to clipboard
common
data class Padding(top: Double, right: Double, bottom: Double, left: Double)
Padding of an element.
PanMode
Link copied to clipboard
common
enum PanMode : Enum<PanMode>
Panning behavior, use it to authorize or restrict panning.
RectZone
Link copied to clipboard
common
data class RectZone(topLeft: Point, bottomRight: Point) : Zone
A Zone shaped as a rectangle, used to indicate interactive zones in a Chart.
SelectionMode
Link copied to clipboard
common
enum SelectionMode : Enum<SelectionMode>
Selection behaviors, define how to handle the selection of Mark symbols.
Stroke
Link copied to clipboard
common
interface Stroke
All the stroke properties needed to draw signs.
TriggerMode
Link copied to clipboard
common
enum TriggerMode : Enum<TriggerMode>
Define when to trigger an event when interacting with a Mark sign, based on the cursor position.
UserAction
Link copied to clipboard
common
enum UserAction : Enum<UserAction>
User action defined on a mouse event.
Zone
Link copied to clipboard
common
interface Zone
A Zone represents a simple shape that indicates this screen zone can interact with user.
Zoom
Link copied to clipboard
common
data class Zoom(xZoom: DirectedZoom, yZoom: DirectedZoom)
A Zoom object stores information of the current zoom on X and Y directions.
ZoomMode
Link copied to clipboard
common
enum ZoomMode : Enum<ZoomMode>
Zoom behavior, use it to authorize or restrict zooming.

Functions

Font
Link copied to clipboard
common
fun Font(fontSize: Double = 12.0, fontColor: Color = Colors.Web.black, fontFamily: FontFamily = FontFamily.SANS_SERIF, fontWeight: FontWeight = FontWeight.NORMAL, fontStyle: FontPosture = FontPosture.NORMAL): Font
Instantiate a Font.
formatSmart
Link copied to clipboard
common
fun Double?.formatSmart(locale: Locale): String
"Smart format" the Double.
formatToBinary
Link copied to clipboard
common
fun Double?.formatToBinary(locale: Locale = Locale()): String
Format the Double to binary notation.
formatToDate
Link copied to clipboard
common
fun Instant.formatToDate(locale: Locale): String
Format the Instant to date (no time).
formatToDateTime
Link copied to clipboard
common
fun Instant.formatToDateTime(locale: Locale): String
Format the Instant to full dateTime
formatToDecimal
Link copied to clipboard
common
fun Double?.formatToDecimal(locale: Locale = Locale()): String
Format the Double to decimal notation, rounded to significant digits.
formatToExponent
Link copied to clipboard
common
fun Double?.formatToExponent(locale: Locale = Locale()): String
Format the Double to exponent notation.
formatToFixedPoint
Link copied to clipboard
common
fun Double?.formatToFixedPoint(locale: Locale = Locale()): String
Format the Double to fixed point notation.
formatToHexadecimal
Link copied to clipboard
common
fun Double?.formatToHexadecimal(locale: Locale = Locale()): String
Format the Double to hexadecimal notation.
formatToInteger
Link copied to clipboard
common
fun Double?.formatToInteger(locale: Locale = Locale()): String
Format the Double to a rounded integer.
formatToOctal
Link copied to clipboard
common
fun Double?.formatToOctal(locale: Locale = Locale()): String
Format the Double to octal notation.
formatToPercent
Link copied to clipboard
common
fun Double?.formatToPercent(locale: Locale = Locale()): String
Format the Double to percentage notation.
formatToPercentInteger
Link copied to clipboard
common
fun Double?.formatToPercentInteger(locale: Locale = Locale()): String
Format the Double to percentage notation rounded to significant digits.
formatToSI
Link copied to clipboard
common
fun Double?.formatToSI(locale: Locale = Locale()): String
Format the Double to SI notation.
measureText
Link copied to clipboard
common
fun measureText(textNode: TextNode): RectGeom
Returns the bounds of the TextNode, no transformation is applied.
common
fun measureText(text: String, font: Font): RectGeom
Returns the bounds of a text to be drawn on screen.
js
fun measureText(text: String, font: Font): RectGeom
Returns the bounds of a text to be drawn on screen.
fun measureText(text: String, font: Font): RectGeom
Returns the bounds of a text to be drawn on screen.