Class NSDashTileDefinition
Defines a dashboard tile with various settings.
Constructors
NSDashTileDefinition()
Initializes a new instance of the NSDashTileDefinition class.
Declaration
NSDashTileDefinitionMethods
GetCurrencyCode()
Returns the currency code for the dashboard tile.
Declaration
String GetCurrencyCode()Returns
| Type | Description |
| String |
GetCurrencyMode()
Retrieves the currency mode of the dashboard tile.
Declaration
Integer GetCurrencyMode()Returns
| Type | Description |
| Integer | The currency mode of the dashboard tile. |
GetDashboardTileDefinitionId()
Gets the primary key ID of the dashboard tile definition.
Declaration
Integer GetDashboardTileDefinitionId()Returns
| Type | Description |
| Integer | Primary key ID of the dashboard tile. |
GetDefaultHeight()
Retrieves the default height of the dashboard tile.
Declaration
Integer GetDefaultHeight()Returns
| Type | Description |
| Integer | The default height of the dashboard tile. |
GetDefaultWidth()
Retrieves the default width of the dashboard tile.
Declaration
Integer GetDefaultWidth()Returns
| Type | Description |
| Integer | The default width of the dashboard tile. |
GetDescription()
Retrieves the description of the dashboard tile.
Declaration
String GetDescription()Returns
| Type | Description |
| String | The description of the dashboard tile. |
GetEntityName()
Retrieves the entity name measured by the dashboard tile.
Declaration
String GetEntityName()Returns
| Type | Description |
| String | The entity name measured by the dashboard tile. |
GetEntityType()
Retrieves the entity type of the dashboard tile.
Declaration
Integer GetEntityType()Returns
| Type | Description |
| Integer | The entity type of the dashboard tile. |
GetLayoutConfig()
Retrieves the JSON formatted layout configuration of the dashboard tile.
Declaration
String GetLayoutConfig()Returns
| Type | Description |
| String | The JSON formatted layout configuration of the dashboard tile. |
GetMeasure()
Retrieves the measure type of the dashboard tile.
Declaration
Integer GetMeasure()Returns
| Type | Description |
| Integer | The measure type of the dashboard tile. |
GetMeasureByField()
Retrieves the field used to group data in the dashboard tile.
Declaration
String GetMeasureByField()Returns
| Type | Description |
| String | The field used to group data by the dashboard tile. |
GetMeasureField()
Retrieves the field to be measured by the dashboard tile.
Declaration
String GetMeasureField()Returns
| Type | Description |
| String | The field to be measured by the dashboard tile. |
GetName()
Retrieves the name of the dashboard tile.
Declaration
String GetName()Returns
| Type | Description |
| String | The name of the dashboard tile. |
GetProviderName()
Retrieves the provider name used with this entity type.
Declaration
String GetProviderName()Returns
| Type | Description |
| String | The name of the provider used with this entity type. |
GetSecondarySelectionId()
Retrieves the secondary selection ID for period comparisons.
Declaration
Integer GetSecondarySelectionId()Returns
| Type | Description |
| Integer | The secondary selection ID for period comparisons. |
GetSelectionId()
Gets the selection criteria ID of the tile definition.
Declaration
Integer GetSelectionId()Returns
| Type | Description |
| Integer | Selection ID defining the criteria for the tile. |
GetSortBy()
Retrieves the sort field for the dashboard tile.
Declaration
String GetSortBy()Returns
| Type | Description |
| String | The field by which the dashboard tile is sorted. |
GetTileType()
Retrieves the type of the dashboard tile.
Declaration
Integer GetTileType()Returns
| Type | Description |
| Integer | The type of the dashboard tile. |
GetUsage()
Retrieves where the dashboard tile can be used.
Declaration
Integer GetUsage()Returns
| Type | Description |
| Integer | Where the dashboard tile can be used. |
SetCurrencyCode(String)
Sets the currency code for the dashboard tile.
Declaration
Void SetCurrencyCode(String currencyCode)Parameters
| Type | Name | Description |
| String | currencyCode | Currency code to be set for the tile. |
Returns
| Type | Description |
| Void |
SetCurrencyMode(Integer)
Sets the currency mode of the dashboard tile.
Declaration
Void SetCurrencyMode(Integer mode)Parameters
| Type | Name | Description |
| Integer | mode | The currency mode to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetDashboardTileDefinitionId(Integer)
Sets the primary key ID of the dashboard tile definition.
Declaration
Void SetDashboardTileDefinitionId(Integer id)Parameters
| Type | Name | Description |
| Integer | id | The primary key ID to set for the dashboard tile definition. |
Returns
| Type | Description |
| Void |
SetDefaultHeight(Integer)
Sets the default height of the dashboard tile.
Declaration
Void SetDefaultHeight(Integer height)Parameters
| Type | Name | Description |
| Integer | height | The default height to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetDefaultWidth(Integer)
Sets the default width of the dashboard tile.
Declaration
Void SetDefaultWidth(Integer width)Parameters
| Type | Name | Description |
| Integer | width | The default width to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Sets the description of the dashboard tile.
Declaration
Void SetDescription(String description)Parameters
| Type | Name | Description |
| String | description | The description to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetEntityName(String)
Sets the entity name measured by the dashboard tile.
Declaration
Void SetEntityName(String entityName)Parameters
| Type | Name | Description |
| String | entityName | The entity name to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetEntityType(Integer)
Sets the entity type of the dashboard tile.
Declaration
Void SetEntityType(Integer entityType)Parameters
| Type | Name | Description |
| Integer | entityType | The entity type to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetLayoutConfig(String)
Sets the JSON formatted layout configuration of the dashboard tile.
Declaration
Void SetLayoutConfig(String layoutConfig)Parameters
| Type | Name | Description |
| String | layoutConfig | The JSON formatted layout configuration to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetMeasure(Integer)
Sets the measure type of the dashboard tile.
Declaration
Void SetMeasure(Integer measure)Parameters
| Type | Name | Description |
| Integer | measure | The measure type to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetMeasureByField(String)
Sets the field to group data in the dashboard tile.
Declaration
Void SetMeasureByField(String measureByField)Parameters
| Type | Name | Description |
| String | measureByField | The field to set for grouping data in the dashboard tile. |
Returns
| Type | Description |
| Void |
SetMeasureField(String)
Sets the field to be measured by the dashboard tile.
Declaration
Void SetMeasureField(String measureField)Parameters
| Type | Name | Description |
| String | measureField | The field to set for measurement by the dashboard tile. |
Returns
| Type | Description |
| Void |
SetName(String)
Sets the name of the dashboard tile.
Declaration
Void SetName(String name)Parameters
| Type | Name | Description |
| String | name | The name to set for the dashboard tile. |
Returns
| Type | Description |
| Void |
SetProviderName(String)
Sets the provider name for the specified entity type.
Declaration
Void SetProviderName(String providerName)Parameters
| Type | Name | Description |
| String | providerName | The name of the provider to set for this entity type. |
Returns
| Type | Description |
| Void |
SetSecondarySelectionId(Integer)
Sets the secondary selection ID for period comparisons.
Declaration
Void SetSecondarySelectionId(Integer secondarySelectionId)Parameters
| Type | Name | Description |
| Integer | secondarySelectionId | The secondary selection ID for period comparisons. |
Returns
| Type | Description |
| Void |
SetSelectionId(Integer)
Sets the selection ID for the tile definition criteria.
Declaration
Void SetSelectionId(Integer selectionId)Parameters
| Type | Name | Description |
| Integer | selectionId | The selection ID to set for the tile definition criteria. |
Returns
| Type | Description |
| Void |
SetSortBy(String)
Sets the sort field for the dashboard tile.
Declaration
Void SetSortBy(String sortBy)Parameters
| Type | Name | Description |
| String | sortBy | The field to set for sorting the dashboard tile. |
Returns
| Type | Description |
| Void |