Packages > @fluidframework/merge-tree > Marker

Marker Class

Markers are a special kind of segment that do not hold any content.

Markers with a reference type of Tile support spatially accelerated queries for finding the next marker to the left or right of it in sub-linear time. This is useful, for example, in the case of jumping from the start of a paragraph to the end, assuming a paragraph is bound by markers at the start and end.

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 Marker extends BaseSegment implements ReferencePosition, ISegment

Extends: BaseSegment

Implements: ReferencePosition , ISegment

Constructors

Constructor Alerts Description
(constructor)(refType) Alpha Constructs a new instance of the Marker class

Static Properties

Property Alerts Modifiers Type Description
type Alpha readonly

Properties

Property Alerts Modifiers Type Description
refType Alpha ReferenceType
type Alpha readonly

Constructor Details

(constructor)

Constructs a new instance of the Marker 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(refType: ReferenceType);

Parameters

Parameter Type Description
refType ReferenceType

Property Details

refType

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

refType: ReferenceType;

Type: ReferenceType

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 = "Marker";

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 = "Marker";