[−][src]Struct vega_lite_3::AxisBuilder
Builder for Axis
.
Methods
impl AxisBuilder
[src]
pub fn band_position<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
An interpolation fraction indicating where, for band
scales, axis ticks should be
positioned. A value of 0
places ticks at the left edge of their bands. A value of 0.5
places ticks in the middle of their bands.
Default value: 0.5
pub fn domain<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
[src]
A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.
Default value: true
pub fn domain_color<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
Color of axis domain line.
Default value: "gray"
.
pub fn domain_dash<VALUE: Into<Vec<f64>>>(&mut self, value: VALUE) -> &mut Self
[src]
An array of alternating [stroke, space] lengths for dashed domain lines.
pub fn domain_dash_offset<VALUE: Into<f64>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
The pixel offset at which to start drawing with the domain dash array.
pub fn domain_opacity<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Opacity of the axis domain line.
pub fn domain_width<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Stroke width of axis domain line
Default value: 1
pub fn format<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
The text formatting pattern for labels of guides (axes, legends, headers) and text marks.
- If the format type is
"number"
(e.g., for quantitative fields), this is D3's number format pattern. - If the format type is
"time"
(e.g., for temporal fields), this is D3's time format pattern.
See the format documentation for more examples.
Default value: Derived from numberFormat config for number format and from timeFormat config for time format.
pub fn format_type<VALUE: Into<FormatType>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
The format type for labels ("number"
or "time"
).
Default value:
"time"
for temporal fields and ordinal and nomimal fields withtimeUnit
."number"
for quantitative fields as well as ordinal and nomimal fields withouttimeUnit
.
pub fn grid<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
[src]
A boolean flag indicating if grid lines should be included as part of the axis
Default value: true
for continuous
scales that are not binned;
otherwise, false
.
pub fn grid_color<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
Color of gridlines.
Default value: "lightGray"
.
pub fn grid_dash<VALUE: Into<Vec<f64>>>(&mut self, value: VALUE) -> &mut Self
[src]
An array of alternating [stroke, space] lengths for dashed grid lines.
pub fn grid_dash_offset<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The pixel offset at which to start drawing with the grid dash array.
pub fn grid_opacity<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The stroke opacity of grid (value between [0,1])
Default value: 1
pub fn grid_width<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The grid width, in pixels.
Default value: 1
pub fn label_align<VALUE: Into<Align>>(&mut self, value: VALUE) -> &mut Self
[src]
Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.
pub fn label_angle<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The rotation angle of the axis labels.
Default value: -90
for nominal and ordinal fields; 0
otherwise.
pub fn label_baseline<VALUE: Into<TextBaseline>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Vertical text baseline of axis tick labels, overriding the default setting for the
current axis orientation. Can be "top"
, "middle"
, "bottom"
, or "alphabetic"
.
pub fn label_bound<VALUE: Into<Label>>(&mut self, value: VALUE) -> &mut Self
[src]
Indicates if labels should be hidden if they exceed the axis range. If false
(the
default) no bounds overlap analysis is performed. If true
, labels will be hidden if
they exceed the axis range by more than 1 pixel. If this property is a number, it
specifies the pixel tolerance: the maximum amount by which a label bounding box may
exceed the axis range.
Default value: false
.
pub fn label_color<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
The color of the tick label, can be in hex color code or regular color name.
pub fn label_flush<VALUE: Into<Label>>(&mut self, value: VALUE) -> &mut Self
[src]
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.
Default value: true
for axis of a continuous x-scale. Otherwise, false
.
pub fn label_flush_offset<VALUE: Into<f64>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Indicates the number of pixels by which to offset flush-adjusted labels. For example, a
value of 2
will push flush-adjusted labels 2 pixels outward from the center of the
axis. Offsets can help the labels better visually group with corresponding axis ticks.
Default value: 0
.
pub fn label_font<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
The font of the tick label.
pub fn label_font_size<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The font size of the label, in pixels.
pub fn label_font_style<VALUE: Into<String>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Font style of the title.
pub fn label_font_weight<VALUE: Into<FontWeight>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Font weight of axis tick labels.
pub fn label_limit<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Maximum allowed pixel width of axis tick labels.
Default value: 180
pub fn label_opacity<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The opacity of the labels.
pub fn label_overlap<VALUE: Into<LabelOverlap>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
The strategy to use for resolving overlap of axis labels. If false
(the default), no
overlap reduction is attempted. If set to true
or "parity"
, a strategy of removing
every other label is used (this works well for standard linear axes). If set to
"greedy"
, a linear scan of the labels is performed, removing any labels that overlaps
with the last visible label (this often works better for log-scaled axes).
Default value: true
for non-nominal fields with non-log scales; "greedy"
for log
scales; otherwise false
.
pub fn label_padding<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The padding, in pixels, between axis and text labels.
Default value: 2
pub fn labels<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
[src]
A boolean flag indicating if labels should be included as part of the axis.
Default value: true
.
pub fn label_separation<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The minimum separation that must be between label bounding boxes for them to be
considered non-overlapping (default 0
). This property is ignored if labelOverlap
resolution is not enabled.
pub fn max_extent<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.
Default value: undefined
.
pub fn min_extent<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.
Default value: 30
for y-axis; undefined
for x-axis.
pub fn offset<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.
Default value: derived from the axis
config's offset
(0
by default)
pub fn orient<VALUE: Into<Orient>>(&mut self, value: VALUE) -> &mut Self
[src]
The orientation of the axis. One of "top"
, "bottom"
, "left"
or "right"
. The
orientation can be used to further specialize the axis type (e.g., a y-axis oriented
towards the right edge of the chart).
Default value: "bottom"
for x-axes and "left"
for y-axes.
pub fn position<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The anchor position of the axis in pixels. For x-axes with top or bottom orientation, this sets the axis group x coordinate. For y-axes with left or right orientation, this sets the axis group y coordinate.
Default value: 0
pub fn tick_color<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
The color of the axis's tick.
Default value: "gray"
pub fn tick_count<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are "nice" (multiples of 2, 5, 10) and lie within the underlying scale's range.
pub fn tick_dash<VALUE: Into<Vec<f64>>>(&mut self, value: VALUE) -> &mut Self
[src]
An array of alternating [stroke, space] lengths for dashed tick mark lines.
pub fn tick_dash_offset<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The pixel offset at which to start drawing with the tick mark dash array.
pub fn tick_extra<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
[src]
Boolean flag indicating if an extra axis tick should be added for the initial position of
the axis. This flag is useful for styling axes for band
scales such that ticks are
placed on band boundaries rather in the middle of a band. Use in conjunction with
"bandPosition": 1
and an axis "padding"
value of 0
.
pub fn tick_min_step<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The minimum desired step between axis ticks, in terms of scale domain values. For
example, a value of 1
indicates that ticks should not be less than 1 unit apart. If
tickMinStep
is specified, the tickCount
value will be adjusted, if necessary, to
enforce the minimum step value.
Default value: undefined
pub fn tick_offset<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Position offset in pixels to apply to ticks, labels, and gridlines.
pub fn tick_opacity<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Opacity of the ticks.
pub fn tick_round<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
[src]
Boolean flag indicating if pixel position values should be rounded to the nearest integer.
Default value: true
pub fn ticks<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self
[src]
Boolean value that determines whether the axis should include ticks.
Default value: true
pub fn tick_size<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The size in pixels of axis ticks.
Default value: 5
pub fn tick_width<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The width, in pixels, of ticks.
Default value: 1
pub fn title<VALUE: Into<RemovableValue<String>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
A title for the field. If null
, the title will be removed.
Default value: derived from the field's name and transformation function
(aggregate
, bin
and timeUnit
). If the field has an aggregate function, the
function is displayed as part of the title (e.g., "Sum of Profit"
). If the field is
binned or has a time unit applied, the applied function is shown in parentheses (e.g.,
"Profit (binned)"
, "Transaction Date (year-month)"
). Otherwise, the title is simply
the field name.
Notes:
-
You can customize the default field title format by providing the
fieldTitle
property in the config orfieldTitle
function via thecompile
function's options. -
If both field definition's
title
and axis, header, or legendtitle
are defined, axis/header/legend title will be used.
pub fn title_align<VALUE: Into<Align>>(&mut self, value: VALUE) -> &mut Self
[src]
Horizontal text alignment of axis titles.
pub fn title_anchor<VALUE: Into<TitleAnchor>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Text anchor position for placing axis titles.
pub fn title_angle<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Angle in degrees of axis titles.
pub fn title_baseline<VALUE: Into<TextBaseline>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Vertical text baseline for axis titles.
pub fn title_color<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
Color of the title, can be in hex color code or regular color name.
pub fn title_font<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self
[src]
Font of the title. (e.g., "Helvetica Neue"
).
pub fn title_font_size<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Font size of the title.
pub fn title_font_style<VALUE: Into<String>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Font style of the title.
pub fn title_font_weight<VALUE: Into<FontWeight>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Font weight of the title.
This can be either a string (e.g "bold"
, "normal"
) or a number (100
, 200
, 300
,
..., 900
where "normal"
= 400
and "bold"
= 700
).
pub fn title_limit<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Maximum allowed pixel width of axis titles.
pub fn title_opacity<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Opacity of the axis title.
pub fn title_padding<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
The padding, in pixels, between title and axis.
pub fn title_x<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
X-coordinate of the axis title relative to the axis group.
pub fn title_y<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
Y-coordinate of the axis title relative to the axis group.
pub fn values<VALUE: Into<Vec<SelectionInitIntervalElement>>>(
&mut self,
value: VALUE
) -> &mut Self
[src]
&mut self,
value: VALUE
) -> &mut Self
Explicitly set the visible axis tick values.
pub fn zindex<VALUE: Into<f64>>(&mut self, value: VALUE) -> &mut Self
[src]
A non-negative integer indicating the z-index of the axis.
If zindex is 0, axes should be drawn behind all chart elements.
To put them in front, use "zindex = 1"
.
Default value: 1
(in front of the marks) for actual axis and 0
(behind the marks)
for grids.
pub fn build(&self) -> Result<Axis, String>
[src]
Trait Implementations
impl Clone for AxisBuilder
[src]
fn clone(&self) -> AxisBuilder
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Default for AxisBuilder
[src]
fn default() -> AxisBuilder
[src]
Auto Trait Implementations
impl RefUnwindSafe for AxisBuilder
impl Send for AxisBuilder
impl Sync for AxisBuilder
impl Unpin for AxisBuilder
impl UnwindSafe for AxisBuilder
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,