Struct ArtifactElem 

pub struct ArtifactElem {
    pub kind: Settable<Self, 0u8>,
    pub body: Content,
}

Marks content as a PDF artifact.

Artifacts are parts of the document that are not meant to be read by Assistive Technology (AT), such as screen readers. Typical examples include purely decorative images that do not contribute to the meaning of the document, watermarks, or repeated content such as page numbers.

Typst will automatically mark certain content, such as page headers, footers, backgrounds, and foregrounds, as artifacts. Likewise, paths and shapes are automatically marked as artifacts, but their content is not. Repetitions of table headers and footers are also marked as artifacts.

Once something is marked as an artifact, you cannot make any of its contents accessible again. If you need to mark only part of something as an artifact, you may need to use this function multiple times.

If you are unsure what constitutes an artifact, check the Accessibility Guide.

In the future, this function may be moved out of the pdf module, making it possible to hide content in HTML export from AT.

Fields

kind: Settable<Self, 0u8>

body: Content

Implementations

impl ArtifactElem

pub fn new(body: Content) -> Self

Create a new instance of the element.

pub fn with_kind(self, kind: ArtifactKind) -> Self

Builder-style setter for the kind field.

impl ArtifactElem

pub const kind: Field<Self, 0u8>

pub const body: Field<Self, 1u8>

Trait Implementations

impl Clone for ArtifactElem

fn clone(&self) -> ArtifactElem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Construct for ArtifactElem

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

Construct an element from the arguments.

impl Debug for ArtifactElem

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

Formats the value using the given formatter.

impl Hash for ArtifactElem

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 ArtifactElem

const ELEM: Element

The associated element.

fn pack(self) -> Content

Pack the element into type-erased content.

impl RequiredField<1> for ArtifactElem

const FIELD: RequiredFieldData<Self, 1u8>

type Type = Content

impl Set for ArtifactElem

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

Parse relevant arguments into style properties for this element.

impl SettableField<0> for ArtifactElem

const FIELD: SettableFieldData<Self, 0u8>

type Type = ArtifactKind

impl RefableProperty<0> for ArtifactElem