Interface IContentBlockTarget

Describes a full or partial selection of an IContentBlock associated with a ContentLocation.

interface IContentBlockTarget {
    getAnchorPoint(): ContentBlockTargetAnchorPoint;
    getCharLength(): number;
    getCharOffset(): number;
    getContentBlock(): IContentBlock;
    toJSON(): IContentBlockTargetData;
}

Methods

getAnchorPoint

getAnchorPoint(): ContentBlockTargetAnchorPoint
The anchor point of the Locator relative the content block.

Returns ContentBlockTargetAnchorPoint

getCharLength

getCharLength(): number
The number of characters selected in the ContentBlock by the ContentLocation.

Returns number

getCharOffset

getCharOffset(): number
The character offset within the content block, corresponding to the start position of the ContentLocation.

Returns number

getContentBlock

getContentBlock(): IContentBlock
The ContentBlock targeted.

Returns IContentBlock

toJSON

toJSON(): IContentBlockTargetData
Get this instance as a JSON serializable object.

Returns IContentBlockTargetData