lightning-haskell-0.1.0.3: Haskell client for lightning-viz REST API

Copyright(c) Connor Moreside, 2016
LicenseBSD-3
Maintainerconnor@moresi.de
Stabilityexperimental
PortabilityPOSIX
Safe HaskellNone
LanguageHaskell2010

Web.Lightning.Types.Visualization

Contents

Description

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

Synopsis

Visualization Types

data Visualization Source

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

Visualization Helper Functions

getEmbedLink Source

Arguments

:: Visualization

Visualization to create embedded link

-> Text

Returns the embedded link for visualization

Returns the embedded link URL for a visualization.

getIFrameLink Source

Arguments

:: Visualization

Visualization to create iFrame link for

-> Text

Returns the iFrame link for visualization

Returns the iFrame link URL for a visualization

getPymLink Source

Arguments

:: Visualization

Visualization to create PYM link for

-> Text

Returns the PYM link for visualization

Returns the PYM link for visualization.

getPublicLink Source

Arguments

:: Visualization

Visualization to create public link for.

-> Text

Returns the public link for visualization.

Returns the public link for a visualization.