Class NSDashAgent
Carrier object for managing various dashboard operations.
Constructors
NSDashAgent()
Initializes a new instance of the NSDashAgent class.
Declaration
NSDashAgentMethods
AddNewTileToDashboard(Integer, NSDashTileDefinition)
Adds a new tile to the specified dashboard.
Declaration
NSDashTile AddNewTileToDashboard(Integer dashboardId, NSDashTileDefinition tileDefinition)Parameters
| Type | Name | Description |
| Integer | dashboardId | |
| NSDashTileDefinition | tileDefinition |
Returns
| Type | Description |
| NSDashTile |
AddTileToDashboard(Integer, Integer)
Adds an existing tile to a specified dashboard.
Declaration
NSDashTile AddTileToDashboard(Integer dashboardId, Integer tileId)Parameters
| Type | Name | Description |
| Integer | dashboardId | |
| Integer | tileId |
Returns
| Type | Description |
| NSDashTile |
CopyTileSelection(Integer)
Copies the specified tile selection.
Declaration
Integer CopyTileSelection(Integer selectionId)Parameters
| Type | Name | Description |
| Integer | selectionId |
Returns
| Type | Description |
| Integer |
CreateDashTileSelectionFromEntity(String)
Creates a dash tile selection based on the specified entity.
Declaration
Integer CreateDashTileSelectionFromEntity(String entity)Parameters
| Type | Name | Description |
| String | entity |
Returns
| Type | Description |
| Integer |
CreateDefaultDash
Generates a default dashboard.
Declaration
NSDash CreateDefaultDash()Returns
| Type | Description |
| NSDash |
CreateDefaultDashCollection
Generates a default collection of dashboards.
Declaration
NSDashCollection CreateDefaultDashCollection()Returns
| Type | Description |
| NSDashCollection |
CreateDefaultDashTheme
Creates a default theme for dashboards.
Declaration
NSDashTheme CreateDefaultDashTheme()Returns
| Type | Description |
| NSDashTheme |
CreateDefaultDashTile
Generates a default tile for dashboards.
Declaration
NSDashTile CreateDefaultDashTile()Returns
| Type | Description |
| NSDashTile |
CreateDefaultDashTileDefinition
Creates a default definition for a dashboard tile.
Declaration
NSDashTileDefinition CreateDefaultDashTileDefinition()Returns
| Type | Description |
| NSDashTileDefinition |
CreateDefaultPreviewDash
Generates a default preview dashboard.
Declaration
NSPreviewDash CreateDefaultPreviewDash()Returns
| Type | Description |
| NSPreviewDash |
CreateDefaultPreviewDashTile
Creates a default tile for preview dashboards.
Declaration
NSPreviewDashTile CreateDefaultPreviewDashTile()Returns
| Type | Description |
| NSPreviewDashTile |
CreateDefaultTileForEntity(String)
Creates a default tile for the specified entity.
Declaration
NSDashTile CreateDefaultTileForEntity(String entity)Parameters
| Type | Name | Description |
| String | entity |
Returns
| Type | Description |
| NSDashTile |
DeleteDash(Integer)
Deletes a specified dashboard.
Declaration
Void DeleteDash(Integer dashId)Parameters
| Type | Name | Description |
| Integer | dashId |
Returns
| Type | Description |
| Void |
DeleteDashTheme(Integer)
Deletes the specified dashboard theme.
Declaration
Void DeleteDashTheme(Integer themeId)Parameters
| Type | Name | Description |
| Integer | themeId |
Returns
| Type | Description |
| Void |
DeleteDashTile(Integer)
Deletes a specified dashboard tile.
Declaration
Void DeleteDashTile(Integer tileId)Parameters
| Type | Name | Description |
| Integer | tileId |
Returns
| Type | Description |
| Void |
DeleteDashTileDefinition(Integer)
Deletes the specified tile definition.
Declaration
Void DeleteDashTileDefinition(Integer tileDefinitionId)Parameters
| Type | Name | Description |
| Integer | tileDefinitionId |
Returns
| Type | Description |
| Void |
DuplicateDashboard(Integer, String)
Creates a copy of the specified dashboard with a new name.
Declaration
NSDash DuplicateDashboard(Integer dashId, String newName)Parameters
| Type | Name | Description |
| Integer | dashId | |
| String | newName |
Returns
| Type | Description |
| NSDash |
DuplicateTile(Integer, String)
Duplicates a tile with a new name.
Declaration
NSDashTile DuplicateTile(Integer tileId, String newName)Parameters
| Type | Name | Description |
| Integer | tileId | |
| String | newName |
Returns
| Type | Description |
| NSDashTile |
GetDash(Integer)
Retrieves a specific dashboard by ID.
Declaration
NSDash GetDash(Integer dashId)Parameters
| Type | Name | Description |
| Integer | dashId |
Returns
| Type | Description |
| NSDash |
GetDashCollection
Retrieves the current collection of dashboards.
Declaration
NSDashCollection GetDashCollection()Returns
| Type | Description |
| NSDashCollection |
GetDashList(Integer[])
Retrieves a list of dashboards based on an array of IDs.
Declaration
NSDash[] GetDashList(Integer[] dashIds)Parameters
| Type | Name | Description |
| Integer[] | dashIds |
Returns
| Type | Description |
| NSDash[] |
GetDashTheme(Integer)
Retrieves a specific dashboard theme by ID.
Declaration
NSDashTheme GetDashTheme(Integer themeId)Parameters
| Type | Name | Description |
| Integer | themeId |
Returns
| Type | Description |
| NSDashTheme |
GetDashTile(Integer)
Retrieves a specific tile from a dashboard by ID.
Declaration
NSDashTile GetDashTile(Integer tileId)Parameters
| Type | Name | Description |
| Integer | tileId |
Returns
| Type | Description |
| NSDashTile |
GetDashTileDefinition(Integer)
Retrieves a tile definition by ID.
Declaration
NSDashTileDefinition GetDashTileDefinition(Integer tileDefinitionId)Parameters
| Type | Name | Description |
| Integer | tileDefinitionId |
Returns
| Type | Description |
| NSDashTileDefinition |
GetDashTileHtml(Integer, String)
Retrieves the HTML content for a specific dashboard tile.
Declaration
NSDashTileHtml GetDashTileHtml(Integer tileId, String context)Parameters
| Type | Name | Description |
| Integer | tileId | |
| String | context |
Returns
| Type | Description |
| NSDashTileHtml |
GetDashTileHtmlList(Integer)
Retrieves a list of HTML content for all tiles in a dashboard.
Declaration
NSDashTileHtml[] GetDashTileHtmlList(Integer dashId)Parameters
| Type | Name | Description |
| Integer | dashId |
Returns
| Type | Description |
| NSDashTileHtml[] |
GetDashTiles(Integer)
Retrieves all tiles in the specified dashboard.
Declaration
NSDashTile[] GetDashTiles(Integer dashId)Parameters
| Type | Name | Description |
| Integer | dashId |
Returns
| Type | Description |
| NSDashTile[] |
GetPreviewDash(Integer)
Retrieves a preview version of a specific dashboard.
Declaration
NSPreviewDash GetPreviewDash(Integer dashId)Parameters
| Type | Name | Description |
| Integer | dashId |
Returns
| Type | Description |
| NSPreviewDash |
GetSecondaryTempTileSelection(Integer)
Retrieves the secondary temporary tile selection by ID.
Declaration
Integer GetSecondaryTempTileSelection(Integer selectionId)Parameters
| Type | Name | Description |
| Integer | selectionId |
Returns
| Type | Description |
| Integer |
GetTempTileSelection(Integer)
Retrieves the temporary tile selection by ID.
Declaration
Integer GetTempTileSelection(Integer selectionId)Parameters
| Type | Name | Description |
| Integer | selectionId |
Returns
| Type | Description |
| Integer |
SaveDash(NSDash)
Saves the specified dashboard with given data.
Declaration
NSDash SaveDash(NSDash dashData)Parameters
| Type | Name | Description |
| NSDash | dashData |
Returns
| Type | Description |
| NSDash |
SaveDashTheme(NSDashTheme)
Saves the specified dashboard theme.
Declaration
NSDashTheme SaveDashTheme(NSDashTheme theme)Parameters
| Type | Name | Description |
| NSDashTheme | theme |
Returns
| Type | Description |
| NSDashTheme |
SaveDashTile(NSDashTile)
Saves the specified dashboard tile.
Declaration
NSDashTile SaveDashTile(NSDashTile tile)Parameters
| Type | Name | Description |
| NSDashTile | tile |
Returns
| Type | Description |
| NSDashTile |
SaveDashTileDefinition(NSDashTileDefinition)
Saves the specified dashboard tile definition.
Declaration
NSDashTileDefinition SaveDashTileDefinition(NSDashTileDefinition tileDefinition)Parameters
| Type | Name | Description |
| NSDashTileDefinition | tileDefinition |
Returns
| Type | Description |
| NSDashTileDefinition |
SaveDashTileHtmlList(Integer, NSDashTileHtml[])
Saves a list of HTML content for dashboard tiles.
Declaration
NSDashTileHtml[] SaveDashTileHtmlList(Integer dashId, NSDashTileHtml[] tileHtmlList)Parameters
| Type | Name | Description |
| Integer | dashId | |
| NSDashTileHtml[] | tileHtmlList |
Returns
| Type | Description |
| NSDashTileHtml[] |
SaveDashTiles(Integer, NSDashTile[])
Saves multiple tiles for the specified dashboard.
Declaration
Void SaveDashTiles(Integer dashId, NSDashTile[] tiles)Parameters
| Type | Name | Description |
| Integer | dashId | |
| NSDashTile[] | tiles |
Returns
| Type | Description |
| Void |