[][src]Struct katex_wasmbind::KaTeXOptions

pub struct KaTeXOptions {
    pub display_mode: bool,
    pub left_equation_numbers: bool,
    pub flush_left_equations: bool,
    pub throw_on_error: bool,
    pub min_rule_thickness: f64,
    pub max_size: f64,
    pub max_expand: i32,
    pub strict: bool,
    pub trust: bool,
    pub global_group: bool,
    // some fields omitted

Read https://katex.org/docs/options.html for more information.


display_mode: bool

Whether to render the math in the display mode.

left_equation_numbers: bool

If true, display math has \tags rendered on the left instead of the right.
like \usepackage[leqno]{amsmath} in LaTeX.

flush_left_equations: bool

If true, display math renders flush left with a 2em left margin
like \documentclass[fleqn] in LaTeX with the amsmath package.

throw_on_error: bool

Whether to let KaTeX throw a ParseError for invalid LaTeX.

min_rule_thickness: f64

Color used for invalid LaTeX. Specifies a minimum thickness, in ems.

max_size: f64

Max size for user-specified sizes. If set to None, users can make elements and spaces arbitrarily large.

max_expand: i32

Limit the number of macro expansions to the specified number. If set to None, the macro expander will try to fully expand as in LaTeX.

strict: bool

strict mode

trust: bool

Whether to trust users' input. Cannot be assigned at the same time with [OptsBuilder::trust_callback].

global_group: bool



impl KaTeXOptions[src]

pub fn display_mode() -> KaTeXOptions[src]

pub fn inline_mode() -> KaTeXOptions[src]

pub fn render(&self, input: &str) -> String[src]

impl KaTeXOptions[src]

pub fn set_output_format(&mut self, format: &str) -> bool[src]

Determines the markup language of the output.
The valid choices are:

  • html: Outputs KaTeX in HTML only.
  • mathml: Outputs KaTeX in MathML only.
  • htmlAndMathml: Outputs HTML for visual rendering and includes MathML for accessibility. This is the default.

pub fn set_error_color(&mut self) -> bool[src]

pub fn set_macro_rules(&mut self) -> bool[src]

pub fn insert_macro_rule(&mut self) -> bool[src]

Trait Implementations

impl Clone for KaTeXOptions[src]

impl Default for KaTeXOptions[src]

impl<'de> Deserialize<'de> for KaTeXOptions[src]

impl From<KaTeXOptions> for JsValue[src]

impl FromWasmAbi for KaTeXOptions[src]

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary. Read more

impl IntoWasmAbi for KaTeXOptions[src]

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary. Read more

impl OptionFromWasmAbi for KaTeXOptions[src]

impl OptionIntoWasmAbi for KaTeXOptions[src]

impl RefFromWasmAbi for KaTeXOptions[src]

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, KaTeXOptions>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous. Read more

impl RefMutFromWasmAbi for KaTeXOptions[src]

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, KaTeXOptions>

Same as RefFromWasmAbi::Anchor

impl Serialize for KaTeXOptions[src]

impl WasmDescribe for KaTeXOptions[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> ReturnWasmAbi for T where
    T: IntoWasmAbi

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.