Web.Lightning.Types.Visualization

Describes the primary visualization return type along with some helper functions.

Visualization Types

data Visualization

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

Methods

showsPrec :: Int -> Visualization -> ShowS

show :: Visualization -> String

showList :: [Visualization] -> ShowS

FromJSON Visualization

Methods

parseJSON :: Value -> Parser Visualization

Receivable Visualization

Methods

receive :: ErrorReceivable e => Response ByteString -> Either (APIError e) Visualization

Visualization Helper Functions

getEmbedLink

Arguments

:: Visualization

Visualization to create embedded link

-> Text

Returns the embedded link for visualization

Returns the embedded link URL for a visualization.

getIFrameLink

Arguments

:: Visualization

Visualization to create iFrame link for

-> Text

Returns the iFrame link for visualization

Returns the iFrame link URL for a visualization

getPymLink

Arguments

:: Visualization

Visualization to create PYM link for

-> Text

Returns the PYM link for visualization

Returns the PYM link for visualization.

getPublicLink

Arguments

:: Visualization

Visualization to create public link for.

-> Text

Returns the public link for visualization.

Returns the public link for a visualization.