---
schema_version: "1"
id: e545bd5ede59eb436cf31009041fef747915db0f7b42c4884c8baccee217a32c
title: CustomView | Tableau Embedding API
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/api/embedding_api/reference/interfaces/CustomView.md
canonical_url: https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/CustomView.html
source_site: help.tableau.com
content_type: documentation
content_hash: 892e9febf9781c79b2f8b9bbeaf3de0eafa3c1bb1c9d9ff3a7e1181fb3dc11f5
description: Documentation for Tableau Embedding API
---
- CustomView

# Interface CustomView

A named snapshot of the workbook at a specific moment.

interface CustomView {  
    [default](#default): boolean;  
    [name](#name): string;  
    [ownerName](#ownername): string;  
    [shared](#shared): boolean;  
    [url](#url): string;  
    [workbook](#workbook): [Workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Workbook.html);  
    [saveAsync](#saveasync-1)(): Promise<CustomView\>;  
}

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:103

##### Index

### Methods

[saveAsync](#saveasync)

### Properties

[default](#default) [name](#name) [ownerName](#ownername) [shared](#shared) [url](#url) [workbook](#workbook)

## Methods

### saveAsync[](#saveasync)

- saveAsync(): Promise<CustomView\>[](#saveasync-1)
    
    Updates an existing custom view
    
    #### Returns Promise<CustomView\>
    
    - Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:137

## Properties

### default[](#default)

default: boolean

Gets or sets whether this is the default custom view.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:117

### name[](#name)

name: string

Gets or sets the user-friendly name for the custom view

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:107

### `Readonly`ownerName[](#ownername)

ownerName: string

Gets the user that created the custom view.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:122

### shared[](#shared)

shared: boolean

Gets or sets whether the custom view is public or private.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:112

### `Readonly`url[](#url)

url: string

Unique URL to load this view again.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:127

### `Readonly`workbook[](#workbook)

workbook: [Workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Workbook.html)

Gets the [Workbook](https://help.tableau.com/v0.0/api/embedding_api/en-us/reference/interfaces/Workbook.html) to which this [CustomView](#) belongs.

- Defined in packages/api-external-contract-js/src/ExternalContract/Embedding/WorkbookInterface.ts:132

### Settings

Member Visibility

- Protected
- Inherited
- External

ThemeOSLightDark

### On This Page

Methods

[saveAsync](#saveasync)

Properties

[default](#default)[name](#name)[ownerName](#ownername)[shared](#shared)[url](#url)[workbook](#workbook)