Text.Pandoc.ImageSize

Functions for determining the size of a PNG, JPEG, or GIF image.

Documentation

data ImageType

Constructors

Png

Gif

Jpeg

Svg

Pdf

Eps

Emf

Instances

Show ImageType

Defined in Text.Pandoc.ImageSize

Methods

showsPrec :: Int -> ImageType -> ShowS

show :: ImageType -> String

showList :: [ImageType] -> ShowS

imageType :: ByteString -> Maybe ImageType

imageSize :: WriterOptions -> ByteString -> Either String ImageSize

sizeInPixels :: ImageSize -> (Integer, Integer)

sizeInPoints :: ImageSize -> (Double, Double)

Calculate (height, width) in points using the image file's dpi metadata, using 72 Points == 1 Inch.

desiredSizeInPoints :: WriterOptions -> Attr -> ImageSize -> (Double, Double)

Calculate (height, width) in points, considering the desired dimensions in the attribute, while falling back on the image file's dpi metadata if no dimensions are specified in the attribute (or only dimensions in percentages).

data Dimension

Constructors

Pixel Integer

Centimeter Double

Millimeter Double

Inch Double

Percent Double

Em Double

Instances

Eq Dimension

Defined in Text.Pandoc.ImageSize

Methods

(==) :: Dimension -> Dimension -> Bool

(/=) :: Dimension -> Dimension -> Bool

Show Dimension

Defined in Text.Pandoc.ImageSize

Methods

showsPrec :: Int -> Dimension -> ShowS

show :: Dimension -> String

showList :: [Dimension] -> ShowS

data Direction

Constructors

Width

Height

Instances

Show Direction

Defined in Text.Pandoc.ImageSize

Methods

showsPrec :: Int -> Direction -> ShowS

show :: Direction -> String

showList :: [Direction] -> ShowS

dimension :: Direction -> Attr -> Maybe Dimension

Read a Dimension from an Attr attribute. `dimension Width attr` might return `Just (Pixel 3)` or for example `Just (Centimeter 2.0)`, etc.

lengthToDim :: String -> Maybe Dimension

scaleDimension :: Double -> Dimension -> Dimension

Scale a dimension by a factor.

inInch :: WriterOptions -> Dimension -> Double

inPixel :: WriterOptions -> Dimension -> Integer

inPoints :: WriterOptions -> Dimension -> Double

inEm :: WriterOptions -> Dimension -> Double

numUnit :: String -> Maybe (Double, String)

Maybe split a string into a leading number and trailing unit, e.g. "3cm" to Just (3.0, "cm")

showInInch :: WriterOptions -> Dimension -> String

Convert a Dimension to a String denoting its equivalent in inches, for example "2.00000". Note: Dimensions in percentages are converted to the empty string.

showInPixel :: WriterOptions -> Dimension -> String

Convert a Dimension to a String denoting its equivalent in pixels, for example "600". Note: Dimensions in percentages are converted to the empty string.

showFl :: RealFloat a => a -> String