spreadsheet_intelligence.models.raw.theme package#

Submodules#

spreadsheet_intelligence.models.raw.theme.theme_models module#

class spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr(val: Color)[source]#

Bases: object

Represents an sRGB color.

val#

The sRGB color value.

Type:

Color

XMLReference:

val – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme

val: Color#
class spreadsheet_intelligence.models.raw.theme.theme_models.SysClr(val: str, last_clr: Color)[source]#

Bases: object

Represents a system color with a fallback color.

val#

The system color value.

Type:

str

last_clr#

The fallback color.

Type:

Color

val: str#
last_clr: Color#
class spreadsheet_intelligence.models.raw.theme.theme_models.ClrScheme(dk1: SysClr | SrgbClr, lt1: SysClr | SrgbClr, dk2: SysClr | SrgbClr, lt2: SysClr | SrgbClr, accent1: SysClr | SrgbClr, accent2: SysClr | SrgbClr, accent3: SysClr | SrgbClr, accent4: SysClr | SrgbClr, accent5: SysClr | SrgbClr, accent6: SysClr | SrgbClr, hlink: SysClr | SrgbClr, folHlink: SysClr | SrgbClr)[source]#

Bases: object

Represents a color scheme with various color roles.

dk1#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

lt1#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

dk2#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

lt2#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

accent1#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

accent2#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

accent3#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

accent4#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

accent5#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

accent6#

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

Union[SysClr, SrgbClr]

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.SysClr | spreadsheet_intelligence.models.raw.theme.theme_models.SrgbClr

XMLReference:
  • dk1 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:dk1

  • lt1 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:lt1

  • dk2 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:dk2

  • lt2 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:lt2

  • accent1 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:accent1

  • accent2 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:accent2

  • accent3 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:accent3

  • accent4 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:accent4

  • accent5 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:accent5

  • accent6 – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:accent6

  • hlink – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:hlink

  • folHlink – xl/theme/themeX.xml/a:theme/a:themeElements/a:clrScheme/a:folHlink

dk1: SysClr | SrgbClr#
lt1: SysClr | SrgbClr#
dk2: SysClr | SrgbClr#
lt2: SysClr | SrgbClr#
accent1: SysClr | SrgbClr#
accent2: SysClr | SrgbClr#
accent3: SysClr | SrgbClr#
accent4: SysClr | SrgbClr#
accent5: SysClr | SrgbClr#
accent6: SysClr | SrgbClr#
hlink: SysClr | SrgbClr#
folHlink: SysClr | SrgbClr#
static map_color(val: str) str[source]#

Maps a color role to its corresponding attribute name.

Parameters:

val (str) – The color role to map.

Returns:

The mapped attribute name.

Return type:

str

get_color(val: str) Color[source]#

Retrieves the color associated with a given role.

Parameters:

val (str) – The color role to retrieve.

Returns:

The color associated with the role.

Return type:

Color

Raises:

ValueError – If the color type is invalid.

class spreadsheet_intelligence.models.raw.theme.theme_models.Theme(clr_scheme: ClrScheme)[source]#

Bases: object

Represents a theme with a color scheme.

clr_scheme#

ClrScheme

Type:

spreadsheet_intelligence.models.raw.theme.theme_models.ClrScheme

# Other schemes can be implemented if needed
clr_scheme: ClrScheme#
class spreadsheet_intelligence.models.raw.theme.theme_models.SchemeClr(val: str, lum_mod: int | None, lum_off: int | None, shade: int | None)[source]#

Bases: object

Represents a scheme color with optional adjustments.

val#

The theme name such as dk1, lt1, dk2, lt2, tx1, tx2, accent1, accent2, accent3, accent4, accent5, accent6

Type:

str

lum_mod#

The luminance modifier.

Type:

Optional[int]

lum_off#

The luminance offset.

Type:

Optional[int]

shade#

The shade value.

Type:

Optional[int]

val: str#
lum_mod: int | None#
lum_off: int | None#
shade: int | None#
get_color(theme: Theme) Color[source]#

Gets the adjusted color from the theme.

Parameters:

theme (Theme) – The theme to retrieve the color from.

Returns:

The adjusted color.

Return type:

Color

class spreadsheet_intelligence.models.raw.theme.theme_models.StyleBaseRef(idx: str, ref_clr: SchemeClr | SrgbClr)[source]#

Bases: object

Represents a base reference for a style.

idx#

The index of the style.

Type:

str

ref_clr#

The reference color.

Type:

Union[SchemeClr, SrgbClr]

idx: str#
ref_clr: SchemeClr | SrgbClr#
class spreadsheet_intelligence.models.raw.theme.theme_models.StyleRefs(ln_ref: StyleBaseRef, fill_ref: StyleBaseRef, effect_ref: StyleBaseRef | None, font_ref: StyleBaseRef | None)[source]#

Bases: object

Represents style references for line, fill, effect, and font.

ln_ref#

The reference for the line style.

Type:

StyleBaseRef

fill_ref#

The reference for the fill style.

Type:

StyleBaseRef

effect_ref#

The reference for the effect style.

Type:

Optional[StyleBaseRef]

font_ref#

The reference for the font style.

Type:

Optional[StyleBaseRef]

XMLReference:
  • ln_ref – xl/drawingX.xml/xdr:twoCellAnchor/xdr:style/a:lnRef

  • fill_ref – xl/drawingX.xml/xdr:twoCellAnchor/xdr:style/a:fillRef

  • effect_ref – xl/drawingX.xml/xdr:twoCellAnchor/xdr:style/a:effectRef

  • font_ref – xl/drawingX.xml/xdr:twoCellAnchor/xdr:style/a:fontRef

ln_ref: StyleBaseRef#
fill_ref: StyleBaseRef#
effect_ref: StyleBaseRef | None#
font_ref: StyleBaseRef | None#

Module contents#