Skip to content

update getCategoryValueType #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kenakamu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update getCategoryValueType #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 8 additions & 13 deletions docs/api/axis-helper.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,27 +326,22 @@ 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

```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
Expand Down