@sheetxl/models
Version:
Models - A Headless javascript spreadsheet library.
196 lines • 6.08 kB
TypeScript
/**
* Horizontal alignment of text within a cell.
*/
export declare enum HorizontalAlignment {
/**
* Aligned based on the data value.
* Text data is left-aligned. Numbers, dates, and times are right-aligned. Boolean types are centered.
*/
General = "general",
/**
* Aligned to the left.
*/
Left = "left",
/**
* Aligned in the center.
*/
Center = "center",
/**
* Aligned to the right.
*/
Right = "right",
/**
* Aligned to the left and right margins.
* Spacing will be inserted between 'words
. */
Justify = "justify",
/**
* Each 'word' in each line of text inside the cell is evenly distributed
* across the width of the cell, with flush right and left margins.
*
* When there is also an indent value to apply, both the left and right side
* of the cell are padded by the indent value.
* A 'word' is a set of characters with no space character in them.
* Two lines inside a cell are separated by a carriage return.
*/
Distributed = "distributed",
/**
* The horizontal alignment is centered across multiple cells.
* The number of cells is determined by the number of consecutive blank cells
* that also have an alignment of CenterContinuous.
*/
CenterContinuous = "centerContinuous",
/**
* The value of the cell should be repeated across the entire width of the cell.
* If blank cells to the right also have the fill alignment, they are also filled
* with the value, using a convention similar to centerContinuous.
*/
Fill = "fill"
}
/**
* Vertical alignment of text within a cell.
*/
export declare enum VerticalAlignment {
/**
* Aligned to the top.
*/
Top = "top",
/**
* Aligned to the center.
*/
Center = "center",
/**
* Aligned to the bottom.
*/
Bottom = "bottom",
/**
* The vertical alignment of lines of text is distributed vertically,
* where each line of text inside the cell is evenly distributed across the height of the cell,
* with flush top and bottom margins.
*/
Justify = "justify",
/**
* Just like Justify, expect that all lines with a single word are centered and the last line is also distributed.
*/
Distributed = "distributed"
}
/**
* Vertical alignment of text within a line.
* @see {@link https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align}
*/
export declare enum VerticalTextAlignment {
/**
* Aligns the baseline of the cell with the baseline of all other cells in the row that are baseline-aligned.
*/
Baseline = "baseline",
/**
* Aligns the baseline of the element with the subscript-baseline of its parent.
*/
Sub = "sub",
/**
* Aligns the baseline of the element with the superscript-baseline of its parent.
*/
Super = "super"
}
export declare enum TextDirection {
/**
* Horizontal text. This is the default.
*/
Horizontal = "horizontal",
/**
* Vertical orientation.
* (each line is 90 degrees rotated clockwise, so it goes
* from top to bottom; each next line is to the left from
* the previous one).
*/
Vertical = "90",
/**
* Vertical orientation.
* (each line is 270 degrees rotated clockwise, so it goes
* from bottom to top; each next line is to the right from
* the previous one).
*/
Vertical270 = "270",
/**
* Determines if all of the text is vertical
* ("one letter on top of another").
* Not Supported
*/
Stacked = "stacked"
}
/**
* The reading direction.
*/
export declare enum ReadingDirection {
Auto = "auto",
LeftToRight = "ltr",
RightToLeft = "rtl"
}
/**
* The behavior of the text when it exceeds the size of the bounding box.
*/
export declare enum TextOverflow {
/**
* Visible means that the text will attempt to be visible on overflow.
* It can still be obscured (either z-index, or another blocking element) or fall out of the viewport.
*/
Visible = "visible",
/**
* Wrap text to keep within the left right margins but may overflow vertically.
*/
Wrap = "wrap",
/**
* Note - This is not part of the OOXML spec
*/
Clip = "clip",
/**
* Shrinks text to fit within the bounding area
*/
Shrink = "shrink",
/** Not OOXML spec - Not support */
Ellipsis = "ellipsis"
}
/**
* How the text should fit within the shape.
*/
export declare enum TextAutofit {
/**
* Specifies that text within the text body should not be auto-fit to the bounding box.
* Auto-fitting is when text within a text box is scaled in order to remain inside
* the text box.
*/
None = "none",
/**
* Specifies that text within the text body should be normally auto-fit to the bounding box.
* AutoFitting is when text within a text box is scaled in order to remain inside the text box.
*
* <p>
* <em>Example:</em> Consider the situation where a user is building a diagram and needs
* to have the text for each shape that they are using stay within the bounds of the shape.
* An easy way this might be done is by using NORMAL autofit
* </p>
*/
Normal = "normal",
/**
* Specifies that a shape should be auto-fit to fully contain the text described within it.
* Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
*
* <p>
* <em>Example:</em> Consider the situation where a user is building a diagram and needs to have
* the text for each shape that they are using stay within the bounds of the shape.
* An easy way this might be done is by using SHAPE autofit
* </p>
*/
Shape = "shape"
}
export declare enum TextCap {
None = "none",
Small = "small",
All = "all"
}
export declare enum TextStrikeStyle {
None = "none",
Single = "single",
Double = "double"
}
//# sourceMappingURL=types.d.ts.map