Skip to main content

ChartSettingsState

egui_charts::widget::settings

Struct ChartSettingsState 

Source 
pub struct ChartSettingsState {
Show 21 fields
    pub chart_type: ChartType,
    pub chart_type_params: Option<ChartTypeParams>,
    pub price_source: Option<PriceSource>,
    pub candle_colors: CandleColorConfig,
    pub precision: PrecisionMode,
    pub timezone: String,
    pub show_price_targets: bool,
    pub adjust_for_dividends: bool,
    pub order_flow: OrderFlowSettings,
    pub status_line: StatusLineOptions,
    pub scales_and_lines: ScalesAndLinesSettings,
    pub chart_basic_styles: ChartBasicStylesSettings,
    pub grid_lines: GridLinesSettings,
    pub crosshair: CrosshairSettings,
    pub watermark: WatermarkSettings,
    pub scales_appearance: ScalesAppearanceSettings,
    pub btns: ButtonsSettings,
    pub margins: MarginsSettings,
    pub trading: TradingSettings,
    pub alerts: AlertsSettings,
    pub events: EventVisibility,

}
Expand description

Serializable display settings shared by the chart and its settings dialog.

Fields§

§chart_type: ChartType

Active representation used to select the Symbol controls. Applying settings keeps the chart type.

§chart_type_params: Option<ChartTypeParams>

Styles and construction inputs; absent in settings saved before these controls existed.

§price_source: Option<PriceSource>

Source for line and area representations; absent in older saved settings.

§candle_colors: CandleColorConfig

Candle body, border and wick colors.

§precision: PrecisionMode

Price display precision.

§timezone: String

UTC, Local, or a supported zone name.

§show_price_targets: bool

Show analyst estimates answered by the host feed.

§adjust_for_dividends: bool

Ask the host for history adjusted for dividends. The host owns the data, so apply_to_chart leaves it to the host, which reloads the adjusted history; from_chart leaves it off.

§order_flow: OrderFlowSettings

Independent heatmap, live book and trade bubble settings; older documents keep them off.

§status_line: StatusLineOptions

Legend content and quote controls.

§scales_and_lines: ScalesAndLinesSettings

Price scale and reference line settings.

§chart_basic_styles: ChartBasicStylesSettings

Chart background settings.

§grid_lines: GridLinesSettings

Grid directions and colors.

§crosshair: CrosshairSettings

Crosshair line appearance.

§watermark: WatermarkSettings

Watermark appearance.

§scales_appearance: ScalesAppearanceSettings

Axis appearance.

§btns: ButtonsSettings

Chart and pane control visibility.

§margins: MarginsSettings

Space around the visible prices.

§trading: TradingSettings

Host trading controls and overlays.

§alerts: AlertsSettings

Alert marks and labels.

§events: EventVisibility

Visible event categories.

Implementations§

Source§

impl ChartSettingsState

Source

pub fn from_chart(chart: &Chart) -> Self

Read the chart’s current display settings. Host-managed trading and alert groups retain defaults; hosts preserve their current values when refreshing chart settings.

Source

pub fn apply_to_chart( &self, chart: &mut Chart, ) -> Result<(), ChartSettingsError>

Apply the display controls offered by the dialog without rebuilding the chart or feed. Host-owned trading and alerts are left to their providers. Invalid timezone, margins or crosshair width returns an error before changing the chart.

Trait Implementations§

Source§

impl Clone for ChartSettingsState

Source§

fn clone(&self) -> ChartSettingsState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ChartSettingsState

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ChartSettingsState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ChartSettingsState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ChartSettingsState

Source§

fn eq(&self, other: &ChartSettingsState) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ChartSettingsState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ChartSettingsState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSend for T
where T: Send + Sync + ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

§

fn simd_from(_simd: S, value: T) -> T

§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.