---
title: "Function: isStateSurface() | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/design-editor/iframe-api/reference/design-editor-iframe/functions/Convert.isStateSurface/"
---

# Function: isStateSurface()

> > **isStateSurface**(`surface`): surface is IStateSurfaces \| IStateSurface

## Parameters

### surface

[`SurfaceTypes`](https://customerscanvas.com/docs/on-premises/design-editor/iframe-api/reference/design-editor-iframe/types/ObjectModel.SurfaceTypes.md) \| [`SurfaceTypes`](https://customerscanvas.com/docs/on-premises/design-editor/iframe-api/reference/design-editor-iframe/types/ObjectModel.SurfaceTypes.md)[] \| [`IStateSurfaces`](https://customerscanvas.com/docs/on-premises/design-editor/iframe-api/reference/design-editor-iframe/interfaces/ObjectModel.IStateSurfaces.md) \| [`IStateSurface`](https://customerscanvas.com/docs/on-premises/design-editor/iframe-api/reference/design-editor-iframe/interfaces/ObjectModel.IStateSurface.md)

## Returns

surface is IStateSurfaces \| IStateSurface