WOLFRAM

Wolfram Language & System Documentation Center

ComponentKeys

is an option of TimeSeries and EventSeries that specifies the keys of the components.

Details
Details and Options Details and Options
Examples  
Basic Examples  
Scope  
Properties & Relations  
See Also
History
Cite this Page

ComponentKeys

ComponentKeys

is an option of TimeSeries and EventSeries that specifies the keys of the components.

Details

  • ComponentKeys is typically used to name the data components of a time or event series.
  • Possible settings for ComponentKeys include:
  • Automaticselect component keys automatically from data »
    Nonereturn a simple time or event series »
    {com1,com2,…}return a time or event series with components comi »
  • TimeSeries[vals,times,keys] is equivalent to TimeSeries[vals,times,ComponentKeyskeys].

Examples

open all close all

Basic Examples  (2)

Construct a time series with component keys "a" and "b":

Wolfram Language code: TimeSeries[{{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> {"a", "b"}]

Show the data using conversion to Tabular:

Wolfram Language code: Tabular[%]

Create an event series from a list of pairs of dates for full moon and new moon:

Wolfram Language code: EventSeries[{{DateObject[{2026, 1, 3, 4, 2, 54.5329}, "Instant", "Gregorian", -6.], DateObject[{2026, 1, 18, 13, 51, 58.9335}, "Instant", "Gregorian", -6.]}, {DateObject[{2026, 2, 1, 16, 9, 14.7054}, "Instant", "Gregorian", -6.], DateObject[{2026, 2, 17, 6, 1, 9.07329}, "Instant", "Gregorian", -6.]}, {DateObject[{2026, 3, 3, 5, 37, 53.7335}, "Instant", "Gregorian", -6.], DateObject[{2026, 3, 18, 19, 23, 28.7273}, "Instant", "Gregorian", -6.]}}, {DateObject[{2026, 1}], Automatic, "Month"}, ComponentKeys -> {"FullMoon", "NewMoon"}]

Show the data using conversion to Tabular:

Wolfram Language code: Tabular[%]

Scope  (6)

Give explicit component keys:

Wolfram Language code: TimeSeries[{{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> {"a", "b"}]

Show the data using conversion to Tabular:

Wolfram Language code: Tabular[%]

Component keys are added automatically when the given list is incomplete:

Wolfram Language code: TimeSeries[{{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> {"number"}]
Wolfram Language code: ColumnKeys[%]

Generate all component keys by giving {}:

Wolfram Language code: TimeSeries[{{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> {}]
Wolfram Language code: ColumnKeys[%]

The Automatic setting of ComponentKeys preserves the input keys:

Wolfram Language code: Tabular[{{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}, {"K1", "K2"}]
Wolfram Language code: tab = Tabular[Association["RawSchema" -> Association["ColumnProperties" -> Association["K1" -> Association["ElementType" -> "Real64"], "K2" -> Association["ElementType" -> "String"]], "KeyColumns" -> None, "Backend" -> "WolframKernel"], "Options" -> {}, "BackendData" -> Association["ColumnData" -> DataStructure["ColumnTable", {{TabularColumn[Association["Data" -> {{0.1, 0.2, 0.3}, {}, None}, "ElementType" -> "Real64"]], TabularColumn[Association[ "Data" -> {{3, {0, 3, 6, 9}, "catdogfox"}, {}, None}, "ElementType" -> "String"]]}}]]]];
Wolfram Language code: TimeSeries[tab, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> Automatic]
Wolfram Language code: Tabular[%]

When component keys are given, they override the input keys:

Wolfram Language code: tab = Tabular[Association["RawSchema" -> Association["ColumnProperties" -> Association["K1" -> Association["ElementType" -> "Real64"], "K2" -> Association["ElementType" -> "String"]], "KeyColumns" -> None, "Backend" -> "WolframKernel"], "Options" -> {}, "BackendData" -> Association["ColumnData" -> DataStructure["ColumnTable", {{TabularColumn[Association["Data" -> {{0.1, 0.2, 0.3}, {}, None}, "ElementType" -> "Real64"]], TabularColumn[Association[ "Data" -> {{3, {0, 3, 6, 9}, "catdogfox"}, {}, None}, "ElementType" -> "String"]]}}]]]];
Wolfram Language code: TimeSeries[tab, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> {"a", "b"}]
Wolfram Language code: Tabular[%]

With component keys set to None, the output time series is simple, without explicit components:

Wolfram Language code: tab = Tabular[Association["RawSchema" -> Association["ColumnProperties" -> Association["K1" -> Association["ElementType" -> "Real64"], "K2" -> Association["ElementType" -> "String"]], "KeyColumns" -> None, "Backend" -> "WolframKernel"], "Options" -> {}, "BackendData" -> Association["ColumnData" -> DataStructure["ColumnTable", {{TabularColumn[Association["Data" -> {{0.1, 0.2, 0.3}, {}, None}, "ElementType" -> "Real64"]], TabularColumn[Association[ "Data" -> {{3, {0, 3, 6, 9}, "catdogfox"}, {}, None}, "ElementType" -> "String"]]}}]]]];
Wolfram Language code: TimeSeries[tab, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> None]
Wolfram Language code: Tabular[%]

When there are no input keys, the Automatic setting will preserve the simple component input:

Wolfram Language code: TimeSeries[{{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}, {{Yesterday, Today, Tomorrow}}, ComponentKeys -> Automatic]
Wolfram Language code: Tabular[%]

Properties & Relations  (2)

The component keys can be provided as a third argument or as an option:

Wolfram Language code: vals = {{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}; times = {Yesterday, Today, Tomorrow}; keys = {"number", "animal"};
Wolfram Language code: TimeSeries[vals, {times}, keys]
Wolfram Language code: TimeSeries[vals, {times}, ComponentKeys -> keys] === %

The component keys given as an argument will override those given by the option:

Wolfram Language code: TimeSeries[{{.1, "cat"}, {.2, "dog"}, {.3, "fox"}}, {{Yesterday, Today, Tomorrow}}, {"A", "B"}, ComponentKeys -> {"a", "b"}]
Wolfram Language code: Tabular[%]
Wolfram Research (2026), ComponentKeys, Wolfram Language function, https://reference.wolfram.com/language/ref/ComponentKeys.html.

Text

Wolfram Research (2026), ComponentKeys, Wolfram Language function, https://reference.wolfram.com/language/ref/ComponentKeys.html.

CMS

Wolfram Language. 2026. "ComponentKeys." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/ComponentKeys.html.

APA

Wolfram Language. (2026). ComponentKeys. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/ComponentKeys.html

BibTeX

@misc{reference.wolfram_2026_componentkeys, author="Wolfram Research", title="{ComponentKeys}", year="2026", howpublished="\url{https://reference.wolfram.com/language/ref/ComponentKeys.html}", note=[Accessed: 12-June-2026]}

BibLaTeX

@online{reference.wolfram_2026_componentkeys, organization={Wolfram Research}, title={ComponentKeys}, year={2026}, url={https://reference.wolfram.com/language/ref/ComponentKeys.html}, note=[Accessed: 12-June-2026]}