Interface Widget

Widget data

interface Widget {
    _links?: any;
    allowedSizes?: WidgetSize[];
    areSettingsBlockedForUser?: boolean;
    artifactId?: string;
    configurationContributionId?: string;
    configurationContributionRelativeId?: string;
    contentUri?: string;
    contributionId?: string;
    dashboard?: Dashboard;
    eTag?: string;
    id?: string;
    isEnabled?: boolean;
    isNameConfigurable?: boolean;
    lightboxOptions?: LightboxOptions;
    loadingImageUrl?: string;
    name?: string;
    position?: WidgetPosition;
    settings?: string;
    settingsVersion?: SemanticVersion;
    size?: WidgetSize;
    typeId?: string;
    url?: string;
}

Hierarchy (View Summary)

Properties

_links? allowedSizes? areSettingsBlockedForUser? artifactId? configurationContributionId? configurationContributionRelativeId? contentUri? contributionId? dashboard? eTag? id? isEnabled? isNameConfigurable? lightboxOptions? loadingImageUrl? name? position? settings? settingsVersion? size? typeId? url?

Properties

Optional_links

_links?: any

OptionalallowedSizes

allowedSizes?: WidgetSize[]

Refers to the allowed sizes for the widget. This gets populated when user wants to configure the widget

OptionalareSettingsBlockedForUser

areSettingsBlockedForUser?: boolean

Read-Only Property from Dashboard Service. Indicates if settings are blocked for the current user.

OptionalartifactId

artifactId?: string

Refers to unique identifier of a feature artifact. Used for pinning+unpinning a specific artifact.

OptionalconfigurationContributionId

configurationContributionId?: string

OptionalconfigurationContributionRelativeId

configurationContributionRelativeId?: string

OptionalcontentUri

contentUri?: string

OptionalcontributionId

contributionId?: string

The id of the underlying contribution defining the supplied Widget Configuration.

Optionaldashboard

dashboard?: Dashboard

Optional partial dashboard content, to support exchanging dashboard-level version ETag for widget-level APIs

OptionaleTag

eTag?: string

Optionalid

id?: string

OptionalisEnabled

isEnabled?: boolean

OptionalisNameConfigurable

isNameConfigurable?: boolean

OptionallightboxOptions

lightboxOptions?: LightboxOptions

OptionalloadingImageUrl

loadingImageUrl?: string

Optionalname

name?: string

Optionalposition

position?: WidgetPosition

Optionalsettings

settings?: string

OptionalsettingsVersion

settingsVersion?: SemanticVersion

Optionalsize

size?: WidgetSize

OptionaltypeId

typeId?: string

Optionalurl

url?: string

Settings

Member Visibility

On This Page

Properties