ItemFlagsSelection type correction. (#31)

* correct type for ItemFlagsSelection for a better representation of bitwise operations intended for this feature. Added JSDoc comments.

* expand ItemFlagsSelection type to support existing visuals without issues

* bumped version and updated changelog

* clarification of JSDoc for AutoFlagsSelection

* clarification of JSDoc for AutoFlagsSelection

Author: Demonkratiy

CHANGELOG.md

@@ -1,4 +1,8 @@
 
+## 6.2.1
+* Improved type definitions and JSDoc documentation for `ItemFlagsSelection` and `AutoFlagsSelection` components
+* Added clarification that both flag selection components require bitwise values (powers of 2) for proper flag functionality
+
 ## 6.2.0
 * All *Slices*, *Groups* and *Cards* now can be `disabled` and provided with `disabledReason` or `disabledReasonKey` for localized version.
 * *Container* card can have `Groups` inside

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-visuals-utils-formattingmodel",
-  "version": "6.2.0",
+  "version": "6.2.1",
   "description": "",
   "main": "lib/index.js",
   "module": "lib/index.js",

package.json

@@ -371,7 +371,12 @@ export class FieldPicker extends SimpleSlice<data.ISQExpr[]> {
     }
 }
 
-export class ItemFlagsSelection extends SimpleSlice<string> {
+/**
+ * Allows selecting multiple flags from a predefined list of items with bitwise values.
+ * The selected flags are stored as a single number using bitwise representation,
+ * where each flag corresponds to a specific bit position.
+ */
+export class ItemFlagsSelection extends SimpleSlice<powerbi.EnumMemberValue> {
     items: powerbi.IEnumMember[] | ILocalizedItemMember[];
 
     type?= visuals.FormattingComponent.FlagsSelection;
@@ -397,7 +402,13 @@ export class ItemFlagsSelection extends SimpleSlice<string> {
     }
 }
 
-export class AutoFlagsSelection extends SimpleSlice<powerbi.EnumMemberValue> {
+/**
+ * Multiple flags selection component with enumeration values defined in capabilities.json,
+ * using bitwise number values in a string representation.
+ * The selected flags are stored as a single number using bitwise representation,
+ * where each flag corresponds to a specific bit position.
+ */
+export class AutoFlagsSelection extends SimpleSlice<string> {
     type?= visuals.FormattingComponent.FlagsSelection;
 }