Apryse WebViewer

Namespace: Types

Core.SpreadsheetEditor. Types

A collection that contains enums used related to SpreadsheetEditor.

Members

<static, readonly> BorderStyle

Enum that defines a set of styles that can be applied to the borders of cells. The supported border styles range from very basic to more complex patterns, resulting in an extensive set of visual presentation options.
Properties:
Name Type Description
NONE string No border.
THIN string A thin, single line border.
HAIR string A very fine, hairline border.
DOTTED string A border comprising of dots.
DASHED string A border consisting of dashes.
DASH_DOT string Alternating dashes and dots.
DASH_DOT_DOT string A DashDotDot pattern.
DOUBLE_LINES string Two parallel lines.
MEDIUM string Thicker than Thin, a medium line border.
MEDIUM_DASHED string A dashed line that's thicker than the Dashed style.
MEDIUM_DASH_DOT string A DashDot pattern with a medium thickness.
MEDIUM_DASH_DOT_DOT string A DashDotDot pattern with a medium thickness.
SLANTED_DASH_DOT string Dashes and dots placed in a slanted manner.
THICK string A thick line border.

<static, readonly> BorderType

Represents the different border positions in a spreadsheet cell.
Properties:
Name Type Description
LEFT number Represents the left border of a cell.
TOP number Represents the top border of a cell.
RIGHT number Represents the right border of a cell.
BOTTOM number Represents the bottom border of a cell.

<static> CellType

Defines the types of cell content within a spreadsheet categorized based on their data content.
Properties:
Name Type Description
UNKNOWN number The cell type is unknown. This is typically used when the cell's content type cannot be determined. (value: 0)
BLANK number The cell is empty, containing no data or value (value: 1)
NUMERIC number The cell contains a numeric value. Numeric cells can hold integers, decimals, and other numerical formats. They are often subject to formatting that affects their display (e.g., number of decimal places, currency symbols). (value: 2)
STRING number The cell contains a string value. String cells can include letters, numbers, symbols, and spaces. They are versatile and can be used for labels, names, or any non-numeric data. (value: 3)
FORMULA number The cell contains a formula. Formulas are expressions that perform calculations or operations based on other cells' values. The cell displays the result of the formula's calculation rather than the formula itself.
BOOL number The cell contains a boolean value, which can be either true or false. Boolean cells are often used for flags, toggles, or simple binary states.
DATE number The cell contains a date. Date cells can represent dates, and potentially times, in various formats. They are subject to formatting that affects their display.

<static> FontStyle

Enum that defines constants that specify style information applied to text.
Properties:
Name Type Description
REGULAR number Indicates no additional styling is applied to the text. This is the default state. (value: 0)
BOLD number Specifies bold text styling. (value: 1)
ITALIC number Specifies italic text styling. (value: 2)
UNDERLINE number Specifies underlined text. (value: 4)
STRIKEOUT number Specifies text with a strikeout or line-through style. (value: 8)

<static> HorizontalAlignment

Enum that specifies the horizontal alignment of content within a container, such as a cell in a spreadsheet or a text block in a document.
Properties:
Name Type Description
GENERAL number Represents the default horizontal alignment (value: 0)
LEFT number Aligns content to the left side of the container (value: 1)
CENTER number Aligns contents to the horizontal center within the container (value: 2)
RIGHT number Aligns content to the right side of the container (value: 3)

<static, readonly> RangeBorderType

Represents the different border types in the cell range.
Properties:
Name Type Description
NONE string Empty border
LEFT string Left border
TOP string Top border
RIGHT string Right border
BOTTOM string Bottom border
OUTSIDE string Outside borders which includes the left, top, right and bottom border
INSIDE string Borders in between cells in the range
HORIZONTAL string Horizontal borders
VERTICAL string Vertical borders
ALL string All borders

<static> TextWrap

Enum for text wrapping behavior for cells within a Sheet.
Properties:
Name Type Description
AUTO number Text wrapping is automatically determined based on the cell's content and width. Text may overflow into adjacent cells if they are empty. (value: 0)
OVERFLOW number Allows text to overflow into adjacent cells if it exceeds the cell width and those cells are empty. If adjacent cells contain data, the text is clipped at the cell boundary. (value: 1)
WRAP number Wraps text within the cell boundaries, expanding the cell height as needed to accommodate the wrapped text. (value: 2)
CLIP number Clips text to the cell boundaries, hiding any content that exceeds the width of the cell without altering the cell's size. (value: 3)

<static> VerticalAlignment

Enum that specifies the vertical alignment of content within cells in a sheet.
Properties:
Name Type Description
NONE number Applies the default vertical alignment as determined by the cell format settings (value: 0)
TOP number Aligns cell content to the top of the cell, leaving any additional space at the bottom (value: 1)
CENTER number Aligns cell content to the vertical center within the cell, distributing space evenly above and below the content (value: 2)
BOTTOM number Aligns cell content to the bottom of the cell, leaving any additional space at the top (value: 3)

Type Definitions

BorderOptions

Represents the different border options for a cell.
Properties:
Name Type Description
type Core.SpreadsheetEditor.Types.BorderType The type of the border.
style Core.SpreadsheetEditor.Types.BorderStyle The drawing style of the border.
color string The color of the border in HEX or CSS rgb() strings.

RangeBorderOptions

Type:
  • Object
Properties:
Name Type Description
type Core.SpreadsheetEditor.Types.RangeBorderType The type of the border.
style Core.SpreadsheetEditor.Types.BorderStyle The drawing style of the border.
color string The color in CSS HEX or RGB string.