laika-core
API
Generated with
laika-core/laika/laika.ast/LinkDefinition

LinkDefinition

laika.ast.LinkDefinition
See theLinkDefinition companion object
case class LinkDefinition(id: String, target: Target, title: Option[String], options: Options) extends Definition, Hidden, Span

An internal or external link target that can be referenced by id, usually only part of the raw document tree and then removed by the rewrite rule that resolves link and image references.

Attributes

Companion
object
Graph
Supertypes
trait Span
trait Hidden
trait Definition
trait Block
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Type members

Types

Value members

Concrete methods

def withOptions(options: Options): LinkDefinition

Returns a new instance of this element with the specified options replacing the current value.

Returns a new instance of this element with the specified options replacing the current value.

Attributes

Inherited methods

def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Attributes

Inherited from:
Element
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Attributes

Inherited from:
Element
def mergeOptions(opt: Options): Self

Returns a new instance of this element with its options merged with the specified options.

Returns a new instance of this element with its options merged with the specified options.

Attributes

Inherited from:
Element
def modifyOptions(f: Options => Options): Self

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Attributes

Inherited from:
Element
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def withId(id: String): Self

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Attributes

Inherited from:
Element
def withStyle(name: String): Self

Returns a new instance of this element with the specified style added to its existing styles.

Returns a new instance of this element with the specified style added to its existing styles.

Attributes

Inherited from:
Element
def withStyles(styles: Iterable[String]): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Attributes

Inherited from:
Element
def withStyles(style: String, styles: String*): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Attributes

Inherited from:
Element
def withoutId: Self

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Attributes

Inherited from:
Element
Generated with