
# IWaveLegend interface

*No description yet.*

```csharp
public interface IWaveLegend : IPrimitive
```

**Namespace:** SCH · **Assembly:** Altium.SDK.Interfaces

**Inherits:** [IPrimitive](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPrimitive.md)

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [DownArrow](#downarrow) | [IScrollArrow](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IScrollArrow.md) | get |  |
| [ParentPlot](#parentplot) | [IPlot](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPlot.md) | get |  |
| [TopWaveIndex](#topwaveindex) | `int` | get; set |  |
| [UpArrow](#uparrow) | [IScrollArrow](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IScrollArrow.md) | get |  |

### DownArrow

*No description yet.*

```csharp
IScrollArrow GetProperty_DownArrow();
```

**Type:** [IScrollArrow](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IScrollArrow.md) · **Access:** read-only

The accessors are extension methods of `IWaveLegendHelper` (`using SCH;`).

### ParentPlot

*No description yet.*

```csharp
IPlot GetProperty_ParentPlot();
```

**Type:** [IPlot](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPlot.md) · **Access:** read-only

The accessors are extension methods of `IWaveLegendHelper` (`using SCH;`).

### TopWaveIndex

*No description yet.*

```csharp
int GetProperty_TopWaveIndex();
void SetProperty_TopWaveIndex(int argValue);
```

**Type:** `int` · **Access:** read/write

### UpArrow

*No description yet.*

```csharp
IScrollArrow GetProperty_UpArrow();
```

**Type:** [IScrollArrow](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IScrollArrow.md) · **Access:** read-only

The accessors are extension methods of `IWaveLegendHelper` (`using SCH;`).

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [GetVisibleWavesCount](#getvisiblewavescount) | `int` |  |

### GetVisibleWavesCount

*No description yet.*

```csharp
int GetVisibleWavesCount(IPlottedWaveList argWavesList);
int GetVisibleWavesCount(object argWavesList);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argWavesList` | [IPlottedWaveList](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPlottedWaveList.md) | value |

**Returns:** `int`

The first overload is an extension method of `IWaveLegendHelper` (`using SCH;`) with typed parameters; the second is declared by the interface.

## Inherited members

- From [IPrimitive](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPrimitive.md): [BoundingRect](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPrimitive.md#boundingrect), [ViewablePrimitiveId](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPrimitive.md#viewableprimitiveid)

## Returned by

[IPlot.WaveLegend](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IPlot.md#wavelegend), [IScrollArrow.ParentLegend](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/IScrollArrow.md#parentlegend)
