Type Alias TemplatePersist

Depending on the value of type, sharing service will internally validate a specific property regarding its data. Type "file" validates property "fileData", type "chart" validates property "chartData", type "story" validates property "storyData". Check description of each of the models for their required properties.

type TemplatePersist = {
    chartData?: ChartTemplate;
    fileAlias?: string;
    fileName?: string;
    fileTimeStamp?:
        | "yyyy-MM-dd"
        | "yyyy-MM-dd_HH-mm"
        | "yyyyMMdd"
        | "yyyyMMdd_HH-mm";
    multiSheetData?: MultiSheetTemplate[];
    sheetData?: SheetTemplate;
    storyData?: StoryTemplate;
    subType?: | "image"
    | "snapshot"
    | "pdf"
    | "pptx"
    | "xlsx"
    | "qpxp"
    | "qhtml"
    | "docx";
    templateId?: string;
    type: | "file"
    | "chart"
    | "story"
    | "sheet"
    | "multi-sheet"
    | "excel"
    | "pixel-perfect"
    | "html"
    | "powerpoint"
    | "word";
}
Index

Properties

chartData? fileAlias? fileName? fileTimeStamp? multiSheetData? sheetData? storyData? subType? templateId? type

Properties

chartData?: ChartTemplate

If the template type is not "chart", this can be null. Otherwise, the following properties are required: appId, sheetId, objectId, widthPx, heightPx, language. The following properties are optional: outZoom, outDpi

fileAlias?: string

fileAlias provide an opaqueId for the client which can be used to filter and select the report generated

fileName?: string

fileName to be used when generating the report

fileTimeStamp?:
    | "yyyy-MM-dd"
    | "yyyy-MM-dd_HH-mm"
    | "yyyyMMdd"
    | "yyyyMMdd_HH-mm"

file name timestamp to be used when generating the report

multiSheetData?: MultiSheetTemplate[]

array of sheet data for multi-sheet type template

sheetData?: SheetTemplate
storyData?: StoryTemplate
subType?:
    | "image"
    | "snapshot"
    | "pdf"
    | "pptx"
    | "xlsx"
    | "qpxp"
    | "qhtml"
    | "docx"
templateId?: string

ID of unique template

type:
    | "file"
    | "chart"
    | "story"
    | "sheet"
    | "multi-sheet"
    | "excel"
    | "pixel-perfect"
    | "html"
    | "powerpoint"
    | "word"

Settings

Member Visibility

On This Page

Properties