Spans (FsSpreadsheet) | FsSpreadsheet

FsSpreadsheet

Spans Module

Namespace: FsSpreadsheet.Net
Assembly: FsSpreadsheet.Net.dll
Parent Module: Row

Functions for working with spans. The spans mark the column wise area in which the row lies.

Functions and values

Function or value	Description
`extendLeft amount spans` Full Usage: `extendLeft amount spans` Parameters: amount : `uint32` spans : `ListValue<StringValue>` Returns: `ListValue<StringValue>`	Extends the left boundary of the spans by the given amount (positive amount decreases the spans to left and vice versa). amount : `uint32` spans : `ListValue<StringValue>` Returns: `ListValue<StringValue>`
`extendRight amount spans` Full Usage: `extendRight amount spans` Parameters: amount : `uint32` spans : `ListValue<StringValue>` Returns: `ListValue<StringValue>`	Extends the right boundary of the spans by the given amount (positive amount increases spans to right and vice versa). amount : `uint32` spans : `ListValue<StringValue>` Returns: `ListValue<StringValue>`
`fromBoundaries fromColumnIndex toColumnIndex` Full Usage: `fromBoundaries fromColumnIndex toColumnIndex` Parameters: fromColumnIndex : `uint32` toColumnIndex : `uint32` Returns: `ListValue<StringValue>`	Given 1 based column start and end indices, returns a "1:1" style spans. fromColumnIndex : `uint32` toColumnIndex : `uint32` Returns: `ListValue<StringValue>`
`leftBoundary spans` Full Usage: `leftBoundary spans` Parameters: spans : `ListValue<StringValue>` Returns: `uint32`	Gets the left boundary of the spans. spans : `ListValue<StringValue>` Returns: `uint32`
`moveHorizontal amount spans` Full Usage: `moveHorizontal amount spans` Parameters: amount : `uint32` spans : `ListValue<StringValue>` Returns: `ListValue<StringValue>`	Moves both start and end of the spans by the given amount (positive amount moves spans to right and vice versa). amount : `uint32` spans : `ListValue<StringValue>` Returns: `ListValue<StringValue>`
`referenceExceedsSpans reference spans` Full Usage: `referenceExceedsSpans reference spans` Parameters: reference : `string` spans : `ListValue<StringValue>` Returns: `bool`	Returns true if the column index of the reference does not lie in the boundary of the spans. reference : `string` spans : `ListValue<StringValue>` Returns: `bool`
`referenceExceedsSpansToLeft reference spans` Full Usage: `referenceExceedsSpansToLeft reference spans` Parameters: reference : `string` spans : `ListValue<StringValue>` Returns: `bool`	Returns true if the column index of the reference exceeds the left boundary of the spans. reference : `string` spans : `ListValue<StringValue>` Returns: `bool`
`referenceExceedsSpansToRight reference spans` Full Usage: `referenceExceedsSpansToRight reference spans` Parameters: reference : `string` spans : `ListValue<StringValue>` Returns: `bool`	Returns true if the column index of the reference exceeds the right boundary of the spans. reference : `string` spans : `ListValue<StringValue>` Returns: `bool`
`rightBoundary spans` Full Usage: `rightBoundary spans` Parameters: spans : `ListValue<StringValue>` Returns: `uint32`	Gets the right boundary of the spans. spans : `ListValue<StringValue>` Returns: `uint32`
`toBoundaries spans` Full Usage: `toBoundaries spans` Parameters: spans : `ListValue<StringValue>` Returns: `uint32 * uint32`	Given a "1:1" style spans, returns 1 based column start and end indices. spans : `ListValue<StringValue>` Returns: `uint32 * uint32`