Skip to content
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

Jump to bottom

Correcting sort values in documentation and examples #207

Closed
wants to merge 1 commit into from
Closed

Correcting sort values in documentation and examples #207

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/perspective_api.md 100644 → 100755
View file
Open in desktop
Expand Up @@ -164,7 +164,7 @@ configuration.
- `config.filter` **[Array][24]<[Array][24]<[string][29]>>?** An Array of Filter configurations to
apply. A filter configuration is an array of 3 elements: A column name,
a supported filter comparison string (e.g. '===', '>'), and a value to compare.
- `config.sort` **[Array][24]<[string][29]>?** An Array of column names by which to sort.
- `config.sort` **[Array][24]<[Array][24]<[string][29]>?** An Array of sort configurations consisting of a column name & its corresponding sort order by which to sort.

**Examples**

Expand All @@ -173,7 +173,7 @@ var view = table.view({
row_pivot: ['region'],
aggregate: [{op: 'dominant', column:'region'}],
filter: [['client', 'contains', 'fred']],
sort: ['value']
sort: [['value', 'asc']]
});
```

Expand Down
13 changes: 9 additions & 4 deletions docs/viewer_api.md 100644 → 100755
View file
Open in desktop
Expand Up @@ -27,22 +27,27 @@ HTMLElement class for `<perspective-viewer` custom element.

### sort

Sets this `perspective.table.view`'s `sort` property, an array of column
names.
Sets this `perspective.table.view`'s `sort` property, an array of sort configurations consisting of a column name and the sort order to apply.
Valid sort orders to apply:
- "asc" - ascending order applied
- "desc" - descending order applied
- "none" - no sort order applied
- "asc abs" - ascending absolute order applied
- "desc abs" - descending absolute order applied

**Examples**

_via Javascript DOM_

```javascript
let elem = document.getElementById('my_viewer');
elem.setAttribute('sort', JSON.stringify(["x"]));
elem.setAttribute('sort', JSON.stringify([["x", "asc"]]));
```

_via HTML_

```javascript
<perspective-viewer sort='["x"]'></perspective-viewer>
<perspective-viewer sort='[["x", "asc"]]'></perspective-viewer>
```

### columns
Expand Down
2 changes: 1 addition & 1 deletion packages/perspective-examples/src/html/coincap.html 100644 → 100755
View file
Open in desktop
Expand Up @@ -27,7 +27,7 @@

<perspective-viewer
index="long"
sort='["mktcap"]'
sort='[["mktcap", "desc"]]'
row-pivots='["long"]'
columns='["mktcap","price","vwapData","supply","volume","perc","shapeshift"]'>

Expand Down
2 changes: 1 addition & 1 deletion packages/perspective-examples/src/html/node.html 100644 → 100755
View file
Open in desktop
Expand Up @@ -23,7 +23,7 @@
</head>
<body>

<perspective-viewer id="view1" sort='["id"]'></perspective-viewer>
<perspective-viewer id="view1" sort='[["id"]]'></perspective-viewer>

<script>

Expand Down
51 changes: 25 additions & 26 deletions packages/perspective-viewer/README.md 100644 → 100755
View file
Open in desktop
Expand Up @@ -49,22 +49,21 @@ HTMLElement class for `<perspective-viewer` custom element.

### sort

Sets this `perspective.table.view`'s `sort` property, an array of column
names.
Sets this `perspective.table.view`'s `sort` property, an array of sort configurations consisting of a column name and its sort order.

**Examples**

_via Javascript DOM_

```javascript
let elem = document.getElementById('my_viewer');
elem.setAttribute('sort', JSON.stringify(["x"]));
let elem = document.getElementById('my_viewer');
elem.setAttribute('sort', JSON.stringify(["x", "desc"]));
```

_via HTML_

```javascript
<perspective-viewer sort='["x"]'></perspective-viewer>
<perspective-viewer sort='["x", "desc"]'></perspective-viewer>
```

### columns
Expand All @@ -80,7 +79,7 @@ The set of visible columns.
_via Javascript DOM_

```javascript
let elem = document.getElementById('my_viewer');
let elem = document.getElementById('my_viewer');
elem.setAttribute('columns', JSON.stringify(["x", "y'"]));
```

Expand All @@ -107,7 +106,7 @@ The set of column aggregate configurations.
_via Javascript DOM_

```javascript
let elem = document.getElementById('my_viewer');
let elem = document.getElementById('my_viewer');
elem.setAttribute('aggregates', JSON.stringify({x: "distinct count"}));
```

Expand All @@ -126,11 +125,11 @@ The set of column filter configurations.
_via Javascript DOM_

```javascript
let filters = [
["x", "<", 3],
["y", "contains", "abc"]
];
let elem = document.getElementById('my_viewer');
let filters = [
["x", "<", 3],
["y", "contains", "abc"]
];
let elem = document.getElementById('my_viewer');
elem.setAttribute('filters', JSON.stringify(filters));
```

Expand Down Expand Up @@ -184,7 +183,7 @@ render it hidden until the message is removed.
**Examples**

```javascript
let elem = document.getElementById('my_viewer');
let elem = document.getElementById('my_viewer');
elem.setAttribute('message', '<h1>Loading</h1>');
```

Expand All @@ -198,8 +197,8 @@ instance from the preferred worker.
**Examples**

```javascript
let elem = document.getElementById('my_viewer');
let table = elem.worker.table([{x:1, y:2}]);
let elem = document.getElementById('my_viewer');
let table = elem.worker.table([{x:1, y:2}]);
elem.load(table);
```

Expand All @@ -218,25 +217,25 @@ element, its internal `perspective.table` will also be deleted.
_Load JSON_

```javascript
const my_viewer = document.getElementById('#my_viewer');
my_viewer.load([
{x: 1, y: 'a'},
{x: 2, y: 'b'}
const my_viewer = document.getElementById('#my_viewer');
my_viewer.load([
{x: 1, y: 'a'},
{x: 2, y: 'b'}
]);
```

_Load CSV_

```javascript
const my_viewer = document.getElementById('#my_viewer');
const my_viewer = document.getElementById('#my_viewer');
my_viewer.load("x,y\n1,a\n2,b");
```

_Load perspective.table_

```javascript
const my_viewer = document.getElementById('#my_viewer');
const tbl = perspective.table("x,y\n1,a\n2,b");
const my_viewer = document.getElementById('#my_viewer');
const tbl = perspective.table("x,y\n1,a\n2,b");
my_viewer.load(tbl);
```

Expand All @@ -252,10 +251,10 @@ Updates this element's `perspective.table` with new data.
**Examples**

```javascript
const my_viewer = document.getElementById('#my_viewer');
my_viewer.update([
{x: 1, y: 'a'},
{x: 2, y: 'b'}
const my_viewer = document.getElementById('#my_viewer');
my_viewer.update([
{x: 1, y: 'a'},
{x: 2, y: 'b'}
]);
```

Expand Down
4 changes: 2 additions & 2 deletions packages/perspective/README.md 100644 → 100755
View file
Open in desktop
Expand Up @@ -259,7 +259,7 @@ configuration.
- `config.filter` **[Array][31]&lt;[Array][31]&lt;[string][33]>>?** An Array of Filter configurations to
apply. A filter configuration is an array of 3 elements: A column name,
a supported filter comparison string (e.g. '===', '>'), and a value to compare.
- `config.sort` **[Array][31]&lt;[string][33]>?** An Array of column names by which to sort.
- `config.sort` **[Array][31]&lt;[array][31]&lt;[string][33]>?** An Array of sort configurations consisting of a column name and its sort order by which to sort.

**Examples**

Expand All @@ -268,7 +268,7 @@ var view = table.view({
row_pivot: ['region'],
aggregate: [{op: 'dominant', column:'region'}],
filter: [['client', 'contains', 'fred']],
sort: ['value']
sort: [['value', "desc"]]
});
```

Expand Down