Skip to content
API Reference
mark_type
MarkType

MarkType

Mojo trait 🡭

MarkType

See the module docstring.

Aliases

  • id =
  • supports_tooltips =
  • supports_data_labels =
  • supports_horizontal =
  • supports_annotations_y =
  • supports_annotations_x =
  • supports_annotations_xy =
  • supports_log_x =
  • supports_log_y =
  • supports_color_size =
  • straight_edged = : Draws only axis-aligned straight edges, so the automatic raster supersample is 1 rather than the curved factor (_auto_supersample, rendering.mojo).
  • continuous_path = : Drawn by _render_generic’s continuous path, which is what carries domain and tick overrides, axis reversal, equal aspect, a shared x- or y-scale, a log axis inside render_layers(), and filled annotations drawn under the mark.
  • layerable = : Can share render_layers()’ continuous frame: places its data on a continuous x/y axis in the caller’s own units (_is_layerable_mark, layers.mojo, gives the reasons for the rest).
  • color_is_value = : Its colors always encode a continuous data value, so scale_color_domain()/scale_color_center() apply. The supports_color_size marks qualify only when given numeric color= (_mark_colors_by_value, validate.mojo).
  • categorical_bars = : A categorical bar mark: the base of a render_layers() bar-combo chart, whose bars share one categorical frame.
  • bar_combo_overlay = : Can be layered over categorical bars in a bar-combo chart, moving onto the bars’ band centers.
  • continuous_error_bars = : Takes encode()’s y_err/x_err columns.

Implemented traits

AnyType, Copyable, Deinitable, Movable

Methods

render 

fn def render[T: DrawTarget](self, mut target: T, style: _MarkStyle, annotations: _AnnotationData, settings: _ChartSettings, ox0: Int, oy0: Int, ox1: Int, oy1: Int, has_shared_y_domain: Bool, shared_y_min: Float64, shared_y_max: Float64, shared_y_is_log: Bool, *, mut cache: FontCache, vector_target: Bool) -> _RenderResult

Parameters:

  • T (DrawTarget)

Args:

  • self (_Self)
  • target (T)
  • style (_MarkStyle)
  • annotations (_AnnotationData)
  • settings (_ChartSettings)
  • ox0 (Int)
  • oy0 (Int)
  • ox1 (Int)
  • oy1 (Int)
  • has_shared_y_domain (Bool)
  • shared_y_min (Float64)
  • shared_y_max (Float64)
  • shared_y_is_log (Bool)
  • cache (FontCache)
  • vector_target (Bool)

Returns:

_RenderResult

Raises:

encode_dendrogram 

fn def encode_dendrogram(mut self, mut settings: _ChartSettings, tree: Dendrogram, labels: List[String], horizontal: Bool = False)

Refused at compile time: this mark has no encode_dendrogram().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • tree (Dendrogram)
  • labels (List[String])
  • horizontal (Bool)

encode 

fn def encode(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], color: List[Float64] = List(), color_categories: List[String] = List(), size: List[Float64] = List(), y_err: List[Float64] = List(), y_err_lower: List[Float64] = List(), y_err_upper: List[Float64] = List(), color_map: Dict[String, Color] = Dict(), shape_map: Dict[String, PointShape] = Dict(), labels: List[String] = List(), x_err: List[Float64] = List(), x_err_lower: List[Float64] = List(), x_err_upper: List[Float64] = List())

Refused at compile time: this mark has no encode().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • color (List[Float64])
  • color_categories (List[String])
  • size (List[Float64])
  • y_err (List[Float64])
  • y_err_lower (List[Float64])
  • y_err_upper (List[Float64])
  • color_map (Dict[String, Color])
  • shape_map (Dict[String, PointShape])
  • labels (List[String])
  • x_err (List[Float64])
  • x_err_lower (List[Float64])
  • x_err_upper (List[Float64])

Raises:

encode_vectors3d 

fn def encode_vectors3d(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], z: List[Float64], u: List[Float64], v: List[Float64], w: List[Float64])

Refused at compile time: this mark has no encode_vectors3d().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • z (List[Float64])
  • u (List[Float64])
  • v (List[Float64])
  • w (List[Float64])

Raises:

encode_ribbon3d 

fn def encode_ribbon3d(mut self, mut settings: _ChartSettings, x1: List[Float64], y1: List[Float64], z1: List[Float64], x2: List[Float64], y2: List[Float64], z2: List[Float64])

Refused at compile time: this mark has no encode_ribbon3d().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x1 (List[Float64])
  • y1 (List[Float64])
  • z1 (List[Float64])
  • x2 (List[Float64])
  • y2 (List[Float64])
  • z2 (List[Float64])

Raises:

encode_bars3d 

fn def encode_bars3d(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], z: List[Float64])

Refused at compile time: this mark has no encode_bars3d().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • z (List[Float64])

Raises:

encode_voxels 

fn def encode_voxels(mut self, mut settings: _ChartSettings, filled: List[List[List[Bool]]])

Refused at compile time: this mark has no encode_voxels().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • filled (List[List[List[Bool]]])

Raises:

encode_surface 

fn def encode_surface(mut self, mut settings: _ChartSettings, z: List[List[Float64]], x: List[Float64] = List(), y: List[Float64] = List())

Refused at compile time: this mark has no encode_surface().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • z (List[List[Float64]])
  • x (List[Float64])
  • y (List[Float64])

Raises:

encode_xyz 

fn def encode_xyz(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], z: List[Float64])

Refused at compile time: this mark has no encode_xyz().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • z (List[Float64])

Raises:

accepts_fill_maps 

fn def accepts_fill_maps(self)

Refused at compile time: this mark does not fill one shape per category or series, so fill_colors()/fill_patterns() have nothing to pin.

Args:

  • self (_Self)

sort_categories 

fn def sort_categories(mut self, order: CategoryOrder)

Refused at compile time: this mark has no categories.

Args:

  • self (_Self)
  • order (CategoryOrder)

Raises:

sort_categories_named 

fn def sort_categories_named(mut self, names: List[String])

Refused at compile time: this mark has no categories.

Args:

  • self (_Self)
  • names (List[String])

Raises:

encode_categorical 

fn def encode_categorical(mut self, mut settings: _ChartSettings, x: List[String], y: List[Float64], y_err: List[Float64] = List(), y_err_lower: List[Float64] = List(), y_err_upper: List[Float64] = List())

Refused at compile time: this mark has no encode_categorical().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[String])
  • y (List[Float64])
  • y_err (List[Float64])
  • y_err_lower (List[Float64])
  • y_err_upper (List[Float64])

Raises:

encode_time_bars 

fn def encode_time_bars(mut self, mut settings: _ChartSettings, dates: List[Morrow], values: List[Float64], y_err: List[Float64] = List(), y_err_lower: List[Float64] = List(), y_err_upper: List[Float64] = List())

Refused at compile time: this mark has no encode_time_bars().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • dates (List[Morrow])
  • values (List[Float64])
  • y_err (List[Float64])
  • y_err_lower (List[Float64])
  • y_err_upper (List[Float64])

Raises:

encode_binned_categories 

fn def encode_binned_categories(mut self, mut settings: _ChartSettings, data: List[Float64], bins: Int = Int(10))

Refused at compile time: this mark has no encode_binned_categories().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • data (List[Float64])
  • bins (Int)

Raises:

fn def encode_binned_categories(mut self, mut settings: _ChartSettings, data: List[Float64], rule: BinRule)

Refused at compile time: this mark has no encode_binned_categories().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • data (List[Float64])
  • rule (BinRule)

Raises:

encode_waterfall 

fn def encode_waterfall(mut self, mut settings: _ChartSettings, categories: List[String], deltas: List[Float64], is_total: List[Bool] = List())

Refused at compile time: this mark has no encode_waterfall().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • deltas (List[Float64])
  • is_total (List[Bool])

Raises:

encode_boxenplot 

fn def encode_boxenplot(mut self, mut settings: _ChartSettings, categories: List[String], values: List[List[Float64]])

Refused at compile time: this mark has no encode_boxenplot().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • values (List[List[Float64]])

Raises:

encode_boxplot 

fn def encode_boxplot(mut self, mut settings: _ChartSettings, categories: List[String], values: List[List[Float64]])

Refused at compile time: this mark has no encode_boxplot().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • values (List[List[Float64]])

Raises:

encode_candlestick 

fn def encode_candlestick(mut self, mut settings: _ChartSettings, categories: List[String], open: List[Float64], high: List[Float64], low: List[Float64], close: List[Float64])

Refused at compile time: this mark has no encode_candlestick().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • open (List[Float64])
  • high (List[Float64])
  • low (List[Float64])
  • close (List[Float64])

Raises:

encode_candlestick_time 

fn def encode_candlestick_time(mut self, mut settings: _ChartSettings, dates: List[Morrow], open: List[Float64], high: List[Float64], low: List[Float64], close: List[Float64])

Refused at compile time: this mark has no encode_candlestick_time().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • dates (List[Morrow])
  • open (List[Float64])
  • high (List[Float64])
  • low (List[Float64])
  • close (List[Float64])

Raises:

encode_bullet 

fn def encode_bullet(mut self, mut settings: _ChartSettings, categories: List[String], measures: List[Float64], targets: List[Float64], ranges: List[List[Float64]])

Refused at compile time: this mark has no encode_bullet().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • measures (List[Float64])
  • targets (List[Float64])
  • ranges (List[List[Float64]])

Raises:

encode_gantt 

fn def encode_gantt(mut self, mut settings: _ChartSettings, categories: List[String], start: List[Float64], end: List[Float64])

Refused at compile time: this mark has no encode_gantt().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • start (List[Float64])
  • end (List[Float64])

Raises:

encode_gantt_time 

fn def encode_gantt_time(mut self, mut settings: _ChartSettings, categories: List[String], start: List[Morrow], end: List[Morrow])

Refused at compile time: this mark has no encode_gantt_time().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • start (List[Morrow])
  • end (List[Morrow])

Raises:

encode_grouped_bar 

fn def encode_grouped_bar(mut self, mut settings: _ChartSettings, categories: List[String], series_names: List[String], values: List[List[Float64]], errors: List[List[Float64]] = List())

Refused at compile time: this mark has no encode_grouped_bar().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • series_names (List[String])
  • values (List[List[Float64]])
  • errors (List[List[Float64]])

Raises:

encode_population_pyramid 

fn def encode_population_pyramid(mut self, mut settings: _ChartSettings, categories: List[String], left_values: List[Float64], right_values: List[Float64], left_name: String = "", right_name: String = "")

Refused at compile time: this mark has no encode_population_pyramid().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • left_values (List[Float64])
  • right_values (List[Float64])
  • left_name (String)
  • right_name (String)

Raises:

encode_heatmap 

fn def encode_heatmap(mut self, mut settings: _ChartSettings, x: List[String], y: List[String], value: List[Float64])

Refused at compile time: this mark has no encode_heatmap().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[String])
  • y (List[String])
  • value (List[Float64])

Raises:

encode_calendar 

fn def encode_calendar(mut self, mut settings: _ChartSettings, dates: List[String], values: List[Float64])

Refused at compile time: this mark has no encode_calendar().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • dates (List[String])
  • values (List[Float64])

Raises:

encode_corrplot 

fn def encode_corrplot(mut self, mut settings: _ChartSettings, variables: List[String], matrix: List[List[Float64]])

Refused at compile time: this mark has no encode_corrplot().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • variables (List[String])
  • matrix (List[List[Float64]])

Raises:

encode_punchcard 

fn def encode_punchcard(mut self, mut settings: _ChartSettings, x: List[String], y: List[String], sizes: List[Float64])

Refused at compile time: this mark has no encode_punchcard().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[String])
  • y (List[String])
  • sizes (List[Float64])

Raises:

encode_barbs 

fn def encode_barbs(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], u: List[Float64], v: List[Float64])

Refused at compile time: this mark has no encode_barbs().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • u (List[Float64])
  • v (List[Float64])

Raises:

encode_contour 

fn def encode_contour(mut self, mut settings: _ChartSettings, z: List[List[Float64]], levels: List[Float64] = List(), x: List[Float64] = List(), y: List[Float64] = List())

Refused at compile time: this mark has no encode_contour().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • z (List[List[Float64]])
  • levels (List[Float64])
  • x (List[Float64])
  • y (List[Float64])

Raises:

encode_pcolormesh 

fn def encode_pcolormesh(mut self, mut settings: _ChartSettings, x_edges: List[Float64], y_edges: List[Float64], z: List[List[Float64]])

Refused at compile time: this mark has no encode_pcolormesh().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x_edges (List[Float64])
  • y_edges (List[Float64])
  • z (List[List[Float64]])

Raises:

fn def encode_pcolormesh(mut self, mut settings: _ChartSettings, x_corners: List[List[Float64]], y_corners: List[List[Float64]], z: List[List[Float64]])

Refused at compile time: this mark has no encode_pcolormesh().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x_corners (List[List[Float64]])
  • y_corners (List[List[Float64]])
  • z (List[List[Float64]])

Raises:

encode_time 

fn def encode_time(mut self, mut settings: _ChartSettings, x: List[Morrow], y: List[Float64])

Refused at compile time: this mark has no encode_time().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Morrow])
  • y (List[Float64])

Raises:

encode_histogram_bins 

fn def encode_histogram_bins(mut self, mut settings: _ChartSettings, bins: HistogramBins)

Refused at compile time: this mark has no encode_histogram_bins().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • bins (HistogramBins)

Raises:

encode_hist2d 

fn def encode_hist2d(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], x_edges: List[Float64], y_edges: List[Float64])

Refused at compile time: this mark has no encode_hist2d().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • x_edges (List[Float64])
  • y_edges (List[Float64])

Raises:

encode_streamplot 

fn def encode_streamplot(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], u: List[List[Float64]], v: List[List[Float64]])

Refused at compile time: this mark has no encode_streamplot().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • u (List[List[Float64]])
  • v (List[List[Float64]])

Raises:

encode_hexbin 

fn def encode_hexbin(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], gridsize: Int = Int(30))

Refused at compile time: this mark has no encode_hexbin().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • gridsize (Int)

Raises:

encode_tricontour 

fn def encode_tricontour(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], z: List[Float64], levels: List[Float64] = List())

Refused at compile time: this mark has no encode_tricontour().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • z (List[Float64])
  • levels (List[Float64])

Raises:

encode_triplot 

fn def encode_triplot(mut self, mut settings: _ChartSettings, x: List[Float64], y: List[Float64], z: List[Float64] = List(), triangulation: Triangulation = Triangulation(), facecolors: List[Float64] = List(), gouraud: Bool = False)

Refused at compile time: this mark has no encode_triplot().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • y (List[Float64])
  • z (List[Float64])
  • triangulation (Triangulation)
  • facecolors (List[Float64])
  • gouraud (Bool)

Raises:

encode_marimekko 

fn def encode_marimekko(mut self, mut settings: _ChartSettings, categories: List[String], subcategories: List[String], values: List[List[Float64]])

Refused at compile time: this mark has no encode_marimekko().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • subcategories (List[String])
  • values (List[List[Float64]])

Raises:

encode_hierarchy 

fn def encode_hierarchy(mut self, mut settings: _ChartSettings, ids: List[String], parent_ids: List[String], values: List[Float64])

Refused at compile time: this mark has no encode_hierarchy().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • ids (List[String])
  • parent_ids (List[String])
  • values (List[Float64])

Raises:

encode_chord 

fn def encode_chord(mut self, mut settings: _ChartSettings, from_categories: List[String], to_categories: List[String], values: List[Float64])

Refused at compile time: this mark has no encode_chord().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • from_categories (List[String])
  • to_categories (List[String])
  • values (List[Float64])

Raises:

encode_polar 

fn def encode_polar(mut self, mut settings: _ChartSettings, angle: List[Float64], radius: List[Float64])

Refused at compile time: this mark has no encode_polar().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • angle (List[Float64])
  • radius (List[Float64])

Raises:

encode_polar_series 

fn def encode_polar_series(mut self, mut settings: _ChartSettings, angle: List[Float64], series_names: List[String], series_values: List[List[Float64]])

Refused at compile time: this mark has no encode_polar_series().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • angle (List[Float64])
  • series_names (List[String])
  • series_values (List[List[Float64]])

Raises:

encode_radar 

fn def encode_radar(mut self, mut settings: _ChartSettings, indicators: List[String], max_values: List[Float64], series_names: List[String], series_values: List[List[Float64]])

Refused at compile time: this mark has no encode_radar().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • indicators (List[String])
  • max_values (List[Float64])
  • series_names (List[String])
  • series_values (List[List[Float64]])

Raises:

encode_gauge 

fn def encode_gauge(mut self, mut settings: _ChartSettings, value: Float64, min_value: Float64 = 0, max_value: Float64 = 100, breakpoints: List[Float64] = List(), band_colors: List[Color] = List())

Refused at compile time: this mark has no encode_gauge().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • value (Float64)
  • min_value (Float64)
  • max_value (Float64)
  • breakpoints (List[Float64])
  • band_colors (List[Color])

Raises:

encode_parallel 

fn def encode_parallel(mut self, mut settings: _ChartSettings, dims: List[String], row_names: List[String], data: List[List[Float64]])

Refused at compile time: this mark has no encode_parallel().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • dims (List[String])
  • row_names (List[String])
  • data (List[List[Float64]])

Raises:

encode_kde 

fn def encode_kde(mut self, mut settings: _ChartSettings, values: List[Float64])

Refused at compile time: this mark has no encode_kde().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • values (List[Float64])

Raises:

encode_eventplot 

fn def encode_eventplot(mut self, mut settings: _ChartSettings, labels: List[String], positions: List[List[Float64]])

Refused at compile time: this mark has no encode_eventplot().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • labels (List[String])
  • positions (List[List[Float64]])

Raises:

encode_distribution 

fn def encode_distribution(mut self, mut settings: _ChartSettings, categories: List[String], values: List[List[Float64]])

Refused at compile time: this mark has no encode_distribution().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • categories (List[String])
  • values (List[List[Float64]])

Raises:

encode_single_axis 

fn def encode_single_axis(mut self, mut settings: _ChartSettings, x: List[Float64], color: List[Float64] = List(), color_categories: List[String] = List(), size: List[Float64] = List())

Refused at compile time: this mark has no encode_single_axis().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • x (List[Float64])
  • color (List[Float64])
  • color_categories (List[String])
  • size (List[Float64])

Raises:

encode_imshow 

fn def encode_imshow(mut self, mut settings: _ChartSettings, z: List[List[Float64]])

Refused at compile time: this mark has no encode_imshow().

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • z (List[List[Float64]])

Raises:

encode_frame 

fn def encode_frame(mut self, mut settings: _ChartSettings, df: DataFrame, x: String, y: String, color: String, size: String, labels: String)

Refused at compile time: this mark reads no DataFrame by column name.

Args:

  • self (_Self)
  • settings (_ChartSettings)
  • df (DataFrame)
  • x (String)
  • y (String)
  • color (String)
  • size (String)
  • labels (String)

Raises: