Options
All
  • Public
  • Public/Protected
  • All
Menu

Module src/types/RealRendererTypes

Index

Interfaces

Type aliases

Type aliases

BGAxes

BGAxes: { axesColor: Color; type: "axes"; xOffset: number; yOffset: number }

Backround with axes.

Type declaration

  • axesColor: Color
  • type: "axes"
  • xOffset: number

    %age offset of the y-axis (in the x-direction).

  • yOffset: number

    %age offset of the x-axis (in the y-direction).

BGGrid

BGGrid: { lineColor: Color; type: "grid"; xSpacing: number; ySpacing: number }

Background with grid.

Type declaration

  • lineColor: Color
  • type: "grid"
  • xSpacing: number

    Percentage spacing between the vertical grid lines lines.

  • ySpacing: number

    Percentage spacing between the horizontal grid lines lines.

BGNone

BGNone: { type: "none" }

Solid background.

Type declaration

  • type: "none"

BGRuled

BGRuled: { lineColor: Color; orientation: "vertical" | "horizontal"; spacing: number; type: "ruled" }

Ruled background.

Type declaration

  • lineColor: Color
  • orientation: "vertical" | "horizontal"
  • spacing: number

    Percentage spacing between the ruled lines.

  • type: "ruled"

BGType

BGType: BGNone | BGRuled | BGGrid | BGAxes

Color

Color: [number, number, number]

An array of R, G and B colors ranging between 0 and 1.

Coordinate

Coordinate: [number, number]

A coordinate in the format [x, y].

GraphDimensions

GraphDimensions: [number, number]

Dimensions of the graph in the format [width, height].

RealExport

RealExport: IRealExportV1 | IRealExportV2

RealRendererOptions

RealRendererOptions: IRealRendererNonOptionals & IRealRendererOptionals | {}

RealRendererParameters

RealRendererParameters: IRealRendererOptionals | {}

RealRendererSettings

RealRendererSettings: IRealRendererNonOptionals & IRealRendererOptionals

SVGSection

SVGSection: "bg" | "strokes" | "overlay"

SVGSections

SVGSections: {[ Property in SVGSection]: SVGGElement }

Stroke

Stroke: StrokeNode[]

One stroke is an combination of multiple stroke nodes

StrokeExportV1

StrokeExportV1: StrokeNodeDataV1[]
deprecated

StrokeExportV2

StrokeExportV2: StrokeNodeDataV2[]

StrokeNode

StrokeNode: Path | Circle | Text | Polygon | GroupNode

StrokeNodeDataV1

StrokeNodeDataV1: { data: string; section: SVGSection; type: StrokeNodeType }
deprecated

Type declaration

StrokeNodeDataV2

StrokeNodeDataV2: ITextNodeData | ICircleNodeData | IGroupNodeData | IPathNodeData | IPolygonNodeData

StrokeNodeType

StrokeNodeType: "path" | "circle" | "text" | "polygon" | "group"

Generated using TypeDoc