| Copyright | Copyright (C) 2011-2017 John MacFarlane |
|---|---|
| License | GNU GPL, version 2 or above |
| Maintainer | John MacFarlane <jgm@berkeley.edu> |
| Stability | alpha |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell98 |
Text.Pandoc.ImageSize
Description
Functions for determining the size of a PNG, JPEG, or GIF image.
- data ImageType
- imageType :: ByteString -> Maybe ImageType
- imageSize :: WriterOptions -> ByteString -> Either String ImageSize
- sizeInPixels :: ImageSize -> (Integer, Integer)
- sizeInPoints :: ImageSize -> (Double, Double)
- desiredSizeInPoints :: WriterOptions -> Attr -> ImageSize -> (Double, Double)
- data Dimension
- data Direction
- dimension :: Direction -> Attr -> Maybe Dimension
- lengthToDim :: String -> Maybe Dimension
- scaleDimension :: Double -> Dimension -> Dimension
- inInch :: WriterOptions -> Dimension -> Double
- inPixel :: WriterOptions -> Dimension -> Integer
- inPoints :: WriterOptions -> Dimension -> Double
- inEm :: WriterOptions -> Dimension -> Double
- numUnit :: String -> Maybe (Double, String)
- showInInch :: WriterOptions -> Dimension -> String
- showInPixel :: WriterOptions -> Dimension -> String
- showFl :: RealFloat a => a -> String
Documentation
imageSize :: WriterOptions -> ByteString -> Either String ImageSize Source #
sizeInPixels :: ImageSize -> (Integer, Integer) Source #
sizeInPoints :: ImageSize -> (Double, Double) Source #
Calculate (height, width) in points using the image file's dpi metadata, using 72 Points == 1 Inch.
desiredSizeInPoints :: WriterOptions -> Attr -> ImageSize -> (Double, Double) Source #
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).
dimension :: Direction -> Attr -> Maybe Dimension Source #
Read a Dimension from an Attr attribute. `dimension Width attr` might return `Just (Pixel 3)` or for example `Just (Centimeter 2.0)`, etc.
numUnit :: String -> Maybe (Double, String) Source #
Maybe split a string into a leading number and trailing unit, e.g. "3cm" to Just (3.0, "cm")
showInInch :: WriterOptions -> Dimension -> String Source #
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 Source #
Convert a Dimension to a String denoting its equivalent in pixels, for example "600". Note: Dimensions in percentages are converted to the empty string.