Interface Decorator

A decorator applied to a content string value in order to create rich text.

Export

Decorator

interface Decorator {
    depth?: number;
    length?: number;
    offset?: number;
    type?: DecoratorType;
}

Properties

depth? length? offset? type?

Properties

Optional depth

depth?: number

The relative intensity or variation of this decorator. Decorators such as bullet-points, for example, can have multiple indentation depths.

Memberof

Decorator

Optional length

length?: number

The number of content characters to alter with this decorator. Decorators such as line breaks can have zero length and fit between characters.

Memberof

Decorator

Optional offset

offset?: number

The starting character of this decorator within the content string. Use zero for the first character.

Memberof

Decorator

Optional type

type?: DecoratorType

Memberof

Decorator

Settings

Member Visibility

Theme

On This Page

depthlengthoffsettype