package matrix

  1. Overview
  2. Docs

Module Matrix_charts.GridlinesSource

Background gridline configuration.

Sourcetype t = {
  1. show : bool;
    (*

    Master visibility toggle.

    *)
  2. x : bool;
    (*

    Vertical gridlines (at x-axis ticks).

    *)
  3. y : bool;
    (*

    Horizontal gridlines (at y-axis ticks).

    *)
  4. style : Ansi.Style.t;
    (*

    Major gridline style.

    *)
  5. pattern : Charset.line_pattern;
    (*

    Gridline pattern.

    *)
  6. x_step : int option;
    (*

    Show every nth vertical gridline. None shows all.

    *)
  7. y_step : int option;
    (*

    Show every nth horizontal gridline. None shows all.

    *)
  8. minor : int option;
    (*

    Minor subdivisions between major gridlines. None disables minor gridlines.

    *)
  9. minor_style : Ansi.Style.t option;
    (*

    Minor gridline style. None inherits from theme.

    *)
}
Sourceval hidden : t

Hidden gridlines: show = false.

Sourceval default : t

Default: visible, dotted, both axes, dimmed style.

Sourceval with_style : Ansi.Style.t -> t -> t

with_style s g is g with major gridline style s.

Sourceval with_pattern : Charset.line_pattern -> t -> t

with_pattern p g is g with gridline pattern p.

Sourceval with_x : bool -> t -> t

with_x b g enables or disables vertical gridlines.

Sourceval with_y : bool -> t -> t

with_y b g enables or disables horizontal gridlines.

Sourceval with_x_step : int option -> t -> t

with_x_step n g is g showing every nth vertical gridline. None uses automatic spacing.

Sourceval with_y_step : int option -> t -> t

with_y_step n g is g showing every nth horizontal gridline. None uses automatic spacing.

Sourceval with_minor : int option -> t -> t

with_minor n g is g with n minor gridlines between major lines. None disables.

Sourceval with_minor_style : Ansi.Style.t option -> t -> t

with_minor_style s g is g with minor gridline style s. None inherits from major style.