Skip navigation

Skip to main content

The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).
Canva Developers SDK
The Canva Apps SDK, Connect APIs, and MCP are now unified in the Canva Developers SDK. Learn more⁠(opens in a new tab or window).
API reference
Asset
getTemporaryUrlfindFontsopenColorSelectorrequestFontSelectionuploadChangelog
Asset: Test
initTestEnvironment
Design
addAudioTrackaddElementAtCursoraddElementAtPointaddNativeElement
addPageapplyTemplateautofillDesignbulkCreate.launchcreateRichtextRangeeditContentgetBrandKitColorsgetBrandTemplateMetadatagetCurrentPageContextgetCurrentPageMetadatagetDefaultPageDimensions
getDesignColorsgetDesignMetadatagetDesignTemplateMetadatagetDesignTokeninitAppElementopenDesignoverlay.registerOnCanOpenpublish.launchrequestApplyPublicTemplaterequestBrandTemplatesrequestDataFieldMatchingrequestExportselection.registerOnChangesetCurrentPageBackgroundsetDataFieldLabelVisibilityui.startDragToCursorui.startDragToPointui.startDrag
Changelog
Design: Test
initTestEnvironment
Error
Changelog
Error: Test
initTestEnvironment
Intents
Changelog
Intents: Content
prepareContentPublisher
Intents: Data
prepareDataConnectorrequestDataTable
Intents: Design
prepareDesignEditor
Intents: Test
initTestEnvironment
Platform
appProcessappProcess.broadcastMessageappProcess.currentappProcess.current.getInfoappProcess.current.requestCloseappProcess.current.setOnDisposeappProcess.requestCloseappProcess.registerOnMessageappProcess.registerOnStateChangefeatures.isSupportedfeatures.registerOnSupportChangegetPlatformInfonotification.addToastrequestOpenExternalUrlChangelog
Platform: Test
initTestEnvironment
User
auth.getCanvaUserTokenauth.initOauthmonetization.isEnabledmonetization.openTrackingSessionmonetization.requestEnableBillableActionChangelog
User: Test
initTestEnvironment
App scripts
builddefineConfigdevextractTranslationsprepareConfigChangelog
Test
initTestEnvironment

setDataFieldLabelVisibility

API reference for the setDataFieldLabelVisibility method.

Controls whether data field labels are visible in the editor for the current app session. When enabled, users can see the purple labels indicating which data field each tagged element is linked to. The setting resets to hidden once the app session ends.

Usage: Show data field labels, then hide them again

import { setDataFieldLabelVisibility } from "@canva/design";


await setDataFieldLabelVisibility({ visible: true });
// User reviews data field labels in the editor.
await setDataFieldLabelVisibility({ visible: false });
TYPESCRIPT

Parameters

optsSetDataFieldLabelVisibilityOptions
Required

The configuration options for this call.

visibleboolean
Required

Whether data field labels should be visible in the editor for the current app session.

Returns

Response object from a setDataFieldLabelVisibility call. This is a Promise that resolves with the following object:

statusstring

The only valid value is "completed".