aws-cdk-lib.aws_quicksight.CfnTemplate.ReferenceLineDataConfigurationProperty

ReferenceLineDataConfigurationProperty Struct

The data configuration of the reference line.

Source

Generated code

Type last changed

v2.103.0 · 26 Oct 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 referenceLineDataConfigurationProperty: quicksight.CfnTemplate.ReferenceLineDataConfigurationProperty = {
  axisBinding: 'axisBinding',
  dynamicConfiguration: {
    calculation: {
      percentileAggregation: {
        percentileValue: 123,
      },
      simpleNumericalAggregation: 'simpleNumericalAggregation',
    },
    column: {
      columnName: 'columnName',

      // the properties below are optional
      dataSetIdentifier: 'dataSetIdentifier',
      topicIdentifier: 'topicIdentifier',
    },

    // the properties below are optional
    measureAggregationFunction: {
      attributeAggregationFunction: {
        simpleAttributeAggregation: 'simpleAttributeAggregation',
        valueForMultipleValues: 'valueForMultipleValues',
      },
      categoricalAggregationFunction: 'categoricalAggregationFunction',
      dateAggregationFunction: 'dateAggregationFunction',
      numericalAggregationFunction: {
        percentileAggregation: {
          percentileValue: 123,
        },
        simpleNumericalAggregation: 'simpleNumericalAggregation',
      },
    },
  },
  seriesType: 'seriesType',
  staticConfiguration: {
    value: 123,
  },
};

# 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

reference_line_data_configuration_property = quicksight.CfnTemplate.ReferenceLineDataConfigurationProperty(
    axis_binding="axisBinding",
    dynamic_configuration=quicksight.CfnTemplate.ReferenceLineDynamicDataConfigurationProperty(
        calculation=quicksight.CfnTemplate.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnTemplate.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        ),
        column=quicksight.CfnTemplate.ColumnIdentifierProperty(
            column_name="columnName",

            # the properties below are optional
            data_set_identifier="dataSetIdentifier",
            topic_identifier="topicIdentifier"
        ),

        # the properties below are optional
        measure_aggregation_function=quicksight.CfnTemplate.AggregationFunctionProperty(
            attribute_aggregation_function=quicksight.CfnTemplate.AttributeAggregationFunctionProperty(
                simple_attribute_aggregation="simpleAttributeAggregation",
                value_for_multiple_values="valueForMultipleValues"
            ),
            categorical_aggregation_function="categoricalAggregationFunction",
            date_aggregation_function="dateAggregationFunction",
            numerical_aggregation_function=quicksight.CfnTemplate.NumericalAggregationFunctionProperty(
                percentile_aggregation=quicksight.CfnTemplate.PercentileAggregationProperty(
                    percentile_value=123
                ),
                simple_numerical_aggregation="simpleNumericalAggregation"
            )
        )
    ),
    series_type="seriesType",
    static_configuration=quicksight.CfnTemplate.ReferenceLineStaticDataConfigurationProperty(
        value=123
    )
)

// 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.*;

ReferenceLineDataConfigurationProperty referenceLineDataConfigurationProperty = ReferenceLineDataConfigurationProperty.builder()
        .axisBinding("axisBinding")
        .dynamicConfiguration(ReferenceLineDynamicDataConfigurationProperty.builder()
                .calculation(NumericalAggregationFunctionProperty.builder()
                        .percentileAggregation(PercentileAggregationProperty.builder()
                                .percentileValue(123)
                                .build())
                        .simpleNumericalAggregation("simpleNumericalAggregation")
                        .build())
                .column(ColumnIdentifierProperty.builder()
                        .columnName("columnName")

                        // the properties below are optional
                        .dataSetIdentifier("dataSetIdentifier")
                        .topicIdentifier("topicIdentifier")
                        .build())

                // the properties below are optional
                .measureAggregationFunction(AggregationFunctionProperty.builder()
                        .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                                .simpleAttributeAggregation("simpleAttributeAggregation")
                                .valueForMultipleValues("valueForMultipleValues")
                                .build())
                        .categoricalAggregationFunction("categoricalAggregationFunction")
                        .dateAggregationFunction("dateAggregationFunction")
                        .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                                .percentileAggregation(PercentileAggregationProperty.builder()
                                        .percentileValue(123)
                                        .build())
                                .simpleNumericalAggregation("simpleNumericalAggregation")
                                .build())
                        .build())
                .build())
        .seriesType("seriesType")
        .staticConfiguration(ReferenceLineStaticDataConfigurationProperty.builder()
                .value(123)
                .build())
        .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 referenceLineDataConfigurationProperty = new ReferenceLineDataConfigurationProperty {
    AxisBinding = "axisBinding",
    DynamicConfiguration = new ReferenceLineDynamicDataConfigurationProperty {
        Calculation = new NumericalAggregationFunctionProperty {
            PercentileAggregation = new PercentileAggregationProperty {
                PercentileValue = 123
            },
            SimpleNumericalAggregation = "simpleNumericalAggregation"
        },
        Column = new ColumnIdentifierProperty {
            ColumnName = "columnName",

            // the properties below are optional
            DataSetIdentifier = "dataSetIdentifier",
            TopicIdentifier = "topicIdentifier"
        },

        // the properties below are optional
        MeasureAggregationFunction = new AggregationFunctionProperty {
            AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
                SimpleAttributeAggregation = "simpleAttributeAggregation",
                ValueForMultipleValues = "valueForMultipleValues"
            },
            CategoricalAggregationFunction = "categoricalAggregationFunction",
            DateAggregationFunction = "dateAggregationFunction",
            NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
                PercentileAggregation = new PercentileAggregationProperty {
                    PercentileValue = 123
                },
                SimpleNumericalAggregation = "simpleNumericalAggregation"
            }
        }
    },
    SeriesType = "seriesType",
    StaticConfiguration = new ReferenceLineStaticDataConfigurationProperty {
        Value = 123
    }
};

// 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"

referenceLineDataConfigurationProperty := &ReferenceLineDataConfigurationProperty{
	AxisBinding: jsii.String("axisBinding"),
	DynamicConfiguration: &ReferenceLineDynamicDataConfigurationProperty{
		Calculation: &NumericalAggregationFunctionProperty{
			PercentileAggregation: &PercentileAggregationProperty{
				PercentileValue: jsii.Number(123),
			},
			SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
		},
		Column: &ColumnIdentifierProperty{
			ColumnName: jsii.String("columnName"),

			// the properties below are optional
			DataSetIdentifier: jsii.String("dataSetIdentifier"),
			TopicIdentifier: jsii.String("topicIdentifier"),
		},

		// the properties below are optional
		MeasureAggregationFunction: &AggregationFunctionProperty{
			AttributeAggregationFunction: &AttributeAggregationFunctionProperty{
				SimpleAttributeAggregation: jsii.String("simpleAttributeAggregation"),
				ValueForMultipleValues: jsii.String("valueForMultipleValues"),
			},
			CategoricalAggregationFunction: jsii.String("categoricalAggregationFunction"),
			DateAggregationFunction: jsii.String("dateAggregationFunction"),
			NumericalAggregationFunction: &NumericalAggregationFunctionProperty{
				PercentileAggregation: &PercentileAggregationProperty{
					PercentileValue: jsii.Number(123),
				},
				SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
			},
		},
	},
	SeriesType: jsii.String("seriesType"),
	StaticConfiguration: &ReferenceLineStaticDataConfigurationProperty{
		Value: jsii.Number(123),
	},
}

Properties

axisBinding?optionalstringaxis_binding?optionalstraxisBinding?optionalStringAxisBinding?optionalstringAxisBinding?optional*string#

The axis binding type of the reference line. Choose one of the following options:.

• PrimaryY
• SecondaryY

dynamicConfiguration?optionalIResolvable | CfnTemplate.ReferenceLineDynamicDataConfigurationPropertydynamic_configuration?optionaltyping.Union[IResolvable, ReferenceLineDynamicDataConfigurationProperty]dynamicConfiguration?optionalIResolvableDynamicConfiguration?optionalIResolvableDynamicConfiguration?optionalinterface{}#

The dynamic configuration of the reference line data configuration.

seriesType?optionalstringseries_type?optionalstrseriesType?optionalStringSeriesType?optionalstringSeriesType?optional*string#

The series type of the reference line data configuration. Choose one of the following options:.

• BAR
• LINE

staticConfiguration?optionalIResolvable | CfnTemplate.ReferenceLineStaticDataConfigurationPropertystatic_configuration?optionaltyping.Union[IResolvable, ReferenceLineStaticDataConfigurationProperty]staticConfiguration?optionalIResolvableStaticConfiguration?optionalIResolvableStaticConfiguration?optionalinterface{}#

The static data configuration of the reference line data configuration.