Interface AddGadget

Details of the settings for a dashboard gadget.

interface AddGadget {
    color?: string;
    dashboardId: number;
    ignoreUriAndModuleKeyValidation?: boolean;
    moduleKey?: string;
    position?: Version3.Version3Models.DashboardGadgetPosition;
    title?: string;
    uri?: string;
}

Hierarchy (view full)

Properties

color? dashboardId ignoreUriAndModuleKeyValidation? moduleKey? position? title? uri?

Properties

Optional color

color?: string

The color of the gadget. Should be one of blue, red, yellow, green, cyan, purple, gray, or white.

dashboardId

dashboardId: number

The ID of the dashboard.

Optional ignoreUriAndModuleKeyValidation

ignoreUriAndModuleKeyValidation?: boolean

Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.

Optional moduleKey

moduleKey?: string

The module key of the gadget type. Can't be provided with uri.

Optional position

position?: Version3.Version3Models.DashboardGadgetPosition

Optional title

title?: string

The title of the gadget.

Optional uri

uri?: string

The URI of the gadget type. Can't be provided with moduleKey.

Settings

Member Visibility

Theme

On This Page

colordashboardIdignoreUriAndModuleKeyValidationmoduleKeypositiontitleuri