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.

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

Granular granularity labels control #163

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions capabilities.json
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,31 @@
"bool": true
}
},
"labelYearVisibility": {
"type": {
"bool": true
}
},
"labelQuarterVisibility": {
"type": {
"bool": true
}
},
"labelMonthVisibility": {
"type": {
"bool": true
}
},
"labelWeekVisibility": {
"type": {
"bool": true
}
},
"labelDayVisibility": {
"type": {
"bool": true
}
},
"fontColor": {
"type": {
"fill": {
Expand Down
7 changes: 4 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 45 additions & 16 deletions src/timeLine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -679,21 +679,21 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual

this.visualSettings = this.formattingSettingsService.populateFormattingSettingsModel(TimeLineSettingsModel, this.dataView);
this.visualSettings.setLocalizedOptions(this.localizationManager);

if (!this.initialized) {
this.timelineData = {
cursorDataPoints: [],
timelineDataPoints: [],
};
}

this.parseJsonFilters(this.visualSettings, <AdvancedFilter[]>(this.options.jsonFilters));
this.setHighContrastColors();

this.adjustHeightOfElements(options.viewport.width);

this.timelineGranularityData = new GranularityData(this.datePeriod.startDate, this.datePeriod.endDate);

this.createTimelineData(
this.visualSettings,
this.datePeriod.startDate,
Expand All @@ -702,27 +702,31 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
this.locale,
this.localizationManager,
);

this.updateCalendar();

const adjustedPeriod: IAdjustedFilterDatePeriod = this.adjustFilterDatePeriod();
const datePeriod: ITimelineDatePeriodBase = this.datePeriod;
const granularity: GranularityType = this.visualSettings.granularity.granularity.value
? <GranularityType>this.visualSettings.granularity.granularity.value.value
: GranularityType.month;

? <GranularityType>this.visualSettings.granularity.granularity.value.value
: GranularityType.month;


const isCurrentPeriodSelected: boolean = !this.isForceSelectionReset && this.visualSettings.forceSelection.currentPeriod.value;
const isLatestAvailableDateSelected: boolean = !this.isForceSelectionReset && this.visualSettings.forceSelection.latestAvailableDate.value;
const isForceSelected: boolean = !this.isForceSelectionReset && (isCurrentPeriodSelected || isLatestAvailableDateSelected);
this.isForceSelectionReset = false; // Reset it to default state to allow re-enabling Force Selection
let currentForceSelectionResult = { startDate: null, endDate: null };

if (isCurrentPeriodSelected) {
currentForceSelectionResult = ({
endDate: adjustedPeriod.period.endDate,
startDate: adjustedPeriod.period.startDate,
} = Timeline.SELECT_CURRENT_PERIOD(datePeriod, granularity, this.calendar));
}

this.removeDisabledFormattingSettings(this.visualSettings);

if (isLatestAvailableDateSelected
&& (
!isCurrentPeriodSelected
Expand Down Expand Up @@ -781,6 +785,7 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
}
this.host.eventService.renderingFinished(options);
}


public fillCells(visSettings: TimeLineSettingsModel): void {
const dataPoints: ITimelineDataPoint[] = this.timelineData.timelineDataPoints;
Expand Down Expand Up @@ -817,6 +822,30 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
.style("stroke-width", cellsSettings.strokeWidth.value + "px");
}

private removeDisabledFormattingSettings(visualSettings: TimeLineSettingsModel): void {
const granularityType = this.timelineData.currentGranularity.getType();

if(visualSettings.labels.displayAll.value) {
visualSettings.labels.slices = visualSettings.labels.slices.filter(slice => !slice.name.startsWith("label"));
}

if(granularityType < GranularityType.quarter) {
visualSettings.labels.slices = visualSettings.labels.slices.filter(slice => slice.name !== "labelQuarterVisibility");
}

if(granularityType < GranularityType.month) {
visualSettings.labels.slices = visualSettings.labels.slices.filter(slice => slice.name !== "labelMonthVisibility");
}

if(granularityType < GranularityType.week) {
visualSettings.labels.slices = visualSettings.labels.slices.filter(slice => slice.name !== "labelWeekVisibility");
}

if(granularityType < GranularityType.day) {
visualSettings.labels.slices = visualSettings.labels.slices.filter(slice => slice.name !== "labelDayVisibility");
}
}

public renderCells(timelineData: ITimelineData, timelineProperties: ITimelineProperties, yPos: number): void {
const dataPoints: ITimelineDataPoint[] = timelineData.timelineDataPoints;
let totalX: number = 0;
Expand Down Expand Up @@ -1382,7 +1411,7 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
let yPos: number = 0;

if (settings.labels.show.value) {
if (settings.labels.displayAll.value || granularityType === GranularityType.year) {
if (settings.labels.displayAll.value || granularityType === GranularityType.year || settings.labels.labelYearVisibility.value) {
this.renderLabels(
extendedLabels.yearLabels,
this.yearLabelsSelection,
Expand All @@ -1393,7 +1422,7 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
}
}

if (settings.labels.displayAll.value || granularityType === GranularityType.quarter) {
if (settings.labels.displayAll.value || granularityType === GranularityType.quarter || settings.labels.labelQuarterVisibility.value) {
this.renderLabels(
extendedLabels.quarterLabels,
this.quarterLabelsSelection,
Expand All @@ -1404,7 +1433,7 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
}
}

if (settings.labels.displayAll.value || granularityType === GranularityType.month) {
if (settings.labels.displayAll.value || granularityType === GranularityType.month || settings.labels.labelMonthVisibility.value) {
this.renderLabels(
extendedLabels.monthLabels,
this.monthLabelsSelection,
Expand All @@ -1415,7 +1444,7 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
}
}

if (settings.labels.displayAll.value || granularityType === GranularityType.week) {
if (settings.labels.displayAll.value || granularityType === GranularityType.week || settings.labels.labelWeekVisibility.value) {
this.renderLabels(
extendedLabels.weekLabels,
this.weekLabelsSelection,
Expand All @@ -1426,7 +1455,7 @@ export class Timeline implements powerbiVisualsApi.extensibility.visual.IVisual
}
}

if (settings.labels.displayAll.value || granularityType === GranularityType.day) {
if (settings.labels.displayAll.value || granularityType === GranularityType.day || settings.labels.labelDayVisibility.value) {
this.renderLabels(
extendedLabels.dayLabels,
this.dayLabelsSelection,
Expand Down
46 changes: 45 additions & 1 deletion src/timeLineSettingsModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,41 @@ export class LabelsSettingsCard extends Card {
value: true,
});

labelYearVisibility = new formattingSettings.ToggleSwitch({
name: "labelYearVisibility",
displayName: "Year visibility",
displayNameKey: "Visual_LabelYearVisibility",
value: true,
});

labelQuarterVisibility = new formattingSettings.ToggleSwitch({
name: "labelQuarterVisibility",
displayName: "Quarter visibility",
displayNameKey: "Visual_LabelQuarterVisibility",
value: true,
});

labelMonthVisibility = new formattingSettings.ToggleSwitch({
name: "labelMonthVisibility",
displayName: "Month visibility",
displayNameKey: "Visual_LabelMonthVisibility",
value: true,
});

labelWeekVisibility = new formattingSettings.ToggleSwitch({
name: "labelWeekVisibility",
displayName: "Week visibility",
displayNameKey: "Visual_LabelWeekVisibility",
value: true,
});

labelDayVisibility = new formattingSettings.ToggleSwitch({
name: "labelDayVisibility",
displayName: "Day visibility",
displayNameKey: "Visual_LabelDayVisibility",
value: true,
});

fontColor = new formattingSettings.ColorPicker({
name: "fontColor",
displayName: "Font color",
Expand All @@ -416,7 +451,16 @@ export class LabelsSettingsCard extends Card {
name: string = "labels";
displayName: string = "Labels";
displayNameKey: string = "Visual_Labels";
slices = [this.displayAll, this.fontColor, this.textSize];
slices = [
this.displayAll,
this.labelYearVisibility,
this.labelQuarterVisibility,
this.labelMonthVisibility,
this.labelWeekVisibility,
this.labelDayVisibility,
this.fontColor,
this.textSize
];
}

class ScrollAutoAdjustmentSettingsCard extends Card {
Expand Down
5 changes: 5 additions & 0 deletions stringResources/en-US/resources.resjson
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@
"Visual_GranularityMonthVisibility": "Month visibility",
"Visual_GranularityWeekVisibility": "Week visibility",
"Visual_GranularityDayVisibility": "Day visibility",
"Visual_LabelYearVisibility": "Year Label",
"Visual_LabelQuarterVisibility": "Quarter Label",
"Visual_LabelMonthVisibility": "Month Label",
"Visual_LabelWeekVisibility": "Week Label",
"Visual_LabelDayVisibility": "Day Label",
"Visual_Weeks_Determination_Standards": "Weeks Determination Standards",
"Visual_Week_Standard": "Standard",
"Visual_Week_Standard_None": "-- none --",
Expand Down