xlsx-0.7.0: Simple and incomplete Excel file parser/writer

Safe HaskellNone
LanguageHaskell2010

Codec.Xlsx.Types.SheetViews

Contents

Synopsis

Structured type to construct SheetViews

data SheetView Source #

Worksheet view

A single sheet view definition. When more than one sheet view is defined in the file, it means that when opening the workbook, each sheet view corresponds to a separate window within the spreadsheet application, where each window is showing the particular sheet containing the same workbookViewId value, the last sheetView definition is loaded, and the others are discarded. When multiple windows are viewing the same sheet, multiple sheetView elements (with corresponding workbookView entries) are saved.

TODO: The pivotSelection and extLst child elements are unsupported.

See Section 18.3.1.87 "sheetView (Worksheet View)" (p. 1880)

Constructors

SheetView 

Fields

  • _sheetViewColorId :: Maybe Int

    Index to the color value for row/column text headings and gridlines. This is an 'index color value' (ICV) rather than rgb value.

  • _sheetViewDefaultGridColor :: Maybe Bool

    Flag indicating that the consuming application should use the default grid lines color (system dependent). Overrides any color specified in colorId.

  • _sheetViewRightToLeft :: Maybe Bool

    Flag indicating whether the sheet is in 'right to left' display mode. When in this mode, Column A is on the far right, Column B ;is one column left of Column A, and so on. Also, information in cells is displayed in the Right to Left format.

  • _sheetViewShowFormulas :: Maybe Bool

    Flag indicating whether this sheet should display formulas.

  • _sheetViewShowGridLines :: Maybe Bool

    Flag indicating whether this sheet should display gridlines.

  • _sheetViewShowOutlineSymbols :: Maybe Bool

    Flag indicating whether the sheet has outline symbols visible. This flag shall always override SheetPr element's outlinePr child element whose attribute is named showOutlineSymbols when there is a conflict.

  • _sheetViewShowRowColHeaders :: Maybe Bool

    Flag indicating whether the sheet should display row and column headings.

  • _sheetViewShowRuler :: Maybe Bool

    Show the ruler in Page Layout View.

  • _sheetViewShowWhiteSpace :: Maybe Bool

    Flag indicating whether page layout view shall display margins. False means do not display left, right, top (header), and bottom (footer) margins (even when there is data in the header or footer).

  • _sheetViewShowZeros :: Maybe Bool

    Flag indicating whether the window should show 0 (zero) in cells containing zero value. When false, cells with zero value appear blank instead of showing the number zero.

  • _sheetViewTabSelected :: Maybe Bool

    Flag indicating whether this sheet is selected. When only 1 sheet is selected and active, this value should be in synch with the activeTab value. In case of a conflict, the Start Part setting wins and sets the active sheet tab.

    Multiple sheets can be selected, but only one sheet shall be active at one time.

  • _sheetViewTopLeftCell :: Maybe CellRef

    Location of the top left visible cell Location of the top left visible cell in the bottom right pane (when in Left-to-Right mode).

  • _sheetViewType :: Maybe SheetViewType

    Indicates the view type.

  • _sheetViewWindowProtection :: Maybe Bool

    Flag indicating whether the panes in the window are locked due to workbook protection. This is an option when the workbook structure is protected.

  • _sheetViewWorkbookViewId :: Int

    Zero-based index of this workbook view, pointing to a workbookView element in the bookViews collection.

    NOTE: This attribute is required.

  • _sheetViewZoomScale :: Maybe Int

    Window zoom magnification for current view representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together.

  • _sheetViewZoomScaleNormal :: Maybe Int

    Zoom magnification to use when in normal view, representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together.

  • _sheetViewZoomScalePageLayoutView :: Maybe Int

    Zoom magnification to use when in page layout view, representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together.

  • _sheetViewZoomScaleSheetLayoutView :: Maybe Int

    Zoom magnification to use when in page break preview, representing percent values. This attribute is restricted to values ranging from 10 to 400. Horizontal & Vertical scale together.

  • _sheetViewPane :: Maybe Pane

    Worksheet view pane

  • _sheetViewSelection :: [Selection]

    Worksheet view selection

    Minimum of 0, maximum of 4 elements

Instances

Eq SheetView Source # 
Ord SheetView Source # 
Show SheetView Source # 
Generic SheetView Source # 

Associated Types

type Rep SheetView :: * -> * #

Default SheetView Source #

NOTE: The Default instance for SheetView sets the required attribute _sheetViewWorkbookViewId to 0.

Methods

def :: SheetView #

NFData SheetView Source # 

Methods

rnf :: SheetView -> () #

FromXenoNode SheetView Source # 
FromCursor SheetView Source #

See CT_SheetView, p. 3913

ToElement SheetView Source #

See CT_SheetView, p. 3913

type Rep SheetView Source # 
type Rep SheetView = D1 * (MetaData "SheetView" "Codec.Xlsx.Types.SheetViews" "xlsx-0.7.0-67d30z0rd5vGH8ecLQYdXm" False) (C1 * (MetaCons "SheetView" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewColorId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_sheetViewDefaultGridColor") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewRightToLeft") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewShowFormulas") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_sheetViewShowGridLines") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewShowOutlineSymbols") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_sheetViewShowRowColHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewShowRuler") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewShowWhiteSpace") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_sheetViewShowZeros") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewTabSelected") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_sheetViewTopLeftCell") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe CellRef)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe SheetViewType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewWindowProtection") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_sheetViewWorkbookViewId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewZoomScale") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewZoomScaleNormal") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_sheetViewZoomScalePageLayoutView") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewZoomScaleSheetLayoutView") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sheetViewPane") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Pane))) (S1 * (MetaSel (Just Symbol "_sheetViewSelection") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Selection]))))))))

data Selection Source #

Worksheet view selection.

Section 18.3.1.78 "selection (Selection)" (p. 1864)

Constructors

Selection 

Fields

  • _selectionActiveCell :: Maybe CellRef

    Location of the active cell

  • _selectionActiveCellId :: Maybe Int

    0-based index of the range reference (in the array of references listed in sqref) containing the active cell. Only used when the selection in sqref is not contiguous. Therefore, this value needs to be aware of the order in which the range references are written in sqref.

    When this value is out of range then activeCell can be used.

  • _selectionPane :: Maybe PaneType

    The pane to which this selection belongs.

  • _selectionSqref :: Maybe SqRef

    Range of the selection. Can be non-contiguous set of ranges.

Instances

Eq Selection Source # 
Ord Selection Source # 
Show Selection Source # 
Generic Selection Source # 

Associated Types

type Rep Selection :: * -> * #

Default Selection Source # 

Methods

def :: Selection #

NFData Selection Source # 

Methods

rnf :: Selection -> () #

FromXenoNode Selection Source # 
FromCursor Selection Source #

See CT_Selection, p. 3914

ToElement Selection Source #

See CT_Selection, p. 3914

type Rep Selection Source # 
type Rep Selection = D1 * (MetaData "Selection" "Codec.Xlsx.Types.SheetViews" "xlsx-0.7.0-67d30z0rd5vGH8ecLQYdXm" False) (C1 * (MetaCons "Selection" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_selectionActiveCell") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe CellRef))) (S1 * (MetaSel (Just Symbol "_selectionActiveCellId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Int)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_selectionPane") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe PaneType))) (S1 * (MetaSel (Just Symbol "_selectionSqref") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe SqRef))))))

data Pane Source #

Worksheet view pane

Section 18.3.1.66 "pane (View Pane)" (p. 1843)

Constructors

Pane 

Fields

  • _paneActivePane :: Maybe PaneType

    The pane that is active.

  • _paneState :: Maybe PaneState

    Indicates whether the pane has horizontal / vertical splits, and whether those splits are frozen.

  • _paneTopLeftCell :: Maybe CellRef

    Location of the top left visible cell in the bottom right pane (when in Left-To-Right mode).

  • _paneXSplit :: Maybe Double

    Horizontal position of the split, in 1/20th of a point; 0 (zero) if none. If the pane is frozen, this value indicates the number of columns visible in the top pane.

  • _paneYSplit :: Maybe Double

    Vertical position of the split, in 1/20th of a point; 0 (zero) if none. If the pane is frozen, this value indicates the number of rows visible in the left pane.

Instances

Eq Pane Source # 

Methods

(==) :: Pane -> Pane -> Bool #

(/=) :: Pane -> Pane -> Bool #

Ord Pane Source # 

Methods

compare :: Pane -> Pane -> Ordering #

(<) :: Pane -> Pane -> Bool #

(<=) :: Pane -> Pane -> Bool #

(>) :: Pane -> Pane -> Bool #

(>=) :: Pane -> Pane -> Bool #

max :: Pane -> Pane -> Pane #

min :: Pane -> Pane -> Pane #

Show Pane Source # 

Methods

showsPrec :: Int -> Pane -> ShowS #

show :: Pane -> String #

showList :: [Pane] -> ShowS #

Generic Pane Source # 

Associated Types

type Rep Pane :: * -> * #

Methods

from :: Pane -> Rep Pane x #

to :: Rep Pane x -> Pane #

Default Pane Source # 

Methods

def :: Pane #

NFData Pane Source # 

Methods

rnf :: Pane -> () #

FromXenoNode Pane Source # 
FromCursor Pane Source #

See CT_Pane, p. 3913

Methods

fromCursor :: Cursor -> [Pane] Source #

ToElement Pane Source #

See CT_Pane, p. 3913

Methods

toElement :: Name -> Pane -> Element Source #

type Rep Pane Source # 

data SheetViewType Source #

View setting of the sheet

Section 18.18.69 "ST_SheetViewType (Sheet View Type)" (p. 2726)

Constructors

SheetViewTypeNormal

Normal view

SheetViewTypePageBreakPreview

Page break preview

SheetViewTypePageLayout

Page layout view

Instances

Eq SheetViewType Source # 
Ord SheetViewType Source # 
Show SheetViewType Source # 
Generic SheetViewType Source # 

Associated Types

type Rep SheetViewType :: * -> * #

NFData SheetViewType Source # 

Methods

rnf :: SheetViewType -> () #

FromAttrBs SheetViewType Source # 
FromAttrVal SheetViewType Source #

See ST_SheetViewType, p. 3913

ToAttrVal SheetViewType Source #

See ST_SheetViewType, p. 3913

type Rep SheetViewType Source # 
type Rep SheetViewType = D1 * (MetaData "SheetViewType" "Codec.Xlsx.Types.SheetViews" "xlsx-0.7.0-67d30z0rd5vGH8ecLQYdXm" False) ((:+:) * (C1 * (MetaCons "SheetViewTypeNormal" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "SheetViewTypePageBreakPreview" PrefixI False) (U1 *)) (C1 * (MetaCons "SheetViewTypePageLayout" PrefixI False) (U1 *))))

data PaneType Source #

Pane type

Section 18.18.52 "ST_Pane (Pane Types)" (p. 2710)

Constructors

PaneTypeBottomLeft

Bottom left pane, when both vertical and horizontal splits are applied.

This value is also used when only a horizontal split has been applied, dividing the pane into upper and lower regions. In that case, this value specifies the bottom pane.

PaneTypeBottomRight 
PaneTypeTopLeft

Top left pane, when both vertical and horizontal splits are applied.

This value is also used when only a horizontal split has been applied, dividing the pane into upper and lower regions. In that case, this value specifies the top pane.

This value is also used when only a vertical split has been applied, dividing the pane into right and left regions. In that case, this value specifies the left pane

PaneTypeTopRight

Top right pane, when both vertical and horizontal splits are applied.

This value is also used when only a vertical split has been applied, dividing the pane into right and left regions. In that case, this value specifies the right pane.

Instances

Eq PaneType Source # 
Ord PaneType Source # 
Show PaneType Source # 
Generic PaneType Source # 

Associated Types

type Rep PaneType :: * -> * #

Methods

from :: PaneType -> Rep PaneType x #

to :: Rep PaneType x -> PaneType #

NFData PaneType Source # 

Methods

rnf :: PaneType -> () #

FromAttrBs PaneType Source # 
FromAttrVal PaneType Source #

See ST_Pane, p. 3914

ToAttrVal PaneType Source #

See ST_Pane, p. 3914

type Rep PaneType Source # 
type Rep PaneType = D1 * (MetaData "PaneType" "Codec.Xlsx.Types.SheetViews" "xlsx-0.7.0-67d30z0rd5vGH8ecLQYdXm" False) ((:+:) * ((:+:) * (C1 * (MetaCons "PaneTypeBottomLeft" PrefixI False) (U1 *)) (C1 * (MetaCons "PaneTypeBottomRight" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "PaneTypeTopLeft" PrefixI False) (U1 *)) (C1 * (MetaCons "PaneTypeTopRight" PrefixI False) (U1 *))))

data PaneState Source #

State of the sheet's pane.

Section 18.18.53 "ST_PaneState (Pane State)" (p. 2711)

Constructors

PaneStateFrozen

Panes are frozen, but were not split being frozen. In this state, when the panes are unfrozen again, a single pane results, with no split. In this state, the split bars are not adjustable.

PaneStateFrozenSplit

Panes are frozen and were split before being frozen. In this state, when the panes are unfrozen again, the split remains, but is adjustable.

PaneStateSplit

Panes are split, but not frozen. In this state, the split bars are adjustable by the user.

Instances

Eq PaneState Source # 
Ord PaneState Source # 
Show PaneState Source # 
Generic PaneState Source # 

Associated Types

type Rep PaneState :: * -> * #

NFData PaneState Source # 

Methods

rnf :: PaneState -> () #

FromAttrBs PaneState Source # 
FromAttrVal PaneState Source #

See ST_PaneState, p. 3929

ToAttrVal PaneState Source #

See ST_PaneState, p. 3929

type Rep PaneState Source # 
type Rep PaneState = D1 * (MetaData "PaneState" "Codec.Xlsx.Types.SheetViews" "xlsx-0.7.0-67d30z0rd5vGH8ecLQYdXm" False) ((:+:) * (C1 * (MetaCons "PaneStateFrozen" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "PaneStateFrozenSplit" PrefixI False) (U1 *)) (C1 * (MetaCons "PaneStateSplit" PrefixI False) (U1 *))))

Lenses

SheetView

Selection

Pane