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

# NSDash

> Carrier object for NSDash.

Carrier object for NSDash.

## Constructors

### NSDash()

```crmscript theme={null}
NSDash
```

Initializes a new instance of the NSDash class.

## Methods

## GetAssociateId()

Associate who owns this dashboard.

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

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

## GetColumns()

How many columns there are in the dashboard.

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

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

## GetDashboardId()

Primary key of dashboard.

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

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

## GetDescription()

Detailed description of the dashboard.

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

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

## GetName()

Gets name the dashboard.

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

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

## GetPinForAll()

Returns 1 if pinned for all.

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

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

## GetPinForAssociates()

Returns array of references to the pinned associates.

```crmscript theme={null}
Integer[] GetPinForAssociates()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)\[]

## GetPinForGroups()

Returns array of references to the pinned groups.

```crmscript theme={null}
Integer[] GetPinForGroups()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)\[]

## GetTheme()

Returns the theme for this dashboard.

```crmscript theme={null}
NSDashTheme GetTheme()
```

**Returns:** [CRMScript.Netserver.NSDashTheme](CRMScript.Netserver.NSDashTheme)

## GetUniqueId()

Returns GUID identifying a default dashboard from SuperOffice.

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

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

## GetVisibleForAll()

Returns 1 if visible for all.

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

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

## GetVisibleForAssociates()

Returns array of references to the visible for associates.

```crmscript theme={null}
Integer[] GetVisibleForAssociates()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)\[]

## GetVisibleForGroups()

Returns array of references to the visible for groups.

```crmscript theme={null}
Integer[] GetVisibleForGroups()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer)\[]

## SetAssociateId(Integer)

Associate who owns this dashboard.

```crmscript theme={null}
Void SetAssociateId(Integer associateId)
```

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

## SetColumns(Integer)

How many columns there are in the dashboard.

```crmscript theme={null}
Void SetColumns(Integer cols)
```

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

## SetDashboardId(Integer)

Primary key of dashboard.

```crmscript theme={null}
Void SetDashboardId(Integer dashId)
```

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

## SetDescription(String)

Detailed description of the dashboard.

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

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

## SetName(String)

Sets name the dashboard.

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

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

## SetPinForAll(Integer)

Set to 1 if pinned for all.

```crmscript theme={null}
Void SetPinForAll(Integer pinned)
```

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

## SetPinForAssociates(Integer\[])

Set an array of references to pinned associates.

```crmscript theme={null}
Void SetPinForAssociates(Integer[] assocList)
```

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

## SetPinForGroups(Integer\[])

Set an array of references to pinned groups.

```crmscript theme={null}
Void SetPinForGroups(Integer[] groups)
```

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

## SetTheme(NSDashTheme)

Sets the theme for this dashboard.

```crmscript theme={null}
Void SetTheme(NSDashTheme theme)
```

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

## SetUniqueId(String)

Sets GUID identifying a default dashboard from SuperOffice.

```crmscript theme={null}
Void SetUniqueId(String guid)
```

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

## SetVisibleForAll(Integer)

Set to 1 if visible for all.

```crmscript theme={null}
Void SetVisibleForAll(Integer visible)
```

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

## SetVisibleForAssociates(Integer\[])

Set an array of references to visible for associates.

```crmscript theme={null}
Void SetVisibleForAssociates(Integer[] assocList)
```

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

## SetVisibleForGroups(Integer\[])

Set an array of references to visible for groups.

```crmscript theme={null}
Void SetVisibleForGroups(Integer[] groups)
```

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


## Related topics

- [NSDashAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashAgent.md)
- [NSDashCollection](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashCollection.md)
- [NSDashTheme](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashTheme.md)
- [NSDashTile](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashTile.md)
- [NSDashTileHtml](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashTileHtml.md)
- [NSDashTileDefinition](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashTileDefinition.md)