Index

Modules: plotly, plotly/api, plotly/color, plotly/errorbar, plotly/image_retrieve, plotly/plotly_display, plotly/plotly_subplots, plotly/plotly_sugar, plotly/plotly_types, plotly/predefined_colormaps.

API symbols

`$`:

• api: proc `$`(d: Trace): string

`%`:

• api: proc `%`(a: Annotation): JsonNode
• api: proc `%`(a: Axis): JsonNode
• api: proc `%`(c: Color): JsonNode
• api: proc `%`(b: ErrorBar): JsonNode
• api: proc `%`(f: Font): JsonNode
• api: proc `%`(l: Layout): JsonNode
• api: proc `%`(l: Legend): JsonNode
• api: proc `%`(m: Marker): JsonNode
• api: proc `%`(t: Trace): JsonNode

`[]=`:

• plotly_subplots: proc `[]=`[T](grid: var Grid; idx: int; plt: Plot[T])
• plotly_subplots: proc `[]=`[T](grid: var Grid; coord: tuple[row, col: int]; plt: Plot[T])

`[]`:

• plotly_subplots: proc `[]`(grid: Grid; idx: int): PlotJson
• plotly_subplots: proc `[]`(grid: Grid; coord: tuple[row, col: int]): PlotJson

add:

• plotly_subplots: proc add[T](grid: var Grid; plt: Plot[T])

addTrace:

• plotly_sugar: proc addTrace[T](plt: Plot[T]; t: Trace[T]): Plot[T]

Annotation:

• plotly_types: type Annotation

Axis:

• plotly_types: type Axis

AxisType:

• plotly_types: enum AxisType

backgroundColor:

• plotly_sugar: proc backgroundColor[T](plt: Plot[T]; color: Color): Plot[T]

BarAlign:

• plotly_types: enum BarAlign

BarMode:

• plotly_types: enum BarMode

barPlot:

• plotly_sugar: template barPlot(x, y: untyped): untyped

binRange:

• plotly_sugar: proc binRange[T](plt: Plot[T]; start, stop: float; idx = 0): Plot[T]

binSize:

• plotly_sugar: proc binSize[T](plt: Plot[T]; size: float; idx = 0): Plot[T]

colormap:

• plotly_sugar: proc colormap[T; U: AllowedColorMap](plt: Plot[T]; colormap: U; idx = 0): Plot[T]

ColorMap:

• plotly_types: enum ColorMap

convertDomain:

• plotly_subplots: proc convertDomain(d: Domain | DomainAlt): Domain

createGrid:

• plotly_subplots: proc createGrid(numPlots: int; numPlotsPerRow = 0; layout = Layout()): Grid
• plotly_subplots: proc createGrid(size: tuple[rows, cols: int]; layout = Layout()): Grid

CustomColorMap:

• plotly_types: type CustomColorMap

Domain:

• plotly_types: tuple Domain

DomainAlt:

• plotly_types: tuple DomainAlt

ebkArrayAsym:

• plotly_types: ErrorBarKind.ebkArrayAsym

ebkArraySym:

• plotly_types: ErrorBarKind.ebkArraySym

ebkConstantAsym:

• plotly_types: ErrorBarKind.ebkConstantAsym

ebkConstantSym:

• plotly_types: ErrorBarKind.ebkConstantSym

ebkPercentAsym:

• plotly_types: ErrorBarKind.ebkPercentAsym

ebkPercentSym:

• plotly_types: ErrorBarKind.ebkPercentSym

ebkSqrt:

• plotly_types: ErrorBarKind.ebkSqrt

empty:

• color: proc empty(): Color

ErrorBar:

• plotly_types: type ErrorBar

ErrorBarKind:

• plotly_types: enum ErrorBarKind

Font:

• plotly_types: type Font

getCustomMap:

• color: proc getCustomMap(customMap: PredefinedCustomMaps): CustomColorMap

Grid:

• plotly_subplots: object Grid

gridColor:

• plotly_sugar: proc gridColor[T](plt: Plot[T]; color: Color): Plot[T]

gridColorX:

• plotly_sugar: proc gridColorX[T](plt: Plot[T]; color: Color): Plot[T]

gridColorY:

• plotly_sugar: proc gridColorY[T](plt: Plot[T]; color: Color): Plot[T]

gridWidth:

• plotly_sugar: proc gridWidth[T](plt: Plot[T]; width: int): Plot[T]

gridWidthX:

• plotly_sugar: proc gridWidthX[T](plt: Plot[T]; width: int): Plot[T]

gridWidthY:

• plotly_sugar: proc gridWidthY[T](plt: Plot[T]; width: int): Plot[T]

hasThreadSupport:

• plotly_display: const hasThreadSupport

heatmap:

• plotly_sugar: template heatmap[T](z: seq[seq[T]]): untyped
• plotly_sugar: template heatmap(x, y, z: untyped): untyped

heatmapTrace:

• plotly_sugar: proc heatmapTrace[T](z: seq[seq[T]]): Trace[T]

height:

• plotly_sugar: proc height[T, U: SomeNumber](plt: Plot[T]; height: U): Plot[T]

HistFunc:

• plotly_types: enum HistFunc

HistNorm:

• plotly_types: enum HistNorm

histPlot:

• plotly_sugar: template histPlot(hist: untyped): untyped

histTrace:

• plotly_sugar: proc histTrace[T](hist: seq[T]): Trace[T]

HoverMode:

• plotly_types: enum HoverMode

Inferno:

• plotly_types: PredefinedCustomMaps.Inferno

InfernoRaw:

• predefined_colormaps: let InfernoRaw

InfernoZeroWhite:

• plotly_types: PredefinedCustomMaps.InfernoZeroWhite

isEmpty:

• color: proc isEmpty(c: Color): bool

json:

• api: proc json(d: Trace; as_pretty = false): string

Layout:

• plotly_types: type Layout

legend:

• plotly_sugar: proc legend[T](plt: Plot[T]; legend: Legend): Plot[T]

Legend:

• plotly_types: type Legend

legendBgColor:

• plotly_sugar: proc legendBgColor[T](plt: Plot[T]; color: Color): Plot[T]

legendBorderColor:

• plotly_sugar: proc legendBorderColor[T](plt: Plot[T]; color: Color): Plot[T]

legendBorderWidth:

• plotly_sugar: proc legendBorderWidth[T](plt: Plot[T]; width: int): Plot[T]

legendLocation:

• plotly_sugar: proc legendLocation[T](plt: Plot[T]; x, y: float): Plot[T]

legendOrientation:

• plotly_sugar: proc legendOrientation[T](plt: Plot[T]; orientation: Orientation): Plot[T]

lineWidth:

• plotly_sugar: proc lineWidth[T](plt: Plot[T]; val: SomeNumber; idx = 0): Plot[T]

listenForImage:

• image_retrieve: proc listenForImage(filename: string)

Magma:

• plotly_types: PredefinedCustomMaps.Magma

MagmaRaw:

• predefined_colormaps: let MagmaRaw

MagmaZeroWhite:

• plotly_types: PredefinedCustomMaps.MagmaZeroWhite

makePlotlyCustomMap:

• color: proc makePlotlyCustomMap(map: CustomColorMap): JsonNode

makeZeroWhite:

• color: proc makeZeroWhite(cmap: CmapData): CmapData

Marker:

• plotly_types: type Marker

markerColor:

• plotly_sugar: proc markerColor[T](plt: Plot[T]; colors: seq[Color] | seq[T] = @[]; map: ColorMap = ColorMap.None; idx = 0): Plot[T]

markerSize:

• plotly_sugar: proc markerSize[T](plt: Plot[T]; val: SomeNumber; idx = 0): Plot[T]

markerSizes:

• plotly_sugar: proc markerSizes[T](plt: Plot[T]; sizes: seq[T]; idx = 0): Plot[T]

mode:

• plotly_sugar: proc mode[T](plt: Plot[T]; m: PlotMode; idx = 0): Plot[T]

name:

• plotly_sugar: proc name[T](plt: Plot[T]; name: string; idx = 0): Plot[T]

nbins:

• plotly_sugar: proc nbins[T](plt: Plot[T]; nbins: int; idx = 0): Plot[T]

newErrorBar:

• errorbar: proc newErrorBar[T: SomeNumber](color: Color = empty(); thickness = 0.0; width = 0.0; visible = true): ErrorBar[T]
• errorbar: proc newErrorBar[T](err: seq[T]; color: Color = empty(); thickness = 0.0; width = 0.0; visible = true): ErrorBar[T]
• errorbar: proc newErrorBar[T: SomeNumber](err: T; color: Color = empty(); thickness = 0.0; width = 0.0; visible = true; percent = false): ErrorBar[ T]
• errorbar: proc newErrorBar[T: SomeNumber](err: tuple[m, p: seq[T]]; color: Color = empty(); thickness = 0.0; width = 0.0; visible = true): ErrorBar[ T]
• errorbar: proc newErrorBar[T: SomeNumber](err: tuple[m, p: T]; color: Color = empty(); thickness = 0.0; width = 0.0; visible = true; percent = false): ErrorBar[T]

newPlot:

• plotly_sugar: proc newPlot(xlabel = ""; ylabel = ""; title = ""): Plot[float64]

Orientation:

• plotly_types: enum Orientation

Other:

• plotly_types: PredefinedCustomMaps.Other

paperColor:

• plotly_sugar: proc paperColor[T](plt: Plot[T]; color: Color): Plot[T]

parseImageType:

• image_retrieve: proc parseImageType(filename: string): string

parseTraces:

• plotly_display: proc parseTraces[T](traces: seq[Trace[T]]): string

Plasma:

• plotly_types: PredefinedCustomMaps.Plasma

PlasmaRaw:

• predefined_colormaps: let PlasmaRaw

PlasmaZeroWhite:

• plotly_types: PredefinedCustomMaps.PlasmaZeroWhite

Plot:

• plotly_types: type Plot

PlotFill:

• plotly_types: enum PlotFill

PlotJson:

• plotly_types: type PlotJson

PlotMode:

• plotly_types: enum PlotMode

PlotSide:

• plotly_types: enum PlotSide

PlotType:

• plotly_types: enum PlotType

pltLabel:

• plotly_sugar: template pltLabel(plt: untyped; axis: untyped; label: string): untyped

PredefinedCustomMaps:

• plotly_types: enum PredefinedCustomMaps

RangeSlider:

• plotly_types: type RangeSlider

roundOrIdent:

• plotly_sugar: proc roundOrIdent[T: SomeNumber](x: T): T

save:

• plotly_display: proc save(p: SomePlot; htmlPath = ""; htmlTemplate = defaultTmplString; filename = ""; autoResize = true): string

saveImage:

• plotly_display: proc saveImage(p: SomePlot; filename: string; htmlPath = ""; htmlTemplate = defaultTmplString; removeTempFile = false; autoResize = false)

scatterColor:

• plotly_sugar: template scatterColor(x, y, z: untyped): untyped

scatterPlot:

• plotly_sugar: template scatterPlot(x, y: untyped): untyped

scatterTrace:

• plotly_sugar: proc scatterTrace[T, U](x: seq[T]; y: seq[U]): Trace[T]

show:

• plotly_display: proc show(grid: Grid; filename = ""; htmlPath = ""; htmlTemplate = defaultTmplString; removeTempFile = false; autoResize = true)
• plotly_display: proc show(p: SomePlot; filename = ""; htmlPath = ""; htmlTemplate = defaultTmplString; onlySave: static bool = false; removeTempFile = false; autoResize = true)

SomePlot:

• plotly_types: type SomePlot

subplots:

• plotly_subplots: macro subplots(stmts: untyped): untyped

text:

• plotly_sugar: proc text[T; U: string | seq[string]](plt: Plot[T]; val: U; idx = 0): Plot[T]

title:

• plotly_sugar: proc title[T](plt: Plot[T]; t: string): Plot[T]

toHtmlHex:

• color: proc toHtmlHex(colors: seq[Color]): seq[string]

toPlotJson:

• api: proc toPlotJson[T](plt: Plot[T]): PlotJson
• plotly_subplots: proc toPlotJson(grid: Grid): PlotJson

Trace:

• plotly_types: type Trace

ViridisRaw:

• predefined_colormaps: let ViridisRaw

ViridisZeroWhite:

• plotly_types: PredefinedCustomMaps.ViridisZeroWhite

WhiteToBlack:

• plotly_types: PredefinedCustomMaps.WhiteToBlack

width:

• plotly_sugar: proc width[T, U: SomeNumber](plt: Plot[T]; width: U): Plot[T]

xlabel:

• plotly_sugar: proc xlabel[T](plt: Plot[T]; label: string): Plot[T]

ylabel:

• plotly_sugar: proc ylabel[T](plt: Plot[T]; label: string): Plot[T]

zmax:

• plotly_sugar: proc zmax[T](plt: Plot[T]; val: float; idx = 0): Plot[T]

zmin:

• plotly_sugar: proc zmin[T](plt: Plot[T]; val: float; idx = 0): Plot[T]