Web.Lightning.Types

Contents

Description

Re-exports all the main types one is likely to need.

Synopsis

Lightning Types

Represents the different errors that may be raised in the lightning-viz wrapper.

Constructors

LightningError Object	Represents a JSON error returned by lightning-viz.
FailError Text	Represents a generic exception error.
ValidationError Text	Represents a validation error in a request record.

Instances

Eq LightningError Source
Show LightningError Source
FromJSON LightningError Source
ErrorReceivable LightningError Source

Represents a lightning-viz session. A session ID is required to create a plot.

Constructors

Session
Fields snId :: Text The unique session ID snName :: Maybe Text The optional session name snUpdated :: Maybe Text The timestamp of when the session was last updated snCreated :: Maybe Text Creation timestamp

Instances

Encapsulates the basic information about a created visualization.

Constructors

Visualization
Fields vizId :: Text The unique identifier for a visualization vizSessionID :: Text The session ID the visualization was created in vizBaseUrl :: Maybe Text Base URL gets filled in later

Instances

Show Visualization Source
FromJSON Visualization Source
Receivable Visualization Source

Can represent an RGBA [red, green, blue, alpha], RGB [red, green, blue], and GreyScale [intensity] pixel.

Represents an image as a matrix of pixels.