Class DashTileDefinition
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for DashTileDefinition.
Dashboard Tile definition
Inheritance
object ←
Carrier ←
DashTileDefinition
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get DashTileDefinition 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new DashAgent(configuration);
var dashTileDefinition = agent.GetDashTileDefinition( 123 );
Constructors
DashTileDefinition()
Default constructor - defaults any enum props to 0.
Properties
CurrencyCode
Currency code
Property Value
string
CurrencyMode
Dashboard currency mode
NULL if unknown enum value.
Property Value
DashTileCurrencyMode?
See Also
DashTileDefinition.CurrencyMode_String
CurrencyMode_String
Dashboard currency mode
Raw string enum value.
Property Value
string
See Also
DashTileDefinition.CurrencyMode
DashboardTileDefinitionId
Primary key
Property Value
int
DefaultHeight
Default height when added to a dashboard
Property Value
int
DefaultWidth
Default width when added to a dashboard
Property Value
int
Description
Detailed description
Property Value
string
EntityName
The entity measured by this tile, defines what provider to use
Property Value
string
EntityType
Dashboard entity type
NULL if unknown enum value.
Property Value
DashTileEntityType?
See Also
DashTileDefinition.EntityType_String
EntityType_String
Dashboard entity type
Raw string enum value.
Property Value
string
See Also
DashTileDefinition.EntityType
LayoutConfig
The JSON formatted layout config
Property Value
string
Measure
Dashboard measure type (Count, Sum, Avg, etc.)
NULL if unknown enum value.
Property Value
DashTileMeasure?
See Also
DashTileDefinition.Measure_String
MeasureByField
Field to group by
Property Value
string
MeasureField
Field to be measured
Property Value
string
Measure_String
Dashboard measure type (Count, Sum, Avg, etc.)
Raw string enum value.
Property Value
string
See Also
DashTileDefinition.Measure
Name
The name of the tile
Property Value
string
ProviderName
Name of provider to use with this entity type - read only property
Property Value
string
SecondarySelectionId
Selection holding the replaced or changed criterias (period comparisons etc)
Property Value
int
SelectionId
Selection holding the criterias for the tile definition
Property Value
int
SortBy
Sort by field
Property Value
string
TileType
Dashboard tile type
NULL if unknown enum value.
Property Value
DashTileType?
See Also
DashTileDefinition.TileType_String
TileType_String
Dashboard tile type
Raw string enum value.
Property Value
string
See Also
DashTileDefinition.TileType
Usage
Where this tile can be used
NULL if unknown enum value.
Property Value
DashTileUsage?
See Also
DashTileDefinition.Usage_String
Usage_String
Where this tile can be used
Raw string enum value.
Property Value
string
See Also
DashTileDefinition.Usage
See Also
DashAgent
