Skip to content

Time Series: tooltip sort by alphabetical order #5442

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
japie1235813 merged 7 commits into from
Dec 1, 2021
Merged

Time Series: tooltip sort by alphabetical order #5442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2c82781
sort by alphabetical order
japie1235813 Nov 30, 2021
13d555c
remove DEFAULT and make ALPHABETICAL the default
japie1235813 Nov 30, 2021
a4aec3a
lint
japie1235813 Nov 30, 2021
a1b0d6c
move order
japie1235813 Nov 30, 2021
4817427
lower case
japie1235813 Dec 1, 2021
cec1bd9
preserve DEFAULT option and fall to alphabetical when global setting …
japie1235813 Dec 1, 2021
07ca32b
ac
japie1235813 Dec 1, 2021
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
2 changes: 1 addition & 1 deletion tensorboard/webapp/metrics/effects/metrics_effects_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ describe('metrics effects', () => {
store.overrideSelector(selectors.getMetricsScalarSmoothing, 0.3);
store.overrideSelector(
selectors.getMetricsTooltipSort,
TooltipSort.DEFAULT
TooltipSort.ALPHABETICAL
);
});

Expand Down
1 change: 1 addition & 0 deletions tensorboard/webapp/metrics/internal_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export enum PluginType {
// deserializer in data_source/metrics_data_source.ts.
export enum TooltipSort {
DEFAULT = 'default',
ALPHABETICAL = 'alphabetical',
ASCENDING = 'ascending',
DESCENDING = 'descending',
NEAREST = 'nearest',
Expand Down
7 changes: 4 additions & 3 deletions tensorboard/webapp/metrics/store/metrics_reducers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,15 +374,16 @@ const reducer = createReducer(
const metricsSettings: Partial<MetricsSettings> = {};
if (partialSettings.tooltipSortString) {
switch (partialSettings.tooltipSortString) {
case TooltipSort.DEFAULT:
case TooltipSort.ALPHABETICAL:
metricsSettings.tooltipSort = TooltipSort.ALPHABETICAL;
break;
case TooltipSort.ASCENDING:
metricsSettings.tooltipSort = TooltipSort.ASCENDING;
break;
case TooltipSort.DESCENDING:
metricsSettings.tooltipSort = TooltipSort.DESCENDING;
break;
case TooltipSort.DEFAULT:
metricsSettings.tooltipSort = TooltipSort.DEFAULT;
break;
case TooltipSort.NEAREST:
metricsSettings.tooltipSort = TooltipSort.NEAREST;
break;
Expand Down
12 changes: 7 additions & 5 deletions tensorboard/webapp/metrics/store/metrics_reducers_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -602,7 +602,7 @@ describe('metrics reducers', () => {
it('changes tooltipSort on metricsChangeTooltipSort', () => {
const prevState = buildMetricsState({
settings: buildMetricsSettingsState({
tooltipSort: TooltipSort.DEFAULT,
tooltipSort: TooltipSort.ALPHABETICAL,
}),
settingOverrides: buildMetricsSettingsState({
tooltipSort: TooltipSort.ASCENDING,
Expand All @@ -612,7 +612,7 @@ describe('metrics reducers', () => {
prevState,
actions.metricsChangeTooltipSort({sort: TooltipSort.NEAREST})
);
expect(nextState.settings.tooltipSort).toBe(TooltipSort.DEFAULT);
expect(nextState.settings.tooltipSort).toBe(TooltipSort.ALPHABETICAL);
expect(nextState.settingOverrides.tooltipSort).toBe(TooltipSort.NEAREST);
});

Expand Down Expand Up @@ -1910,7 +1910,7 @@ describe('metrics reducers', () => {
});

describe('#globalSettingsLoaded', () => {
it('adds partial state from loading the settings to the (default) settings', () => {
it('adds partial state from loading the settings to the (alphabetical) settings', () => {
const beforeState = buildMetricsState({
settings: buildMetricsSettingsState({
scalarSmoothing: 0.3,
Expand All @@ -1919,7 +1919,7 @@ describe('metrics reducers', () => {
}),
settingOverrides: {
scalarSmoothing: 0.5,
tooltipSort: TooltipSort.DEFAULT,
tooltipSort: TooltipSort.ALPHABETICAL,
},
});

Expand All @@ -1937,7 +1937,9 @@ describe('metrics reducers', () => {
expect(nextState.settings.ignoreOutliers).toBe(true);
expect(nextState.settings.tooltipSort).toBe(TooltipSort.DESCENDING);
expect(nextState.settingOverrides.scalarSmoothing).toBe(0.5);
expect(nextState.settingOverrides.tooltipSort).toBe(TooltipSort.DEFAULT);
expect(nextState.settingOverrides.tooltipSort).toBe(
TooltipSort.ALPHABETICAL
);
});

it(
Expand Down
2 changes: 1 addition & 1 deletion tensorboard/webapp/metrics/store/metrics_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ export interface State {

export const METRICS_SETTINGS_DEFAULT: MetricsSettings = {
cardMinWidth: null,
tooltipSort: TooltipSort.DEFAULT,
tooltipSort: TooltipSort.ALPHABETICAL,
ignoreOutliers: true,
xAxisType: XAxisType.STEP,
scalarSmoothing: 0.6,
Expand Down
13 changes: 11 additions & 2 deletions tensorboard/webapp/metrics/views/card_renderer/scalar_card_component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,6 @@ export class ScalarCardComponent<Downloader> {
}

switch (this.tooltipSort) {
case TooltipSort.DEFAULT:
return scalarTooltipData;
case TooltipSort.ASCENDING:
return scalarTooltipData.sort((a, b) => a.point.y - b.point.y);
case TooltipSort.DESCENDING:
Expand All @@ -167,6 +165,17 @@ export class ScalarCardComponent<Downloader> {
return scalarTooltipData.sort((a, b) => {
return a.metadata.distSqToCursor - b.metadata.distSqToCursor;
});
case TooltipSort.DEFAULT:
case TooltipSort.ALPHABETICAL:
return scalarTooltipData.sort((a, b) => {
if (a.metadata.displayName < b.metadata.displayName) {
return -1;
}
if (a.metadata.displayName > b.metadata.displayName) {
return 1;
}
return 0;
});
}
}

Expand Down
73 changes: 72 additions & 1 deletion tensorboard/webapp/metrics/views/card_renderer/scalar_card_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ describe('scalar card', () => {
store.overrideSelector(selectors.getMetricsIgnoreOutliers, false);
store.overrideSelector(
selectors.getMetricsTooltipSort,
TooltipSort.DEFAULT
TooltipSort.ALPHABETICAL
);
store.overrideSelector(selectors.getRunColorMap, {});
store.overrideSelector(selectors.getDarkModeEnabled, false);
Expand Down Expand Up @@ -1614,6 +1614,77 @@ describe('scalar card', () => {
['', 'Row 3', '3', '10,000', anyString, anyString],
]);
}));

it('sorts by displayname alphabetical order', fakeAsync(() => {
store.overrideSelector(
selectors.getMetricsTooltipSort,
TooltipSort.ALPHABETICAL
);
store.overrideSelector(selectors.getMetricsScalarSmoothing, 0);
const fixture = createComponent('card1');
setTooltipData(fixture, [
buildTooltipDatum(
{
id: 'row1',
type: SeriesType.ORIGINAL,
displayName: 'hello',
alias: null,
visible: true,
color: '#f00',
aux: false,
},
{
x: 0,
step: 0,
y: 1000,
value: 1000,
wallTime: new Date('2020-01-01').getTime(),
}
),
buildTooltipDatum(
{
id: 'row2',
type: SeriesType.ORIGINAL,
displayName: 'world',
alias: null,
visible: true,
color: '#0f0',
aux: false,
},
{
x: 1000,
step: 1000,
y: -500,
value: -500,
wallTime: new Date('2020-12-31').getTime(),
}
),
buildTooltipDatum(
{
id: 'row3',
type: SeriesType.ORIGINAL,
displayName: 'cat',
alias: null,
visible: true,
color: '#00f',
aux: false,
},
{
x: 10000,
step: 10000,
y: 3,
value: 3,
wallTime: new Date('2021-01-01').getTime(),
}
),
]);
fixture.detectChanges();
assertTooltipRows(fixture, [
['', 'cat', '3', '10,000', anyString, anyString],
['', 'hello', '1000', '0', anyString, anyString],
['', 'world', '-500', '1,000', anyString, anyString],
]);
}));
});

describe('non-monotonic increase in x-axis', () => {
Expand Down
6 changes: 3 additions & 3 deletions tensorboard/webapp/metrics/views/right_pane/right_pane_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ describe('metrics right_pane', () => {
beforeEach(() => {
store.overrideSelector(
selectors.getMetricsTooltipSort,
TooltipSort.DEFAULT
TooltipSort.ALPHABETICAL
);
store.overrideSelector(selectors.getMetricsIgnoreOutliers, false);
store.overrideSelector(selectors.getMetricsXAxisType, XAxisType.STEP);
Expand Down Expand Up @@ -119,7 +119,7 @@ describe('metrics right_pane', () => {
it('renders', () => {
store.overrideSelector(
selectors.getMetricsTooltipSort,
TooltipSort.DEFAULT
TooltipSort.ALPHABETICAL
);
store.overrideSelector(selectors.getMetricsIgnoreOutliers, false);
store.overrideSelector(selectors.getMetricsXAxisType, XAxisType.STEP);
Expand All @@ -139,7 +139,7 @@ describe('metrics right_pane', () => {
// In the test setting, material component's DOM does not reflect the
// value.
expect(tooltipSortSelect.componentInstance.value).toBe(
TooltipSort.DEFAULT
TooltipSort.ALPHABETICAL
);

expect(
Expand Down
2 changes: 1 addition & 1 deletion tensorboard/webapp/metrics/views/right_pane/settings_view_component.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ export class SettingsViewComponent {
@Input() isImageSupportEnabled!: boolean;

readonly TooltipSortDropdownOptions: DropdownOption[] = [
{value: TooltipSort.DEFAULT, displayText: 'Default'},
{value: TooltipSort.ALPHABETICAL, displayText: 'Alphabetical'},
{value: TooltipSort.ASCENDING, displayText: 'Ascending'},
{value: TooltipSort.DESCENDING, displayText: 'Descending'},
{value: TooltipSort.NEAREST, displayText: 'Nearest'},
Expand Down