Text.Pandoc.Filter.FigureSpec

This module defines types and functions that help with keeping track of figure specifications

Documentation

data FigureSpec

Datatype containing all parameters required to run pandoc-pyplot

Constructors

FigureSpec

Fields

• caption :: String

  Figure caption.

• script :: PythonScript

  Source code for the figure.

• saveFormat :: SaveFormat

  Save format of the figure

• directory :: FilePath

  Directory where to save the file

• dpi :: Int

  Dots-per-inch of figure

• blockAttrs :: Attr

  Attributes not related to pandoc-pyplot will be propagated.

Instances

Hashable FigureSpec

Defined in Text.Pandoc.Filter.FigureSpec

Methods

hashWithSalt :: Int -> FigureSpec -> Int

hash :: FigureSpec -> Int

data SaveFormat

Constructors

PNG

PDF

SVG

JPG

EPS

saveFormatFromString :: String -> Maybe SaveFormat

Parse an image save format string

toImage :: FigureSpec -> Block

Convert a FigureSpec to a Pandoc block component

sourceCodePath :: FigureSpec -> FilePath

Determine the path to the source code that generated the figure.

figurePath :: FigureSpec -> FilePath

Determine the path a figure should have.

addPlotCapture

Arguments

:: FigureSpec

Path where to save the figure

-> PythonScript

Code block with added capture

Modify a Python plotting script to save the figure to a filename. An additional file will also be captured.

extension :: SaveFormat -> String

Save format file extension