Header menu logo Deedle

Excel Module

Types and nested modules

Type/Module Description

ExcelStyles

ColumnDescription

ColumnFormat

DynamicExcel

ExcelRange

ExcelState

FsiVariable

IExportExcelTable

Range

Xl

Functions and values

Function or value Description

range *= v

Full Usage: range *= v

Parameters:
    range : string
    v : obj

range : string
v : obj

DeedleToExcel addPrintTransformer

Full Usage: DeedleToExcel addPrintTransformer

Parameters:
    addPrintTransformer : ('t -> obj) -> unit

Copy all Series and Frames in the FSharp interactive session to Excel. A sheet is created for each Series and each Frame. As series and frames are added to the session they will be added to the current Excel workbook as new sheets.

addPrintTransformer : ('t -> obj) -> unit

GetCurrentFsiTypes ()

Full Usage: GetCurrentFsiTypes ()

Parameters:
    () : unit

Returns: Type[]
() : unit
Returns: Type[]

GetFsiSeriesAndFrames knownTypes

Full Usage: GetFsiSeriesAndFrames knownTypes

Parameters:
Returns: IDictionary<Type, FsiVariable[]>

Inspect the FSharp interactive session and find all Series and Frames

knownTypes : ICollection<Type>
Returns: IDictionary<Type, FsiVariable[]>

asFrame name aSeries

Full Usage: asFrame name aSeries

Parameters:
    name : 'a
    aSeries : 'b

Returns: obj
name : 'a
aSeries : 'b
Returns: obj

attach

Full Usage: attach

Returns: bool
Returns: bool

changeActiveWorkbook wbIdx

Full Usage: changeActiveWorkbook wbIdx

Parameters:
    wbIdx : int

wbIdx : int

clearRange range

Full Usage: clearRange range

Parameters:
    range : 'a

range : 'a

closeWorkbook ()

Full Usage: closeWorkbook ()

Parameters:
    () : unit

() : unit

convertRange startRange

Full Usage: convertRange startRange

Parameters:
Returns: Range
startRange : ExcelRange
Returns: Range

deleteSheet sheetName

Full Usage: deleteSheet sheetName

Parameters:
    sheetName : string

sheetName : string

excelApp

Full Usage: excelApp

Returns: Application
Returns: Application

freezePanes rows cols

Full Usage: freezePanes rows cols

Parameters:
    rows : int
    cols : int

rows : int
cols : int

getActiveWorkbook ()

Full Usage: getActiveWorkbook ()

Parameters:
    () : unit

Returns: Workbook
() : unit
Returns: Workbook

getRealRange range

Full Usage: getRealRange range

Parameters:
    range : obj

Returns: Range
range : obj
Returns: Range

moveDownRows n

Full Usage: moveDownRows n

Parameters:
    n : 'a

Returns: ExcelState -> ExcelState
n : 'a
Returns: ExcelState -> ExcelState

moveLeftCols n

Full Usage: moveLeftCols n

Parameters:
    n : int

Returns: ExcelState -> ExcelState
n : int
Returns: ExcelState -> ExcelState

moveOffset (arg1, arg1) state

Full Usage: moveOffset (arg1, arg1) state

Parameters:
Returns: ExcelState
arg0 : 'a
arg1 : 'b
state : ExcelState
Returns: ExcelState

moveRightcols n

Full Usage: moveRightcols n

Parameters:
    n : 'a

Returns: ExcelState -> ExcelState
n : 'a
Returns: ExcelState -> ExcelState

moveUpRows n

Full Usage: moveUpRows n

Parameters:
    n : int

Returns: ExcelState -> ExcelState
n : int
Returns: ExcelState -> ExcelState

offset (r, c) range

Full Usage: offset (r, c) range

Parameters:
    r : 'a
    c : 'b
    range : Range

Returns: Range
r : 'a
c : 'b
range : Range
Returns: Range

openExcel

Full Usage: openExcel

Returns: string -> Workbook
Returns: string -> Workbook

openExcelReadOnly

Full Usage: openExcelReadOnly

Returns: string -> Workbook
Returns: string -> Workbook

openNewExcelApplication ()

Full Usage: openNewExcelApplication ()

Parameters:
    () : unit

Returns: Application
() : unit
Returns: Application

overwriteSave filename

Full Usage: overwriteSave filename

Parameters:
    filename : string

filename : string

quit ()

Full Usage: quit ()

Parameters:
    () : unit

() : unit

renameSheet sheetName

Full Usage: renameSheet sheetName

Parameters:
    sheetName : string

sheetName : string

resize (r, c) range

Full Usage: resize (r, c) range

Parameters:
    r : 'a
    c : 'b
    range : Range

Returns: Range
r : 'a
c : 'b
range : Range
Returns: Range

saveToImage filename state

Full Usage: saveToImage filename state

Parameters:
filename : string
state : ExcelState

saveWorkbook filename

Full Usage: saveWorkbook filename

Parameters:
    filename : string

filename : string

saveWorksheetAsHtml filename sheet

Full Usage: saveWorksheetAsHtml filename sheet

Parameters:
    filename : string
    sheet : string

filename : string
sheet : string

setApplication app

Full Usage: setApplication app

Parameters:
    app : obj

app : obj

setExcelVisibility visible

Full Usage: setExcelVisibility visible

Parameters:
    visible : bool

visible : bool

startRange range

Full Usage: startRange range

Parameters:
    range : string

Returns: ExcelState
range : string
Returns: ExcelState

switchSheet sheetName

Full Usage: switchSheet sheetName

Parameters:
    sheetName : string

sheetName : string

toExcel rangeStr v

Full Usage: toExcel rangeStr v

Parameters:
    rangeStr : string
    v : obj

rangeStr : string
v : obj

xl

Full Usage: xl

Returns: DynamicExcel
Returns: DynamicExcel

Active patterns

Active pattern Description

(|DeedleFrameAsExcelTable|_|) v

Full Usage: (|DeedleFrameAsExcelTable|_|) v

Parameters:
    v : obj

Returns: IExportExcelTable option
v : obj
Returns: IExportExcelTable option

(|GenericFrame|_|) f

Full Usage: (|GenericFrame|_|) f

Parameters:
    f : 'a

Returns: Type[] option
f : 'a
Returns: Type[] option

(|GenericSeries|_|) s

Full Usage: (|GenericSeries|_|) s

Parameters:
    s : 'a

Returns: Type[] option
s : 'a
Returns: Type[] option

Type something to start searching.