sitemap.xml llms.txt
Skip to main content

PowerPoint Entities

These interfaces and types are used by the PowerPoint adapter and encapsulate data objects used by the Epicenter PowerPoint API.

TemplateDirectory​

A string literal type that specifies where the PowerPoint template file is stored within the project.

Values​

  • 'DATA': The template is stored in the project's Data folder.
  • 'MODEL': The template is stored in the project's Model folder.

NDataPoint​

Represents a single-value data point used in bar, area, line, and pie chart series.

Properties​

  • n? (number | null): The numeric value of the data point.

XYDataPoint​

Represents a two-dimensional data point used in scatter and XY chart series.

Properties​

  • x? (number | null): The value along the horizontal axis.
  • y? (number | null): The value along the vertical axis.

BarSeriesShadow​

Defines a data series for a bar chart.

Properties​

  • objectType ('bar'): Discriminant tag identifying this as a bar series.
  • name? (string): Display name for the series.
  • data? (NDataPoint[] | null): Array of NDataPoint values for the series.

AreaSeriesShadow​

Defines a data series for an area chart.

Properties​

  • objectType ('area'): Discriminant tag identifying this as an area series.
  • name? (string): Display name for the series.
  • data? (NDataPoint[] | null): Array of NDataPoint values for the series.

LineSeriesShadow​

Defines a data series for a line chart.

Properties​

  • objectType ('line'): Discriminant tag identifying this as a line series.
  • name? (string): Display name for the series.
  • data? (NDataPoint[] | null): Array of NDataPoint values for the series.

PieSeriesShadow​

Defines a data series for a pie chart.

Properties​

  • objectType ('pie'): Discriminant tag identifying this as a pie series.
  • name? (string): Display name for the series.
  • data? (NDataPoint[] | null): Array of NDataPoint values for the series.

ScatterSeriesShadow​

Defines a data series for a scatter chart.

Properties​

  • objectType ('scatter'): Discriminant tag identifying this as a scatter series.
  • name? (string): Display name for the series.
  • data? (XYDataPoint[] | null): Array of XYDataPoint values for the series.

YSeriesShadow​

Defines a series of plain numeric values (Y-axis only), without an associated category axis.

Properties​

  • objectType ('y'): Discriminant tag identifying this as a Y-series.
  • name? (string): Display name for the series.
  • data? (number[] | null): Array of numeric values.

XYSeriesShadow​

Defines a data series with explicit X and Y coordinates.

Properties​

  • objectType ('xy'): Discriminant tag identifying this as an XY series.
  • name? (string): Display name for the series.
  • data? (XYDataPoint[] | null): Array of XYDataPoint values for the series.

SeriesShadow​

A union type representing any supported chart series. The objectType discriminant determines which concrete series type is used.

type SeriesShadow =
    | BarSeriesShadow
    | AreaSeriesShadow
    | LineSeriesShadow
    | PieSeriesShadow
    | ScatterSeriesShadow
    | YSeriesShadow
    | XYSeriesShadow;

ChartShadow​

Represents a chart to be rendered on a slide. Maps to a chart shape in the PowerPoint template by name.

Properties​

  • name? (string): The name of the chart shape in the template.
  • categories? (unknown[] | null): The category labels for the chart's axis.
  • series? (SeriesShadow[] | null): Array of SeriesShadow objects defining the chart's data series.

TableShadow​

Represents a table to be rendered on a slide. Maps to a table shape in the PowerPoint template by name.

Properties​

  • name? (string): The name of the table shape in the template.
  • header? (unknown): An optional header row definition.
  • data? (unknown[] | null): Array of row data to populate the table.

PictureShadow​

Represents a picture to be rendered on a slide. Maps to an image shape in the PowerPoint template by name.

Properties​

  • name? (string): The name of the picture shape in the template.
  • data? (BinaryData): The binary image content to insert.

BinaryData​

Represents binary file content returned by or provided to the PowerPoint API. Used both as the return type of generate() and as the image payload in PictureShadow.

Properties​

  • encoding ('HEX' | 'BASE_64'): The encoding format of data. Use 'HEX' for hexadecimal or 'BASE_64' for Base64.
  • data (unknown): The encoded binary content.
  • encryption? ('AES' | null): The encryption scheme applied to the data, if any.
  • name? (string | null): The filename associated with the binary data.
  • content_type? (string | null): The MIME type of the binary data (for example, application/vnd.openxmlformats-officedocument.presentationml.presentation).
  • contentType? (unknown): An alternate content type field returned by the API.

EnvironmentShadow​

Defines the data environment for a slide or the entire document — the set of charts, tables, pictures, and named parameters to inject into the template.

Properties​

  • parameters? (Record<string, unknown> | null): A map of named template parameters (text placeholders) and their replacement values.
  • charts? (ChartShadow[] | null): Array of ChartShadow objects to inject.
  • tables? (TableShadow[] | null): Array of TableShadow objects to inject.
  • pictures? (PictureShadow[] | null): Array of PictureShadow objects to inject.

SlideShadow​

Defines the per-slide overrides to apply when generating a document. If a slide's environment is provided, it takes precedence over the document-level environment for the shapes on that slide.

Properties​

  • number? (number): The 1-based index of the slide to target.
  • environment? (EnvironmentShadow): The data environment to apply to this specific slide.

DocumentShadow​

The top-level input to the PowerPoint generation functions. Defines the output filename, a document-wide data environment, and optional per-slide overrides.

Properties​

  • output? (string): The filename for the generated PowerPoint file (for example, 'debrief-slides.pptx').
  • environment? (EnvironmentShadow): A document-wide data environment applied to all slides unless overridden.
  • slides? (SlideShadow[] | null): Array of SlideShadow objects for per-slide data overrides.