Trilium Frontend API
    Preparing search index...

    Class DecorationAbstract

    A decoration provides information on how to draw or style a piece of content. You'll usually use it wrapped in a Range, which adds a start and end position.

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • InternalstartSide: number
      • InternalendSide: number
      • Internalwidget: WidgetType
      • spec: any

        The config object used to create this decoration. You can include additional properties in there to store metadata about your decoration.

      Returns Decoration

    Properties

    endSide: number

    The bias value at the end of the range. Defaults to 0.

    mapMode: MapMode

    The mode with which the location of the range should be mapped when its from and to are the same, to decide whether a change deletes the range. Defaults to MapMode.TrackDel.

    point: boolean

    Determines whether this value marks a point range. Regular ranges affect the part of the document they cover, and are meaningless when empty. Point ranges have a meaning on their own. When non-empty, a point range is treated as atomic and shadows any ranges contained in it.

    spec: any

    The config object used to create this decoration. You can include additional properties in there to store metadata about your decoration.

    startSide: number

    The bias value at the start of the range. Determines how the range is positioned relative to other ranges starting at this position. Defaults to 0.

    The empty set of decorations.

    Methods

    • Compare this value with another value. Used when comparing rangesets. The default implementation compares by identity. Unless you are only creating a fixed number of unique instances of your value type, it is a good idea to implement this properly.

      Parameters

      Returns boolean

    • Create a mark decoration, which influences the styling of the content in its range. Nested mark decorations will cause nested DOM elements to be created. Nesting order is determined by precedence of the facet, with the higher-precedence decorations creating the inner DOM nodes. Such elements are split on line boundaries and on the boundaries of lower-precedence decorations.

      Parameters

      Returns Decoration