---
title: "Indicator (Basic)"
canonical: "https://docs.cuesystem.com/space/CVCGC/404324353/Indicator%20(Basic)"
format: markdown
---
> Macro (toc)

---

# Description

This object can indicate two states - it simulates LED. Up to five ActiveColors are available. BlinkPeriod and BlinkDutyCycle can be set. Up to eight object sizes can be selected.

![image](media://1f5be1f5-379c-4ec8-aab7-a199f7712511)

#  Properties

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Behavior |
| BlinkDutyCycle | Byte | 0 to 255 | 128 | The DutyCycle is the time spent in an ActiveColor as a fraction of the total BlinkPeriod time. |
| BlinkPeriod | Time | Any non-negative | :0 | It is a total time between two ActiveColors. |
| Value | Boolean | True   
False | False | True means ActiveColor is displayed. |
| Appearance |
| ActiveColor | Long | 1 = Blue  
2 = Green  
3 = Yellow  
4 = Orange  
5 = Purple | 1 | Color of active state |
| ObjectSize | Long | 0 = Drag&Fit  
1 = 10x10  
2 = 12x12  
3 = 16x16  
4 = 20x20  
5 = 28x28  
6 = 36x36  
7 = 48x48  
8 = 60x60 | 0 | Specifies size of the object. If Drag&Fit is selected it picks biggest size which fits into object boundary. |

# Functions

## SetActiveColor 

This function sets ActiveColor to newactivecolor. Possible values are

- 1 = Blue
- 2 = Green
- 3 = Yellow
- 4 = Orange
- 5 = Purple

The function returns True on success or False if an error occurs (parameter is out of limits).

#### Syntax

```visualbasic
Function SetActiveColor(newactivecolor As Long) As Boolean
```

## GetActiveColor

This function returns current ActiveColor of indicator. For possible values see command SetActiveColor.

#### Syntax

```visualbasic
Function GetActiveColor() As Long
```

## SetBlinkDutyCycle 

This function sets BlinkDutyCycle to newblinkdutycycle. It returns True on success or False if an error occurs (parameter is out of limits).

#### Syntax

```visualbasic
Function SetBlinkDutyCycle(newblinkdutycycle As Byte) As Boolean
```

## GetBlinkDutyCycle

This function returns current ActiveBlinkDutyCycle of indicator.

#### Syntax

```visualbasic
Function GetBlinkDutyCycle() As Byte
```

## SetBlinkPeriod

This function sets BlinkPeriod to newblinkperiod. It returns True.

#### Syntax

```visualbasic
Function SetBlinkPeriod(newblinkperiod As Time) As Boolean
```

## GetBlinkPeriod 

This function returns current BlinkPeriod of indicator.

#### Syntax

```visualbasic
Function GetBlinkPeriod() As Time
```

## SetObjectSize

This function sets object size to newobjectsize. Possible values are

- 0 = Drag&Fit
- 1 = 10x10
- 2 = 12x12
- 3 = 16x16
- 4 = 20x20
- 5 = 28x28
- 6 = 36x36
- 7 = 48x48
- 8 = 60x60

The function returns True on success or False if an error occurs.

#### Syntax

```visualbasic
Function SetObjectSize(newobjectsize As Long) As Boolean
```

## GetObjectSize

This function returns current object size. For possible values see function SetObjectSize.

#### Syntax

```visualbasic
Function GetObjectSize() As Long
```

## SetValue 

This function sets indicator value to newvalue. It returns True.

#### Syntax

```visualbasic
Function SetValue(newvalue As Boolean) As Boolean
```

## GetValue 

This function returns current value of indicator.

#### Syntax

```visualbasic
Function GetValue() As Boolean
```