Package @aurigma/design-atoms-text
Classes
AddListItemCmd
The command to add a new list item to the current cursor position.
AddListItemCmdData
Data required to initialize the command.
ApplyListTypeCmd
The command to apply list type to list items by paragraph indexes.
ApplyListTypeCmdData
Data required to initialize the command.
BlockElement
Br
ClearFormattingCmd
The command to clear formatting (character style) for the current cursor position or selected text.
CommandFactory
CommandHistory
CopyToClipboardCmd
The command to copy the selected text to the clipboard.
CreateBulletedListItemCmd
The command to create a new list with the first item by paragraph index.
CreateBulletedListItemCmdData
Data required to initialize the command.
CreateNumberedListItemCmd
The command to create a new list with the first item by paragraph index.
CreateNumberedListItemCmdData
Data required to initialize the command.
CursorHandler
Handler for performing simple operations with the cursor.
DecreaseFontSizeCmd
The command to decrease the font size by a specified value for the current cursor position or selected text.
DecreaseFontSizeCmdData
Data required to initialize the command.
DecreaseListItemIndentCmd
The command to decrease the indent of list items by paragraph indexes.
DecreaseListItemIndentData
Data required to initialize the command.
DeleteListItemCmd
The command to remove the current list item by paragraph index.
DeleteListItemCmdData
Data required to initialize the command.
DeleteTextCmd
The command to delete the selected text or character relative to the current cursor position.
DeleteTextCmdData
Data required to initialize the command.
IncreaseFontSizeCmd
The command to increase the font size by a specified value for the current cursor position or selected text.
IncreaseFontSizeCmdData
Data required to initialize the command.
IncreaseListItemIndentCmd
The command to increase the indent of list items by paragraph indexes.
IncreaseListItemIndentData
Data required to initialize the command.
InlineElement
InlineText
InputManager
InsertLineBrakeCmd
The command to insert a line break relative to the current cursor position.
InsertLineBrakeCmdData
Data required to initialize the command.
InsertNewLineCmd
The command to insert a new line relative to the current cursor position.
InsertNewLineCmdData
Data required to initialize the command.
InsertTabCmd
The command to insert a tab relative to the current cursor position.
InsertTextCmd
The command to insert plain text relative to the current cursor position.
InsertTextCmdData
Data required to initialize the command.
ListCmd
Command for working with list items.
MetadataHandler
Handler for performing simple operations with text metadata.
MobileTextEditor
MoveCursorCmd
The command to move the current cursor position.
MoveCursorCmdData
Data required to initialize the command.
NewTextEditor
In-place text editor.
NewTextManager
Manager for performing basic operations with text.
NotImplementedException
NumericValue
OpenTypeFeature
Paragraph
ParagraphListStyle
ParagraphMetadata
ParagraphStyle
RedoCmd
The command to redo an action.
RenderManager
SelectAllTextCmd
The command to select all text.
SelectionHandler
Handler for performing simple operations with text selection.
SelectParagraphCmd
The command to select a paragraph relative to the current cursor position.
SelectParagraphCmdData
Data required to initialize the command.
SelectWordCmd
The command to select a word relative to the current cursor position.
SelectWordCmdData
Data required to initialize the command.
SerializationException
SetAlignmentCmd
The command to set text alignment for the current cursor position or selected text.
SetAlignmentCmdData
Data required to initialize the command.
SetCapitalLettersCmd
The command to set capital letters for the current cursor position or selected text.
SetCharStyleCmd
The command to set the character style for the current cursor position or selected text.
SetCharStyleCmdData
Data required to initialize the command.
SetCursorCmd
The command to set the cursor to the specified point.
SetCursorCmdData
Data required to initialize the command.
SetFontBoldCmd
The command to make font bold for the current cursor position or selected text.
SetFontItalicCmd
The command to make font italic for the current cursor position or selected text.
SetFontUnderlineCmd
The command to make font underline for the current cursor position or selected text.
SetParagraphStyleCmd
The command to set the paragraph style for the current cursor position or selected text.
SetParagraphStyleCmdData
Data required to initialize the command.
SetSelectionCmd
The command to set the text selection by start and end points.
SetSelectionCmdData
Data required to initialize the command.
SetSubscriptLettersCmd
The command to set subscript letters for the current cursor position or selected text.
SetSuperscriptLettersCmd
The command to set superscript letters for the current cursor position or selected text.
Span
SpanStyle
StringUtils
StyleHandler
Handler for performing simple operations with paragraph and character styles.
Text_2
TextEditorInitData
TextHandler
Handler for performing simple operations with text content.
TextManagerInitData
TextMeasurer
Handler for measuring text.
TextUtils
TextWhizzCharStyle
TextWhizzColorPalette
TextWhizzConverter
TextWhizzFrame
TextWhizzMetadata
TextWhizzMetadataProperty
TextWhizzParagraphStyle
TextWhizzPosition
TextWhizzRange
TextWhizzUnwrapper
TextWhizzWrapper
A text engine wrapper for editing and measuring text.
UndoCmd
The command to undo an action.
UndoRedoHandler
Handler for performing operations with redoing and undoing of actions.
Interfaces
ICharStyle
IClipboard
IColorData
IColorPalette
IColorPreviewService
ICommand
Executable command.
ICommandFactory
ICommandHistory
History of executed commands.
ICurrentTextInfo
Information about the current cursor position and selected text.
ICursorHandler
Handler for performing simple operations with the cursor.
IDesignAtomsApiClient
IFontRegistry
IFontSettings
IInputManager
IInputTextValidator
IInputTextValidatorResult
IKeyboardEvent
IKeyboardInputCommand
ILimitsViolationEventData
IListConfiguration
A structure defining layout settings and format of lists in text elements.
IListService
Service for performing basic operations with lists.
IListServiceInitData
IListSetting
IListStyle
IListStyleSheet
IListStyleSheetAccessor
IListStyleSheetManager
IListStyleSheetManagerFactory
IMetadata
IMetadataHandler
Handler for performing simple operations with text metadata.
IMetadataProperty
IMouseEvent
IParagraphStyle
IPositionInText
IRenderManager
ISelectionHandler
Handler for performing simple operations with text selection.
IStroke
IStyleHandler
Handler for performing simple operations with paragraph and character styles.
ITextEditor
ITextEditorElementHandler
ITextEditorRenderer
ITextEngineWrapper
ITextFrameData
ITextHandler
Handler for performing simple operations with text content.
ITextLimits
ITextManager
Manager for performing basic operations with text.
ITextMeasurer
Handler for measuring text.
ITextMeasurerHolder
ITextMetrics
ITextRange
ITextWhizzHolder
ITextWhizzInitData
IUndoRedoHandler
Handler for performing operations with redoing and undoing of actions.
IWrappingPathData
Enums
CommandType
InputCommandType
Keys
ListStyleType
ListType
MouseEventType
MoveDirectionType
MovementSideType
NumberFormatType
NumberingFormatType
The format of numbered list markers.
NumberingModeType
NumberMode
ParagraphAlignment
TextFrameType
Units
Functions
comparePositions(p0, p1)
Compares two positions.
Declaration
export declare function comparePositions(p0: TextWhizz.TextPosition, p1: TextWhizz.TextPosition): boolean;Parameters
| Type | Name | Description |
|---|---|---|
| TextWhizz.TextPosition | p0 |
first position. |
| TextWhizz.TextPosition | p1 |
second position. true if the positions match, false otherwise. |
Returns
| Type | Description |
|---|---|
| boolean |
compareRanges(sel0, sel1)
Compares two ranges.
Declaration
export declare function compareRanges(sel0: TextWhizz.TextRange, sel1: TextWhizz.TextRange): boolean;Parameters
| Type | Name | Description |
|---|---|---|
| TextWhizz.TextRange | sel0 |
first range. |
| TextWhizz.TextRange | sel1 |
second range. true if the ranges match, false otherwise. |
Returns
| Type | Description |
|---|---|
| boolean |
fromTextWhizzPath(path)
Declaration
export declare function fromTextWhizzPath(path: TextWhizz.Path): Path;Parameters
| Type | Name | Description |
|---|---|---|
| TextWhizz.Path | path |
Returns
| Type | Description |
|---|---|
| Path |
getPathFirstPoint(path)
Declaration
export declare function getPathFirstPoint(path: Path): PointF;Parameters
| Type | Name | Description |
|---|---|---|
| Path | path |
Returns
| Type | Description |
|---|---|
| PointF |
getPathLastPoint(path)
Declaration
export declare function getPathLastPoint(path: Path): PointF;Parameters
| Type | Name | Description |
|---|---|---|
| Path | path |
Returns
| Type | Description |
|---|---|
| PointF |
toTextWhizzPath(textWhizz, modelPath)
Declaration
export declare function toTextWhizzPath(textWhizz: typeof TextWhizz, modelPath: Path): TextWhizz.Path;Parameters
| Type | Name | Description |
|---|---|---|
| typeof TextWhizz | textWhizz | |
| Path | modelPath |
Returns
| Type | Description |
|---|---|
| TextWhizz.Path |
Type Aliases
EditorInitData
Declaration
export declare type EditorInitData = {
text?: string;
defaultParagraphStyle?: IParagraphStyle;
defaultInlineStyle?: ICharStyle;
rectangle?: RotatedRectangleF;
textAlignment?: TextAlignment;
borderWidth?: number;
borderColor?: string;
fillColor?: string;
opacity?: number;
point?: IPoint;
previewScale?: number;
textFormattingEnabled?: boolean;
transform?: Transform;
textVerticalAlignment?: TextVerticalAlignment;
newLineEnabled?: boolean;
isVertical?: boolean;
listSettings: IListConfiguration;
limits?: ITextLimits;
};OpenTypeFeatureTag
Declaration
export declare type OpenTypeFeatureTag = string;