Struct PieChart 

pub struct PieChart<T: 'static> { /* private fields */ }

Implementations

impl<T> PieChart<T>

pub fn new<I>(data: I) -> Self

where I: IntoIterator<Item = T>,

pub fn id(self, id: impl Into<ElementId>) -> Self

Name this chart’s ElementId, replacing the default taken from the construction site.

Pass one where a single construction site renders several of these charts as siblings: they share the default id, and with it one hover state and one path cache. The id must be unique among those siblings.

pub fn interactive(self, interactive: bool) -> Self

Turn this chart’s interactive layer on or off. On by default.

The layer is the hitbox under the cursor and what it drives: the hovered slice lifts out of the ring, and a tooltip shows its value and share. Turn it off for a chart that only decorates, or one an element above it wants the cursor for: without a hitbox it neither answers the mouse nor takes the hover from what sits over it. A chart that is off also drops its path cache, which is keyed on the same id.

pub fn name(self, name: impl Into<SharedString>) -> Self

Set the series name shown in the hover tooltip row (e.g. “Desktop”).

pub fn inner_radius(self, inner_radius: f32) -> Self

Set the inner radius of the pie chart.

pub fn inner_radius_fn( self, inner_radius_fn: impl Fn(&ArcData<'_, T>) -> f32 + 'static, ) -> Self

Set the inner radius of the pie chart based on the arc data.

pub fn outer_radius(self, outer_radius: f32) -> Self

Set the outer radius of the pie chart.

pub fn outer_radius_fn( self, outer_radius_fn: impl Fn(&ArcData<'_, T>) -> f32 + 'static, ) -> Self

Set the outer radius of the pie chart based on the arc data.

pub fn pad_angle(self, pad_angle: f32) -> Self

Set the pad angle of the pie chart.

pub fn value(self, value: impl Fn(&T) -> f32 + 'static) -> Self

pub fn color<H>(self, color: impl Fn(&T) -> H + 'static) -> Self

where H: Into<Hsla> + 'static,

Set the color of the pie chart.

pub fn label(self, label: impl Fn(&T) -> SharedString + 'static) -> Self

Set the label text for each slice.

Once set, a “leader line + text” is drawn outside the ring for every slice.

pub fn label_line_color(self, color: impl Fn(&T) -> Hsla + 'static) -> Self

Set the leader line color per slice (defaults to cx.theme().border).

pub fn label_color(self, color: Hsla) -> Self

Set the label text color (defaults to cx.theme().foreground).

pub fn label_gap(self, gap: f32) -> Self

Set the extra gap between outer_radius and the label radius (defaults to 15px).

pub fn tooltip_name(self, name: impl Fn(&T) -> SharedString + 'static) -> Self

Name the slice under the cursor in the hover tooltip’s row, beside its value. Falls back to name, the one name the whole series carries.

A pie shows one number per slice, so the slice’s own name is what the row wants; a single series name leaves the row reading as a swatch and a number with a gap between them. The alternative was to title the tooltip from label, but that also draws the leader lines around the ring.

pub fn tooltip_value( self, value: impl Fn(&T, f32, f32) -> SharedString + 'static, ) -> Self

Set the text of the hover tooltip’s row, the value the slice is worth. Defaults to the raw value followed by its share in parentheses.

The closure receives the datum, the value value returned for it, and that value’s share of the total as a percentage. Set it wherever the raw number is not what a reader should see: a value that is already a ratio reads as 0.35 (35.0%) by default, and a chart drawn from adjusted values — a floor that keeps a hairline slice visible, say — would report the adjustment as though it were the datum.

Trait Implementations

impl<T: 'static> IntoElement for PieChart<T>

type Element = PlotElement<PieChart<T>>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl<T> Plot for PieChart<T>

fn paint(&mut self, bounds: Bounds<Pixels>, window: &mut Window, cx: &mut App)

fn id(&self) -> Option<ElementId>

A stable element id that enables interactive tooltip support for this plot.

fn tooltip_state( &self, position: Point<Pixels>, bounds: Bounds<Pixels>, _cx: &App, ) -> Option<TooltipState>

Map the cursor to the tooltip state to display.

fn hover( &mut self, hover: Option<&PlotHover>, window: &mut Window, cx: &mut App, )

Receive the hovered datum this frame, before Plot::tooltip and Plot::paint run.

fn tooltip( &self, state: &TooltipState, cursor: Point<Pixels>, bounds: Bounds<Pixels>, _window: &mut Window, cx: &mut App, ) -> Option<AnyElement>

Render the tooltip overlay for the active TooltipState.

fn prepaint( &mut self, _bounds: Bounds<Pixels>, _window: &mut Window, _cx: &mut App, ) -> Vec<AnyElement>

Lay out and place the child elements this plot hosts (e.g. element labels).