types

type ArrayOK ¶

type ArrayOK[T any] struct {
	Value T
	Array []T
}

ArrayOK is a type that allows you to define a single value or an array of values, But not both. If Array is defined, Value will be ignored.

func ArrayOKArray[T any](array ...T) *ArrayOK[*T]

func ArrayOKValue[T any](value T) *ArrayOK[*T]

func (arrayOK *ArrayOK[T]) MarshalJSON() ([]byte, error)

func (arrayOK *ArrayOK[T]) UnmarshalJSON(data []byte) error

type BDataArrayType ¶ added in v0.7.0

type BDataArrayType struct {
	Dtype DType          `json:"dtype,omitempty"`
	Bdata []byte         `json:"bdata,omitempty"`
	Shape DataArrayShape `json:"shape,omitempty"`
}

type BoolType ¶ added in v0.7.0

type BoolType *bool

BoolType represents a *bool value. Needed to tell the different between false and nil.

var (

	// True is a *bool with true value
	True BoolType = &trueValue
	// False is a *bool with false value
	False BoolType = &falseValue
)

func B(v bool) BoolType

func BA(v []bool) []BoolType

type Color ¶

type Color string

Color A string describing color. Supported formats: - hex (e.g. '#d3d3d3') - rgb (e.g. 'rgb(255, 0, 0)') - rgba (e.g. 'rgb(255, 0, 0, 0.5)') - hsl (e.g. 'hsl(0, 100%, 50%)') - hsv (e.g. 'hsv(0, 100%, 100%)') - named colors (full list: http://www.w3.org/TR/css3-color/#svg-color)",

func C(v string) Color

func CN(v []string) []Color

type ColorList ¶

type ColorList []Color

ColorList A list of colors. Must be an {array} containing valid colors.

type ColorScale ¶

type ColorScale struct {
	Name   string
	Values []ColorScaleReference
}

ColorScale A Plotly colorscale either picked by a name: (any of Greys, YlGnBu, Greens, YlOrRd, Bluered, RdBu, Reds, Blues, Picnic, Rainbow, Portland, Jet, Hot, Blackbody, Earth, Electric, Viridis, Cividis ) customized as an {array} of 2-element {arrays} where the first element is the normalized color level value (starting at *0* and ending at *1*), and the second item is a valid color string.

func (cs *ColorScale) MarshalJSON() ([]byte, error)

func (cs *ColorScale) UnmarshalJSON(data []byte) error

type ColorScaleReference ¶

type ColorScaleReference struct {
	NormalizedValue float64
	Color           Color
}

func (cs *ColorScaleReference) MarshalJSON() ([]byte, error)

type ColorWithColorScale ¶

type ColorWithColorScale struct {
	Color *Color
	Value float64
}

func UseColor(in Color) ColorWithColorScale

func UseColorScaleValues(in []float64) []ColorWithColorScale

func UseColors(in []Color) []ColorWithColorScale

func (c *ColorWithColorScale) MarshalJSON() ([]byte, error)

func (c *ColorWithColorScale) UnmarshalJSON(data []byte) error

type DType ¶ added in v0.7.0

type DType string

const (
	DTypeFloat64 DType = "float64"
	DTypeFloat32 DType = "float32"
	DTypeInt32   DType = "int32"
	DTypeUInt32  DType = "uint32"
	DTypeInt16   DType = "int16"
	DTypeUInt16  DType = "uint16"
	DTypeInt8    DType = "int8"
	DTypeUInt8   DType = "uint8"
	DTypeUInt8c  DType = "uint8c"
)

type DataArrayShape ¶ added in v0.7.0

type DataArrayShape []int

func (d DataArrayShape) MarshalJSON() ([]byte, error)

func (d *DataArrayShape) UnmarshalJSON(data []byte) error

type DataArrayType ¶ added in v0.7.0

type DataArrayType struct {
	// contains filtered or unexported fields
}

DataArrayType An {array} of data. The value must represent an {array} or it will be ignored, but this array can be provided in several forms: (1) a regular {array} object (2) a typed array (e.g. Float32Array) (3) an object with keys dtype, bdata, and optionally shape. In this 3rd form, dtype is one of *f8*, *f4*. *i4*, *u4*, *i2*, *u2*, *i1*, *u1* or *u1c* for Uint8ClampedArray. In addition to shorthand `dtype` above one could also use the following forms: *float64*, *float32*, *int32*, *uint32*, *int16*, *uint16*, *int8*, *uint8* or *uint8c* for Uint8ClampedArray. `bdata` is either a base64-encoded string or the ArrayBuffer of an integer or float typed array. For either multi-dimensional arrays you must also provide its dimensions separated by comma via `shape`. For example using `dtype`: *f4* and `shape`: *5,100* you can declare a 2-D array that has 5 rows and 100 columns containing float32 values i.e. 4 bits per value. `shape` is optional for one dimensional arrays.",

func BDataArray(dtype DType, bdata []byte, shape []int) *DataArrayType

func DataArray[T any](data []T) *DataArrayType

func (d *DataArrayType) MarshalJSON() ([]byte, error)

func (d *DataArrayType) UnmarshalJSON(data []byte) error

func (da *DataArrayType) Value() interface{}

type Fig ¶

type Fig interface {
	Info() Version
}

Fig Represents a plotly figure use the Info method to get details about the plotly version

type IntegerType ¶ added in v0.7.0

type IntegerType *int

IntegerType as defined by plotly schema

func I(n int) IntegerType

func IA(n []int) []IntegerType

func IS(n string) IntegerType

type NumberType ¶ added in v0.7.0

type NumberType *float64

NumberType as defined by plotly schema

func N(n float64) NumberType

func NA(n []float64) []NumberType

func NS(n string) NumberType

type StringType ¶ added in v0.7.0

type StringType string

StringType as defined by plotly schema This is not *string because I do not see any case where an empty string is a desired input for plotly and having this as string makes it much easier to work with the package.

func S(v string) StringType

type Trace ¶

type Trace interface {
	GetType() TraceType
}

Trace Every trace implements this interface It is useful for autocompletion, it is a better idea to use type assertions/switches to identify trace types

type TraceType ¶

type TraceType string

TraceType is the type for the TraceType field on every trace

type Version ¶

type Version struct {
	Name      string `yaml:"Name"`      // name of the version
	Tag       string `yaml:"Tag"`       // git tag of the plotly version
	URL       string `yaml:"URL"`       // url under which the plotly schema json file can be downloaded directly
	Path      string `yaml:"Path"`      // path under which the schema file will be saved locally for future use
	Generated string `yaml:"Generated"` // path for the generated package
	Cdn       string `yaml:"CDN"`       // url for the cdn which should be included in the head of the generated html
}