Title

Title :: # (opaque)

A visible chart or axis title, or an inherited title setting.

default : Title

Leave the title unset, encoding an empty object. This is different from a title whose text is the empty string.

new : Props -> Title

Construct a visible title without a fallible validation step. Use it for the chart title in Layout.Props or for an axis title. The supplied text is escaped during JSON encoding.

get_text : Title -> Try(Str, [TitleNotSet])

Read the explicitly supplied title text, including an empty string. Returns TitleNotSet only for Title.default; it does not invent a fallback title.

to_json_value : Title -> InternalJson

Internal composition hook used by Plume's renderers. Applications normally use Title.to_json for complete JSON text; this returns the package's safe internal value without accepting raw JSON.

to_json : Title -> Str

Serialize this validated value as a complete JSON document.

Props

:= { text : Str, font : Font ?? Font.default }

A visible title's text and font override. text is required and may be empty. Plotly interprets supported text markup. font defaults to Font.default, inheriting chart styling.