1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
//! Polar scatter plot
use crate::common::color::{Color, ColorWrapper};
use crate::common::{
Dim, Fill, Font, GroupNorm, HoverInfo, Label, Line, Marker, Mode, Orientation, PlotType,
Position, Visible,
};
use crate::private;
use crate::Trace;
use serde::Serialize;
#[cfg(feature = "plotly_ndarray")]
use crate::ndarray::ArrayTraces;
use crate::private::{
copy_iterable_to_vec, to_num_or_string_wrapper, NumOrString, NumOrStringWrapper, TruthyEnum,
};
#[cfg(feature = "plotly_ndarray")]
use ndarray::{Array, Ix1, Ix2};
#[derive(Serialize, Clone, Debug)]
pub struct ScatterPolar<Theta, R>
where
Theta: Serialize + Clone + 'static,
R: Serialize + Clone + 'static,
{
r#type: PlotType,
#[serde(skip_serializing_if = "Option::is_none")]
name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
visible: Option<TruthyEnum<Visible>>,
#[serde(skip_serializing_if = "Option::is_none", rename = "showlegend")]
show_legend: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none", rename = "legendgroup")]
legend_group: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
opacity: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
mode: Option<Mode>,
#[serde(skip_serializing_if = "Option::is_none")]
ids: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
theta: Option<Vec<Theta>>,
#[serde(skip_serializing_if = "Option::is_none")]
theta0: Option<NumOrStringWrapper>,
#[serde(skip_serializing_if = "Option::is_none")]
dtheta: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
r: Option<Vec<R>>,
#[serde(skip_serializing_if = "Option::is_none")]
r0: Option<NumOrStringWrapper>,
#[serde(skip_serializing_if = "Option::is_none")]
dr: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
subplot: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
text: Option<Dim<String>>,
#[serde(skip_serializing_if = "Option::is_none", rename = "textposition")]
text_position: Option<Dim<Position>>,
#[serde(skip_serializing_if = "Option::is_none", rename = "texttemplate")]
text_template: Option<Dim<String>>,
#[serde(skip_serializing_if = "Option::is_none", rename = "hovertext")]
hover_text: Option<Dim<String>>,
#[serde(skip_serializing_if = "Option::is_none", rename = "hoverinfo")]
hover_info: Option<HoverInfo>,
#[serde(skip_serializing_if = "Option::is_none", rename = "hovertemplate")]
hover_template: Option<Dim<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
meta: Option<NumOrStringWrapper>,
#[serde(skip_serializing_if = "Option::is_none")]
custom_data: Option<Vec<NumOrStringWrapper>>,
#[serde(skip_serializing_if = "Option::is_none")]
orientation: Option<Orientation>,
#[serde(skip_serializing_if = "Option::is_none", rename = "groupnorm")]
group_norm: Option<GroupNorm>,
#[serde(skip_serializing_if = "Option::is_none", rename = "selectedpoints")]
selected_points: Option<Vec<u32>>,
#[serde(skip_serializing_if = "Option::is_none", rename = "stackgroup")]
stack_group: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
marker: Option<Marker>,
#[serde(skip_serializing_if = "Option::is_none")]
line: Option<Line>,
#[serde(skip_serializing_if = "Option::is_none", rename = "textfont")]
text_font: Option<Font>,
#[serde(skip_serializing_if = "Option::is_none", rename = "cliponaxis")]
clip_on_axis: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none", rename = "connectgaps")]
connect_gaps: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
fill: Option<Fill>,
#[serde(skip_serializing_if = "Option::is_none", rename = "fillcolor")]
fill_color: Option<ColorWrapper>,
#[serde(skip_serializing_if = "Option::is_none", rename = "hoverlabel")]
hover_label: Option<Label>,
#[serde(skip_serializing_if = "Option::is_none", rename = "hoveron")]
hover_on: Option<String>,
#[serde(skip_serializing_if = "Option::is_none", rename = "stackgaps")]
stack_gaps: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
uid: Option<String>,
}
impl<Theta, R> Default for ScatterPolar<Theta, R>
where
Theta: Serialize + Clone + 'static,
R: Serialize + Clone + 'static,
{
fn default() -> Self {
Self {
r#type: PlotType::ScatterPolar,
name: None,
visible: None,
show_legend: None,
legend_group: None,
opacity: None,
mode: None,
ids: None,
theta: None,
theta0: None,
dtheta: None,
r: None,
r0: None,
dr: None,
subplot: None,
text: None,
text_position: None,
text_template: None,
hover_text: None,
hover_info: None,
hover_template: None,
meta: None,
custom_data: None,
orientation: None,
group_norm: None,
selected_points: None,
stack_group: None,
marker: None,
line: None,
text_font: None,
clip_on_axis: None,
connect_gaps: None,
fill: None,
fill_color: None,
hover_label: None,
hover_on: None,
stack_gaps: None,
uid: None,
}
}
}
impl<Theta, R> ScatterPolar<Theta, R>
where
Theta: Serialize + Clone + 'static,
R: Serialize + Clone + 'static,
{
pub fn new<I, K>(theta: I, r: K) -> Box<Self>
where
I: IntoIterator<Item = Theta>,
K: IntoIterator<Item = R>,
{
let theta = copy_iterable_to_vec(theta);
let r = copy_iterable_to_vec(r);
Box::new(Self {
theta: Some(theta),
r: Some(r),
r#type: PlotType::ScatterPolar,
..Default::default()
})
}
#[cfg(feature = "plotly_ndarray")]
pub fn from_array(theta: Array<Theta, Ix1>, r: Array<R, Ix1>) -> Box<Self> {
Box::new(Self {
theta: Some(theta.to_vec()),
r: Some(r.to_vec()),
r#type: PlotType::ScatterPolar,
..Default::default()
})
}
/// Produces `ScatterPolar` traces from a 2 dimensional tensor (`traces_matrix`) indexed by `x`. This
/// function requires the `ndarray` feature.
///
/// # Arguments
/// * `x` - One dimensional array (or view) that represents the `x` axis coordinates.
/// * `traces_matrix` - Two dimensional array (or view) containing the `y` axis coordinates of
/// the traces.
/// * `array_traces` - Determines whether the traces are arranged in the matrix over the
/// columns (`ArrayTraces::OverColumns`) or over the rows (`ArrayTraces::OverRows`).
///
/// # Examples
///
/// ```
/// use plotly::common::Mode;
/// use plotly::{Plot, ScatterPolar, ArrayTraces};
/// use ndarray::{Array, Ix1, Ix2};
///
/// fn ndarray_to_traces() {
/// let n: usize = 11;
/// let theta: Array<f64, Ix1> = Array::range(0., 360., 360. / n as f64);
/// let mut rs: Array<f64, Ix2> = Array::zeros((11, 11));
/// let mut count = 0.;
/// for mut row in rs.gencolumns_mut() {
/// for index in 0..row.len() {
/// row[index] = count + (index as f64).powf(2.);
/// }
/// count += 1.;
/// }
///
/// let traces = ScatterPolar::default()
/// .mode(Mode::LinesMarkers)
/// .to_traces(theta, rs, ArrayTraces::OverColumns);
///
/// let mut plot = Plot::new();
/// plot.add_traces(traces);
/// plot.show();
/// }
/// fn main() -> std::io::Result<()> {
/// ndarray_to_traces();
/// Ok(())
/// }
/// ```
#[cfg(feature = "plotly_ndarray")]
pub fn to_traces(
&self,
theta: Array<Theta, Ix1>,
traces_matrix: Array<R, Ix2>,
array_traces: ArrayTraces,
) -> Vec<Box<dyn Trace>> {
let mut traces: Vec<Box<dyn Trace>> = Vec::new();
let mut trace_vectors = private::trace_vectors_from(traces_matrix, array_traces);
trace_vectors.reverse();
while !trace_vectors.is_empty() {
let mut sc = Box::new(self.clone());
sc.theta = Some(theta.to_vec());
let data = trace_vectors.pop();
if let Some(d) = data {
sc.r = Some(d);
traces.push(sc);
}
}
traces
}
/// Enables WebGL.
pub fn web_gl_mode(mut self, on: bool) -> Box<Self> {
self.r#type = if on {
PlotType::ScatterPolarGL
} else {
PlotType::ScatterPolar
};
Box::new(self)
}
/// Sets the trace name. The trace name appear as the legend item and on hover.
pub fn name(mut self, name: &str) -> Box<Self> {
self.name = Some(name.to_owned());
Box::new(self)
}
/// Determines whether or not this trace is visible. If `Visible::LegendOnly`, the trace is not
/// drawn, but can appear as a legend item (provided that the legend itself is visible).
pub fn visible(mut self, visible: Visible) -> Box<Self> {
self.visible = Some(TruthyEnum { e: visible });
Box::new(self)
}
/// Determines whether or not an item corresponding to this trace is shown in the legend.
pub fn show_legend(mut self, show_legend: bool) -> Box<Self> {
self.show_legend = Some(show_legend);
Box::new(self)
}
/// Sets the legend group for this trace. Traces part of the same legend group hide/show at the
/// same time when toggling legend items.
pub fn legend_group(mut self, legend_group: &str) -> Box<Self> {
self.legend_group = Some(legend_group.to_owned());
Box::new(self)
}
/// Sets the opacity of the trace.
pub fn opacity(mut self, opacity: f64) -> Box<Self> {
self.opacity = Some(opacity);
Box::new(self)
}
/// Determines the drawing mode for this scatter trace. If the provided `Mode` includes
/// "Text" then the `text` elements appear at the coordinates. Otherwise, the `text` elements
/// appear on hover. If there are less than 20 points and the trace is not stacked then the
/// default is `Mode::LinesMarkers`, otherwise it is `Mode::Lines`.
pub fn mode(mut self, mode: Mode) -> Box<Self> {
self.mode = Some(mode);
Box::new(self)
}
/// Assigns id labels to each datum. These ids for object constancy of data points during
/// animation. Should be an array of strings, not numbers or any other type.
pub fn ids<S: AsRef<str>>(mut self, ids: Vec<S>) -> Box<Self> {
let ids = private::owned_string_vector(ids);
self.ids = Some(ids);
Box::new(self)
}
/// Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the
/// starting coordinate and `dx` the step.
pub fn theta0<C: NumOrString>(mut self, theta0: C) -> Box<Self> {
self.theta0 = Some(theta0.to_num_or_string());
Box::new(self)
}
/// Sets the x coordinate step. See `x0` for more info.
pub fn dtheta(mut self, dtheta: f64) -> Box<Self> {
self.dtheta = Some(dtheta);
Box::new(self)
}
/// Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the
/// starting coordinate and `dy` the step.
pub fn r0<C: NumOrString>(mut self, r0: C) -> Box<Self> {
self.r0 = Some(r0.to_num_or_string());
Box::new(self)
}
/// Sets the y coordinate step. See `y0` for more info.
pub fn dr(mut self, dr: f64) -> Box<Self> {
self.dr = Some(dr);
Box::new(self)
}
/// Sets a reference between this trace's data coordinates and a polar subplot. If "polar"
/// (the default value), the data refer to `layout.polar`. If "polar2", the data refer to
/// `layout.polar2`, and so on.
pub fn subplot(mut self, subplot: &str) -> Box<Self> {
self.subplot = Some(subplot.to_owned());
Box::new(self)
}
/// Sets text elements associated with each (x,y) pair. If a single string, the same string
/// appears over all the data points. If an array of string, the items are mapped in order to
/// the this trace's (x,y) coordinates. If the trace `HoverInfo` contains a "text" flag and
/// `hover_text` is not set, these elements will be seen in the hover labels.
pub fn text(mut self, text: &str) -> Box<Self> {
self.text = Some(Dim::Scalar(text.to_owned()));
Box::new(self)
}
/// Sets text elements associated with each (x,y) pair. If a single string, the same string
/// appears over all the data points. If an array of string, the items are mapped in order to
/// the this trace's (x,y) coordinates. If trace `HoverInfo` contains a "text" flag and
/// `hover_text` is not set, these elements will be seen in the hover labels.
pub fn text_array<S: AsRef<str>>(mut self, text: Vec<S>) -> Box<Self> {
let text = private::owned_string_vector(text);
self.text = Some(Dim::Vector(text));
Box::new(self)
}
/// Sets the positions of the `text` elements with respects to the (x,y) coordinates.
pub fn text_position(mut self, text_position: Position) -> Box<Self> {
self.text_position = Some(Dim::Scalar(text_position));
Box::new(self)
}
/// Sets the positions of the `text` elements with respects to the (x,y) coordinates.
pub fn text_position_array(mut self, text_position: Vec<Position>) -> Box<Self> {
self.text_position = Some(Dim::Vector(text_position));
Box::new(self)
}
/// Template string used for rendering the information text that appear on points. Note that
/// this will override `textinfo`. Variables are inserted using %{variable}, for example
/// "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example
/// "Price: %{y:$.2f}". See [format](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3)
/// for details on the formatting syntax. Dates are formatted using d3-time-format's syntax
/// %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}".
/// See [format](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format) for details
/// on the date formatting syntax. Every attributes that can be specified per-point (the ones
/// that are `arrayOk: true`) are available.
pub fn text_template(mut self, text_template: &str) -> Box<Self> {
self.text_template = Some(Dim::Scalar(text_template.to_owned()));
Box::new(self)
}
/// Template string used for rendering the information text that appear on points. Note that
/// this will override `textinfo`. Variables are inserted using %{variable}, for example
/// "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example
/// "Price: %{y:$.2f}". See [format](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3)
/// for details on the formatting syntax. Dates are formatted using d3-time-format's syntax
/// %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}".
/// See [format](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format) for details
/// on the date formatting syntax. Every attributes that can be specified per-point (the ones
/// that are `arrayOk: true`) are available.
pub fn text_template_array<S: AsRef<str>>(mut self, text_template: Vec<S>) -> Box<Self> {
let text_template = private::owned_string_vector(text_template);
self.text_template = Some(Dim::Vector(text_template));
Box::new(self)
}
/// Sets hover text elements associated with each (x,y) pair. If a single string, the same
/// string appears over all the data points. If an array of string, the items are mapped in
/// order to the this trace's (x,y) coordinates. To be seen, trace `HoverInfo` must contain a
/// "Text" flag.
pub fn hover_text(mut self, hover_text: &str) -> Box<Self> {
self.hover_text = Some(Dim::Scalar(hover_text.to_owned()));
Box::new(self)
}
/// Sets hover text elements associated with each (x,y) pair. If a single string, the same
/// string appears over all the data points. If an array of string, the items are mapped in
/// order to the this trace's (x,y) coordinates. To be seen, trace `HoverInfo` must contain a
/// "Text" flag.
pub fn hover_text_array<S: AsRef<str>>(mut self, hover_text: Vec<S>) -> Box<Self> {
let hover_text = private::owned_string_vector(hover_text);
self.hover_text = Some(Dim::Vector(hover_text));
Box::new(self)
}
/// Determines which trace information appear on hover. If `HoverInfo::None` or `HoverInfo::Skip`
/// are set, no information is displayed upon hovering. But, if `HoverInfo::None` is set, click
/// and hover events are still fired.
pub fn hover_info(mut self, hover_info: HoverInfo) -> Box<Self> {
self.hover_info = Some(hover_info);
Box::new(self)
}
/// Template string used for rendering the information that appear on hover box. Note that this
/// will override `HoverInfo`. Variables are inserted using %{variable}, for example "y: %{y}".
/// Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example
/// "Price: %{y:$.2f}".
/// https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details
/// on the formatting syntax. Dates are formatted using d3-time-format's syntax
/// %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}".
/// https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details
/// on the date formatting syntax. The variables available in `hovertemplate` are the ones
/// emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data.
/// Additionally, every attributes that can be specified per-point (the ones that are
/// `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the
/// secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box
/// completely, use an empty tag `<extra></extra>`.
pub fn hover_template(mut self, hover_template: &str) -> Box<Self> {
self.hover_template = Some(Dim::Scalar(hover_template.to_owned()));
Box::new(self)
}
/// Template string used for rendering the information that appear on hover box. Note that this
/// will override `HoverInfo`. Variables are inserted using %{variable}, for example "y: %{y}".
/// Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example
/// "Price: %{y:$.2f}".
/// https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details
/// on the formatting syntax. Dates are formatted using d3-time-format's syntax
/// %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}".
/// https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details
/// on the date formatting syntax. The variables available in `hovertemplate` are the ones
/// emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data.
/// Additionally, every attributes that can be specified per-point (the ones that are
/// `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the
/// secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box
/// completely, use an empty tag `<extra></extra>`.
pub fn hover_template_array<S: AsRef<str>>(mut self, hover_template: Vec<S>) -> Box<Self> {
let hover_template = private::owned_string_vector(hover_template);
self.hover_template = Some(Dim::Vector(hover_template));
Box::new(self)
}
/// Assigns extra meta information associated with this trace that can be used in various text
/// attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`,
/// annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support
/// `meta`. To access the trace `meta` values in an attribute in the same trace, simply use
/// `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace
/// `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the
/// `meta` and `n` is the trace index.
pub fn meta<C: NumOrString>(mut self, meta: C) -> Box<Self> {
self.meta = Some(meta.to_num_or_string());
Box::new(self)
}
/// Assigns extra data each datum. This may be useful when listening to hover, click and
/// selection events. Note that, "scatter" traces also appends customdata items in the markers
/// DOM elements
pub fn custom_data<C: NumOrString>(mut self, custom_data: Vec<C>) -> Box<Self> {
let wrapped = to_num_or_string_wrapper(custom_data);
self.custom_data = Some(wrapped);
Box::new(self)
}
/// Only relevant when `stackgroup` is used, and only the first `orientation` found in the
/// `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`.
/// Sets the stacking direction. With "v" ("h"), the y (x) values of subsequent traces are
/// added. Also affects the default value of `fill`.
pub fn orientation(mut self, orientation: Orientation) -> Box<Self> {
self.orientation = Some(orientation);
Box::new(self)
}
/// Only relevant when `stackgroup` is used, and only the first `groupnorm` found in the
/// `stackgroup` will be used - including if `visible` is "legendonly" but not if it is `false`.
/// Sets the normalization for the sum of this `stackgroup`. With "fraction", the value of each
/// trace at each location is divided by the sum of all trace values at that location. "percent"
/// is the same but multiplied by 100 to show percentages. If there are multiple subplots, or
/// multiple `stackgroup`s on one subplot, each will be normalized within its own set.
pub fn group_norm(mut self, group_norm: GroupNorm) -> Box<Self> {
self.group_norm = Some(group_norm);
Box::new(self)
}
/// Array containing integer indices of selected points. Has an effect only for traces that
/// support selections. Note that an empty array means an empty selection where the
/// `unselected` are turned on for all points, whereas, any other non-array values means no
/// selection all where the `selected` and `unselected` styles have no effect.
pub fn selected_points(mut self, selected_points: Vec<u32>) -> Box<Self> {
self.selected_points = Some(selected_points);
Box::new(self)
}
/// Set several scatter traces (on the same subplot) to the same stackgroup in order to add
/// their y values (or their x values if `orientation` is "h"). If blank or omitted this trace
/// will not be stacked. Stacking also turns `fill` on by default, using "tonexty" ("tonextx")
/// if `orientation` is "h" ("v") and sets the default `mode` to "lines" irrespective of point
/// count. You can only stack on a numeric (linear or log) axis. Traces in a `stackgroup` will
/// only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s
/// or some traces stacked and some not, if fill-linked traces are not already consecutive, the
/// later ones will be pushed down in the drawing order.
pub fn stack_group(mut self, stack_group: &str) -> Box<Self> {
self.stack_group = Some(stack_group.to_owned());
Box::new(self)
}
/// Determines how points are displayed and joined.
pub fn marker(mut self, marker: Marker) -> Box<Self> {
self.marker = Some(marker);
Box::new(self)
}
/// Line display properties.
pub fn line(mut self, line: Line) -> Box<Self> {
self.line = Some(line);
Box::new(self)
}
/// Sets the text font.
pub fn text_font(mut self, text_font: Font) -> Box<Self> {
self.text_font = Some(text_font);
Box::new(self)
}
/// Determines whether or not markers and text nodes are clipped about the subplot axes. To show
/// markers and text nodes above axis lines and tick labels, make sure to set `xaxis.layer` and
/// `yaxis.layer` to "below traces".
pub fn clip_on_axis(mut self, clip_on_axis: bool) -> Box<Self> {
self.clip_on_axis = Some(clip_on_axis);
Box::new(self)
}
/// Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays
/// are connected.
pub fn connect_gaps(mut self, connect_gaps: bool) -> Box<Self> {
self.connect_gaps = Some(connect_gaps);
Box::new(self)
}
/// Sets the area to fill with a solid color. Defaults to "none" unless this trace is stacked,
/// then it gets "tonexty" ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` if not
/// "none". "tozerox" and "tozeroy" fill to x=0 and y=0 respectively. "tonextx" and "tonexty"
/// fill between the endpoints of this trace and the endpoints of the trace before it,
/// connecting those endpoints with straight lines (to make a stacked area graph); if there is
/// no trace before it, they behave like "tozerox" and "tozeroy". "toself" connects the
/// endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.
/// "tonext" fills the space between two traces if one completely encloses the other
/// (eg consecutive contour lines), and behaves like "toself" if there is no trace before it.
/// "tonext" should not be used if one trace does not enclose the other. Traces in a
/// `stackgroup` will only fill to (or be filled to) other traces in the same group. With
/// multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not
/// already consecutive, the later ones will be pushed down in the drawing order.
pub fn fill(mut self, fill: Fill) -> Box<Self> {
self.fill = Some(fill);
Box::new(self)
}
/// Sets the fill color. Defaults to a half-transparent variant of the line color, marker color,
/// or marker line color, whichever is available.
pub fn fill_color<C: Color>(mut self, fill_color: C) -> Box<Self> {
self.fill_color = Some(fill_color.to_color());
Box::new(self)
}
/// Properties of label displayed on mouse hover.
pub fn hover_label(mut self, hover_label: Label) -> Box<Self> {
self.hover_label = Some(hover_label);
Box::new(self)
}
/// Do the hover effects highlight individual points (markers or line points) or do they
/// highlight filled regions? If the fill is "toself" or "tonext" and there are no markers or
/// text, then the default is "fills", otherwise it is "points".
pub fn hover_on(mut self, hover_on: &str) -> Box<Self> {
self.hover_on = Some(hover_on.to_owned());
Box::new(self)
}
/// Only relevant when `stack_group` is used, and only the first `stack_gaps` found in the
/// `stackgroup` will be used - including if `visible` is set to `Visible::LegendOnly` but not
/// if it is set to `Visible::False`.
/// Determines how we handle locations at which other traces in this group have data but this
/// one does not. With "infer zero" we insert a zero at these locations. With "interpolate" we
/// linearly interpolate between existing values, and extrapolate a constant beyond the existing
/// values.
pub fn stack_gaps(mut self, stack_gaps: &str) -> Box<Self> {
self.stack_gaps = Some(stack_gaps.to_owned());
Box::new(self)
}
/// Assign an id to this trace, Use this to provide object constancy between traces during
/// animations and transitions.
pub fn uid(mut self, uid: &str) -> Box<Self> {
self.uid = Some(uid.to_owned());
Box::new(self)
}
}
impl<Theta, R> Trace for ScatterPolar<Theta, R>
where
Theta: Serialize + Clone + 'static,
R: Serialize + Clone + 'static,
{
fn serialize(&self) -> String {
serde_json::to_string(&self).unwrap()
}
}