Customize Your Tableau Data Story: Functions

Important changes for Tableau Data Stories

Tableau Data Stories will be retired in Tableau Desktop, Tableau Cloud, and Tableau Server in January of 2025 (2025.1). With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see How Tableau Pulse powered by Tableau AI is Reimagining the Data Experience(Link opens in a new window).

If you’d like to customize your Tableau Data Story with a function, it helps to know what functions you can use, what each function does, and what dimensions and measures you’ll need for each function.

Learn how to Add functions to your Data Story.

Click a letter to see functions that begin with that letter. If no functions start with that letter, the functions that start with the next letter in the alphabet are shown. You can also press Ctrl+F (Command-F on a Mac) to open a search box that you can use to search the page for a specific function.

A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X  Y  Z


Average

Description: The average value of the given measure.

Syntax: Average(dimension, measure, filterDimensionValue)

Count

Description: The number of dimension values within a given dimension.

Syntax: Count(dimension)

Difference

Description: The difference in measure values between the two provided dimension values.

Syntax: Difference(dimension, measure, firstDimensionValue, secondDimensionValue, filterDimensionValue)

DifferenceFromMean

Description: The difference between the mean and the measure value for the given dimension value.

Syntax: DifferenceFromMean(dimension, measure, firstDimensionValue, filterDimensionValue)

Direction

Description: Language describing the direction (e.g., increase or decrease) between measure values for the two provided dimension values.

Syntax: Direction(dimension, measure, firstDimensionValue, secondDimensionValue, filterDimensionValue, phrase)

Ending Label

Description: The name of the last period in the series.

Syntax: Label(measure)

EndingValue

Description: The value at the last period in the series for the given measure.

Syntax: EndingValue(measure, filterDimensionValue)

Label

Description: The label for the given measure.

Syntax: Label(measure)

LargestNegativeChangeDifference

Description: The value of the largest negative period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestNegativeChangeDifference(measure, filterDimensionValue)

LargestNegativeChangeEndingLabel

Description: The name of the ending period for the largest negative period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestNegativeChangeEndingLabel(measure, filterDimensionValue)

LargestNegativeChangeEndingValue

Description: The ending value of the largest negative period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestNegativeChangeEndingValue(measure, filterDimensionValue)

LargestNegativeChangePercentDifference

Description: The percent change of the largest negative period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestNegativeChangePercentDifference(measure, filterDimensionValue)

LargestNegativeChangeStartingLabel

Description: The name of the starting period for the largest negative period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestNegativeChangeStartingLabel(measure, filterDimensionValue)

LargestNegativeChangeStartingValue

Description: The starting value of the largest negative period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestNegativeChangeStartingValue(measure, filterDimensionValue)

LargestNegativePercentChangeDifference

Description: The value of the largest negative period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestNegativePercentChangeDifference(measure, filterDimensionValue)

LargestNegativePercentChangeEndingLabel

Description: The name of the ending period for the largest negative period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestNegativePercentChangeEndingLabel(measure, filterDimensionValue)

LargestNegativePercentChangeEndingValue

Description: The ending value of the largest negative period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestNegativePercentChangeEndingValue(measure, filterDimensionValue)

LargestNegativePercentChangePercentDifference

Description: The percent change of the largest negative period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestNegativePercentChangePercentDifference(measure, filterDimensionValue)

LargestNegativePercentChangeStartingLabel

Description: The name of the starting period for the largest negative period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestNegativePercentChangeStartingLabel(measure, filterDimensionValue)

LargestNegativePercentChangeStartingValue

Description: The starting value of the largest negative period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestNegativePercentChangeStartingValue(measure, filterDimensionValue)

LargestPositiveChangeDifference

Description: The value of the largest positive period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestPositiveChangeDifference(measure, filterDimensionValue)

LargestPositiveChangeEndingLabel

Description: The name of the ending period for the largest positive period-over-period difference, on a absolute basis, in the given series.

Syntax: LargestPositiveChangeEndingLabel(measure, filterDimensionValue)

LargestPositiveChangeEndingValue

Description: The ending value of the largest positive period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestPositiveChangeEndingValue(measure, filterDimensionValue)

LargestPositiveChangePercentDifference

Description: The percent change of the largest positive period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestPositiveChangePercentDifference(measure, filterDimensionValue)

LargestPositiveChangeStartingLabel

Description: The name of the starting period for the largest positive period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestPositiveChangeStartingLabel(measure, filterDimensionValue)

LargestPositiveChangeStartingValue

Description: The starting value of the largest positive period-over-period difference, on an absolute basis, in the given series.

Syntax: LargestPositiveChangeStartingValue(measure, filterDimensionValue)

LargestPositivePercentChangeDifference

Description: The value of the largest positive period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestPositivePercentChangeDifference(measure, filterDimensionValue)

LargestPositivePercentChangeEndingLabel

Description: The name of the ending period for the largest positive period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestPositivePercentChangeEndingLabel(measure, filterDimensionValue)

LargestPositivePercentChangeEndingValue

Description: The ending value of the largest positive period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestPositivePercentChangeEndingValue(measure, filterDimensionValue)

LargestPositivePercentChangePercentDifference

Description: The percent change of the largest positive period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestPositivePercentChangePercentDifference(measure, filterDimensionValue)

LargestPositivePercentChangeStartingLabel

Description: The name of the starting period for the largest positive period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestPositivePercentChangeStartingLabel(measure, filterDimensionValue)

LargestPositivePercentChangeStartingValue

Description: The starting value of the largest positive period-over-period difference, on a percentage basis, in the given series.

Syntax: LargestPositivePercentChangeStartingValue(measure, filterDimensionValue)

LongestStreakDifference

Description: The difference over the longest streak of consecutive increases or decreases for the given series.

Syntax: LongestStreakDifference(measure, filterDimensionValue)

LongestStreakDirection

Description: The direction (positive or negative) of the longest streak of consecutive increases or decreases for the given series.

Syntax: LongestStreakDirection(measure, filterDimensionValue)

LongestStreakEndingLabel

Description: The name of the ending period for the longest streak of consecutive increases or decreases for the given series.

Syntax: LongestStreakEndingLabel(measure, filterDimensionValue)

LongestStreakEndingValue

Description: The ending value of the longest streak of consecutive increases or decreases for the given series.

Syntax: LongestStreakEndingValue(measure, filterDimensionValue)

LongestStreakLength

Description: The largest number of periods of consecutive increase or decrease for the given series.

Syntax: LongestStreakLength(measure, filterDimensionValue)

LongestStreakPercentDifference

Description: The percent difference over the longest streak of consecutive increases or decreases for the given series.

Syntax: LongestStreakPercentDifference(measure, filterDimensionValue)

LongestStreakStartingLabel

Description: The name of the starting period for the longest streak of consecutive increases or decreases for the given series.

Syntax: LongestStreakStartingLabel(measure, filterDimensionValue)

LongestStreakStartingValue

Description: The starting value of the longest streak of consecutive increases or decreases for the given series.

Syntax: LongestStreakStartingValue(measure, filterDimensionValue)

MaxLabel

Description: The name of the entity with the maximum value for the given measure.

Syntax: MaxLabel(dimension, measure, filterDimensionValue)

MaxValue

Description: The maximum value for the given measure.

Syntax: MaxValue(measure)

Median

Description: The median value for the given measure.

Syntax: Median(dimension, measure, filterDimensionValue)

MinLabel

Description: The name of the entity with the minimum value for the given measure. Syntax: MinLabel(dimension, measure, filterDimensionValue)

MinValue

Description: The minimum value for the given measure.

Syntax: MinValue(dimension, measure, filterDimensionValue)

PercentDifference

Description: The percent difference in measure values between the two provided dimension values.

Syntax: PercentDifference(dimension, measure, firstDimensionValue, secondDimensionValue, filterDimensionValue)

PercentOfWhole

Description: The percent in measure values for a given dimension value over the total measure values for that dimension.

Syntax: PercentOfWhole(dimension, measure, dimensionvalue, filterDimensionValue)

PeriodLabel

Description: The name of the nth period in the series, starting at 1.

Syntax: PeriodLabel(index)

PeriodLabelNewest

Description: The name of the nth period in the series, starting at the newest and counting back.

Syntax: PeriodLabelNewest(index)

PeriodValue

Description: The value of the given measure at the nth period in the series, starting at 1.

Syntax: PeriodValue(measure, index, filterDimensionValue)

PeriodValueNewest

Description: The value of the given measure at the nth period in the series, starting at the newest and counting back.

Syntax: PeriodValueNewest(measure, index)

Range

Description: The difference between the maximum and minimum values for the given measure.

Syntax: Range(dimension, measure, filterDimensionValue)

SortAscendingLabel

Description: The entity name of the given measure sorted in descending order at the given rank (starting at 1).

Syntax: SortAscendingLabel(measure, rank, dimension, filterDimensionValue)

SortAscendingValue

Description: The value of the given measure sorted in ascending order at the given rank (starting at 1).

Syntax: SortAscendingValue(measure, rank, dimension, filterDimensionValue)

SortDescendingLabel

Description: The entity name of the given measure sorted in descending order at the given rank (starting at 1).

Syntax: SortDescendingLabel(measure, rank, dimension, filterDimensionValue)

SortDescendingValue

Description: The value of the given measure sorted in descending order at the given rank (starting at 1).

Syntax: SortDescendingValue(measure, rank, dimension, filterDimensionValue)

StartingLabel

Description: The name of the first period in the series.

Syntax: StartingLabel()

StartingValue

Description: The value at the first period in the series for the given measure.

Syntax: StartingValue(measure, filterDimensionValue)

StartToFinishDifference

Description: The difference between the values for the first and last periods in the given series.

Syntax: StartToFinishDifference(measure, filterDimensionValue)

StartToFinishPercentDifference

Description: The percent difference between the values for the first and last periods in the given series.

Syntax: StartToFinishPercentDifference(measure, filterDimensionValue)

StdDev

Description: The standard deviation value for the given measure.

Syntax: StdDev(dimension, measure, filterDimensionValue)

Sum

Description: The sum of measure values for the two provided dimension values.

Syntax: Sum(dimension, measure, firstDimensionValue, secondDimensionValue, filterDimensionValue)

Total

Description: The sum total value for the given measure.

Syntax: Total(dimension, measure, filterDimensionValue)

Value

Description: The metric value for a given dimension, measure, and dimension value.

Syntax: Value(dimension, measure, dimension value, filterDimensionValue)

Z-Score

Description: The z-score for the given measure.

Syntax: Z-Score(dimension, measure, firstDimensionValue, filterDimensionValue)

Thanks for your feedback!Your feedback has been successfully submitted. Thank you!