OPF
OpenPresentation/opf
SpecDefinition referenceView source

Background Shortcut

String shorthand for a background. Theme slots ('light1', 'light2', 'dark1', 'dark2') are equivalent to { type: 'theme', slot: value }; hex colors are equivalent to { type: 'solid', color: value }; an image source (starting with 'asset:', 'https://', 'data:', './' or '../') is equivalent to { type: 'image', src: value }, a cover image. Any other string is invalid.

Metadata

Definition
#/$defs/BackgroundShortcut
Form
3 alternative forms (oneOf)
Source
spec/schemas/opf.schema.json

Field index

This definition uses the forms or value constraints below.

oneOf 1 · ref:ThemeBackgroundSlot

Referenced ThemeBackgroundSlot · enum

PowerPoint theme-controlled slide background slot from the active color scheme. These are slots, not assumptions about actual colors: light1 is usually white and dark1 is usually black by convention, but the color scheme controls the real values.

Exact constraints for Referenced ThemeBackgroundSlot
Referenced ThemeBackgroundSlot schema
{
  "type": "string",
  "description": "PowerPoint theme-controlled slide background slot from the active color scheme. These are slots, not assumptions about actual colors: light1 is usually white and dark1 is usually black by convention, but the color scheme controls the real values.",
  "enum": [
    "light1",
    "light2",
    "dark1",
    "dark2"
  ]
}
Exact constraints for oneOf 1
oneOf 1 schema
{
  "$ref": "#/$defs/ThemeBackgroundSlot"
}

oneOf 2 · ref:HexColor

Referenced HexColor · string

Hex color shorthand accepted by selected string fields.

Exact constraints for Referenced HexColor
Referenced HexColor schema
{
  "type": "string",
  "pattern": "^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})$",
  "description": "Hex color shorthand accepted by selected string fields.",
  "examples": [
    "#fff",
    "#ffff00",
    "#0F172AFF"
  ]
}
Exact constraints for oneOf 2
oneOf 2 schema
{
  "$ref": "#/$defs/HexColor"
}

oneOf 3 · ref:ImageSource

Referenced ImageSource · string

An image source in a string shorthand: an 'asset:<id>' reference, an HTTPS URL, a data URI, or a relative path starting with './' or '../' (resolved against the OPF file location).

Exact constraints for Referenced ImageSource
Referenced ImageSource schema
{
  "type": "string",
  "pattern": "^(asset:|https://|data:|\\./|\\.\\./)",
  "description": "An image source in a string shorthand: an 'asset:<id>' reference, an HTTPS URL, a data URI, or a relative path starting with './' or '../' (resolved against the OPF file location).",
  "examples": [
    "asset:cover-photo",
    "https://cdn.acme.com/backgrounds/cover.jpg",
    "./images/harbour.jpg"
  ]
}
Exact constraints for oneOf 3
oneOf 3 schema
{
  "$ref": "#/$defs/ImageSource"
}
Complete definition constraints
Schema constraints
{
  "oneOf": [
    {
      "$ref": "#/$defs/ThemeBackgroundSlot"
    },
    {
      "$ref": "#/$defs/HexColor"
    },
    {
      "$ref": "#/$defs/ImageSource"
    }
  ],
  "description": "String shorthand for a background. Theme slots ('light1', 'light2', 'dark1', 'dark2') are equivalent to { type: 'theme', slot: value }; hex colors are equivalent to { type: 'solid', color: value }; an image source (starting with 'asset:', 'https://', 'data:', './' or '../') is equivalent to { type: 'image', src: value }, a cover image. Any other string is invalid.",
  "examples": [
    "dark1",
    "light2",
    "#ffff00",
    "asset:cover-photo",
    "./images/harbour.jpg"
  ]
}
value · Named choices (see schema for other values and constraints)
"light1""light2""dark1""dark2"