TextSegment Class
Packages > @fluidframework/merge-tree > TextSegment
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/merge-tree/legacy.
For more information about our API support guarantees, see here .
Signature
export declare class TextSegment extends BaseSegment
Extends: BaseSegment
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(text, props) | Alpha |
Constructs a new instance of the TextSegment class |
Static Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| type | Alpha |
readonly |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| text | Alpha |
string | ||
| type | Alpha |
readonly |
Constructor Details
(constructor)
Constructs a new instance of the TextSegment class
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
constructor(text: string, props?: PropertySet);
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| text | string | ||
| props | optional | PropertySet |
Property Details
text
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
text: string;
Type: string
type
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
readonly type = "TextSegment";
type
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha.
For more information about our API support guarantees, see here .
Signature
static readonly type = "TextSegment";