Struct GgsqlPalette 

pub struct GgsqlPalette { /* private fields */ }

A resolved ggsci palette ready for ggsql conversion.

The wrapper retains the source palette semantics until a caller selects a ggsql scale kind or converts the colors to an untyped output range.

Implementations

impl GgsqlPalette

pub fn from_colors(colors: Vec<Rgb>, palette_kind: PaletteKind) -> Self

Creates a wrapper from already resolved colors and their source semantics.

pub fn from_spec(spec: &str, n: usize) -> Result<Self, Error>

Resolves and samples a core palette using its discrete or continuous semantics.

Errors

Returns an error when the specification is invalid, the palette is not known, or a discrete palette does not have n colors.

Examples found in repository

examples/discrete.rs (line 4)

fn main() -> Result<(), ggsci_ggsql::Error> {
    let palette = GgsqlPalette::from_spec("observable:observable10", 3)?;

    assert_eq!(palette.to_sql_array(), "['#4269D0', '#EFB118', '#FF725C']");
    println!("{}", palette.to_default_scale_clause("color")?);

    Ok(())
}

pub fn from_continuous( spec: &str, n: usize, options: ContinuousOptions, ) -> Result<Self, Error>

Resolves and interpolates a continuous core palette with explicit options.

Errors

Returns an error when the palette cannot be found or is not continuous.

Examples found in repository

examples/continuous.rs (lines 5-9)

fn main() -> Result<(), ggsci_ggsql::Error> {
    let palette = GgsqlPalette::from_continuous(
        "material:blue-grey",
        256,
        ContinuousOptions::new().with_reverse(true),
    )?;

    let clause = palette.to_default_scale_clause("fill")?;
    assert!(clause.starts_with("SCALE CONTINUOUS fill TO"));

    let binned = palette.to_scale_clause(ScaleKind::Binned, "fill")?;
    assert!(binned.starts_with("SCALE BINNED fill TO"));

    Ok(())
}

pub fn from_iterm( palette: &str, variant: ItermVariant, n: usize, ) -> Result<Self, Error>

Resolves colors from a fixed discrete iTerm theme variant.

Errors

Returns an error when the theme is unknown or n exceeds the six colors in a variant.

pub fn from_gephi(palette: &str, n: usize) -> Result<Self, Error>

Generates colors from a generative discrete Gephi palette.

Use Self::from_gephi_with_seed when reproducibility matters.

Errors

Returns an error when the palette is unknown or generation fails.

pub fn from_gephi_with_seed( palette: &str, n: usize, seed: u64, ) -> Result<Self, Error>

Generates reproducible colors from a generative discrete Gephi palette.

Errors

Returns an error when the palette is unknown or generation fails.

pub fn colors(&self) -> &[Rgb]

Returns the resolved colors.

pub fn into_colors(self) -> Vec<Rgb>

Consumes the wrapper and returns its resolved colors.

pub const fn palette_kind(&self) -> PaletteKind

Returns the source palette’s semantic kind.

pub fn to_sql_array(&self) -> String

Formats the colors as a ggsql array of uppercase #RRGGBB strings.

Examples found in repository

examples/discrete.rs (line 6)

fn main() -> Result<(), ggsci_ggsql::Error> {
    let palette = GgsqlPalette::from_spec("observable:observable10", 3)?;

    assert_eq!(palette.to_sql_array(), "['#4269D0', '#EFB118', '#FF725C']");
    println!("{}", palette.to_default_scale_clause("color")?);

    Ok(())
}

pub fn to_output_range(&self) -> OutputRange

Converts the colors to ggsql’s typed explicit output range.

The resulting value intentionally does not retain scale-kind metadata.

pub fn to_scale_clause( &self, kind: ScaleKind, aesthetic: &str, ) -> Result<String, Error>

Emits an explicit-array ggsql scale clause of the selected kind.

Errors

Returns Error::InvalidAesthetic unless aesthetic, after trimming, is an ASCII identifier matching [A-Za-z_][A-Za-z0-9_]*.

Examples found in repository

examples/continuous.rs (line 14)

fn main() -> Result<(), ggsci_ggsql::Error> {
    let palette = GgsqlPalette::from_continuous(
        "material:blue-grey",
        256,
        ContinuousOptions::new().with_reverse(true),
    )?;

    let clause = palette.to_default_scale_clause("fill")?;
    assert!(clause.starts_with("SCALE CONTINUOUS fill TO"));

    let binned = palette.to_scale_clause(ScaleKind::Binned, "fill")?;
    assert!(binned.starts_with("SCALE BINNED fill TO"));

    Ok(())
}

pub fn to_default_scale_clause(&self, aesthetic: &str) -> Result<String, Error>

Emits an explicit-array ggsql scale clause whose kind defaults from the source palette semantics.

Errors

Returns Error::InvalidAesthetic unless aesthetic, after trimming, is a valid ASCII identifier.

Examples found in repository

examples/discrete.rs (line 7)

fn main() -> Result<(), ggsci_ggsql::Error> {
    let palette = GgsqlPalette::from_spec("observable:observable10", 3)?;

    assert_eq!(palette.to_sql_array(), "['#4269D0', '#EFB118', '#FF725C']");
    println!("{}", palette.to_default_scale_clause("color")?);

    Ok(())
}

examples/continuous.rs (line 11)

fn main() -> Result<(), ggsci_ggsql::Error> {
    let palette = GgsqlPalette::from_continuous(
        "material:blue-grey",
        256,
        ContinuousOptions::new().with_reverse(true),
    )?;

    let clause = palette.to_default_scale_clause("fill")?;
    assert!(clause.starts_with("SCALE CONTINUOUS fill TO"));

    let binned = palette.to_scale_clause(ScaleKind::Binned, "fill")?;
    assert!(binned.starts_with("SCALE BINNED fill TO"));

    Ok(())
}

Trait Implementations

impl Clone for GgsqlPalette

fn clone(&self) -> GgsqlPalette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GgsqlPalette

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

Formats the value using the given formatter.

impl Eq for GgsqlPalette

impl From<&GgsqlPalette> for OutputRange

fn from(palette: &GgsqlPalette) -> Self

Converts to this type from the input type.

impl From<GgsqlPalette> for OutputRange

fn from(palette: GgsqlPalette) -> Self

Converts to this type from the input type.

impl PartialEq for GgsqlPalette

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GgsqlPalette