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,
    /* private fields */
}

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

Fields

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

group

Implementations

impl KaTeXOptions

pub fn display_mode() -> KaTeXOptions

pub fn inline_mode() -> KaTeXOptions

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

impl KaTeXOptions

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

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

pub fn set_macro_rules(&mut self) -> bool

pub fn insert_macro_rule(&mut self) -> bool

Trait Implementations

impl Clone for KaTeXOptions

fn clone(&self) -> KaTeXOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for KaTeXOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KaTeXOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<KaTeXOptions> for JsValue

fn from(value: KaTeXOptions) -> Self

Performs the conversion.

impl FromWasmAbi for KaTeXOptions

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for KaTeXOptions

type Abi = u32

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

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for KaTeXOptions

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for KaTeXOptions

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for KaTeXOptions

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.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for KaTeXOptions

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, KaTeXOptions>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Serialize for KaTeXOptions

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

Serialize this value into the given Serde serializer.

impl WasmDescribe for KaTeXOptions

fn describe()