From b8ddfd1c0ff1de1f72230126b58bce8d7403cf31 Mon Sep 17 00:00:00 2001 From: Kenichiro Nakamura Date: Tue, 12 Jun 2018 10:57:07 +0900 Subject: [PATCH] update getCategoryValueType function signature and sample are incorrect for getCategoryValueType. --- docs/api/axis-helper.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/docs/api/axis-helper.md b/docs/api/axis-helper.md index a478f2e..bd82bb4 100644 --- a/docs/api/axis-helper.md +++ b/docs/api/axis-helper.md @@ -326,7 +326,7 @@ var domain = axisHelper.createDomain(cartesianSeries, ValueType.fromDescriptor({ This function gets the ValueType of a category column, defaults to Text if the type is not present. ```typescript -function getCategoryValueType(data: any[], axisType: ValueTypeDescriptor, isScalar: boolean, forcedScalarDomain: any[], ensureDomain?: NumberRange): number[]; +function getCategoryValueType(metadataColumn: DataViewMetadataColumn, isScalar?: boolean): ValueType; ``` ### Example @@ -334,19 +334,14 @@ function getCategoryValueType(data: any[], axisType: ValueTypeDescriptor, isScal ```typescript import axisHelper = powerbi.extensibility.utils.chart.axis; -var cartesianSeries = [ - { - data: [{ categoryValue: 7, value: 11, categoryIndex: 0, seriesIndex: 0, }, { - categoryValue: 9, value: 9, categoryIndex: 1, seriesIndex: 0, - }, { - categoryValue: 15, value: 6, categoryIndex: 2, seriesIndex: 0, - }, { categoryValue: 22, value: 7, categoryIndex: 3, seriesIndex: 0, }] - }, -]; +var source: DataViewMetadataColumn = { + "displayName": "salesDate", + "type":{"dateTime":true} +}; + +axisHelper.getCategoryValueType(source, true); -axisHelper.getCategoryValueType(cartesianSeries, ValueType.fromDescriptor({ text: true }), false, []); - -// returns: [0, 1, 2, 3] +// returns datetime ValueType ``` ## createAxis