Struct TimelineCreateOptions 

pub struct TimelineCreateOptions {
    pub date: Option<String>,
    pub tags: Option<Vec<String>>,
    pub index: Option<i32>,
    pub title: Option<String>,
    pub label: Option<String>,
    pub lane: Option<String>,
    pub milestone: Option<bool>,
    pub start: Option<BTreeMap<String, i64>>,
    pub end: Option<BTreeMap<String, i64>>,
    pub references: Option<Vec<i32>>,
    pub timeline: Option<String>,
}

The optional inputs of create; leave any out with ..Default::default().

Fields

date: Option<String>

Deprecated alias of label; label wins when both are given.

tags: Option<Vec<String>>

index: Option<i32>

Its position in the timeline; left out, the end. A dated timeline takes none.

title: Option<String>

Its own title; left out, the content’s first line is shown.

label: Option<String>

Free-text “when” a manual timeline shows, such as “Day 3” or “Spring, 1802”.

lane: Option<String>

The lane it runs in.

milestone: Option<bool>

A turning point, marked across every lane.

start: Option<BTreeMap<String, i64>>

When it starts on the timeline’s calendar, such as {“year”: 97, “day”: 210}; required on a dated timeline.

end: Option<BTreeMap<String, i64>>

When it ends, in the same form as start; needs a start.

references: Option<Vec<i32>>

Scene and entry ids it refers to.

timeline: Option<String>

The timeline’s id, from timeline.settings.read; left out, or “main”, the main timeline.

Trait Implementations

impl Clone for TimelineCreateOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimelineCreateOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TimelineCreateOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TimelineCreateOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TimelineCreateOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimelineCreateOptions