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 #
Methods (==) :: LightningError -> LightningError -> Bool # (/=) :: LightningError -> LightningError -> Bool #
Show LightningError Source #
Methods showsPrec :: Int -> LightningError -> ShowS # show :: LightningError -> String # showList :: [LightningError] -> ShowS #
FromJSON LightningError Source #
Methods parseJSON :: Value -> Parser LightningError #
ErrorReceivable LightningError Source #
Methods receiveError :: Response ByteString -> Maybe LightningError #

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

Eq Session Source #
Methods (==) :: Session -> Session -> Bool # (/=) :: Session -> Session -> Bool #
Read Session Source #
Methods readsPrec :: Int -> ReadS Session # readList :: ReadS [Session] # readPrec :: ReadPrec Session # readListPrec :: ReadPrec [Session] #
Show Session Source #
Methods showsPrec :: Int -> Session -> ShowS # show :: Session -> String # showList :: [Session] -> ShowS #
FromJSON Session Source #
Methods parseJSON :: Value -> Parser Session #
Receivable Session Source #
Methods receive :: ErrorReceivable e => Response ByteString -> Either (APIError e) Session #
Default Session Source #
Methods def :: Session #

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 #
Methods showsPrec :: Int -> Visualization -> ShowS # show :: Visualization -> String # showList :: [Visualization] -> ShowS #
FromJSON Visualization Source #
Methods parseJSON :: Value -> Parser Visualization #
Receivable Visualization Source #
Methods receive :: ErrorReceivable e => Response ByteString -> Either (APIError e) Visualization #

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

Represents an image as a matrix of pixels.