@rowsncolumns/functions 15.1.0 → 15.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"function-descriptions.d.ts","sourceRoot":"","sources":["../../function-descriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,
|
|
1
|
+
{"version":3,"file":"function-descriptions.d.ts","sourceRoot":"","sources":["../../function-descriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,EAklXpD,CAAC"}
|
|
@@ -10362,4 +10362,380 @@ exports.functionDescriptions = [
|
|
|
10362
10362
|
},
|
|
10363
10363
|
],
|
|
10364
10364
|
},
|
|
10365
|
+
{
|
|
10366
|
+
datatype: "Database",
|
|
10367
|
+
title: "CUBEKPIMEMBER",
|
|
10368
|
+
syntax: "CUBEKPIMEMBER(connection, kpi_name, kpi_property, [caption])",
|
|
10369
|
+
description: "Returns a key performance indicator (KPI) property from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10370
|
+
example: "CUBEKPIMEMBER(\"Sales\",\"MySalesKPI\",1)",
|
|
10371
|
+
usage: ["CUBEKPIMEMBER(\"Sales\",\"MySalesKPI\",1)"],
|
|
10372
|
+
parameters: [
|
|
10373
|
+
{
|
|
10374
|
+
title: "connection",
|
|
10375
|
+
description: "The name of the workbook connection to the cube.",
|
|
10376
|
+
},
|
|
10377
|
+
{
|
|
10378
|
+
title: "kpi_name",
|
|
10379
|
+
description: "The name of the KPI in the cube.",
|
|
10380
|
+
},
|
|
10381
|
+
{
|
|
10382
|
+
title: "kpi_property",
|
|
10383
|
+
description: "The KPI component returned (1 value, 2 goal, 3 status, 4 trend, 5 weight, 6 current time member).",
|
|
10384
|
+
},
|
|
10385
|
+
{
|
|
10386
|
+
title: "caption [OPTIONAL]",
|
|
10387
|
+
description: "Text shown in the cell instead of the KPI name.",
|
|
10388
|
+
},
|
|
10389
|
+
],
|
|
10390
|
+
},
|
|
10391
|
+
{
|
|
10392
|
+
datatype: "Database",
|
|
10393
|
+
title: "CUBEMEMBER",
|
|
10394
|
+
syntax: "CUBEMEMBER(connection, member_expression, [caption])",
|
|
10395
|
+
description: "Returns a member or tuple from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10396
|
+
example: "CUBEMEMBER(\"Sales\",\"[Time].[Fiscal].[2024]\")",
|
|
10397
|
+
usage: ["CUBEMEMBER(\"Sales\",\"[Time].[Fiscal].[2024]\")"],
|
|
10398
|
+
parameters: [
|
|
10399
|
+
{
|
|
10400
|
+
title: "connection",
|
|
10401
|
+
description: "The name of the workbook connection to the cube.",
|
|
10402
|
+
},
|
|
10403
|
+
{
|
|
10404
|
+
title: "member_expression",
|
|
10405
|
+
description: "An MDX expression that evaluates to a unique member or tuple.",
|
|
10406
|
+
},
|
|
10407
|
+
{
|
|
10408
|
+
title: "caption [OPTIONAL]",
|
|
10409
|
+
description: "Text shown in the cell instead of the member caption.",
|
|
10410
|
+
},
|
|
10411
|
+
],
|
|
10412
|
+
},
|
|
10413
|
+
{
|
|
10414
|
+
datatype: "Database",
|
|
10415
|
+
title: "CUBEMEMBERPROPERTY",
|
|
10416
|
+
syntax: "CUBEMEMBERPROPERTY(connection, member_expression, property)",
|
|
10417
|
+
description: "Returns the value of a member property from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10418
|
+
example: "CUBEMEMBERPROPERTY(\"Sales\",\"[Store].[MyFavoriteStore]\",\"[Store].[Store Name].[Store Sqft]\")",
|
|
10419
|
+
usage: ["CUBEMEMBERPROPERTY(\"Sales\",\"[Store].[MyFavoriteStore]\",\"[Store].[Store Name].[Store Sqft]\")"],
|
|
10420
|
+
parameters: [
|
|
10421
|
+
{
|
|
10422
|
+
title: "connection",
|
|
10423
|
+
description: "The name of the workbook connection to the cube.",
|
|
10424
|
+
},
|
|
10425
|
+
{
|
|
10426
|
+
title: "member_expression",
|
|
10427
|
+
description: "An MDX expression for the member.",
|
|
10428
|
+
},
|
|
10429
|
+
{
|
|
10430
|
+
title: "property",
|
|
10431
|
+
description: "The name of the property to return.",
|
|
10432
|
+
},
|
|
10433
|
+
],
|
|
10434
|
+
},
|
|
10435
|
+
{
|
|
10436
|
+
datatype: "Database",
|
|
10437
|
+
title: "CUBERANKEDMEMBER",
|
|
10438
|
+
syntax: "CUBERANKEDMEMBER(connection, set_expression, rank, [caption])",
|
|
10439
|
+
description: "Returns the nth, or ranked, member of a set from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10440
|
+
example: "CUBERANKEDMEMBER(\"Sales\",$D$4,1,\"Top Month\")",
|
|
10441
|
+
usage: ["CUBERANKEDMEMBER(\"Sales\",$D$4,1,\"Top Month\")"],
|
|
10442
|
+
parameters: [
|
|
10443
|
+
{
|
|
10444
|
+
title: "connection",
|
|
10445
|
+
description: "The name of the workbook connection to the cube.",
|
|
10446
|
+
},
|
|
10447
|
+
{
|
|
10448
|
+
title: "set_expression",
|
|
10449
|
+
description: "A set expression or a reference to a CUBESET cell.",
|
|
10450
|
+
},
|
|
10451
|
+
{
|
|
10452
|
+
title: "rank",
|
|
10453
|
+
description: "The position of the member to return.",
|
|
10454
|
+
},
|
|
10455
|
+
{
|
|
10456
|
+
title: "caption [OPTIONAL]",
|
|
10457
|
+
description: "Text shown in the cell instead of the member caption.",
|
|
10458
|
+
},
|
|
10459
|
+
],
|
|
10460
|
+
},
|
|
10461
|
+
{
|
|
10462
|
+
datatype: "Database",
|
|
10463
|
+
title: "CUBESET",
|
|
10464
|
+
syntax: "CUBESET(connection, set_expression, [caption], [sort_order], [sort_by])",
|
|
10465
|
+
description: "Defines a calculated set of members or tuples on an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10466
|
+
example: "CUBESET(\"Sales\",\"[Product].[All Products].Children\",\"Products\",1,\"[Measures].[Sales Amount]\")",
|
|
10467
|
+
usage: ["CUBESET(\"Sales\",\"[Product].[All Products].Children\",\"Products\",1,\"[Measures].[Sales Amount]\")"],
|
|
10468
|
+
parameters: [
|
|
10469
|
+
{
|
|
10470
|
+
title: "connection",
|
|
10471
|
+
description: "The name of the workbook connection to the cube.",
|
|
10472
|
+
},
|
|
10473
|
+
{
|
|
10474
|
+
title: "set_expression",
|
|
10475
|
+
description: "An MDX expression that results in a set.",
|
|
10476
|
+
},
|
|
10477
|
+
{
|
|
10478
|
+
title: "caption [OPTIONAL]",
|
|
10479
|
+
description: "Text shown in the cell.",
|
|
10480
|
+
},
|
|
10481
|
+
{
|
|
10482
|
+
title: "sort_order [OPTIONAL]",
|
|
10483
|
+
description: "How the set is sorted (0 none to 6 descending natural).",
|
|
10484
|
+
},
|
|
10485
|
+
{
|
|
10486
|
+
title: "sort_by [OPTIONAL]",
|
|
10487
|
+
description: "The value to sort by.",
|
|
10488
|
+
},
|
|
10489
|
+
],
|
|
10490
|
+
},
|
|
10491
|
+
{
|
|
10492
|
+
datatype: "Database",
|
|
10493
|
+
title: "CUBESETCOUNT",
|
|
10494
|
+
syntax: "CUBESETCOUNT(set)",
|
|
10495
|
+
description: "Returns the number of items in a cube set. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10496
|
+
example: "CUBESETCOUNT(CUBESET(\"Sales\",\"[Product].[All Products].Children\"))",
|
|
10497
|
+
usage: ["CUBESETCOUNT(CUBESET(\"Sales\",\"[Product].[All Products].Children\"))"],
|
|
10498
|
+
parameters: [
|
|
10499
|
+
{
|
|
10500
|
+
title: "set",
|
|
10501
|
+
description: "A CUBESET result or a reference to a CUBESET cell.",
|
|
10502
|
+
},
|
|
10503
|
+
],
|
|
10504
|
+
},
|
|
10505
|
+
{
|
|
10506
|
+
datatype: "Database",
|
|
10507
|
+
title: "CUBEVALUE",
|
|
10508
|
+
syntax: "CUBEVALUE(connection, [member_expression1], ...)",
|
|
10509
|
+
description: "Returns an aggregated value from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10510
|
+
example: "CUBEVALUE(\"Sales\",\"[Measures].[Profit]\",\"[Time].[2024]\")",
|
|
10511
|
+
usage: ["CUBEVALUE(\"Sales\",\"[Measures].[Profit]\",\"[Time].[2024]\")"],
|
|
10512
|
+
parameters: [
|
|
10513
|
+
{
|
|
10514
|
+
title: "connection",
|
|
10515
|
+
description: "The name of the workbook connection to the cube.",
|
|
10516
|
+
},
|
|
10517
|
+
{
|
|
10518
|
+
title: "member_expression1 [OPTIONAL]",
|
|
10519
|
+
description: "An MDX expression for a member or tuple; more may follow.",
|
|
10520
|
+
},
|
|
10521
|
+
],
|
|
10522
|
+
},
|
|
10523
|
+
{
|
|
10524
|
+
datatype: "Lookup",
|
|
10525
|
+
title: "RTD",
|
|
10526
|
+
syntax: "RTD(prog_id, server, topic1, [topic2], ...)",
|
|
10527
|
+
description: "Retrieves real-time data from a program that supports COM automation. Athena has no real-time data server, so the call returns #N/A, as Excel does when the server is not installed.",
|
|
10528
|
+
example: "RTD(\"mytest.rtd\",,\"Price\")",
|
|
10529
|
+
usage: ["RTD(\"mytest.rtd\",,\"Price\")"],
|
|
10530
|
+
parameters: [
|
|
10531
|
+
{
|
|
10532
|
+
title: "prog_id",
|
|
10533
|
+
description: "The registered ProgID of the RTD server.",
|
|
10534
|
+
},
|
|
10535
|
+
{
|
|
10536
|
+
title: "server",
|
|
10537
|
+
description: "The server that runs the RTD server; blank for the local machine.",
|
|
10538
|
+
},
|
|
10539
|
+
{
|
|
10540
|
+
title: "topic1",
|
|
10541
|
+
description: "The data to retrieve; up to 253 topics.",
|
|
10542
|
+
},
|
|
10543
|
+
],
|
|
10544
|
+
},
|
|
10545
|
+
{
|
|
10546
|
+
datatype: "Info",
|
|
10547
|
+
title: "STOCKHISTORY",
|
|
10548
|
+
syntax: "STOCKHISTORY(stock, start_date, [end_date], [interval], [headers], [property0], ...)",
|
|
10549
|
+
description: "Retrieves historical data about a financial instrument as an array. Athena has no connection to the stock data service, so the call returns #CONNECT!.",
|
|
10550
|
+
example: "STOCKHISTORY(\"MSFT\",\"1/1/2024\",\"1/31/2024\")",
|
|
10551
|
+
usage: ["STOCKHISTORY(\"MSFT\",\"1/1/2024\",\"1/31/2024\")"],
|
|
10552
|
+
parameters: [
|
|
10553
|
+
{
|
|
10554
|
+
title: "stock",
|
|
10555
|
+
description: "A ticker symbol in quotes or a Stocks data type.",
|
|
10556
|
+
},
|
|
10557
|
+
{
|
|
10558
|
+
title: "start_date",
|
|
10559
|
+
description: "The earliest date to retrieve.",
|
|
10560
|
+
},
|
|
10561
|
+
{
|
|
10562
|
+
title: "end_date [OPTIONAL]",
|
|
10563
|
+
description: "The latest date to retrieve; defaults to start_date.",
|
|
10564
|
+
},
|
|
10565
|
+
{
|
|
10566
|
+
title: "interval [OPTIONAL]",
|
|
10567
|
+
description: "0 daily (default), 1 weekly, 2 monthly.",
|
|
10568
|
+
},
|
|
10569
|
+
{
|
|
10570
|
+
title: "headers [OPTIONAL]",
|
|
10571
|
+
description: "0 no headers, 1 headers (default), 2 instrument identifier and headers.",
|
|
10572
|
+
},
|
|
10573
|
+
{
|
|
10574
|
+
title: "property0 [OPTIONAL]",
|
|
10575
|
+
description: "Columns to return: 0 Date, 1 Close, 2 Open, 3 High, 4 Low, 5 Volume.",
|
|
10576
|
+
},
|
|
10577
|
+
],
|
|
10578
|
+
},
|
|
10579
|
+
{
|
|
10580
|
+
datatype: "Text",
|
|
10581
|
+
title: "TRANSLATE",
|
|
10582
|
+
syntax: "TRANSLATE(text, [source_language], [target_language])",
|
|
10583
|
+
description: "Translates text from one language to another. Athena has no connection to the translation service, so the call returns #CONNECT!.",
|
|
10584
|
+
example: "TRANSLATE(\"Hello\",\"en\",\"fr\")",
|
|
10585
|
+
usage: ["TRANSLATE(\"Hello\",\"en\",\"fr\")"],
|
|
10586
|
+
parameters: [
|
|
10587
|
+
{
|
|
10588
|
+
title: "text",
|
|
10589
|
+
description: "The text to translate.",
|
|
10590
|
+
},
|
|
10591
|
+
{
|
|
10592
|
+
title: "source_language [OPTIONAL]",
|
|
10593
|
+
description: "Language code of the text; detected when omitted.",
|
|
10594
|
+
},
|
|
10595
|
+
{
|
|
10596
|
+
title: "target_language [OPTIONAL]",
|
|
10597
|
+
description: "Language code to translate into.",
|
|
10598
|
+
},
|
|
10599
|
+
],
|
|
10600
|
+
},
|
|
10601
|
+
{
|
|
10602
|
+
datatype: "Text",
|
|
10603
|
+
title: "DETECTLANGUAGE",
|
|
10604
|
+
syntax: "DETECTLANGUAGE(text)",
|
|
10605
|
+
description: "Identifies the language of a text. Athena has no connection to the translation service, so the call returns #CONNECT!.",
|
|
10606
|
+
example: "DETECTLANGUAGE(\"Bonjour\")",
|
|
10607
|
+
usage: ["DETECTLANGUAGE(\"Bonjour\")"],
|
|
10608
|
+
parameters: [
|
|
10609
|
+
{
|
|
10610
|
+
title: "text",
|
|
10611
|
+
description: "The text whose language to detect.",
|
|
10612
|
+
},
|
|
10613
|
+
],
|
|
10614
|
+
},
|
|
10615
|
+
{
|
|
10616
|
+
datatype: "Financial",
|
|
10617
|
+
title: "EUROCONVERT",
|
|
10618
|
+
syntax: "EUROCONVERT(number, source, target, [full_precision], [triangulation_precision])",
|
|
10619
|
+
description: "Converts a number to euros, from euros to a euro member currency, or between member currencies through the euro, at the fixed EU conversion rates.",
|
|
10620
|
+
example: "EUROCONVERT(1.2,\"DEM\",\"EUR\")",
|
|
10621
|
+
usage: ["EUROCONVERT(1.2,\"DEM\",\"EUR\")"],
|
|
10622
|
+
parameters: [
|
|
10623
|
+
{
|
|
10624
|
+
title: "number",
|
|
10625
|
+
description: "The amount to convert.",
|
|
10626
|
+
},
|
|
10627
|
+
{
|
|
10628
|
+
title: "source",
|
|
10629
|
+
description: "ISO code of the source currency: EUR, BEF, LUF, DEM, ESP, FRF, IEP, ITL, NLG, ATS, PTE, FIM, GRD or SIT.",
|
|
10630
|
+
},
|
|
10631
|
+
{
|
|
10632
|
+
title: "target",
|
|
10633
|
+
description: "ISO code of the target currency.",
|
|
10634
|
+
},
|
|
10635
|
+
{
|
|
10636
|
+
title: "full_precision [OPTIONAL]",
|
|
10637
|
+
description: "TRUE keeps every digit; FALSE (default) rounds to the target currency's decimals.",
|
|
10638
|
+
},
|
|
10639
|
+
{
|
|
10640
|
+
title: "triangulation_precision [OPTIONAL]",
|
|
10641
|
+
description: "Decimals (3 or more) for the intermediate euro value.",
|
|
10642
|
+
},
|
|
10643
|
+
],
|
|
10644
|
+
},
|
|
10645
|
+
{
|
|
10646
|
+
datatype: "Web",
|
|
10647
|
+
title: "IMPORTTEXT",
|
|
10648
|
+
syntax: "IMPORTTEXT(path, [delimiter], [skip_rows], [take_rows], [encoding], [locale])",
|
|
10649
|
+
description: "Imports a text file (CSV, TSV, TXT) as an array. Athena cannot read files from a local path, so the call returns #BLOCKED!.",
|
|
10650
|
+
example: "IMPORTTEXT(\"C:\\\\data\\\\sales.txt\",\",\")",
|
|
10651
|
+
usage: ["IMPORTTEXT(\"C:\\\\data\\\\sales.txt\",\",\")"],
|
|
10652
|
+
parameters: [
|
|
10653
|
+
{
|
|
10654
|
+
title: "path",
|
|
10655
|
+
description: "The file path or URL of the text file.",
|
|
10656
|
+
},
|
|
10657
|
+
{
|
|
10658
|
+
title: "delimiter [OPTIONAL]",
|
|
10659
|
+
description: "The column delimiter; tab by default.",
|
|
10660
|
+
},
|
|
10661
|
+
{
|
|
10662
|
+
title: "skip_rows [OPTIONAL]",
|
|
10663
|
+
description: "Rows to skip from the start (negative: from the end).",
|
|
10664
|
+
},
|
|
10665
|
+
{
|
|
10666
|
+
title: "take_rows [OPTIONAL]",
|
|
10667
|
+
description: "Rows to return (negative: from the end).",
|
|
10668
|
+
},
|
|
10669
|
+
{
|
|
10670
|
+
title: "encoding [OPTIONAL]",
|
|
10671
|
+
description: "The file encoding; UTF-8 by default.",
|
|
10672
|
+
},
|
|
10673
|
+
{
|
|
10674
|
+
title: "locale [OPTIONAL]",
|
|
10675
|
+
description: "The locale for numbers and dates.",
|
|
10676
|
+
},
|
|
10677
|
+
],
|
|
10678
|
+
},
|
|
10679
|
+
{
|
|
10680
|
+
datatype: "Web",
|
|
10681
|
+
title: "IMPORTCSV",
|
|
10682
|
+
syntax: "IMPORTCSV(path, [skip_rows], [take_rows], [locale])",
|
|
10683
|
+
description: "Imports a CSV file as an array. Athena cannot read files from a local path, so the call returns #BLOCKED!.",
|
|
10684
|
+
example: "IMPORTCSV(\"C:\\\\data\\\\sales.csv\")",
|
|
10685
|
+
usage: ["IMPORTCSV(\"C:\\\\data\\\\sales.csv\")"],
|
|
10686
|
+
parameters: [
|
|
10687
|
+
{
|
|
10688
|
+
title: "path",
|
|
10689
|
+
description: "The file path or URL of the CSV file.",
|
|
10690
|
+
},
|
|
10691
|
+
{
|
|
10692
|
+
title: "skip_rows [OPTIONAL]",
|
|
10693
|
+
description: "Rows to skip from the start (negative: from the end).",
|
|
10694
|
+
},
|
|
10695
|
+
{
|
|
10696
|
+
title: "take_rows [OPTIONAL]",
|
|
10697
|
+
description: "Rows to return (negative: from the end).",
|
|
10698
|
+
},
|
|
10699
|
+
{
|
|
10700
|
+
title: "locale [OPTIONAL]",
|
|
10701
|
+
description: "The locale for numbers and dates.",
|
|
10702
|
+
},
|
|
10703
|
+
],
|
|
10704
|
+
},
|
|
10705
|
+
{
|
|
10706
|
+
datatype: "Info",
|
|
10707
|
+
title: "PY",
|
|
10708
|
+
syntax: "PY(python_code, return_type)",
|
|
10709
|
+
description: "Runs Python code (Python in Excel). Athena has no Python in Excel runtime, so the call returns #BLOCKED!.",
|
|
10710
|
+
example: "PY(\"1+1\",0)",
|
|
10711
|
+
usage: ["PY(\"1+1\",0)"],
|
|
10712
|
+
parameters: [
|
|
10713
|
+
{
|
|
10714
|
+
title: "python_code",
|
|
10715
|
+
description: "The Python code to run.",
|
|
10716
|
+
},
|
|
10717
|
+
{
|
|
10718
|
+
title: "return_type",
|
|
10719
|
+
description: "0 returns an Excel value, 1 a Python object.",
|
|
10720
|
+
},
|
|
10721
|
+
],
|
|
10722
|
+
},
|
|
10723
|
+
{
|
|
10724
|
+
datatype: "Info",
|
|
10725
|
+
title: "FIELDVALUE",
|
|
10726
|
+
syntax: "FIELDVALUE(value, field_name)",
|
|
10727
|
+
description: "Returns a field from a linked data type value, the same as value.field_name. Athena has no linked data types, so the call returns #FIELD!.",
|
|
10728
|
+
example: "FIELDVALUE(A2,\"Price\")",
|
|
10729
|
+
usage: ["FIELDVALUE(A2,\"Price\")"],
|
|
10730
|
+
parameters: [
|
|
10731
|
+
{
|
|
10732
|
+
title: "value",
|
|
10733
|
+
description: "A cell holding a linked data type.",
|
|
10734
|
+
},
|
|
10735
|
+
{
|
|
10736
|
+
title: "field_name",
|
|
10737
|
+
description: "The name of the field to return.",
|
|
10738
|
+
},
|
|
10739
|
+
],
|
|
10740
|
+
},
|
|
10365
10741
|
];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"function-descriptions.d.ts","sourceRoot":"","sources":["../../function-descriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,
|
|
1
|
+
{"version":3,"file":"function-descriptions.d.ts","sourceRoot":"","sources":["../../function-descriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,eAAO,MAAM,oBAAoB,EAAE,kBAAkB,EAklXpD,CAAC"}
|
|
@@ -10359,4 +10359,380 @@ export const functionDescriptions = [
|
|
|
10359
10359
|
},
|
|
10360
10360
|
],
|
|
10361
10361
|
},
|
|
10362
|
+
{
|
|
10363
|
+
datatype: "Database",
|
|
10364
|
+
title: "CUBEKPIMEMBER",
|
|
10365
|
+
syntax: "CUBEKPIMEMBER(connection, kpi_name, kpi_property, [caption])",
|
|
10366
|
+
description: "Returns a key performance indicator (KPI) property from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10367
|
+
example: "CUBEKPIMEMBER(\"Sales\",\"MySalesKPI\",1)",
|
|
10368
|
+
usage: ["CUBEKPIMEMBER(\"Sales\",\"MySalesKPI\",1)"],
|
|
10369
|
+
parameters: [
|
|
10370
|
+
{
|
|
10371
|
+
title: "connection",
|
|
10372
|
+
description: "The name of the workbook connection to the cube.",
|
|
10373
|
+
},
|
|
10374
|
+
{
|
|
10375
|
+
title: "kpi_name",
|
|
10376
|
+
description: "The name of the KPI in the cube.",
|
|
10377
|
+
},
|
|
10378
|
+
{
|
|
10379
|
+
title: "kpi_property",
|
|
10380
|
+
description: "The KPI component returned (1 value, 2 goal, 3 status, 4 trend, 5 weight, 6 current time member).",
|
|
10381
|
+
},
|
|
10382
|
+
{
|
|
10383
|
+
title: "caption [OPTIONAL]",
|
|
10384
|
+
description: "Text shown in the cell instead of the KPI name.",
|
|
10385
|
+
},
|
|
10386
|
+
],
|
|
10387
|
+
},
|
|
10388
|
+
{
|
|
10389
|
+
datatype: "Database",
|
|
10390
|
+
title: "CUBEMEMBER",
|
|
10391
|
+
syntax: "CUBEMEMBER(connection, member_expression, [caption])",
|
|
10392
|
+
description: "Returns a member or tuple from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10393
|
+
example: "CUBEMEMBER(\"Sales\",\"[Time].[Fiscal].[2024]\")",
|
|
10394
|
+
usage: ["CUBEMEMBER(\"Sales\",\"[Time].[Fiscal].[2024]\")"],
|
|
10395
|
+
parameters: [
|
|
10396
|
+
{
|
|
10397
|
+
title: "connection",
|
|
10398
|
+
description: "The name of the workbook connection to the cube.",
|
|
10399
|
+
},
|
|
10400
|
+
{
|
|
10401
|
+
title: "member_expression",
|
|
10402
|
+
description: "An MDX expression that evaluates to a unique member or tuple.",
|
|
10403
|
+
},
|
|
10404
|
+
{
|
|
10405
|
+
title: "caption [OPTIONAL]",
|
|
10406
|
+
description: "Text shown in the cell instead of the member caption.",
|
|
10407
|
+
},
|
|
10408
|
+
],
|
|
10409
|
+
},
|
|
10410
|
+
{
|
|
10411
|
+
datatype: "Database",
|
|
10412
|
+
title: "CUBEMEMBERPROPERTY",
|
|
10413
|
+
syntax: "CUBEMEMBERPROPERTY(connection, member_expression, property)",
|
|
10414
|
+
description: "Returns the value of a member property from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10415
|
+
example: "CUBEMEMBERPROPERTY(\"Sales\",\"[Store].[MyFavoriteStore]\",\"[Store].[Store Name].[Store Sqft]\")",
|
|
10416
|
+
usage: ["CUBEMEMBERPROPERTY(\"Sales\",\"[Store].[MyFavoriteStore]\",\"[Store].[Store Name].[Store Sqft]\")"],
|
|
10417
|
+
parameters: [
|
|
10418
|
+
{
|
|
10419
|
+
title: "connection",
|
|
10420
|
+
description: "The name of the workbook connection to the cube.",
|
|
10421
|
+
},
|
|
10422
|
+
{
|
|
10423
|
+
title: "member_expression",
|
|
10424
|
+
description: "An MDX expression for the member.",
|
|
10425
|
+
},
|
|
10426
|
+
{
|
|
10427
|
+
title: "property",
|
|
10428
|
+
description: "The name of the property to return.",
|
|
10429
|
+
},
|
|
10430
|
+
],
|
|
10431
|
+
},
|
|
10432
|
+
{
|
|
10433
|
+
datatype: "Database",
|
|
10434
|
+
title: "CUBERANKEDMEMBER",
|
|
10435
|
+
syntax: "CUBERANKEDMEMBER(connection, set_expression, rank, [caption])",
|
|
10436
|
+
description: "Returns the nth, or ranked, member of a set from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10437
|
+
example: "CUBERANKEDMEMBER(\"Sales\",$D$4,1,\"Top Month\")",
|
|
10438
|
+
usage: ["CUBERANKEDMEMBER(\"Sales\",$D$4,1,\"Top Month\")"],
|
|
10439
|
+
parameters: [
|
|
10440
|
+
{
|
|
10441
|
+
title: "connection",
|
|
10442
|
+
description: "The name of the workbook connection to the cube.",
|
|
10443
|
+
},
|
|
10444
|
+
{
|
|
10445
|
+
title: "set_expression",
|
|
10446
|
+
description: "A set expression or a reference to a CUBESET cell.",
|
|
10447
|
+
},
|
|
10448
|
+
{
|
|
10449
|
+
title: "rank",
|
|
10450
|
+
description: "The position of the member to return.",
|
|
10451
|
+
},
|
|
10452
|
+
{
|
|
10453
|
+
title: "caption [OPTIONAL]",
|
|
10454
|
+
description: "Text shown in the cell instead of the member caption.",
|
|
10455
|
+
},
|
|
10456
|
+
],
|
|
10457
|
+
},
|
|
10458
|
+
{
|
|
10459
|
+
datatype: "Database",
|
|
10460
|
+
title: "CUBESET",
|
|
10461
|
+
syntax: "CUBESET(connection, set_expression, [caption], [sort_order], [sort_by])",
|
|
10462
|
+
description: "Defines a calculated set of members or tuples on an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10463
|
+
example: "CUBESET(\"Sales\",\"[Product].[All Products].Children\",\"Products\",1,\"[Measures].[Sales Amount]\")",
|
|
10464
|
+
usage: ["CUBESET(\"Sales\",\"[Product].[All Products].Children\",\"Products\",1,\"[Measures].[Sales Amount]\")"],
|
|
10465
|
+
parameters: [
|
|
10466
|
+
{
|
|
10467
|
+
title: "connection",
|
|
10468
|
+
description: "The name of the workbook connection to the cube.",
|
|
10469
|
+
},
|
|
10470
|
+
{
|
|
10471
|
+
title: "set_expression",
|
|
10472
|
+
description: "An MDX expression that results in a set.",
|
|
10473
|
+
},
|
|
10474
|
+
{
|
|
10475
|
+
title: "caption [OPTIONAL]",
|
|
10476
|
+
description: "Text shown in the cell.",
|
|
10477
|
+
},
|
|
10478
|
+
{
|
|
10479
|
+
title: "sort_order [OPTIONAL]",
|
|
10480
|
+
description: "How the set is sorted (0 none to 6 descending natural).",
|
|
10481
|
+
},
|
|
10482
|
+
{
|
|
10483
|
+
title: "sort_by [OPTIONAL]",
|
|
10484
|
+
description: "The value to sort by.",
|
|
10485
|
+
},
|
|
10486
|
+
],
|
|
10487
|
+
},
|
|
10488
|
+
{
|
|
10489
|
+
datatype: "Database",
|
|
10490
|
+
title: "CUBESETCOUNT",
|
|
10491
|
+
syntax: "CUBESETCOUNT(set)",
|
|
10492
|
+
description: "Returns the number of items in a cube set. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10493
|
+
example: "CUBESETCOUNT(CUBESET(\"Sales\",\"[Product].[All Products].Children\"))",
|
|
10494
|
+
usage: ["CUBESETCOUNT(CUBESET(\"Sales\",\"[Product].[All Products].Children\"))"],
|
|
10495
|
+
parameters: [
|
|
10496
|
+
{
|
|
10497
|
+
title: "set",
|
|
10498
|
+
description: "A CUBESET result or a reference to a CUBESET cell.",
|
|
10499
|
+
},
|
|
10500
|
+
],
|
|
10501
|
+
},
|
|
10502
|
+
{
|
|
10503
|
+
datatype: "Database",
|
|
10504
|
+
title: "CUBEVALUE",
|
|
10505
|
+
syntax: "CUBEVALUE(connection, [member_expression1], ...)",
|
|
10506
|
+
description: "Returns an aggregated value from an OLAP cube. Athena has no connection to this provider, so the call returns #NAME?, as Excel does without a cube connection.",
|
|
10507
|
+
example: "CUBEVALUE(\"Sales\",\"[Measures].[Profit]\",\"[Time].[2024]\")",
|
|
10508
|
+
usage: ["CUBEVALUE(\"Sales\",\"[Measures].[Profit]\",\"[Time].[2024]\")"],
|
|
10509
|
+
parameters: [
|
|
10510
|
+
{
|
|
10511
|
+
title: "connection",
|
|
10512
|
+
description: "The name of the workbook connection to the cube.",
|
|
10513
|
+
},
|
|
10514
|
+
{
|
|
10515
|
+
title: "member_expression1 [OPTIONAL]",
|
|
10516
|
+
description: "An MDX expression for a member or tuple; more may follow.",
|
|
10517
|
+
},
|
|
10518
|
+
],
|
|
10519
|
+
},
|
|
10520
|
+
{
|
|
10521
|
+
datatype: "Lookup",
|
|
10522
|
+
title: "RTD",
|
|
10523
|
+
syntax: "RTD(prog_id, server, topic1, [topic2], ...)",
|
|
10524
|
+
description: "Retrieves real-time data from a program that supports COM automation. Athena has no real-time data server, so the call returns #N/A, as Excel does when the server is not installed.",
|
|
10525
|
+
example: "RTD(\"mytest.rtd\",,\"Price\")",
|
|
10526
|
+
usage: ["RTD(\"mytest.rtd\",,\"Price\")"],
|
|
10527
|
+
parameters: [
|
|
10528
|
+
{
|
|
10529
|
+
title: "prog_id",
|
|
10530
|
+
description: "The registered ProgID of the RTD server.",
|
|
10531
|
+
},
|
|
10532
|
+
{
|
|
10533
|
+
title: "server",
|
|
10534
|
+
description: "The server that runs the RTD server; blank for the local machine.",
|
|
10535
|
+
},
|
|
10536
|
+
{
|
|
10537
|
+
title: "topic1",
|
|
10538
|
+
description: "The data to retrieve; up to 253 topics.",
|
|
10539
|
+
},
|
|
10540
|
+
],
|
|
10541
|
+
},
|
|
10542
|
+
{
|
|
10543
|
+
datatype: "Info",
|
|
10544
|
+
title: "STOCKHISTORY",
|
|
10545
|
+
syntax: "STOCKHISTORY(stock, start_date, [end_date], [interval], [headers], [property0], ...)",
|
|
10546
|
+
description: "Retrieves historical data about a financial instrument as an array. Athena has no connection to the stock data service, so the call returns #CONNECT!.",
|
|
10547
|
+
example: "STOCKHISTORY(\"MSFT\",\"1/1/2024\",\"1/31/2024\")",
|
|
10548
|
+
usage: ["STOCKHISTORY(\"MSFT\",\"1/1/2024\",\"1/31/2024\")"],
|
|
10549
|
+
parameters: [
|
|
10550
|
+
{
|
|
10551
|
+
title: "stock",
|
|
10552
|
+
description: "A ticker symbol in quotes or a Stocks data type.",
|
|
10553
|
+
},
|
|
10554
|
+
{
|
|
10555
|
+
title: "start_date",
|
|
10556
|
+
description: "The earliest date to retrieve.",
|
|
10557
|
+
},
|
|
10558
|
+
{
|
|
10559
|
+
title: "end_date [OPTIONAL]",
|
|
10560
|
+
description: "The latest date to retrieve; defaults to start_date.",
|
|
10561
|
+
},
|
|
10562
|
+
{
|
|
10563
|
+
title: "interval [OPTIONAL]",
|
|
10564
|
+
description: "0 daily (default), 1 weekly, 2 monthly.",
|
|
10565
|
+
},
|
|
10566
|
+
{
|
|
10567
|
+
title: "headers [OPTIONAL]",
|
|
10568
|
+
description: "0 no headers, 1 headers (default), 2 instrument identifier and headers.",
|
|
10569
|
+
},
|
|
10570
|
+
{
|
|
10571
|
+
title: "property0 [OPTIONAL]",
|
|
10572
|
+
description: "Columns to return: 0 Date, 1 Close, 2 Open, 3 High, 4 Low, 5 Volume.",
|
|
10573
|
+
},
|
|
10574
|
+
],
|
|
10575
|
+
},
|
|
10576
|
+
{
|
|
10577
|
+
datatype: "Text",
|
|
10578
|
+
title: "TRANSLATE",
|
|
10579
|
+
syntax: "TRANSLATE(text, [source_language], [target_language])",
|
|
10580
|
+
description: "Translates text from one language to another. Athena has no connection to the translation service, so the call returns #CONNECT!.",
|
|
10581
|
+
example: "TRANSLATE(\"Hello\",\"en\",\"fr\")",
|
|
10582
|
+
usage: ["TRANSLATE(\"Hello\",\"en\",\"fr\")"],
|
|
10583
|
+
parameters: [
|
|
10584
|
+
{
|
|
10585
|
+
title: "text",
|
|
10586
|
+
description: "The text to translate.",
|
|
10587
|
+
},
|
|
10588
|
+
{
|
|
10589
|
+
title: "source_language [OPTIONAL]",
|
|
10590
|
+
description: "Language code of the text; detected when omitted.",
|
|
10591
|
+
},
|
|
10592
|
+
{
|
|
10593
|
+
title: "target_language [OPTIONAL]",
|
|
10594
|
+
description: "Language code to translate into.",
|
|
10595
|
+
},
|
|
10596
|
+
],
|
|
10597
|
+
},
|
|
10598
|
+
{
|
|
10599
|
+
datatype: "Text",
|
|
10600
|
+
title: "DETECTLANGUAGE",
|
|
10601
|
+
syntax: "DETECTLANGUAGE(text)",
|
|
10602
|
+
description: "Identifies the language of a text. Athena has no connection to the translation service, so the call returns #CONNECT!.",
|
|
10603
|
+
example: "DETECTLANGUAGE(\"Bonjour\")",
|
|
10604
|
+
usage: ["DETECTLANGUAGE(\"Bonjour\")"],
|
|
10605
|
+
parameters: [
|
|
10606
|
+
{
|
|
10607
|
+
title: "text",
|
|
10608
|
+
description: "The text whose language to detect.",
|
|
10609
|
+
},
|
|
10610
|
+
],
|
|
10611
|
+
},
|
|
10612
|
+
{
|
|
10613
|
+
datatype: "Financial",
|
|
10614
|
+
title: "EUROCONVERT",
|
|
10615
|
+
syntax: "EUROCONVERT(number, source, target, [full_precision], [triangulation_precision])",
|
|
10616
|
+
description: "Converts a number to euros, from euros to a euro member currency, or between member currencies through the euro, at the fixed EU conversion rates.",
|
|
10617
|
+
example: "EUROCONVERT(1.2,\"DEM\",\"EUR\")",
|
|
10618
|
+
usage: ["EUROCONVERT(1.2,\"DEM\",\"EUR\")"],
|
|
10619
|
+
parameters: [
|
|
10620
|
+
{
|
|
10621
|
+
title: "number",
|
|
10622
|
+
description: "The amount to convert.",
|
|
10623
|
+
},
|
|
10624
|
+
{
|
|
10625
|
+
title: "source",
|
|
10626
|
+
description: "ISO code of the source currency: EUR, BEF, LUF, DEM, ESP, FRF, IEP, ITL, NLG, ATS, PTE, FIM, GRD or SIT.",
|
|
10627
|
+
},
|
|
10628
|
+
{
|
|
10629
|
+
title: "target",
|
|
10630
|
+
description: "ISO code of the target currency.",
|
|
10631
|
+
},
|
|
10632
|
+
{
|
|
10633
|
+
title: "full_precision [OPTIONAL]",
|
|
10634
|
+
description: "TRUE keeps every digit; FALSE (default) rounds to the target currency's decimals.",
|
|
10635
|
+
},
|
|
10636
|
+
{
|
|
10637
|
+
title: "triangulation_precision [OPTIONAL]",
|
|
10638
|
+
description: "Decimals (3 or more) for the intermediate euro value.",
|
|
10639
|
+
},
|
|
10640
|
+
],
|
|
10641
|
+
},
|
|
10642
|
+
{
|
|
10643
|
+
datatype: "Web",
|
|
10644
|
+
title: "IMPORTTEXT",
|
|
10645
|
+
syntax: "IMPORTTEXT(path, [delimiter], [skip_rows], [take_rows], [encoding], [locale])",
|
|
10646
|
+
description: "Imports a text file (CSV, TSV, TXT) as an array. Athena cannot read files from a local path, so the call returns #BLOCKED!.",
|
|
10647
|
+
example: "IMPORTTEXT(\"C:\\\\data\\\\sales.txt\",\",\")",
|
|
10648
|
+
usage: ["IMPORTTEXT(\"C:\\\\data\\\\sales.txt\",\",\")"],
|
|
10649
|
+
parameters: [
|
|
10650
|
+
{
|
|
10651
|
+
title: "path",
|
|
10652
|
+
description: "The file path or URL of the text file.",
|
|
10653
|
+
},
|
|
10654
|
+
{
|
|
10655
|
+
title: "delimiter [OPTIONAL]",
|
|
10656
|
+
description: "The column delimiter; tab by default.",
|
|
10657
|
+
},
|
|
10658
|
+
{
|
|
10659
|
+
title: "skip_rows [OPTIONAL]",
|
|
10660
|
+
description: "Rows to skip from the start (negative: from the end).",
|
|
10661
|
+
},
|
|
10662
|
+
{
|
|
10663
|
+
title: "take_rows [OPTIONAL]",
|
|
10664
|
+
description: "Rows to return (negative: from the end).",
|
|
10665
|
+
},
|
|
10666
|
+
{
|
|
10667
|
+
title: "encoding [OPTIONAL]",
|
|
10668
|
+
description: "The file encoding; UTF-8 by default.",
|
|
10669
|
+
},
|
|
10670
|
+
{
|
|
10671
|
+
title: "locale [OPTIONAL]",
|
|
10672
|
+
description: "The locale for numbers and dates.",
|
|
10673
|
+
},
|
|
10674
|
+
],
|
|
10675
|
+
},
|
|
10676
|
+
{
|
|
10677
|
+
datatype: "Web",
|
|
10678
|
+
title: "IMPORTCSV",
|
|
10679
|
+
syntax: "IMPORTCSV(path, [skip_rows], [take_rows], [locale])",
|
|
10680
|
+
description: "Imports a CSV file as an array. Athena cannot read files from a local path, so the call returns #BLOCKED!.",
|
|
10681
|
+
example: "IMPORTCSV(\"C:\\\\data\\\\sales.csv\")",
|
|
10682
|
+
usage: ["IMPORTCSV(\"C:\\\\data\\\\sales.csv\")"],
|
|
10683
|
+
parameters: [
|
|
10684
|
+
{
|
|
10685
|
+
title: "path",
|
|
10686
|
+
description: "The file path or URL of the CSV file.",
|
|
10687
|
+
},
|
|
10688
|
+
{
|
|
10689
|
+
title: "skip_rows [OPTIONAL]",
|
|
10690
|
+
description: "Rows to skip from the start (negative: from the end).",
|
|
10691
|
+
},
|
|
10692
|
+
{
|
|
10693
|
+
title: "take_rows [OPTIONAL]",
|
|
10694
|
+
description: "Rows to return (negative: from the end).",
|
|
10695
|
+
},
|
|
10696
|
+
{
|
|
10697
|
+
title: "locale [OPTIONAL]",
|
|
10698
|
+
description: "The locale for numbers and dates.",
|
|
10699
|
+
},
|
|
10700
|
+
],
|
|
10701
|
+
},
|
|
10702
|
+
{
|
|
10703
|
+
datatype: "Info",
|
|
10704
|
+
title: "PY",
|
|
10705
|
+
syntax: "PY(python_code, return_type)",
|
|
10706
|
+
description: "Runs Python code (Python in Excel). Athena has no Python in Excel runtime, so the call returns #BLOCKED!.",
|
|
10707
|
+
example: "PY(\"1+1\",0)",
|
|
10708
|
+
usage: ["PY(\"1+1\",0)"],
|
|
10709
|
+
parameters: [
|
|
10710
|
+
{
|
|
10711
|
+
title: "python_code",
|
|
10712
|
+
description: "The Python code to run.",
|
|
10713
|
+
},
|
|
10714
|
+
{
|
|
10715
|
+
title: "return_type",
|
|
10716
|
+
description: "0 returns an Excel value, 1 a Python object.",
|
|
10717
|
+
},
|
|
10718
|
+
],
|
|
10719
|
+
},
|
|
10720
|
+
{
|
|
10721
|
+
datatype: "Info",
|
|
10722
|
+
title: "FIELDVALUE",
|
|
10723
|
+
syntax: "FIELDVALUE(value, field_name)",
|
|
10724
|
+
description: "Returns a field from a linked data type value, the same as value.field_name. Athena has no linked data types, so the call returns #FIELD!.",
|
|
10725
|
+
example: "FIELDVALUE(A2,\"Price\")",
|
|
10726
|
+
usage: ["FIELDVALUE(A2,\"Price\")"],
|
|
10727
|
+
parameters: [
|
|
10728
|
+
{
|
|
10729
|
+
title: "value",
|
|
10730
|
+
description: "A cell holding a linked data type.",
|
|
10731
|
+
},
|
|
10732
|
+
{
|
|
10733
|
+
title: "field_name",
|
|
10734
|
+
description: "The name of the field to return.",
|
|
10735
|
+
},
|
|
10736
|
+
],
|
|
10737
|
+
},
|
|
10362
10738
|
];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rowsncolumns/functions",
|
|
3
|
-
"version": "15.1.
|
|
3
|
+
"version": "15.1.1",
|
|
4
4
|
"author": "Vinay M",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
6
6
|
"main": "./dist/cjs/index.js",
|
|
@@ -42,11 +42,11 @@
|
|
|
42
42
|
"url": "https://github.com/rowsncolumns/spreadsheet/issues"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
-
"@rowsncolumns/common-types": ">=5.3.
|
|
45
|
+
"@rowsncolumns/common-types": ">=5.3.6",
|
|
46
46
|
"@rowsncolumns/calculator": ">=7.3.2",
|
|
47
47
|
"@rowsncolumns/fast-formula-parser": ">=6.2.43",
|
|
48
|
-
"@rowsncolumns/utils": ">=9.
|
|
49
|
-
"@rowsncolumns/toolkit": ">=24.5.
|
|
48
|
+
"@rowsncolumns/utils": ">=9.6.3",
|
|
49
|
+
"@rowsncolumns/toolkit": ">=24.5.21"
|
|
50
50
|
},
|
|
51
51
|
"peerDependencies": {
|
|
52
52
|
"@rowsncolumns/common-types": ">=5.2.32",
|