[−]Struct xterm_js_sys::xterm::TerminalOptions

pub struct TerminalOptions {
    pub allow_proposed_api: Option<bool>,
    pub allow_transparency: Option<bool>,
    pub(super) bell_sound: Option<Str>,
    pub bell_style: Option<BellStyle>,
    pub cols: Option<u16>,
    pub convert_eol: Option<bool>,
    pub cursor_blink: Option<bool>,
    pub cursor_style: Option<CursorStyle>,
    pub cursor_width: Option<f32>,
    pub disable_stdin: Option<bool>,
    pub draw_bold_text_in_bright_colors: Option<bool>,
    pub fast_scroll_modifier: Option<FastScrollModifier>,
    pub fast_scroll_sensitivity: Option<f32>,
    pub(super) font_family: Option<Str>,
    pub font_size: Option<f32>,
    pub font_weight: Option<f32>,
    pub font_weight_bold: Option<FontWeight>,
    pub letter_spacing: Option<u16>,
    pub line_height: Option<u16>,
    pub link_tooltip_hover_duration: Option<u16>,
    pub log_level: Option<LogLevel>,
    pub mac_option_click_forces_selection: Option<bool>,
    pub mac_option_is_meta: Option<bool>,
    pub minimum_contrast_ratio: Option<f32>,
    pub renderer_type: Option<RendererType>,
    pub right_click_selects_word: Option<bool>,
    pub rows: Option<u16>,
    pub screen_reader_mode: Option<bool>,
    pub scroll_sensitivity: Option<f32>,
    pub scrollback: Option<u32>,
    pub tab_stop_width: Option<u16>,
    pub(super) theme: Option<Theme>,
    pub(super) window_options: Option<WindowOptions>,
    pub windows_mode: Option<bool>,
    pub(super) word_separator: Option<Str>,
}

An object containing start up options for the terminal.

(This is really an interface, but we just go and define our own type that satisfies the interface.)

Fields

allow_proposed_api: Option<bool>

Whether to allow the use of proposed API. When false, any usage of APIs marked as experimental/proposed will throw an error. This defaults to true currently, but will change to false in v5.0.

allow_transparency: Option<bool>

Whether background should support non-opaque color. It must be set before executing the Terminal::open method and can’t be changed later without executing it again. Note that enabling this can negatively impact performance.

bell_sound: Option<Str>

A data uri of the sound to use for the bell when [TerminalOptions.bell_style] = 'sound'.

bell_style: Option<BellStyle>

The type of the bell notification the terminal will use.

cols: Option<u16>

The number of columns in the terminal.

convert_eol: Option<bool>

When enabled the cursor will be set to the beginning of the next line with every new line. This is equivalent to sending ‘\r\n’ for each ‘\n’. Normally the termios settings of the underlying PTY deals with the translation of ‘\n’ to ‘\r\n’ and this setting should not be used. If you deal with data from a non-PTY related source, this settings might be useful.

cursor_blink: Option<bool>

Whether the cursor blinks.

cursor_style: Option<CursorStyle>

The style of the cursor.

cursor_width: Option<f32>

The width of the cursor in CSS pixels when cursor_style is set to ‘bar’.

disable_stdin: Option<bool>

Whether input should be disabled.

draw_bold_text_in_bright_colors: Option<bool>

Whether to draw bold text in bright colors. The default is true.

fast_scroll_modifier: Option<FastScrollModifier>

The modifier key hold to multiply scroll speed.

fast_scroll_sensitivity: Option<f32>

The scroll speed multiplier used for fast scrolling.

font_family: Option<Str>

The font family used to render text.

font_size: Option<f32>

The font size used to render text.

font_weight: Option<f32>

The font weight used to render non-bold text.

font_weight_bold: Option<FontWeight>

The font weight used to render bold text.

letter_spacing: Option<u16>

The spacing in whole pixels between characters.

line_height: Option<u16>

The line height used to render text.

link_tooltip_hover_duration: Option<u16>

👎 Deprecated since 4.6.0:

This will be removed when the link matcher API is removed. See: https://github.com/xtermjs/xterm.js/issues/2703

The duration in milliseconds before link tooltip events fire when hovering on a link.

log_level: Option<LogLevel>

What log level to use, this will log for all levels below and including what is set:

debug
info (default)
warn
error
off

mac_option_click_forces_selection: Option<bool>

Whether holding a modifier key will force normal selection behavior, regardless of whether the terminal is in mouse events mode. This will also prevent mouse events from being emitted by the terminal. For example, this allows you to use xterm.js’ regular selection inside tmux with mouse mode enabled.

mac_option_is_meta: Option<bool>

Whether to treat option as the meta key.

minimum_contrast_ratio: Option<f32>

The minimum contrast ratio for text in the terminal, setting this will change the foreground color dynamically depending on whether the contrast ratio is met. Example values:

1: The default, do nothing.
4.5: Minimum for WCAG AA compliance.
7: Minimum for WCAG AAA compliance.
21: White on black or black on white.

renderer_type: Option<RendererType>

The type of renderer to use, this allows using the fallback DOM renderer when canvas is too slow for the environment. The following features do not work when the DOM renderer is used:

Letter spacing
Cursor blink

right_click_selects_word: Option<bool>

Whether to select the word under the cursor on right click, this is standard behavior in a lot of macOS applications.

rows: Option<u16>

The number of rows in the terminal.

screen_reader_mode: Option<bool>

Whether screen reader support is enabled. When on this will expose supporting elements in the DOM to support NVDA on Windows and VoiceOver on macOS.

scroll_sensitivity: Option<f32>

The scrolling speed multiplier used for adjusting normal scrolling speed.

scrollback: Option<u32>

The amount of scrollback in the terminal. Scrollback is the amount of rows that are retained when lines are scrolled beyond the initial viewport.

tab_stop_width: Option<u16>

The size of tab stops in the terminal.

theme: Option<Theme>

The color theme of the terminal.

window_options: Option<WindowOptions>

Enable various window manipulation and report features. All features are disabled by default for security reasons.

windows_mode: Option<bool>

Whether “Windows mode” is enabled. Because Windows backends winpty and conpty operate by doing line wrapping on their side, xterm.js does not have access to wrapped lines. When Windows mode is enabled the following changes will be in effect:

Reflow is disabled.
Lines are assumed to be wrapped if the last character of the line is not whitespace.

word_separator: Option<Str>

A string containing all characters that are considered word separated by the double click to select work logic.

Implementations

`impl TerminalOptions`[src]

#[must_use]pub const fn new( allow_proposed_api: Option<bool>, allow_transparency: Option<bool>, bell_sound: Option<Str>, bell_style: Option<BellStyle>, cols: Option<u16>, convert_eol: Option<bool>, cursor_blink: Option<bool>, cursor_style: Option<CursorStyle>, cursor_width: Option<f32>, disable_stdin: Option<bool>, draw_bold_text_in_bright_colors: Option<bool>, fast_scroll_modifier: Option<FastScrollModifier>, fast_scroll_sensitivity: Option<f32>, font_family: Option<Str>, font_size: Option<f32>, font_weight: Option<f32>, font_weight_bold: Option<FontWeight>, letter_spacing: Option<u16>, line_height: Option<u16>, link_tooltip_hover_duration: Option<u16>, log_level: Option<LogLevel>, mac_option_click_forces_selection: Option<bool>, mac_option_is_meta: Option<bool>, minimum_contrast_ratio: Option<f32>, renderer_type: Option<RendererType>, right_click_selects_word: Option<bool>, rows: Option<u16>, screen_reader_mode: Option<bool>, scroll_sensitivity: Option<f32>, scrollback: Option<u32>, tab_stop_width: Option<u16>, theme: Option<Theme>, window_options: Option<WindowOptions>, windows_mode: Option<bool>, word_separator: Option<Str> ) -> Self[src]

Constructor.

`impl TerminalOptions`

`#[must_use]pub fn bell_sound(&self) -> Option<Str>`[src]

A data uri of the sound to use for the bell when [TerminalOptions.bell_style] = 'sound'. Getter.

`pub fn set_bell_sound(&mut self, bell_sound: Option<Str>)`[src]

A data uri of the sound to use for the bell when [TerminalOptions.bell_style] = 'sound'. Setter.

`#[must_use]pub fn font_family(&self) -> Option<Str>`[src]

The font family used to render text. Getter.

`pub fn set_font_family(&mut self, font_family: Option<Str>)`[src]

The font family used to render text. Setter.

`#[must_use]pub fn theme(&self) -> Option<Theme>`[src]

The color theme of the terminal. Getter.

`pub fn set_theme(&mut self, theme: Option<Theme>)`[src]

The color theme of the terminal. Setter.

`#[must_use]pub fn window_options(&self) -> Option<WindowOptions>`[src]

Enable various window manipulation and report features. All features are disabled by default for security reasons. Getter.

`pub fn set_window_options(&mut self, window_options: Option<WindowOptions>)`[src]

Enable various window manipulation and report features. All features are disabled by default for security reasons. Setter.

`#[must_use]pub fn word_separator(&self) -> Option<Str>`[src]

A string containing all characters that are considered word separated by the double click to select work logic. Getter.

`pub fn set_word_separator(&mut self, word_separator: Option<Str>)`[src]

A string containing all characters that are considered word separated by the double click to select work logic. Setter.