Struct WordCloud

pub struct WordCloud<'a> { /* private fields */ }

Creates the WordCloud

Implementations

impl<'a> WordCloud<'a>

pub fn write_content(&self, content: RankedWords, max_word_count: usize)

Add new words to the WordCloud. For the best results, call this function only once.

pub fn export_rendered(&self) -> Result<String, Error>

Export the resulting WordCloud as an SVG formatted String. Here the text is rendered using SVG Paths instead of Text elements. This leads to way bigger file sizes, but also to a little bit more accurate drawing of the text.

To export using text elements, use the Self::export_text function.

pub fn export_rendered_to_file(&self, filename: &str) -> Result<(), Error>

Writes the result of Self::export_rendered to a file.

pub fn export_text(&self) -> Result<String, Error>

Export the resulting WordCloud as an SVG formatted String. Here the text is rendered using Text elements.

This function should be preferred over Self::export_rendered in most use-cases.

pub fn export_text_to_file(&self, filename: &str) -> Result<(), Error>

Writes the result of Self::export_text to a file.

impl<'a> WordCloud<'a>

pub fn export_debug_to_folder(&self, folder_name: &str)

Exports versions of the WordCloud to a folder, which are mainly used for debugging purposes. This function may panic, so it shouldn’t be used in production.