Codec.Xlsx.Types.Drawing

Documentation

data FileInfo

information about image file as a par of a drawing

Constructors

FileInfo

Fields

• _fiFilename :: FilePath

  image filename, images are assumed to be stored under path "xl/media/"

• _fiContentType :: Text

  image content type, ECMA-376 advises to use "image/png" or "image/jpeg" if interoperability is wanted

• _fiContents :: ByteString

  image file contents

Instances

Eq FileInfo

Methods

(==) :: FileInfo -> FileInfo -> Bool

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

Show FileInfo

Methods

showsPrec :: Int -> FileInfo -> ShowS

show :: FileInfo -> String

showList :: [FileInfo] -> ShowS

data Marker

Constructors

Marker

Fields

• _mrkCol :: Int
• _mrkColOff :: Coordinate
• _mrkRow :: Int
• _mrkRowOff :: Coordinate

Instances

Eq Marker

Methods

(==) :: Marker -> Marker -> Bool

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

Show Marker

Methods

showsPrec :: Int -> Marker -> ShowS

show :: Marker -> String

showList :: [Marker] -> ShowS

ToElement Marker

Methods

toElement :: Name -> Marker -> Element

FromCursor Marker

Methods

fromCursor :: Cursor -> [Marker]

unqMarker :: (Int, Int) -> (Int, Int) -> Marker

data EditAs

Constructors

EditAsTwoCell

EditAsOneCell

EditAsAbsolute

Instances

Eq EditAs

Methods

(==) :: EditAs -> EditAs -> Bool

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

Show EditAs

Methods

showsPrec :: Int -> EditAs -> ShowS

show :: EditAs -> String

showList :: [EditAs] -> ShowS

ToAttrVal EditAs

Methods

toAttrVal :: EditAs -> Text

FromAttrVal EditAs

Methods

fromAttrVal :: Reader EditAs

data Anchoring

Constructors

AbsoluteAnchor

Fields

• absaPos :: Point2D
• absaExt :: PositiveSize2D

OneCellAnchor

Fields

• onecaFrom :: Marker
• onecaExt :: PositiveSize2D

TwoCellAnchor

Fields

• tcaFrom :: Marker
• tcaTo :: Marker
• tcaEditAs :: EditAs

Instances

Eq Anchoring

Methods

(==) :: Anchoring -> Anchoring -> Bool

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

Show Anchoring

Methods

showsPrec :: Int -> Anchoring -> ShowS

show :: Anchoring -> String

showList :: [Anchoring] -> ShowS

FromCursor Anchoring

Methods

fromCursor :: Cursor -> [Anchoring]

data DrawingObject p g

Constructors

Picture

Fields

• _picMacro :: Maybe Text
• _picPublished :: Bool
• _picNonVisual :: PicNonVisual
• _picBlipFill :: BlipFillProperties p
• _picShapeProperties :: ShapeProperties

Graphic

Fields

• _grNonVisual :: GraphNonVisual
• _grChartSpace :: g
• _grTransform :: Transform2D

Instances

(Eq g, Eq p) => Eq (DrawingObject p g)

Methods

(==) :: DrawingObject p g -> DrawingObject p g -> Bool

(/=) :: DrawingObject p g -> DrawingObject p g -> Bool

(Show g, Show p) => Show (DrawingObject p g)

Methods

showsPrec :: Int -> DrawingObject p g -> ShowS

show :: DrawingObject p g -> String

showList :: [DrawingObject p g] -> ShowS

FromCursor (DrawingObject RefId RefId)

Methods

fromCursor :: Cursor -> [DrawingObject RefId RefId]

picture :: DrawingElementId -> FileInfo -> DrawingObject FileInfo c

basic function to create picture drawing object

Note: specification says that drawing element ids need to be unique within 1 document, otherwise /...document shall be considered non-conformant/.

extractPictures :: Drawing -> [(Anchoring, FileInfo)]

helper to retrive information about all picture files in particular drawing alongside with their anchorings (i.e. sizes and positions)

data ClientData

This element is used to set certain properties related to a drawing element on the client spreadsheet application.

see 20.5.2.3 "clientData (Client Data)" (p. 3156)

Constructors

ClientData

Fields

• _cldLcksWithSheet :: Bool

  This attribute indicates whether to disable selection on drawing elements when the sheet is protected.

• _cldPrintsWithSheet :: Bool

  This attribute indicates whether to print drawing elements when printing the sheet.

Instances

Eq ClientData

Methods

(==) :: ClientData -> ClientData -> Bool

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

Show ClientData

Methods

showsPrec :: Int -> ClientData -> ShowS

show :: ClientData -> String

showList :: [ClientData] -> ShowS

Default ClientData

Methods

def :: ClientData

ToElement ClientData

Methods

toElement :: Name -> ClientData -> Element

FromCursor ClientData

Methods

fromCursor :: Cursor -> [ClientData]

data PicNonVisual

Constructors

PicNonVisual

Fields

• _pnvDrawingProps :: NonVisualDrawingProperties

Instances

Eq PicNonVisual

Methods

(==) :: PicNonVisual -> PicNonVisual -> Bool

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

Show PicNonVisual

Methods

showsPrec :: Int -> PicNonVisual -> ShowS

show :: PicNonVisual -> String

showList :: [PicNonVisual] -> ShowS

ToElement PicNonVisual

Methods

toElement :: Name -> PicNonVisual -> Element

FromCursor PicNonVisual

Methods

fromCursor :: Cursor -> [PicNonVisual]

data GraphNonVisual

Constructors

GraphNonVisual

Fields

• _gnvDrawingProps :: NonVisualDrawingProperties

Instances

Eq GraphNonVisual

Methods

(==) :: GraphNonVisual -> GraphNonVisual -> Bool

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

Show GraphNonVisual

Methods

showsPrec :: Int -> GraphNonVisual -> ShowS

show :: GraphNonVisual -> String

showList :: [GraphNonVisual] -> ShowS

ToElement GraphNonVisual

Methods

toElement :: Name -> GraphNonVisual -> Element

FromCursor GraphNonVisual

Methods

fromCursor :: Cursor -> [GraphNonVisual]

newtype DrawingElementId

Constructors

DrawingElementId

Fields

• unDrawingElementId :: Int

Instances

Eq DrawingElementId

Methods

(==) :: DrawingElementId -> DrawingElementId -> Bool

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

Show DrawingElementId

Methods

showsPrec :: Int -> DrawingElementId -> ShowS

show :: DrawingElementId -> String

showList :: [DrawingElementId] -> ShowS

ToAttrVal DrawingElementId

Methods

toAttrVal :: DrawingElementId -> Text

FromAttrVal DrawingElementId

Methods

fromAttrVal :: Reader DrawingElementId

data NonVisualDrawingProperties

Constructors

NonVisualDrawingProperties

Fields

• _nvdpId :: DrawingElementId

  Specifies a unique identifier for the current DrawingML object within the current

  TODO: make ids internal and consistent by construction

• _nvdpName :: Text

  Specifies the name of the object. Typically, this is used to store the original file name of a picture object.

• _nvdpDescription :: Maybe Text

  Alternative Text for Object

• _nvdpHidden :: Bool
• _nvdpTitle :: Maybe Text

Instances

Eq NonVisualDrawingProperties

Methods

(==) :: NonVisualDrawingProperties -> NonVisualDrawingProperties -> Bool

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

Show NonVisualDrawingProperties

Methods

showsPrec :: Int -> NonVisualDrawingProperties -> ShowS

show :: NonVisualDrawingProperties -> String

showList :: [NonVisualDrawingProperties] -> ShowS

ToElement NonVisualDrawingProperties

Methods

toElement :: Name -> NonVisualDrawingProperties -> Element

FromCursor NonVisualDrawingProperties

Methods

fromCursor :: Cursor -> [NonVisualDrawingProperties]

data BlipFillProperties a

Constructors

BlipFillProperties

Fields

• _bfpImageInfo :: Maybe a
• _bfpFillMode :: Maybe FillMode

Instances

Eq a => Eq (BlipFillProperties a)

Methods

(==) :: BlipFillProperties a -> BlipFillProperties a -> Bool

(/=) :: BlipFillProperties a -> BlipFillProperties a -> Bool

Show a => Show (BlipFillProperties a)

Methods

showsPrec :: Int -> BlipFillProperties a -> ShowS

show :: BlipFillProperties a -> String

showList :: [BlipFillProperties a] -> ShowS

ToElement (BlipFillProperties RefId)

Methods

toElement :: Name -> BlipFillProperties RefId -> Element

FromCursor (BlipFillProperties RefId)

Methods

fromCursor :: Cursor -> [BlipFillProperties RefId]

data FillMode

Constructors

FillTile

FillStretch

Instances

Eq FillMode

Methods

(==) :: FillMode -> FillMode -> Bool

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

Show FillMode

Methods

showsPrec :: Int -> FillMode -> ShowS

show :: FillMode -> String

showList :: [FillMode] -> ShowS

FromCursor FillMode

Methods

fromCursor :: Cursor -> [FillMode]

data Anchor p g

Constructors

Anchor

Fields

• _anchAnchoring :: Anchoring
• _anchObject :: DrawingObject p g
• _anchClientData :: ClientData

Instances

(Eq p, Eq g) => Eq (Anchor p g)

Methods

(==) :: Anchor p g -> Anchor p g -> Bool

(/=) :: Anchor p g -> Anchor p g -> Bool

(Show p, Show g) => Show (Anchor p g)

Methods

showsPrec :: Int -> Anchor p g -> ShowS

show :: Anchor p g -> String

showList :: [Anchor p g] -> ShowS

FromCursor (Anchor RefId RefId)

Methods

fromCursor :: Cursor -> [Anchor RefId RefId]

simpleAnchorXY

Arguments

:: (Int, Int)

x+y coordinates of a cell used as top left anchoring corner

-> PositiveSize2D

size of drawing object to be anchored

-> DrawingObject p g

-> Anchor p g

simple drawing object anchoring using one cell as a top lelft corner and dimensions of that object

data GenericDrawing p g

Constructors

Drawing

Fields

• _xdrAnchors :: [Anchor p g]

Instances

ToElement UnresolvedDrawing

Methods

toElement :: Name -> UnresolvedDrawing -> Element

ToDocument UnresolvedDrawing

Methods

toDocument :: UnresolvedDrawing -> Document

FromCursor UnresolvedDrawing

Methods

fromCursor :: Cursor -> [UnresolvedDrawing]

(Eq g, Eq p) => Eq (GenericDrawing p g)

Methods

(==) :: GenericDrawing p g -> GenericDrawing p g -> Bool

(/=) :: GenericDrawing p g -> GenericDrawing p g -> Bool

(Show g, Show p) => Show (GenericDrawing p g)

Methods

showsPrec :: Int -> GenericDrawing p g -> ShowS

show :: GenericDrawing p g -> String

showList :: [GenericDrawing p g] -> ShowS

type Drawing = GenericDrawing FileInfo ChartSpace

type UnresolvedDrawing = GenericDrawing RefId RefId

anchObject :: forall p g p g. Lens (Anchor p g) (Anchor p g) (DrawingObject p g) (DrawingObject p g)

anchClientData :: forall p g. Lens' (Anchor p g) ClientData

anchAnchoring :: forall p g. Lens' (Anchor p g) Anchoring

picShapeProperties :: forall p g. Traversal' (DrawingObject p g) ShapeProperties

picPublished :: forall p g. Traversal' (DrawingObject p g) Bool

picNonVisual :: forall p g. Traversal' (DrawingObject p g) PicNonVisual

picMacro :: forall p g. Traversal' (DrawingObject p g) (Maybe Text)

picBlipFill :: forall p g p. Traversal (DrawingObject p g) (DrawingObject p g) (BlipFillProperties p) (BlipFillProperties p)

grTransform :: forall p g. Traversal' (DrawingObject p g) Transform2D

grNonVisual :: forall p g. Traversal' (DrawingObject p g) GraphNonVisual

grChartSpace :: forall p g g. Traversal (DrawingObject p g) (DrawingObject p g) g g

bfpImageInfo :: forall a a. Lens (BlipFillProperties a) (BlipFillProperties a) (Maybe a) (Maybe a)

bfpFillMode :: forall a. Lens' (BlipFillProperties a) (Maybe FillMode)

xdrAnchors :: forall p g p g. Iso (GenericDrawing p g) (GenericDrawing p g) [Anchor p g] [Anchor p g]

anchoringFromNode :: Node -> [Anchoring]

drawingObjectFromNode :: Node -> [DrawingObject RefId RefId]

fillModeFromNode :: Node -> [FillMode]

anchorToElement :: Anchor RefId RefId -> Element

anchoringToElement :: Anchoring -> Element

drawingObjToElement :: DrawingObject RefId RefId -> Element

fillModeToElement :: FillMode -> Element

xdr :: Text -> Name

Add Spreadsheet DrawingML namespace to name

xlDrawingNs :: Text