Struct ImageElem 

pub struct ImageElem {
    pub source: Derived<DataSource, Loaded>,
    pub format: Settable<Self, 1u8>,
    pub width: Settable<Self, 2u8>,
    pub height: Settable<Self, 3u8>,
    pub alt: Settable<Self, 4u8>,
    pub page: Settable<Self, 5u8>,
    pub fit: Settable<Self, 6u8>,
    pub scaling: Settable<Self, 7u8>,
    pub icc: Settable<Self, 8u8>,
    pub locale: Option<Locale>,
}

A raster or vector graphic.

You can wrap the image in a [figure] to give it a number and caption.

Like most elements, images are block-level by default and thus do not integrate themselves into adjacent paragraphs. To force an image to become inline, put it into a [box].

Example

#figure(
  image("molecular.jpg", width: 80%),
  caption: [
    A step in the molecular testing
    pipeline of our lab.
  ],
)

Fields

source: Derived<DataSource, Loaded>

format: Settable<Self, 1u8>

width: Settable<Self, 2u8>

height: Settable<Self, 3u8>

alt: Settable<Self, 4u8>

page: Settable<Self, 5u8>

fit: Settable<Self, 6u8>

scaling: Settable<Self, 7u8>

icc: Settable<Self, 8u8>

locale: Option<Locale>

Implementations

impl ImageElem

pub fn new(source: Derived<DataSource, Loaded>) -> Self

Create a new instance of the element.

pub fn with_format(self, format: Smart<ImageFormat>) -> Self

Builder-style setter for the format field.

pub fn with_width(self, width: Smart<Rel<Length>>) -> Self

Builder-style setter for the width field.

pub fn with_height(self, height: Sizing) -> Self

Builder-style setter for the height field.

pub fn with_alt(self, alt: Option<EcoString>) -> Self

Builder-style setter for the alt field.

pub fn with_page(self, page: NonZeroUsize) -> Self

Builder-style setter for the page field.

pub fn with_fit(self, fit: ImageFit) -> Self

Builder-style setter for the fit field.

pub fn with_scaling(self, scaling: Smart<ImageScaling>) -> Self

Builder-style setter for the scaling field.

pub fn with_icc(self, icc: Smart<Derived<DataSource, Bytes>>) -> Self

Builder-style setter for the icc field.

pub fn with_locale(self, locale: Locale) -> Self

Builder-style setter for the locale field.

impl ImageElem

pub const source: Field<Self, 0u8>

pub const format: Field<Self, 1u8>

pub const width: Field<Self, 2u8>

pub const height: Field<Self, 3u8>

pub const alt: Field<Self, 4u8>

pub const page: Field<Self, 5u8>

pub const fit: Field<Self, 6u8>

pub const scaling: Field<Self, 7u8>

pub const icc: Field<Self, 8u8>

pub const locale: Field<Self, 9u8>

impl ImageElem

pub fn decode( span: Span, data: Spanned<Readable>, format: Option<Smart<ImageFormat>>, width: Option<Smart<Rel<Length>>>, height: Option<Sizing>, alt: Option<Option<EcoString>>, fit: Option<ImageFit>, scaling: Option<Smart<ImageScaling>>, ) -> StrResult<Content>

Decode a raster or vector graphic from bytes or a string.

Trait Implementations

impl Clone for ImageElem

fn clone(&self) -> ImageElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for ImageElem

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

Construct an element from the arguments.

impl Debug for ImageElem

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

Formats the value using the given formatter.

impl Hash for ImageElem

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 NativeElement for ImageElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl NativeScope for ImageElem

fn constructor() -> Option<&'static NativeFuncData>

The constructor function for the type, if any.

fn scope() -> Scope

Get the associated scope for the type.

impl RequiredField<0> for ImageElem

const FIELD: RequiredFieldData<Self, 0u8>

type Type = Derived<DataSource, Loaded>

impl Set for ImageElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<1> for ImageElem

const FIELD: SettableFieldData<Self, 1u8>

type Type = Smart<ImageFormat>

impl SettableField<2> for ImageElem

const FIELD: SettableFieldData<Self, 2u8>

type Type = Smart<Rel>

impl SettableField<3> for ImageElem

const FIELD: SettableFieldData<Self, 3u8>

type Type = Sizing

impl SettableField<4> for ImageElem

const FIELD: SettableFieldData<Self, 4u8>

type Type = Option<EcoString>

impl SettableField<5> for ImageElem

const FIELD: SettableFieldData<Self, 5u8>

type Type = NonZero<usize>

impl SettableField<6> for ImageElem

const FIELD: SettableFieldData<Self, 6u8>

type Type = ImageFit

impl SettableField<7> for ImageElem

const FIELD: SettableFieldData<Self, 7u8>

type Type = Smart<ImageScaling>

impl SettableField<8> for ImageElem

const FIELD: SettableFieldData<Self, 8u8>

type Type = Smart<Derived<DataSource, Bytes>>

impl SynthesizedField<9> for ImageElem

const FIELD: SynthesizedFieldData<Self, 9u8>

type Type = Locale

impl RefableProperty<1> for ImageElem

impl RefableProperty<2> for ImageElem

impl RefableProperty<3> for ImageElem

impl RefableProperty<4> for ImageElem

impl RefableProperty<5> for ImageElem

impl RefableProperty<6> for ImageElem

impl RefableProperty<7> for ImageElem

impl RefableProperty<8> for ImageElem