Skip to content

Add embed.reload(). Allows reloading embeds using existing configuration. #37

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

Merged
mattmazzola merged 1 commit into from
Aug 30, 2016
Merged

Add embed.reload(). Allows reloading embeds using existing configuration. #37

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions demo/app/filters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ $(function () {
var $operatorFields = $('.filter-operators');
var $targetTypeFields = $('input[type=radio][name=filterTarget]');
var $targetFields = $('.filter-target');
var $reloadButton = $('#reload');

var $predefinedFilter1 = $('#predefinedFilter1');
var predefinedFilter1 = new models.AdvancedFilter({
Expand Down Expand Up @@ -56,6 +57,13 @@ $(function () {
}
]);

$reloadButton.on('click', function (event) {
event.preventDefault();

console.log('reload');
customFilterPaneReport.reload();
});

$customFilterForm.on('submit', function (event) {
event.preventDefault();
console.log('submit');
Expand Down
5 changes: 5 additions & 0 deletions demo/filters.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ <h4>Visual</h4>
Not Implemented
</div>
</div>
<div class="row">
<div class="col-md-4">
<button type="button" class="btn btn-danger btn-block" id="reload">Reload</button>
</div>
</div>
</div>
<div class="col-md-3">
<form id="customfilterform" name="abc">
Expand Down
12 changes: 12 additions & 0 deletions src/embed.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,18 @@ export abstract class Embed {
this.element.addEventListener(eventName, <any>handler)
}

/**
* Reloads embed using existing configuration.
* E.g. For reports this effectively clears all filters and makes the first page active which simulates resetting a report back to loaded state.
*
* ```javascript
* report.reload();
* ```
*/
reload(): Promise<void> {
return this.load(this.config);
}

/**
* Gets an access token from the first available location: config, attribute, global.
*
Expand Down
27 changes: 27 additions & 0 deletions test/test.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2146,6 +2146,33 @@ describe('SDK-to-HPM', function () {
});
});

describe('reload', function () {
it('report.reload() sends POST /report/load with configuration in body', function () {
// Arrange
const testData = {
loadConfiguration: {
id: 'fakeId',
accessToken: 'fakeToken'
},
response: {
body: null
}
};

spyHpm.post.and.returnValue(Promise.resolve(testData.response));
report.load(testData.loadConfiguration)
.then(() => {
spyHpm.post.calls.reset();

// Act
report.reload();

// Assert
expect(spyHpm.post).toHaveBeenCalledWith('/report/load', jasmine.objectContaining(testData.loadConfiguration), { uid: uniqueId }, iframe.contentWindow);
});
});
});

describe('settings', function () {
it('report.updateSettings(settings) sends PATCH /report/settings with settings object', function () {
// Arrange
Expand Down