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

Show hide columns #420

Merged
merged 5 commits into from
Nov 13, 2023
Merged
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
3 changes: 2 additions & 1 deletion src/assets/t9n/layer-table/resources.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@
"showAll": "Show all",
"recordsSelected": "Total: {{total}} | Selection: {{selected}}",
"cancel": "Cancel",
"moreOptions": "More table options"
"moreOptions": "More table options",
"showHideColumns": "Show/hide columns"
}
3 changes: 2 additions & 1 deletion src/assets/t9n/layer-table/resources_en.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@
"showAll": "Show all",
"recordsSelected": "Total: {{total}} | Selection: {{selected}}",
"cancel": "Cancel",
"moreOptions": "More table options"
"moreOptions": "More table options",
"showHideColumns": "Show/hide columns"
}
4 changes: 2 additions & 2 deletions src/components/crowdsource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,10 @@ graph TD;
layer-table --> calcite-action-bar
layer-table --> map-layer-picker
layer-table --> calcite-dropdown
layer-table --> calcite-action
layer-table --> calcite-button
layer-table --> calcite-dropdown-group
layer-table --> calcite-dropdown-item
layer-table --> calcite-action
layer-table --> calcite-button
layer-table --> calcite-tooltip
layer-table --> calcite-modal
map-layer-picker --> calcite-tooltip
Expand Down
155 changes: 147 additions & 8 deletions src/components/layer-table/layer-table.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { getLocaleComponentStrings } from "../../utils/locale";
import { getLayerOrTable, goToSelection } from "../../utils/mapViewUtils";
import { queryAllIds, queryFeaturesByGlobalID } from "../../utils/queryUtils";
import * as downloadUtils from "../../utils/downloadUtils";
import { IExportInfos, ILayerInfo, IMapClick, IMapInfo, IToolInfo, IToolSizeInfo } from "../../utils/interfaces";
import { IColumnsInfo, IExportInfos, ILayerInfo, IMapClick, IMapInfo, IToolInfo, IToolSizeInfo } from "../../utils/interfaces";

@Component({
tag: "layer-table",
Expand Down Expand Up @@ -138,6 +138,11 @@ export class LayerTable {
*/
@State() _selectedIndexes: number[] = [];

/**
* boolean: When true the show/hide fields list is forced open
*/
@State() _showHideOpen = false;

/**
* boolean: When true only selected records will be shown in the table
*/
Expand Down Expand Up @@ -170,6 +175,11 @@ export class LayerTable {
*/
protected _allIds: number[] = [];

/**
* IColumnsInfo: Key/value pair with fieldname/(visible in table)
*/
protected _columnsInfo: IColumnsInfo;

/**
* boolean: When false alerts will be shown to indicate that the layer must have editing enabled for edit actions
*/
Expand Down Expand Up @@ -215,6 +225,16 @@ export class LayerTable {
*/
protected _selectAllElement: HTMLCalciteCheckboxElement;

/**
* HTMLCalciteDropdownElement: Dropdown the will support show/hide of table columns
*/
protected _showHideDropdown: HTMLCalciteDropdownElement;

/**
* HTMLCalciteDropdownElement: Dropdown the will support overflow tools that won't fit in the current display
*/
protected _moreDropdown: HTMLCalciteDropdownElement;

/**
* esri/widgets/FeatureTable: https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html
*/
Expand Down Expand Up @@ -489,6 +509,7 @@ export class LayerTable {
*/
async componentDidLoad(): Promise<void> {
this._resizeObserver.observe(this._toolbar);
document.onclick = (e) => this._handleDocumentClick(e);
}

/**
Expand Down Expand Up @@ -598,11 +619,53 @@ export class LayerTable {
prev.push(
cur.isDanger ?
this._getDangerAction(cur.icon, cur.label, cur.func, cur.disabled) :
cur.isSublist ? (
<calcite-dropdown
closeOnSelectDisabled={true}
id={this._getId(cur.icon)}
onCalciteDropdownBeforeClose={() => this._forceShowHide()}
ref={(el) => this._showHideDropdown = el}
>
{this._getAction(this._showHideOpen ? "chevron-down" : cur.icon, cur.label, cur.func, cur.disabled, "trigger")}
{this._showHideOpen ? this._getFieldlist() : undefined}
</calcite-dropdown>
) :
this._getAction(cur.icon, cur.label, cur.func, cur.disabled)
)
}
return prev;
}, [])
}, []);
}

_getFieldlist(): VNode {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc

return this._columnsInfo ? (
<calcite-dropdown-group
selection-mode="multiple"
>
{
Object.keys(this._columnsInfo).map(k => {
const selected = this._columnsInfo[k];
return (
<calcite-dropdown-item
id={k}
onClick={(e) => {
const target = e.target;
this._columnsInfo[target.id] = target.selected;
if (!target.selected) {
this._table.hideColumn(target.id);
} else {
this._table.showColumn(target.id);
}
}}
selected={selected}
>
{k}
</calcite-dropdown-item>
)
})
}
</calcite-dropdown-group>
) : undefined;
}

/**
Expand Down Expand Up @@ -693,7 +756,14 @@ export class LayerTable {
label: this._translations.exportCSV,
disabled: featuresEmpty,
isOverflow: false
} : undefined];
} : undefined, {
icon: this._showHideOpen ? "chevron-down" : "chevron-right",
func: () => this._toggleShowHide(),
label: this._translations.showHideColumns,
disabled: false,
isOverflow: false,
isSublist: true
}];

this._defaultVisibleToolSizeInfos = undefined;
}
Expand Down Expand Up @@ -799,7 +869,7 @@ export class LayerTable {
if (skipControls.indexOf(n.id) < 0 && !update) {
update = this._controlsThatFit.map(c => c.id).indexOf(n.id) < 0;
}
})
});
if (update) {
this._controlsThatFit = [...controlsThatFit];
}
Expand Down Expand Up @@ -862,11 +932,18 @@ export class LayerTable {
): VNode {
const dropdownItems = this._getDropdownItems();
return dropdownItems.length > 0 ? (
<calcite-dropdown disabled={this._layer === undefined} id="solutions-more">
<calcite-dropdown
closeOnSelectDisabled={true}
disabled={this._layer === undefined}
id="solutions-more"
onCalciteDropdownBeforeClose={() => this._forceShowHide()}
ref={(el) => this._moreDropdown = el}
>
<calcite-action
appearance="solid"
id={id}
label=""
onClick={() => this._closeShowHide()}
slot="trigger"
text=""
>
Expand All @@ -883,7 +960,8 @@ export class LayerTable {
dropdownItems.map(item => {
return (
<calcite-dropdown-item
iconStart={item.icon}
iconStart={item.isSublist && this._showHideOpen ? "chevron-down" : item.icon}
id="solutions-subset-list"
onClick={item.func}
>
{item.label}
Expand All @@ -892,6 +970,7 @@ export class LayerTable {
})
}
</calcite-dropdown-group>
{this._showHideOpen ? this._getFieldlist() : undefined}
</calcite-dropdown>
) : undefined;
}
Expand Down Expand Up @@ -919,11 +998,12 @@ export class LayerTable {
icon: string,
label: string,
func: any,
disabled: boolean
disabled: boolean,
slot?: string
): VNode {
const _disabled = this._layer === undefined ? true : disabled;
return (
<div class={"display-flex"} id={this._getId(icon)}>
<div class={"display-flex"} id={this._getId(icon)} slot={slot}>
<calcite-action
appearance="solid"
disabled={_disabled}
Expand Down Expand Up @@ -1063,6 +1143,8 @@ export class LayerTable {
} as __esri.FeatureTableProperties);
});

this._initColumnsInfo();

this._checkEditEnabled();

await this._table.when(() => {
Expand Down Expand Up @@ -1117,6 +1199,7 @@ export class LayerTable {
await this._table.when(async () => {
this._table.highlightIds.removeAll();
this._table.clearSelectionFilter();
this._initColumnsInfo();

if (!this._defaultOidHonored && this.defaultOid?.length > 0 && this.defaultOid[0] > -1) {
this._selectDefaultFeature(this.defaultOid);
Expand All @@ -1138,6 +1221,18 @@ export class LayerTable {
await this._sortTable();
}

/**
* Store the column names and current hidden status to support show/hide of columns
*
* @returns void
*/
protected _initColumnsInfo(): void {
this._columnsInfo = this._table.columns.reduce((prev, cur: any) => {
prev[cur.name] = !cur.hidden;
return prev;
}, {});
}

/**
* Select the feature that was specified via url params
*
Expand Down Expand Up @@ -1183,6 +1278,50 @@ export class LayerTable {
}
}

/**
* Open show/hide dropdown
*/
protected _forceShowHide(): void {
if(this._showHideDropdown) {
this._showHideDropdown.open = this._showHideOpen;
}
if(this._moreDropdown) {
this._moreDropdown.open = this._showHideOpen;
}
}

/**
* Toggle show/hide dropdown
*/
protected _toggleShowHide(): void {
this._showHideOpen = !this._showHideOpen;
}

/**
* Open show/hide dropdown
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Open"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No...this is a bool prop

*/
protected _closeShowHide(): void {
this._showHideOpen = false;
}

/**
* Close show/hide dropdown when the user clicks outside of it
*/
protected _handleDocumentClick(
e: MouseEvent
): void {
const id = (e.target as any)?.id;
if (this._showHideOpen && Object.keys(this._columnsInfo).indexOf(id) < 0 && id !== "solutions-subset-list" && id !== "chevron-right"){
this._closeShowHide();
if (this._moreDropdown) {
this._moreDropdown.open = false;
}
if (this._showHideDropdown) {
this._showHideDropdown.open = false;
}
}
}

/**
* Show delete confirmation message
*
Expand Down
8 changes: 4 additions & 4 deletions src/components/layer-table/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@
- calcite-action-bar
- [map-layer-picker](../map-layer-picker)
- calcite-dropdown
- calcite-action
- calcite-button
- calcite-dropdown-group
- calcite-dropdown-item
- calcite-action
- calcite-button
- calcite-tooltip
- calcite-modal

Expand All @@ -61,10 +61,10 @@ graph TD;
layer-table --> calcite-action-bar
layer-table --> map-layer-picker
layer-table --> calcite-dropdown
layer-table --> calcite-action
layer-table --> calcite-button
layer-table --> calcite-dropdown-group
layer-table --> calcite-dropdown-item
layer-table --> calcite-action
layer-table --> calcite-button
layer-table --> calcite-tooltip
layer-table --> calcite-modal
calcite-panel --> calcite-action
Expand Down
5 changes: 5 additions & 0 deletions src/utils/interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -488,9 +488,14 @@ export interface IToolInfo {
disabled: boolean;
isDanger?: boolean;
isOverflow: boolean;
isSublist?: boolean;
}

export interface IToolSizeInfo {
id: string;
width: number;
}

export interface IColumnsInfo {
[key: string]: boolean;
}
Loading