Struct CancelElem

pub struct CancelElem {
    pub body: Content,
    /* private fields */
}

Displays a diagonal line over a part of an equation.

This is commonly used to show the elimination of a term.

Example

>>> #set page(width: 140pt)
Here, we can simplify:
$ (a dot b dot cancel(x)) /
    cancel(x) $

Fields

body: Content

Implementations

impl CancelElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_length(self, length: Rel<Length>) -> Self

Builder-style setter for the length field.

pub fn with_inverted(self, inverted: bool) -> Self

Builder-style setter for the inverted field.

pub fn with_cross(self, cross: bool) -> Self

Builder-style setter for the cross field.

pub fn with_angle(self, angle: Smart<CancelAngle>) -> Self

Builder-style setter for the angle field.

pub fn with_stroke(self, stroke: Stroke) -> Self

Builder-style setter for the stroke field.

pub fn push_length(&mut self, length: Rel<Length>)

Setter for the length field.

pub fn push_inverted(&mut self, inverted: bool)

Setter for the inverted field.

pub fn push_cross(&mut self, cross: bool)

Setter for the cross field.

pub fn push_angle(&mut self, angle: Smart<CancelAngle>)

Setter for the angle field.

pub fn push_stroke(&mut self, stroke: Stroke)

Setter for the stroke field.

pub fn length(&self, styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

The length of the line, relative to the length of the diagonal spanning the whole element being “cancelled”. A value of {100%} would then have the line span precisely the element’s diagonal.

>>> #set page(width: 140pt)
$ a + cancel(x, length: #200%)
    - cancel(x, length: #200%) $

pub fn inverted(&self, styles: StyleChain<'_>) -> bool

Whether the cancel line should be inverted (flipped along the y-axis). For the default angle setting, inverted means the cancel line points to the top left instead of top right.

>>> #set page(width: 140pt)
$ (a cancel((b + c), inverted: #true)) /
    cancel(b + c, inverted: #true) $

pub fn cross(&self, styles: StyleChain<'_>) -> bool

Whether two opposing cancel lines should be drawn, forming a cross over the element. Overrides inverted.

>>> #set page(width: 140pt)
$ cancel(Pi, cross: #true) $

pub fn angle(&self, styles: StyleChain<'_>) -> Smart<CancelAngle>

How much to rotate the cancel line.

• If given an angle, the line is rotated by that angle clockwise with respect to the y-axis.
• If {auto}, the line assumes the default angle; that is, along the rising diagonal of the content box.
• If given a function angle => angle, the line is rotated, with respect to the y-axis, by the angle returned by that function. The function receives the default angle as its input.

>>> #set page(width: 140pt)
$ cancel(Pi)
  cancel(Pi, angle: #0deg)
  cancel(Pi, angle: #45deg)
  cancel(Pi, angle: #90deg)
  cancel(1/(1+x), angle: #(a => a + 45deg))
  cancel(1/(1+x), angle: #(a => a + 90deg)) $

pub fn stroke(&self, styles: StyleChain<'_>) -> <Stroke as Resolve>::Output

How to stroke the cancel line.

>>> #set page(width: 140pt)
$ cancel(
  sum x,
  stroke: #(
    paint: red,
    thickness: 1.5pt,
    dash: "dashed",
  ),
) $

pub fn length_in(styles: StyleChain<'_>) -> <Rel<Length> as Resolve>::Output

Access the length field in the given style chain.

pub fn inverted_in(styles: StyleChain<'_>) -> bool

Access the inverted field in the given style chain.

pub fn cross_in(styles: StyleChain<'_>) -> bool

Access the cross field in the given style chain.

pub fn angle_in(styles: StyleChain<'_>) -> Smart<CancelAngle>

Access the angle field in the given style chain.

pub fn stroke_in(styles: StyleChain<'_>) -> <Stroke as Resolve>::Output

Access the stroke field in the given style chain.

pub fn set_length(length: Rel<Length>) -> Property

Create a style property for the length field.

pub fn set_inverted(inverted: bool) -> Property

Create a style property for the inverted field.

pub fn set_cross(cross: bool) -> Property

Create a style property for the cross field.

pub fn set_angle(angle: Smart<CancelAngle>) -> Property

Create a style property for the angle field.

pub fn set_stroke(stroke: Stroke) -> Property

Create a style property for the stroke field.

Trait Implementations

impl Capable for CancelElem

fn vtable(capability: TypeId) -> Option<NonNull<()>>

Get the pointer to the vtable for the given capability / trait.

impl Clone for CancelElem

fn clone(&self) -> CancelElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for CancelElem

fn construct(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Content>

Construct an element from the arguments.

impl Debug for CancelElem

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

Formats the value using the given formatter.

impl Fields for CancelElem

type Enum = Fields

An enum with the fields of the element.

fn has(&self, id: u8) -> bool

Whether the element has the given field set.

fn field(&self, id: u8) -> Result<Value, FieldAccessError>

Get the field with the given field ID.

fn field_with_styles( &self, id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID in the presence of styles.

fn field_from_styles( id: u8, styles: StyleChain<'_>, ) -> Result<Value, FieldAccessError>

Get the field with the given ID from the styles.

fn materialize(&mut self, styles: StyleChain<'_>)

Resolve all fields with the styles and save them in-place.

fn fields(&self) -> Dict

Get the fields of the element.

impl Hash for CancelElem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoValue for CancelElem

fn into_value(self) -> Value

Cast this type into a value.

impl NativeElement for CancelElem

fn data() -> &'static NativeElementData

Get the element data for the native Rust element.

fn elem() -> Element

where Self: Sized,

Get the element for the native Rust element.

fn pack(self) -> Content

where Self: Sized,

Pack the element into type-erased content.

impl PartialEq for CancelElem

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Repr for CancelElem

fn repr(&self) -> EcoString

Return the debug representation of the value.

impl Set for CancelElem

fn set(engine: &mut Engine<'_>, args: &mut Args) -> SourceResult<Styles>

Parse relevant arguments into style properties for this element.