Interface IVisualization

interface IVisualization {
    heightPx: number;
    id: string;
    jsOpts?: {};
    patches?: {
        qOp: "replace" | "add" | "remove";
        qPath: string;
        qValue?: string;
    }[];
    type?: "visualization" | "sessionobject";
    widthPx: number;
}

Properties

heightPx id jsOpts? patches? type? widthPx

Properties

heightPx

heightPx: number

Height in pixels

minimum=5, maximum=4000

id

id: string

The sense visualization id or json definition

Optional jsOpts

jsOpts?: {}

A JSON object that is passed as-is to the mashup page while rendering.

Type declaration

    Optional patches

    patches?: {
        qOp: "replace" | "add" | "remove";
        qPath: string;
        qValue?: string;
    }[]

    Soft properties, aka patches, to be applied to the visualization

    Type declaration

    • qOp: "replace" | "add" | "remove"
    • qPath: string

      Path to the property to add, remove or replace.

    • Optional qValue?: string

      Corresponds to the value of the property to add or to the new value of the property to update

    Optional type

    type?: "visualization" | "sessionobject"

    Choose visualization to export an image of a sense chart, sessionobject for a visualization to be created on-the-fly. An empty value leads to the type being inferred by its id

    widthPx

    widthPx: number

    Width in pixels

    minimum=5, maximum=4000

    Settings

    Member Visibility

    Theme

    On This Page