xnano.components.schema

Named declarative component field.

Attributes:

• name (str) –

  Attribute name assigned by the owning component class.

name: str = dataclasses.field(default='', init=False)

Bases: ComponentDescriptor

Describe one table column.

Attributes:

• header (str | None) –

  Header displayed for the column.

• accessor (Callable[[Any], Any] | None) –

  Row attribute, mapping key, or value callback.

• format (FormatResolver) –

  Optional format string or value callback.

• foreground (ColorResolver) –

  Cell foreground color.

• background (ColorResolver) –

  Cell background color.

• horizontal_align ('Alignment | None') –

  Cell alignment.

• width (int | float | None) –

  Fixed or proportional column width.

header: str | None = None

accessor: Callable[[Any], Any] | None = None

format: FormatResolver = None

foreground: ColorResolver = None

background: ColorResolver = None

horizontal_align: 'Alignment | None' = None

width: int | float | None = None

name: str = dataclasses.field(default='', init=False)

resolve_header() -> str

74
75
76

def resolve_header(self) -> str:
    """Return the displayed header."""
    return self.header or self.name.replace("_", " ").title()

resolve_value(row: Any) -> Any

78
79
80
81
82
83
84

def resolve_value(self, row: Any) -> Any:
    """Read this column's value from a row."""
    if self.accessor is not None:
        return self.accessor(row)
    if isinstance(row, dict):
        return row.get(self.name)
    return getattr(row, self.name, None)

resolve_text(value: Any) -> str

86
87
88
89
90
91
92
93
94

def resolve_text(self, value: Any) -> str:
    """Format a value for display."""
    if value is None:
        return ""
    if self.format is None:
        return str(value)
    if isinstance(self.format, str):
        return self.format.format(value)
    return self.format(value)

resolve_color(value: Any) -> Any

96
97
98
99

def resolve_color(self, value: Any) -> Any:
    """Resolve the foreground color for a value."""
    resolver = self.foreground
    return resolver(value) if callable(resolver) else resolver

resolve_background(value: Any) -> Any

101
102
103
104
105
106
107

def resolve_background(self, value: Any) -> Any:
    """Resolve the background color for a value."""
    return (
        self.background(value)
        if callable(self.background)
        else self.background
    )

Bases: ComponentDescriptor

Describe one chart series.

Attributes:

• label (str | None) –

  Legend label; None derives it from the attribute name.

• color ('ColorLike | None') –

  Series color.

• kind ('GraphTypeLike | None') –

  Plot representation.

• marker ('CanvasMarkerLike | None') –

  Glyph set used to paint the series.

label: str | None = None

color: 'ColorLike | None' = None

kind: 'GraphTypeLike | None' = None

marker: 'CanvasMarkerLike | None' = None

name: str = dataclasses.field(default='', init=False)

resolve_label() -> str

134
135
136

def resolve_label(self) -> str:
    """Return the displayed legend label."""
    return self.label if self.label is not None else self.name