aws-cdk-lib.aws_quicksight.CfnAnalysis.DataLabelOptionsProperty

DataLabelOptionsProperty Struct

The options that determine the presentation of the data labels.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const dataLabelOptionsProperty: quicksight.CfnAnalysis.DataLabelOptionsProperty = {
  categoryLabelVisibility: 'categoryLabelVisibility',
  dataLabelTypes: [{
    dataPathLabelType: {
      fieldId: 'fieldId',
      fieldValue: 'fieldValue',
      visibility: 'visibility',
    },
    fieldLabelType: {
      fieldId: 'fieldId',
      visibility: 'visibility',
    },
    maximumLabelType: {
      visibility: 'visibility',
    },
    minimumLabelType: {
      visibility: 'visibility',
    },
    rangeEndsLabelType: {
      visibility: 'visibility',
    },
  }],
  labelColor: 'labelColor',
  labelContent: 'labelContent',
  labelFontConfiguration: {
    fontColor: 'fontColor',
    fontDecoration: 'fontDecoration',
    fontFamily: 'fontFamily',
    fontSize: {
      absolute: 'absolute',
      relative: 'relative',
    },
    fontStyle: 'fontStyle',
    fontWeight: {
      name: 'name',
    },
  },
  measureLabelVisibility: 'measureLabelVisibility',
  overlap: 'overlap',
  position: 'position',
  totalsVisibility: 'totalsVisibility',
  visibility: 'visibility',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_label_options_property = quicksight.CfnAnalysis.DataLabelOptionsProperty(
    category_label_visibility="categoryLabelVisibility",
    data_label_types=[quicksight.CfnAnalysis.DataLabelTypeProperty(
        data_path_label_type=quicksight.CfnAnalysis.DataPathLabelTypeProperty(
            field_id="fieldId",
            field_value="fieldValue",
            visibility="visibility"
        ),
        field_label_type=quicksight.CfnAnalysis.FieldLabelTypeProperty(
            field_id="fieldId",
            visibility="visibility"
        ),
        maximum_label_type=quicksight.CfnAnalysis.MaximumLabelTypeProperty(
            visibility="visibility"
        ),
        minimum_label_type=quicksight.CfnAnalysis.MinimumLabelTypeProperty(
            visibility="visibility"
        ),
        range_ends_label_type=quicksight.CfnAnalysis.RangeEndsLabelTypeProperty(
            visibility="visibility"
        )
    )],
    label_color="labelColor",
    label_content="labelContent",
    label_font_configuration=quicksight.CfnAnalysis.FontConfigurationProperty(
        font_color="fontColor",
        font_decoration="fontDecoration",
        font_family="fontFamily",
        font_size=quicksight.CfnAnalysis.FontSizeProperty(
            absolute="absolute",
            relative="relative"
        ),
        font_style="fontStyle",
        font_weight=quicksight.CfnAnalysis.FontWeightProperty(
            name="name"
        )
    ),
    measure_label_visibility="measureLabelVisibility",
    overlap="overlap",
    position="position",
    totals_visibility="totalsVisibility",
    visibility="visibility"
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;

DataLabelOptionsProperty dataLabelOptionsProperty = DataLabelOptionsProperty.builder()
        .categoryLabelVisibility("categoryLabelVisibility")
        .dataLabelTypes(List.of(DataLabelTypeProperty.builder()
                .dataPathLabelType(DataPathLabelTypeProperty.builder()
                        .fieldId("fieldId")
                        .fieldValue("fieldValue")
                        .visibility("visibility")
                        .build())
                .fieldLabelType(FieldLabelTypeProperty.builder()
                        .fieldId("fieldId")
                        .visibility("visibility")
                        .build())
                .maximumLabelType(MaximumLabelTypeProperty.builder()
                        .visibility("visibility")
                        .build())
                .minimumLabelType(MinimumLabelTypeProperty.builder()
                        .visibility("visibility")
                        .build())
                .rangeEndsLabelType(RangeEndsLabelTypeProperty.builder()
                        .visibility("visibility")
                        .build())
                .build()))
        .labelColor("labelColor")
        .labelContent("labelContent")
        .labelFontConfiguration(FontConfigurationProperty.builder()
                .fontColor("fontColor")
                .fontDecoration("fontDecoration")
                .fontFamily("fontFamily")
                .fontSize(FontSizeProperty.builder()
                        .absolute("absolute")
                        .relative("relative")
                        .build())
                .fontStyle("fontStyle")
                .fontWeight(FontWeightProperty.builder()
                        .name("name")
                        .build())
                .build())
        .measureLabelVisibility("measureLabelVisibility")
        .overlap("overlap")
        .position("position")
        .totalsVisibility("totalsVisibility")
        .visibility("visibility")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var dataLabelOptionsProperty = new DataLabelOptionsProperty {
    CategoryLabelVisibility = "categoryLabelVisibility",
    DataLabelTypes = new [] { new DataLabelTypeProperty {
        DataPathLabelType = new DataPathLabelTypeProperty {
            FieldId = "fieldId",
            FieldValue = "fieldValue",
            Visibility = "visibility"
        },
        FieldLabelType = new FieldLabelTypeProperty {
            FieldId = "fieldId",
            Visibility = "visibility"
        },
        MaximumLabelType = new MaximumLabelTypeProperty {
            Visibility = "visibility"
        },
        MinimumLabelType = new MinimumLabelTypeProperty {
            Visibility = "visibility"
        },
        RangeEndsLabelType = new RangeEndsLabelTypeProperty {
            Visibility = "visibility"
        }
    } },
    LabelColor = "labelColor",
    LabelContent = "labelContent",
    LabelFontConfiguration = new FontConfigurationProperty {
        FontColor = "fontColor",
        FontDecoration = "fontDecoration",
        FontFamily = "fontFamily",
        FontSize = new FontSizeProperty {
            Absolute = "absolute",
            Relative = "relative"
        },
        FontStyle = "fontStyle",
        FontWeight = new FontWeightProperty {
            Name = "name"
        }
    },
    MeasureLabelVisibility = "measureLabelVisibility",
    Overlap = "overlap",
    Position = "position",
    TotalsVisibility = "totalsVisibility",
    Visibility = "visibility"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

dataLabelOptionsProperty := &DataLabelOptionsProperty{
	CategoryLabelVisibility: jsii.String("categoryLabelVisibility"),
	DataLabelTypes: []interface{}{
		&DataLabelTypeProperty{
			DataPathLabelType: &DataPathLabelTypeProperty{
				FieldId: jsii.String("fieldId"),
				FieldValue: jsii.String("fieldValue"),
				Visibility: jsii.String("visibility"),
			},
			FieldLabelType: &FieldLabelTypeProperty{
				FieldId: jsii.String("fieldId"),
				Visibility: jsii.String("visibility"),
			},
			MaximumLabelType: &MaximumLabelTypeProperty{
				Visibility: jsii.String("visibility"),
			},
			MinimumLabelType: &MinimumLabelTypeProperty{
				Visibility: jsii.String("visibility"),
			},
			RangeEndsLabelType: &RangeEndsLabelTypeProperty{
				Visibility: jsii.String("visibility"),
			},
		},
	},
	LabelColor: jsii.String("labelColor"),
	LabelContent: jsii.String("labelContent"),
	LabelFontConfiguration: &FontConfigurationProperty{
		FontColor: jsii.String("fontColor"),
		FontDecoration: jsii.String("fontDecoration"),
		FontFamily: jsii.String("fontFamily"),
		FontSize: &FontSizeProperty{
			Absolute: jsii.String("absolute"),
			Relative: jsii.String("relative"),
		},
		FontStyle: jsii.String("fontStyle"),
		FontWeight: &FontWeightProperty{
			Name: jsii.String("name"),
		},
	},
	MeasureLabelVisibility: jsii.String("measureLabelVisibility"),
	Overlap: jsii.String("overlap"),
	Position: jsii.String("position"),
	TotalsVisibility: jsii.String("totalsVisibility"),
	Visibility: jsii.String("visibility"),
}

Properties

categoryLabelVisibility?optionalstringcategory_label_visibility?optionalstrcategoryLabelVisibility?optionalStringCategoryLabelVisibility?optionalstringCategoryLabelVisibility?optional*string#

Determines the visibility of the category field labels.

dataLabelTypes?optionalIResolvable | IResolvable | CfnAnalysis.DataLabelTypeProperty[]data_label_types?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataLabelTypeProperty]]]dataLabelTypes?optionalIResolvableDataLabelTypes?optionalIResolvableDataLabelTypes?optionalinterface{}#

The option that determines the data label type.

labelColor?optionalstringlabel_color?optionalstrlabelColor?optionalStringLabelColor?optionalstringLabelColor?optional*string#

Determines the color of the data labels.

labelContent?optionalstringlabel_content?optionalstrlabelContent?optionalStringLabelContent?optionalstringLabelContent?optional*string#

Determines the content of the data labels.

labelFontConfiguration?optionalIResolvable | CfnAnalysis.FontConfigurationPropertylabel_font_configuration?optionaltyping.Union[IResolvable, FontConfigurationProperty]labelFontConfiguration?optionalIResolvableLabelFontConfiguration?optionalIResolvableLabelFontConfiguration?optionalinterface{}#

Determines the font configuration of the data labels.

measureLabelVisibility?optionalstringmeasure_label_visibility?optionalstrmeasureLabelVisibility?optionalStringMeasureLabelVisibility?optionalstringMeasureLabelVisibility?optional*string#

Determines the visibility of the measure field labels.

overlap?optionalstringoverlap?optionalstroverlap?optionalStringOverlap?optionalstringOverlap?optional*string#

Determines whether overlap is enabled or disabled for the data labels.

position?optionalstringposition?optionalstrposition?optionalStringPosition?optionalstringPosition?optional*string#

Determines the position of the data labels.

totalsVisibility?optionalstringtotals_visibility?optionalstrtotalsVisibility?optionalStringTotalsVisibility?optionalstringTotalsVisibility?optional*string#

Determines the visibility of the total.

visibility?optionalstringvisibility?optionalstrvisibility?optionalStringVisibility?optionalstringVisibility?optional*string#

Determines the visibility of the data labels.