GuidedNavigationDocument class

A Readium Guided Navigation Document, describing a structured sequence of media-aligned navigation steps for a publication.

See https://readium.org/guided-navigation/schema/document.schema.json

Implemented types

• JSONable

Annotations

• @immutable

Constructors

GuidedNavigationDocument({required List<GuidedNavigationObject> guided, List<Link> links = const []})

const

Properties

guided → List<GuidedNavigationObject>

The ordered list of guided navigation objects. Must contain at least one.

final

hashCode → int

The hash code for this object.

no setter, inherited

links → List<Link>

Optional cross-references to related resources, using the Readium Web Publication Manifest link schema.

final

props → List<Object>

The list of properties that will be used to determine whether two instances are equal.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes the object to its JSON representation.

override

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromJson(Map<String, dynamic>? json) → GuidedNavigationDocument?