Type Alias MultiSheetTemplate

type MultiSheetTemplate = {
    appId?: string;
    heightPx?: number;
    isPrivate?: boolean;
    jsOpts?: unknown;
    jsOptsById?: Record<string, unknown>;
    patchesById?: Record<string, unknown[]>;
    persistentBookmarkIncludeVariables?: boolean;
    resizeType?: "none" | "fit" | "autofit";
    sheetId?: string;
    sheetName?: string;
    widthPx?: number;
}
Index

Properties

appId? heightPx? isPrivate? jsOpts? jsOptsById? patchesById? persistentBookmarkIncludeVariables? resizeType? sheetId? sheetName? widthPx?

Properties

appId?: string

ID of app

heightPx?: number

heightPx of chart, must be 0 or omitted for autofit.

isPrivate?: boolean

optional value to indicate that this sheet is private

jsOpts?: unknown

Sheet state from client as a string json value. Can include language, theme, viewState etc.

jsOptsById?: Record<string, unknown>
patchesById?: Record<string, unknown[]>
persistentBookmarkIncludeVariables?: boolean

Flag to configure the persistent bookmark to use variables

resizeType?: "none" | "fit" | "autofit"

Currently only autofit is supported. If omitted, autofit is the default. The type of resize to be performed:

  • none is used to export a visualization, sheet as is (e.g. normal size), regardless its size. This may result in cropping.
  • autofit automatically fits the visualization, sheet into the output size (i.e. A4, A3 etc.). Any provided resizeData parameter will be ignored for this configuration.
  • fit fits the visualization, sheet into the area specified in resizeData. The content will be rescaled to fit in that area.
sheetId?: string

ID of sheet

sheetName?: string

an optional name for the sheet

widthPx?: number

widthPx of chart, must be 0 or omitted for autofit.

Settings

Member Visibility

On This Page

Properties