Class: Anydoc::Inline

Inherits:

Data

• Object
• Data
• Anydoc::Inline

Defined in:

lib/anydoc/document.rb,
sig/anydoc.rbs

Overview

One inline-level piece of content.

Instance Attribute Summary

• #alt ⇒ String^? readonly

  Image.

• #anchor ⇒ String^? readonly

  Anchor: the anchor id.

• #content ⇒ Array<Inline>^? readonly

  Link.

• #kind ⇒ Symbol readonly

  :text | :link | :image | :anchor | :note_ref | :line_break.

• #note_id ⇒ String^? readonly

  Note_ref: the id of the note in Document#notes.

• #source ⇒ ImageSource^? readonly

  Image.

• #style ⇒ Style^? readonly

  Text.

• #target ⇒ LinkTarget^? readonly

  Link.

• #text ⇒ String^? readonly

  Text.

Instance Attribute Details

#alt ⇒ String^? (readonly)

Returns image.

Returns:

• (String, nil) —

  image.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#anchor ⇒ String^? (readonly)

Returns anchor: the anchor id.

Returns:

• (String, nil) —

  anchor: the anchor id.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#content ⇒ Array<Inline>^? (readonly)

Returns link.

Returns:

• (Array<Inline>, nil) —

  link.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#kind ⇒ Symbol (readonly)

:text | :link | :image | :anchor | :note_ref | :line_break

Returns:

• (Symbol)

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#note_id ⇒ String^? (readonly)

Returns note_ref: the id of the note in Document#notes.

Returns:

• (String, nil) —

  note_ref: the id of the note in Document#notes.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#source ⇒ ImageSource^? (readonly)

Returns image.

Returns:

• (ImageSource, nil) —

  image.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#style ⇒ Style^? (readonly)

Returns text.

Returns:

• (Style, nil) —

  text.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#target ⇒ LinkTarget^? (readonly)

Returns link.

Returns:

• (LinkTarget, nil) —

  link.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end

#text ⇒ String^? (readonly)

Returns text.

Returns:

• (String, nil) —

  text.

# File 'lib/anydoc/document.rb', line 81

class Inline < Data.define(
  :kind, :text, :style, :content, :target, :alt, :source, :anchor, :note_id
)
end