WidgetManager

definitely-typed › Akumina › Digispace › Data › WidgetManager

Hierarchy

• WidgetManager

Index

Methods

• AddDashboardWidgetInstance
• AreDashboardContainerWidgets
• CopyWidgetInstance
• GetAndInitWidgetsPerJSFile
• GetManualDependencyMap
• GetNextAkId
• GetSiteId
• GetWidgetInstances
• GetWidgetInstancesOnPage
• GetWidgetJSArrayFromWidget
• GetWidgetJSFromDependency
• GetWidgetManagerApp
• GetWidgetManagerAppAuthorization
• GetWidgetObjsOnPage
• GetWidgetPropertiesForInstances
• GetWidgetViews
• InitWidget
• InitializeChildWidgetsWithOverride
• InitializeWidgets
• PopulateAutoDependencyMap
• RenderChildWidgets

Methods

AddDashboardWidgetInstance

▸ AddDashboardWidgetInstance(dashboardWidgetTitle: string, widgetInstance: any): JQueryDeferred‹any›

Defined in index.d.ts:560

Add dashboard widget instance

Parameters:

Name	Type
dashboardWidgetTitle	string
widgetInstance	any

Returns: JQueryDeferred‹any›

---

AreDashboardContainerWidgets

▸ AreDashboardContainerWidgets(widgetInstanceIds: any[]): JQueryDeferred‹any›

Defined in index.d.ts:558

Check if widgetinstances are Dashboard Container widgets

Parameters:

Name	Type
widgetInstanceIds	any[]

Returns: JQueryDeferred‹any›

---

CopyWidgetInstance

▸ CopyWidgetInstance(widgetInstanceId: string): JQueryDeferred‹any›

Defined in index.d.ts:562

Copy Widget Instance

Parameters:

Name	Type
widgetInstanceId	string

Returns: JQueryDeferred‹any›

---

GetAndInitWidgetsPerJSFile

▸ GetAndInitWidgetsPerJSFile(item: any, widgetDepJsArray: any[]): void

Defined in index.d.ts:615

Parameters:

Name	Type
item	any
widgetDepJsArray	any[]

Returns: void

---

GetManualDependencyMap

▸ GetManualDependencyMap(widgetName: string): any[]

Defined in index.d.ts:563

Parameters:

Name	Type
widgetName	string

Returns: any[]

---

GetNextAkId

▸ GetNextAkId(): JQueryDeferred‹any›

Defined in index.d.ts:565

Resolves with next AkId

Returns: JQueryDeferred‹any›

---

GetSiteId

▸ GetSiteId(): JQueryDeferred‹any›

Defined in index.d.ts:567

Resolves with siteId

Returns: JQueryDeferred‹any›

---

GetWidgetInstances

▸ GetWidgetInstances(): JQueryDeferred‹any›

Defined in index.d.ts:571

Returns: JQueryDeferred‹any›

Resolves with Array with object of all the widget Instances

---

GetWidgetInstancesOnPage

▸ GetWidgetInstancesOnPage(): any

Defined in index.d.ts:602

Retrives all the widget instances ID on the current page.

Returns: any

object with ids: string[] & rel: Array<>

---

GetWidgetJSArrayFromWidget

▸ GetWidgetJSArrayFromWidget(widgetName: string, widgetToDeps: any[], depJsFiles: any[]): any[]

Defined in index.d.ts:596

Get js file list for dependent widgets

Parameters:

Name	Type	Description
widgetName	string	-
widgetToDeps	any[]	-
depJsFiles	any[]

Returns: any[]

---

GetWidgetJSFromDependency

▸ GetWidgetJSFromDependency(widgets: any[]): JQueryDeferred‹any›

Defined in index.d.ts:597

Parameters:

Name	Type
widgets	any[]

Returns: JQueryDeferred‹any›

---

GetWidgetManagerApp

▸ GetWidgetManagerApp(): JQueryDeferred‹any›

Defined in index.d.ts:579

Returns: JQueryDeferred‹any›

def Resolves in success with Widget Manager Instance ID

---

GetWidgetManagerAppAuthorization

▸ GetWidgetManagerAppAuthorization(): JQueryDeferred‹any›

Defined in index.d.ts:575

Returns: JQueryDeferred‹any›

def Resolves in success with Object with authorized user groups

---

GetWidgetObjsOnPage

▸ GetWidgetObjsOnPage(widgets: any[]): any[]

Defined in index.d.ts:607

Get list of widget on current page.

Parameters:

Name	Type	Description
widgets	any[]

Returns: any[]

---

GetWidgetPropertiesForInstances

▸ GetWidgetPropertiesForInstances(widgetInstanceIds: string[] | null): JQueryDeferred‹any›

Defined in index.d.ts:589

#MARK - dataType correction

Parameters:

Name	Type	Description
widgetInstanceIds	string[] | null	Array of widget Instance Ids

Returns: JQueryDeferred‹any›

---

GetWidgetViews

▸ GetWidgetViews(widgetType: string): JQueryDeferred‹any›

Defined in index.d.ts:584

Parameters:

Name	Type	Description
widgetType	string	WidgetType

Returns: JQueryDeferred‹any›

def Resolves in success with array of objects of widget view of widgetType passed

---

InitWidget

▸ InitWidget(item: any): void

Defined in index.d.ts:610

Initialize widget passed

Parameters:

Name	Type
item	any

Returns: void

---

InitializeChildWidgetsWithOverride

▸ InitializeChildWidgetsWithOverride(widgetIds: string[], pageId: string, widgetProps: any[], view: string): any

Defined in index.d.ts:553

Parameters:

Name	Type
widgetIds	string[]
pageId	string
widgetProps	any[]
view	string

Returns: any

---

InitializeWidgets

▸ InitializeWidgets(widgets: any[]): JQueryDeferred‹any›

Defined in index.d.ts:613

Initialize widgets passed in array

Parameters:

Name	Type
widgets	any[]

Returns: JQueryDeferred‹any›

---

PopulateAutoDependencyMap

▸ PopulateAutoDependencyMap(widgetsWithPropsArray: any[], widgetArray: any[]): any[]

Defined in index.d.ts:616

Parameters:

Name	Type
widgetsWithPropsArray	any[]
widgetArray	any[]

Returns: any[]

---

RenderChildWidgets

▸ RenderChildWidgets(selector: string, pageId: string | null, mode: string): void

Defined in index.d.ts:623

Render Child Widgets

Parameters:

Name	Type	Description
selector	string	-
pageId	string | null	-
mode	string

Returns: void