내장된 대시보드 및 시각적 개체의 모양과 느낌을 사용자 지정합니다. - 아마존 QuickSight

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

내장된 대시보드 및 시각적 개체의 모양과 느낌을 사용자 지정합니다.

Amazon QuickSight Embedding SDK (버전 2.5.0 이상) 을 사용하여 런타임에 내장된 QuickSight 대시보드 및 시각적 개체의 테마를 변경할 수 있습니다. 런타임 테마를 사용하면 SaaS (Software as a Service) 애플리케이션을 QuickSight Amazon 임베디드 자산과 쉽게 통합할 수 있습니다. 런타임 테마를 사용하면 임베디드 콘텐츠의 테마를 QuickSight 자산이 임베드된 상위 애플리케이션의 테마와 동기화할 수 있습니다. 또한 런타임 테마를 사용하여 독자를 위한 사용자 지정 옵션을 추가할 수 있습니다. 테마 변경 사항은 초기화 시 또는 내장된 대시보드 또는 비주얼의 전체 수명 주기 동안 임베디드 자산에 적용할 수 있습니다.

테마에 대한 자세한 내용은 을 참조하십시오. 아마존에서 테마 사용하기 QuickSight QuickSight 임베딩 사용에 대한 자세한 내용은 SDK amazon-quicksight-embedding-sdk GitHubon을 참조하십시오.

사전 조건 

시작하기 전에 다음과 같은 사전 요구 사항이 있는지 확인하세요.

  • QuickSight 임베딩 SDK 버전 2.5.0 이상을 사용하고 있습니다.

  • 작업하려는 테마에 액세스할 수 있는 권한 에서 QuickSight 테마에 권한을 부여하려면 UpdateThemePermissions API 전화를 걸거나 QuickSight 콘솔의 분석 편집기에서 테마 옆에 있는 공유 아이콘을 사용하세요.

용어 및 개념

다음 용어는 내장된 런타임 테마를 사용할 때 유용할 수 있습니다.

  • 테마 - 콘텐츠 표시 방식을 변경하는 여러 분석 및 대시보드에 적용할 수 있는 설정 모음입니다.

  • ThemeConfiguration— 테마의 모든 표시 속성을 포함하는 구성 개체입니다.

  • 테마 오버라이드 — 콘텐츠가 표시되는 방식의 일부 또는 전체를 재정의하기 위해 활성 테마에 적용되는 ThemeConfiguration 객체입니다.

  • 테마 ARN — 테마를 식별하는 Amazon 리소스 이름 (ARN). QuickSight 다음은 사용자 지정 ARN 테마의 예입니다.

    arn:aws:quicksight:region:account-id:theme/theme-id

    QuickSight 제공된 스타터 테마의 테마에는 지역이 없습니다ARN. 다음은 스타터 테마의 ARN 예시입니다.

    arn:aws:quicksight::aws:theme/CLASSIC

설정

런타임 테마 작업을 시작하는 데 필요한 다음 정보를 준비했는지 확인하세요.

  • 사용하려는 ARNs 테마의 테마. 기존 테마를 선택하거나 새 테마를 만들 수 있습니다. QuickSight 계정의 모든 테마와 테마 ARNs 목록을 보려면 오퍼레이션에 ListThemesAPI문의하세요. 사전 설정된 QuickSight 테마에 대한 자세한 내용은 을 참조하십시오Amazon QuickSight 분석을 위한 기본 테마 설정.

  • 등록된 사용자 임베딩을 사용하는 경우 사용자가 사용하려는 테마에 액세스할 수 있는지 확인하십시오.

    익명 사용자 임베딩을 사용하는 경우 테마 ARNs 목록을 의 AuthorizedResourceArns 매개 변수에 전달하십시오. GenerateEmbedUrlForAnonymousUser API 익명 사용자에게는 AuthorizedResourceArns 매개변수에 나열된 모든 테마에 대한 액세스 권한이 부여됩니다.

SDK메서드 인터페이스

세터 메서드

다음 표에서는 개발자가 런타임 테마에 사용할 수 있는 다양한 setter 메서드에 대해 설명합니다.

메서드 설명

setTheme(themeArn: string)

대시보드 또는 비주얼의 활성 테마를 다른 테마로 대체합니다. 적용한 경우 테마 오버라이드가 제거됩니다.

테마에 액세스할 수 없거나 테마가 존재하지 않는 경우 오류가 반환됩니다.

setThemeOverride(themeOverride: ThemeConfiguration)

현재 활성 테마를 ThemeConfiguration 재정의하도록 다이내믹을 설정합니다. 이는 이전에 설정된 테마 오버라이드를 대체합니다. 새 테마에서 제공되지 않은 모든 값은 ThemeConfiguration 현재 활성화된 테마의 값이 기본값으로 설정됩니다.

입력한 내용이 유효하지 않은 경우 오류가 반환됩니다. ThemeConfiguration

테마를 사용하여 임베디드 콘텐츠 초기화하기

기본 테마가 아닌 내장 대시보드 또는 비주얼을 초기화하려면 DashboardContentOptions 또는 VisualContentOptions 매개변수에서 themeOptions 개체를 정의하고 themeArn 속성을 원하는 themeOptions 테마로 설정합니다. ARN

다음 예제에서는 테마를 사용하여 내장된 대시보드를 초기화합니다. MIDNIGHT

import { createEmbeddingContext } from 'amazon-quicksight-embedding-sdk'; const embeddingContext = await createEmbeddingContext(); const { embedDashboard, } = embeddingContext; const frameOptions = { url: '<YOUR_EMBED_URL>', container: '#experience-container', }; const contentOptions = { themeOptions: { themeArn: "arn:aws:quicksight::aws:theme/MIDNIGHT" } }; // Embedding a dashboard experience const embeddedDashboardExperience = await embedDashboard(frameOptions, contentOptions);

테마 오버라이드로 임베디드 콘텐츠 초기화

개발자는 테마 오버라이드를 사용하여 런타임에 임베디드 대시보드 또는 비주얼의 테마를 정의할 수 있습니다. 이렇게 하면 대시보드 또는 비주얼에서 테마를 미리 구성할 필요 없이 타사 응용 프로그램의 테마를 상속할 수 있습니다. QuickSight 테마 오버라이드가 포함된 내장된 대시보드 또는 비주얼을 초기화하려면 or 매개 변수 내에서 themeOverride themeOptions 속성을 설정하십시오. DashboardContentOptions VisualContentOptions 다음 예제에서는 대시보드 테마의 글꼴을 기본 글꼴에서 로 재정의합니다. Amazon Ember

import { createEmbeddingContext } from 'amazon-quicksight-embedding-sdk'; const embeddingContext = await createEmbeddingContext(); const { embedDashboard, } = embeddingContext; const frameOptions = { url: '<YOUR_EMBED_URL>', container: '#experience-container', }; const contentOptions = { themeOptions: { "themeOverride":{"Typography":{"FontFamilies":[{"FontFamily":"Comic Neue"}]}} } }; // Embedding a dashboard experience const embeddedDashboardExperience = await embedDashboard(frameOptions, contentOptions);

미리 로드된 테마로 임베디드 콘텐츠 초기화

개발자는 초기화 시 미리 로드되도록 대시보드 테마 세트를 구성할 수 있습니다. 이는 서로 다른 보기 (예: 어두운 모드와 밝은 모드) 간에 빠르게 전환할 때 가장 유용합니다. 내장된 대시보드 또는 비주얼은 최대 5개의 사전 로드된 테마로 초기화할 수 있습니다. 미리 로드된 테마를 사용하려면 preloadThemes 속성을 둘 중 하나 DashboardContentOptions 또는 최대 VisualContentOptions 5개의 배열로 설정하십시오. themeArns 다음 예제는 MidnightRainier 시작 테마를 대시보드에 미리 로드합니다.

import { createEmbeddingContext } from 'amazon-quicksight-embedding-sdk'; const embeddingContext = await createEmbeddingContext(); const { embedDashboard, } = embeddingContext; const frameOptions = { url: '<YOUR_EMBED_URL>', container: '#experience-container', }; const contentOptions = { themeOptions: { "preloadThemes": ["arn:aws:quicksight::aws:theme/RAINIER", "arn:aws:quicksight::aws:theme/MIDNIGHT"] } }; // Embedding a dashboard experience const embeddedDashboardExperience = await embedDashboard(frameOptions, contentOptions);