> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.DashTileDefinition

# <a id="SuperOffice_WebApi_Data_DashTileDefinition" /> Class DashTileDefinition

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for DashTileDefinition.
Dashboard Tile definition

```csharp theme={null}
public class DashTileDefinition : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get DashTileDefinition 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new DashAgent(configuration);
var dashTileDefinition = agent.GetDashTileDefinition( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_DashTileDefinition__ctor" /> DashTileDefinition()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public DashTileDefinition()
```

## Properties

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_CurrencyCode" /> CurrencyCode

Currency code

```csharp theme={null}
public virtual string CurrencyCode { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_CurrencyMode" /> CurrencyMode

Dashboard currency mode
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public DashTileCurrencyMode? CurrencyMode { get; set; }
```

#### Property Value

[DashTileCurrencyMode](SuperOffice.WebApi.Data.DashTileCurrencyMode.md)?

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[CurrencyMode\_String](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_CurrencyMode_String)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_CurrencyMode_String" /> CurrencyMode\_String

Dashboard currency mode
Raw string enum value.

```csharp theme={null}
[JsonProperty("CurrencyMode")]
public string CurrencyMode_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[CurrencyMode](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_CurrencyMode)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_DashboardTileDefinitionId" /> DashboardTileDefinitionId

Primary key

```csharp theme={null}
public virtual int DashboardTileDefinitionId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_DefaultHeight" /> DefaultHeight

Default height when added to a dashboard

```csharp theme={null}
public virtual int DefaultHeight { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_DefaultWidth" /> DefaultWidth

Default width when added to a dashboard

```csharp theme={null}
public virtual int DefaultWidth { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_Description" /> Description

Detailed description

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_EntityName" /> EntityName

The entity measured by this tile, defines what provider to use

```csharp theme={null}
public virtual string EntityName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_EntityType" /> EntityType

Dashboard entity type
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public DashTileEntityType? EntityType { get; set; }
```

#### Property Value

[DashTileEntityType](SuperOffice.WebApi.Data.DashTileEntityType.md)?

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[EntityType\_String](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_EntityType_String)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_EntityType_String" /> EntityType\_String

Dashboard entity type
Raw string enum value.

```csharp theme={null}
[JsonProperty("EntityType")]
public string EntityType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[EntityType](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_EntityType)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_LayoutConfig" /> LayoutConfig

The JSON formatted layout config

```csharp theme={null}
public virtual string LayoutConfig { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_Measure" /> Measure

Dashboard measure type (Count, Sum, Avg, etc.)
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public DashTileMeasure? Measure { get; set; }
```

#### Property Value

[DashTileMeasure](SuperOffice.WebApi.Data.DashTileMeasure.md)?

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[Measure\_String](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_Measure_String)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_MeasureByField" /> MeasureByField

Field to group by

```csharp theme={null}
public virtual string MeasureByField { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_MeasureField" /> MeasureField

Field to be measured

```csharp theme={null}
public virtual string MeasureField { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_Measure_String" /> Measure\_String

Dashboard measure type (Count, Sum, Avg, etc.)
Raw string enum value.

```csharp theme={null}
[JsonProperty("Measure")]
public string Measure_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[Measure](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_Measure)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_Name" /> Name

The name of the tile

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_ProviderName" /> ProviderName

Name of provider to use with this entity type - read only property

```csharp theme={null}
public virtual string ProviderName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_SecondarySelectionId" /> SecondarySelectionId

Selection holding the replaced or changed criterias (period comparisons etc)

```csharp theme={null}
public virtual int SecondarySelectionId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_SelectionId" /> SelectionId

Selection holding the criterias for the tile definition

```csharp theme={null}
public virtual int SelectionId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_SortBy" /> SortBy

Sort by field

```csharp theme={null}
public virtual string SortBy { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_TileType" /> TileType

Dashboard tile type
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public DashTileType? TileType { get; set; }
```

#### Property Value

[DashTileType](SuperOffice.WebApi.Data.DashTileType.md)?

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[TileType\_String](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_TileType_String)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_TileType_String" /> TileType\_String

Dashboard tile type
Raw string enum value.

```csharp theme={null}
[JsonProperty("TileType")]
public string TileType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[TileType](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_TileType)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_Usage" /> Usage

Where this tile can be used
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public DashTileUsage? Usage { get; set; }
```

#### Property Value

[DashTileUsage](SuperOffice.WebApi.Data.DashTileUsage.md)?

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[Usage\_String](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_Usage_String)

### <a id="SuperOffice_WebApi_Data_DashTileDefinition_Usage_String" /> Usage\_String

Where this tile can be used
Raw string enum value.

```csharp theme={null}
[JsonProperty("Usage")]
public string Usage_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[DashTileDefinition](SuperOffice.WebApi.Data.DashTileDefinition.md).[Usage](SuperOffice.WebApi.Data.DashTileDefinition.md#SuperOffice_WebApi_Data_DashTileDefinition_Usage)

## See Also

[DashAgent](SuperOffice.WebApi.Agents.DashAgent.md)


## Related topics

- [SuperOffice.WebApi.Agents.DashAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DashAgent.md)
- [SuperOffice.WebApi.Agents.IDashAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDashAgent.md)
- [SuperOffice.WebApi.Data.DashTile](/en/api/reference/webapi/SuperOffice.WebApi.Data.DashTile.md)
- [SuperOffice.WebApi.Data.DashTileUsage](/en/api/reference/webapi/SuperOffice.WebApi.Data.DashTileUsage.md)
- [SuperOffice.WebApi.Data.Dash AddNewTileToDashboardRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_AddNewTileToDashboardRequest.md)
- [SuperOffice.WebApi.Data.Dash CreateDefaultTileDefinitionForEntityRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_CreateDefaultTileDefinitionForEntityRequest.md)