> ## 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.

# NSDashTileDefinition

> Defines a dashboard tile with various settings.

Defines a dashboard tile with various settings.

## Constructors

### NSDashTileDefinition()

```crmscript theme={null}
NSDashTileDefinition
```

Initializes a new instance of the NSDashTileDefinition class.

## Methods

## GetCurrencyCode()

Returns the currency code for the dashboard tile.

```crmscript theme={null}
String GetCurrencyCode()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String)

## GetCurrencyMode()

Retrieves the currency mode of the dashboard tile.

```crmscript theme={null}
Integer GetCurrencyMode()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The currency mode of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetDashboardTileDefinitionId()

Gets the primary key ID of the dashboard tile definition.

```crmscript theme={null}
Integer GetDashboardTileDefinitionId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key ID of the dashboard tile.

## GetDefaultHeight()

Retrieves the default height of the dashboard tile.

```crmscript theme={null}
Integer GetDefaultHeight()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The default height of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetDefaultWidth()

Retrieves the default width of the dashboard tile.

```crmscript theme={null}
Integer GetDefaultWidth()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The default width of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetDescription()

Retrieves the description of the dashboard tile.

```crmscript theme={null}
String GetDescription()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The description of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetEntityName()

Retrieves the entity name measured by the dashboard tile.

```crmscript theme={null}
String GetEntityName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The entity name measured by the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetEntityType()

Retrieves the entity type of the dashboard tile.

```crmscript theme={null}
Integer GetEntityType()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The entity type of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetLayoutConfig()

Retrieves the JSON formatted layout configuration of the dashboard tile.

```crmscript theme={null}
String GetLayoutConfig()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The JSON formatted layout configuration of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetMeasure()

Retrieves the measure type of the dashboard tile.

```crmscript theme={null}
Integer GetMeasure()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The measure type of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetMeasureByField()

Retrieves the field used to group data in the dashboard tile.

```crmscript theme={null}
String GetMeasureByField()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The field used to group data by the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetMeasureField()

Retrieves the field to be measured by the dashboard tile.

```crmscript theme={null}
String GetMeasureField()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The field to be measured by the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetName()

Retrieves the name of the dashboard tile.

```crmscript theme={null}
String GetName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetProviderName()

Retrieves the provider name used with this entity type.

```crmscript theme={null}
String GetProviderName()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The name of the provider used with this entity type.

<Note>
  Generated from NetServer
</Note>

## GetSecondarySelectionId()

Retrieves the secondary selection ID for period comparisons.

```crmscript theme={null}
Integer GetSecondarySelectionId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The secondary selection ID for period comparisons.

<Note>
  Generated from NetServer
</Note>

## GetSelectionId()

Gets the selection criteria ID of the tile definition.

```crmscript theme={null}
Integer GetSelectionId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Selection ID defining the criteria for the tile.

## GetSortBy()

Retrieves the sort field for the dashboard tile.

```crmscript theme={null}
String GetSortBy()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The field by which the dashboard tile is sorted.

<Note>
  Generated from NetServer
</Note>

## GetTileType()

Retrieves the type of the dashboard tile.

```crmscript theme={null}
Integer GetTileType()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - The type of the dashboard tile.

<Note>
  Generated from NetServer
</Note>

## GetUsage()

Retrieves where the dashboard tile can be used.

```crmscript theme={null}
Integer GetUsage()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Where the dashboard tile can be used.

<Note>
  Generated from NetServer
</Note>

## SetCurrencyCode(String)

Sets the currency code for the dashboard tile.

```crmscript theme={null}
Void SetCurrencyCode(String currencyCode)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## SetCurrencyMode(Integer)

Sets the currency mode of the dashboard tile.

```crmscript theme={null}
Void SetCurrencyMode(Integer mode)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetDashboardTileDefinitionId(Integer)

Sets the primary key ID of the dashboard tile definition.

```crmscript theme={null}
Void SetDashboardTileDefinitionId(Integer id)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetDefaultHeight(Integer)

Sets the default height of the dashboard tile.

```crmscript theme={null}
Void SetDefaultHeight(Integer height)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetDefaultWidth(Integer)

Sets the default width of the dashboard tile.

```crmscript theme={null}
Void SetDefaultWidth(Integer width)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetDescription(String)

Sets the description of the dashboard tile.

```crmscript theme={null}
Void SetDescription(String description)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetEntityName(String)

Sets the entity name measured by the dashboard tile.

```crmscript theme={null}
Void SetEntityName(String entityName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetEntityType(Integer)

Sets the entity type of the dashboard tile.

```crmscript theme={null}
Void SetEntityType(Integer entityType)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetLayoutConfig(String)

Sets the JSON formatted layout configuration of the dashboard tile.

```crmscript theme={null}
Void SetLayoutConfig(String layoutConfig)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetMeasure(Integer)

Sets the measure type of the dashboard tile.

```crmscript theme={null}
Void SetMeasure(Integer measure)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetMeasureByField(String)

Sets the field to group data in the dashboard tile.

```crmscript theme={null}
Void SetMeasureByField(String measureByField)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetMeasureField(String)

Sets the field to be measured by the dashboard tile.

```crmscript theme={null}
Void SetMeasureField(String measureField)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetName(String)

Sets the name of the dashboard tile.

```crmscript theme={null}
Void SetName(String name)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetProviderName(String)

Sets the provider name for the specified entity type.

```crmscript theme={null}
Void SetProviderName(String providerName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetSecondarySelectionId(Integer)

Sets the secondary selection ID for period comparisons.

```crmscript theme={null}
Void SetSecondarySelectionId(Integer secondarySelectionId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetSelectionId(Integer)

Sets the selection ID for the tile definition criteria.

```crmscript theme={null}
Void SetSelectionId(Integer selectionId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetSortBy(String)

Sets the sort field for the dashboard tile.

```crmscript theme={null}
Void SetSortBy(String sortBy)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetTileType(Integer)

Sets the type of the dashboard tile.

```crmscript theme={null}
Void SetTileType(Integer type)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>

## SetUsage(Integer)

Sets where the dashboard tile can be used.

```crmscript theme={null}
Void SetUsage(Integer usage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  Generated from NetServer
</Note>


## Related topics

- [NSDashTile](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashTile.md)
- [NSDashAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashAgent.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [Delete Dash Tile Definition](/en/api/reference/restful/rest/dashtiledefinition/delete-dash-tile-definition.md)
- [Get Dash Tile Definition](/en/api/reference/restful/rest/dashtiledefinition/get-dash-tile-definition.md)
- [Post Dash Tile Definition](/en/api/reference/restful/rest/dashtiledefinition/post-dash-tile-definition.md)