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

Codec.Xlsx.Types.SheetViews

# 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 IntIndex to the color value for row/column text headings and gridlines. This is an 'index color value' (ICV) rather than rgb value._sheetViewDefaultGridColor :: Maybe BoolFlag indicating that the consuming application should use the default grid lines color (system dependent). Overrides any color specified in colorId._sheetViewRightToLeft :: Maybe BoolFlag 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 BoolFlag indicating whether this sheet should display formulas._sheetViewShowGridLines :: Maybe BoolFlag indicating whether this sheet should display gridlines._sheetViewShowOutlineSymbols :: Maybe BoolFlag 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 BoolFlag indicating whether the sheet should display row and column headings._sheetViewShowRuler :: Maybe BoolShow the ruler in Page Layout View._sheetViewShowWhiteSpace :: Maybe BoolFlag 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 BoolFlag 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 BoolFlag 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 CellRefLocation 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 SheetViewTypeIndicates the view type._sheetViewWindowProtection :: Maybe BoolFlag indicating whether the panes in the window are locked due to workbook protection. This is an option when the workbook structure is protected._sheetViewWorkbookViewId :: IntZero-based index of this workbook view, pointing to a workbookView element in the bookViews collection.NOTE: This attribute is required._sheetViewZoomScale :: Maybe IntWindow 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 IntZoom 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 IntZoom 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 IntZoom 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 PaneWorksheet view pane_sheetViewSelection :: [Selection]Worksheet view selectionMinimum of 0, maximum of 4 elements

Instances

 Source # Methods Source # Methods Source # MethodsshowList :: [SheetView] -> ShowS # Source # NOTE: The Default instance for SheetView sets the required attribute _sheetViewWorkbookViewId to 0. Methods Source # See CT_SheetView, p. 3913 Methods Source # See CT_SheetView, p. 3913 Methods

data Selection Source #

Worksheet view selection.

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

Constructors

 Selection Fields_selectionActiveCell :: Maybe CellRefLocation of the active cell_selectionActiveCellId :: Maybe Int0-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 PaneTypeThe pane to which this selection belongs._selectionSqref :: Maybe SqRefRange of the selection. Can be non-contiguous set of ranges.

Instances

 Source # Methods Source # Methods Source # MethodsshowList :: [Selection] -> ShowS # Source # Methods Source # See CT_Selection, p. 3914 Methods Source # See CT_Selection, p. 3914 Methods

data Pane Source #

Worksheet view pane

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

Constructors

 Pane Fields_paneActivePane :: Maybe PaneTypeThe pane that is active._paneState :: Maybe PaneStateIndicates whether the pane has horizontal / vertical splits, and whether those splits are frozen._paneTopLeftCell :: Maybe CellRefLocation of the top left visible cell in the bottom right pane (when in Left-To-Right mode)._paneXSplit :: Maybe DoubleHorizontal 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 DoubleVertical 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

 Source # Methods(==) :: Pane -> Pane -> Bool #(/=) :: Pane -> Pane -> Bool # Source # Methodscompare :: Pane -> Pane -> Ordering #(<) :: Pane -> Pane -> Bool #(<=) :: Pane -> Pane -> Bool #(>) :: Pane -> Pane -> Bool #(>=) :: Pane -> Pane -> Bool #max :: Pane -> Pane -> Pane #min :: Pane -> Pane -> Pane # Source # MethodsshowsPrec :: Int -> Pane -> ShowS #show :: Pane -> String #showList :: [Pane] -> ShowS # Source # Methodsdef :: Pane # Source # See CT_Pane, p. 3913 Methods Source # See CT_Pane, p. 3913 MethodsfromCursor :: Cursor -> [Pane] 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

 Source # Methods Source # Methods Source # MethodsshowList :: [SheetViewType] -> ShowS # Source # See ST_SheetViewType, p. 3913 Methods Source # See ST_SheetViewType, p. 3913 Methods

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

 Source # Methods Source # Methods(<) :: PaneType -> PaneType -> Bool #(>) :: PaneType -> PaneType -> Bool # Source # MethodsshowList :: [PaneType] -> ShowS # Source # See ST_Pane, p. 3914 Methods Source # See ST_Pane, p. 3914 Methods

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

 Source # Methods Source # Methods Source # MethodsshowList :: [PaneState] -> ShowS # Source # See ST_PaneState, p. 3929 Methods Source # See ST_PaneState, p. 3929 Methods