Type Alias Sheet

It refers to the Sense Sheet to be exported. Note that if widthPx and heightPx are not specified, default values will be applied depending on the actual size and layout properties of the Sense Sheet object.

type Sheet = {
    heightPx?: number;
    id: string;
    jsOpts?: unknown;
    jsOptsById?: Record<string, unknown>;
    patchesById?: Record<string, NxPatch[]>;
    widthPx?: number;
}
Index

Properties

heightPx? id jsOpts? jsOptsById? patchesById? widthPx?

Properties

heightPx?: number

The height of the sheet in pixels. Default value is: - 1120 pixels for responsive sheet - 1680 pixels for extended sheet - same height set in sheet properties for custom sheet

id: string

The id of the sheet.

jsOpts?: unknown

A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc.

jsOptsById?: Record<string, unknown>

A map for applying jsOpts to specific visualization IDs within the sheet.

patchesById?: Record<string, NxPatch[]>

A map for applying soft properties, aka patches, to specific visualization IDs within the sheet.

widthPx?: number

The width of the sheet in pixels. Default value is: - 1680 pixels for responsive sheet - 1120 pixels for extended sheet - same width set in sheet properties for custom sheet

Settings

Member Visibility

On This Page

Properties