diff --git a/.version b/.version index 7cbea073..80444066 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -5.2.0 \ No newline at end of file +5.2.1 \ No newline at end of file diff --git a/client/packages/demo-site/package.json b/client/packages/demo-site/package.json index 1fea6501..dd43d25e 100644 --- a/client/packages/demo-site/package.json +++ b/client/packages/demo-site/package.json @@ -1,6 +1,6 @@ { "name": "demo-site", - "version": "5.2.0", + "version": "5.2.1", "private": true, "dependencies": { "@types/blazor__javascript-interop": "^3.1.2", @@ -10,9 +10,9 @@ "@types/react-dom": "^17.0.11", "@types/sql.js": "^1.4.3", "chart.js": "^3.7.0", - "flowerbi-react": "5.2.0", - "flowerbi-react-utils": "5.2.0", - "flowerbi-dates": "5.2.0", + "flowerbi-react": "5.2.1", + "flowerbi-react-utils": "5.2.1", + "flowerbi-dates": "5.2.1", "json-date-parser": "^1.0.1", "moment": "^2.29.4", "prettier": "^2.5.1", diff --git a/client/packages/flowerbi-dates/package.json b/client/packages/flowerbi-dates/package.json index 6349ded3..32bce2a6 100644 --- a/client/packages/flowerbi-dates/package.json +++ b/client/packages/flowerbi-dates/package.json @@ -1,6 +1,6 @@ { "name": "flowerbi-dates", - "version": "5.2.0", + "version": "5.2.1", "author": "Daniel Earwicker ", "license": "MIT", "description": "FlowerBI: ultra-minimal BI analytics query and UI tools", diff --git a/client/packages/flowerbi-react-utils/package.json b/client/packages/flowerbi-react-utils/package.json index 2324e112..9a939aaa 100644 --- a/client/packages/flowerbi-react-utils/package.json +++ b/client/packages/flowerbi-react-utils/package.json @@ -1,6 +1,6 @@ { "name": "flowerbi-react-utils", - "version": "5.2.0", + "version": "5.2.1", "author": "Daniel Earwicker ", "license": "MIT", "description": "React helpers useful in FlowerBI apps (but not actually dependent on it", diff --git a/client/packages/flowerbi-react/package.json b/client/packages/flowerbi-react/package.json index b6eaeac6..8ef4a2e1 100644 --- a/client/packages/flowerbi-react/package.json +++ b/client/packages/flowerbi-react/package.json @@ -1,6 +1,6 @@ { "name": "flowerbi-react", - "version": "5.2.0", + "version": "5.2.1", "author": "Daniel Earwicker ", "license": "MIT", "description": "React helpers for FlowerBI", @@ -9,7 +9,7 @@ "dependencies": { "@types/json-stable-stringify": "^1.0.32", "@types/react": "^16.9.0", - "flowerbi": "5.2.0", + "flowerbi": "5.2.1", "json-stable-stringify": "^1.0.1" }, "devDependencies": { diff --git a/client/packages/flowerbi/package.json b/client/packages/flowerbi/package.json index 7c152f36..a4e2c8ad 100644 --- a/client/packages/flowerbi/package.json +++ b/client/packages/flowerbi/package.json @@ -1,6 +1,6 @@ { "name": "flowerbi", - "version": "5.2.0", + "version": "5.2.1", "author": "Daniel Earwicker ", "license": "MIT", "description": "FlowerBI: ultra-minimal BI analytics query and UI tools", diff --git a/docs/demo/_framework/FlowerBI.DemoSchema.pdb b/docs/demo/_framework/FlowerBI.DemoSchema.pdb index fae1be16..354d90d5 100644 Binary files a/docs/demo/_framework/FlowerBI.DemoSchema.pdb and b/docs/demo/_framework/FlowerBI.DemoSchema.pdb differ diff --git a/docs/demo/_framework/FlowerBI.DemoSchema.pdb.gz b/docs/demo/_framework/FlowerBI.DemoSchema.pdb.gz index 49f9ee64..02edf18f 100644 Binary files a/docs/demo/_framework/FlowerBI.DemoSchema.pdb.gz and b/docs/demo/_framework/FlowerBI.DemoSchema.pdb.gz differ diff --git a/docs/demo/_framework/FlowerBI.DemoSchema.wasm b/docs/demo/_framework/FlowerBI.DemoSchema.wasm index 4a987923..336a7887 100644 Binary files a/docs/demo/_framework/FlowerBI.DemoSchema.wasm and b/docs/demo/_framework/FlowerBI.DemoSchema.wasm differ diff --git a/docs/demo/_framework/FlowerBI.DemoSchema.wasm.gz b/docs/demo/_framework/FlowerBI.DemoSchema.wasm.gz index 91867a15..ffb05cc8 100644 Binary files a/docs/demo/_framework/FlowerBI.DemoSchema.wasm.gz and b/docs/demo/_framework/FlowerBI.DemoSchema.wasm.gz differ diff --git a/docs/demo/_framework/FlowerBI.Engine.pdb b/docs/demo/_framework/FlowerBI.Engine.pdb index 45e72a5e..375205de 100644 Binary files a/docs/demo/_framework/FlowerBI.Engine.pdb and b/docs/demo/_framework/FlowerBI.Engine.pdb differ diff --git a/docs/demo/_framework/FlowerBI.Engine.pdb.gz b/docs/demo/_framework/FlowerBI.Engine.pdb.gz index 2ba133ca..32fedb41 100644 Binary files a/docs/demo/_framework/FlowerBI.Engine.pdb.gz and b/docs/demo/_framework/FlowerBI.Engine.pdb.gz differ diff --git a/docs/demo/_framework/FlowerBI.Engine.wasm b/docs/demo/_framework/FlowerBI.Engine.wasm index 399d5984..17ab9d74 100644 Binary files a/docs/demo/_framework/FlowerBI.Engine.wasm and b/docs/demo/_framework/FlowerBI.Engine.wasm differ diff --git a/docs/demo/_framework/FlowerBI.Engine.wasm.gz b/docs/demo/_framework/FlowerBI.Engine.wasm.gz index 8fd27cae..518a0284 100644 Binary files a/docs/demo/_framework/FlowerBI.Engine.wasm.gz and b/docs/demo/_framework/FlowerBI.Engine.wasm.gz differ diff --git a/docs/demo/_framework/FlowerBI.WasmHost.pdb b/docs/demo/_framework/FlowerBI.WasmHost.pdb index 186cd011..0450edd6 100644 Binary files a/docs/demo/_framework/FlowerBI.WasmHost.pdb and b/docs/demo/_framework/FlowerBI.WasmHost.pdb differ diff --git a/docs/demo/_framework/FlowerBI.WasmHost.pdb.gz b/docs/demo/_framework/FlowerBI.WasmHost.pdb.gz index 49538441..28d345d9 100644 Binary files a/docs/demo/_framework/FlowerBI.WasmHost.pdb.gz and b/docs/demo/_framework/FlowerBI.WasmHost.pdb.gz differ diff --git a/docs/demo/_framework/FlowerBI.WasmHost.wasm b/docs/demo/_framework/FlowerBI.WasmHost.wasm index bdc37b71..0303ee42 100644 Binary files a/docs/demo/_framework/FlowerBI.WasmHost.wasm and b/docs/demo/_framework/FlowerBI.WasmHost.wasm differ diff --git a/docs/demo/_framework/FlowerBI.WasmHost.wasm.gz b/docs/demo/_framework/FlowerBI.WasmHost.wasm.gz index ecf69662..7599187a 100644 Binary files a/docs/demo/_framework/FlowerBI.WasmHost.wasm.gz and b/docs/demo/_framework/FlowerBI.WasmHost.wasm.gz differ diff --git a/docs/demo/_framework/blazor.boot.json b/docs/demo/_framework/blazor.boot.json index 1504a2c5..de22ab41 100644 --- a/docs/demo/_framework/blazor.boot.json +++ b/docs/demo/_framework/blazor.boot.json @@ -1,7 +1,7 @@ { "mainAssemblyName": "FlowerBI.WasmHost", "resources": { - "hash": "sha256-xHbQw+96uVMsPUMWwWMUpAf5Sn3t7bN35Y7WaDgcTkw=", + "hash": "sha256-HO72tyS9uokvPHzHfek2UeJfhrE8KSnXy3ogbxJjo9g=", "jsModuleNative": { "dotnet.native.js": "sha256-VdKq87/z5NIxZKmuM+fv38XF+RcEb/bg3jVBwQSfwP4=" }, @@ -212,14 +212,14 @@ "mscorlib.wasm": "sha256-04e4k5XU8HWGB/dq/2+j84xzzGPflTs0IYWI0OxogVc=", "netstandard.wasm": "sha256-gnGZURPnoSmjXuYNCOJi5tt8qn2LRImWgue1Ru3/TDQ=", "System.Private.CoreLib.wasm": "sha256-6w3jYr0arcp8jnt4aeqh+AmqrLA6q7jl9rQYAwLzE0M=", - "FlowerBI.DemoSchema.wasm": "sha256-LCLsUBru89Dw1ZgybG5AgnLl/US9u8MDrCwhAWwM83k=", - "FlowerBI.Engine.wasm": "sha256-Xedhzp0JqJpVpDNUuBkIbGiBGgh1PXFCEW99HrcvqUg=", - "FlowerBI.WasmHost.wasm": "sha256-ZKzoKdTzwiHWkaZhwUr5EGM5RxTGBbbZs8BqQ+/ULzQ=" + "FlowerBI.DemoSchema.wasm": "sha256-8dC5I1cQkAme3pkCZUCOd+opZyPVEZqqtJhRa3IIe44=", + "FlowerBI.Engine.wasm": "sha256-o5suElg7k2qJOgmK1jDrL5djHQ1fEaZ7cd/GloXYhWU=", + "FlowerBI.WasmHost.wasm": "sha256-2Zd/wcXLRp5m5iYp+q43/qJ8eRRhBmhDN/oXtYNrt1k=" }, "pdb": { - "FlowerBI.DemoSchema.pdb": "sha256-yGa3YxDhwtuK53A3jc+IlQbqlq7GamjK8nZ1MKsBYiw=", - "FlowerBI.Engine.pdb": "sha256-Gcpivf0Jv0drCd/8sjnS/lR46kd6CM3vuf8sL495i+g=", - "FlowerBI.WasmHost.pdb": "sha256-1mKLDAOsRNMwZzzpcZbI/37NL12TFQUIwmTVyevSDVg=" + "FlowerBI.DemoSchema.pdb": "sha256-mE37UFsaLxCMqtKNKsDDc0vo/1PPArjK08OdBXiVI2c=", + "FlowerBI.Engine.pdb": "sha256-t10054QhrAv7KTI2yUUI9tjnYxiJNJZPbzuMyUSFROI=", + "FlowerBI.WasmHost.pdb": "sha256-EtGtgDJfu3BfeW1xyuIt8HH1q+scdaujuOLNDMpnc5M=" } }, "cacheBootResources": true, diff --git a/docs/demo/_framework/blazor.boot.json.gz b/docs/demo/_framework/blazor.boot.json.gz index 3a4edae5..c38f6008 100644 Binary files a/docs/demo/_framework/blazor.boot.json.gz and b/docs/demo/_framework/blazor.boot.json.gz differ diff --git a/docs/typedoc/flowerbi-dates/interfaces/FillDatesOptions.html b/docs/typedoc/flowerbi-dates/interfaces/FillDatesOptions.html index 07070382..3f2fe487 100644 --- a/docs/typedoc/flowerbi-dates/interfaces/FillDatesOptions.html +++ b/docs/typedoc/flowerbi-dates/interfaces/FillDatesOptions.html @@ -1,18 +1,18 @@ FillDatesOptions | flowerbi-dates
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FillDatesOptions<T, R>

Options for fillDates function.

-

Type parameters

  • T

  • R

Hierarchy

  • FillDatesOptions

Index

Properties

max?: FillDate
+

Type parameters

  • T

  • R

Hierarchy

  • FillDatesOptions

Index

Properties

max?: FillDate

The maximum date to generate. It will be rounded down by the type so doesn't need to be on an exact boundary.

-
min?: FillDate
+
min?: FillDate

The minimum date to generate. It will be rounded down by the type so doesn't need to be on an exact boundary.

-
records: T[]
+
records: T[]

The records to base the filled list on.

-
+

The operations to use for rounding, incrementing and formatting dates.

-

Methods

  • fill(dateText: string, record: undefined | T): R

Methods

  • fill(dateText: string, record: undefined | T): R
  • Generate a record for a date, from the formatted {@link dateText} and the input record for that date, if any.

    -

    Parameters

    • dateText: string
    • record: undefined | T

    Returns R

  • +

    Parameters

    • dateText: string
    • record: undefined | T

    Returns R

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-dates/modules.html b/docs/typedoc/flowerbi-dates/modules.html index 40dfc3f1..de3cd5c3 100644 --- a/docs/typedoc/flowerbi-dates/modules.html +++ b/docs/typedoc/flowerbi-dates/modules.html @@ -1,17 +1,17 @@ -flowerbi-dates
Options
All
  • Public
  • Public/Protected
  • All
Menu

flowerbi-dates

Index

Type aliases

FillDate: Date | string | number | Moment
FillDateType: { format: any; increment: any; round: any }
+flowerbi-dates
Options
All
  • Public
  • Public/Protected
  • All
Menu

flowerbi-dates

Index

Type aliases

FillDate: Date | string | number | Moment
FillDateType: { format: any; increment: any; round: any }

Three operations on dates used by fillDates.

-

Type declaration

  • format:function
    • format(d: Moment): string
    • +

      Type declaration

      • format:function
        • format(d: Moment): string
        • Format the given date to a string

          -

          Parameters

          • d: Moment

          Returns string

      • increment:function
        • increment(d: Moment): Moment
      • increment:function
        • increment(d: Moment): Moment
        • Increment the date by the unit. The given date will already be rounded down.

          -

          Parameters

          • d: Moment

          Returns Moment

      • round:function
        • round(d: Moment): Moment
      • round:function
        • round(d: Moment): Moment
        • Round the given date down to the nearest whole unit (e.g. start of month, quarter, year)

          -

          Parameters

          • d: Moment

          Returns Moment

Variables

dateTypes: { days: FillDateType; months: FillDateType; quarters: FillDateType; years: FillDateType } = ...
+

Parameters

  • d: Moment

Returns Moment

Variables

dateTypes: { days: FillDateType; months: FillDateType; quarters: FillDateType; years: FillDateType } = ...

Standard built-in date types. To customise, implement the FillDateType interface.

-

Type declaration

Functions

Functions

  • Examines a set of dates and chooses the most specific type that includes them all. If all fall on Jan, 1 then years is chosen, and so on.

    -

    Parameters

    • dates: Moment[]

    Returns FillDateType

  • When querying for a time series chart, e.g. x-axis is Month and y-axis is Total Sales, there may be months where nothing was sold so they are missing from the list of records.

    @@ -35,4 +35,4 @@ extra records to be added at the start and end of the range if necessary.

    If you don't pass a type, a suitable type will be detected based on how the input record dates fall on unit boundaries.

    -

    Type parameters

    • T

    • R

    Parameters

    Returns R[]

  • smartDates<T, R>(records: T[], min: undefined | FillDate, max: undefined | FillDate, getDate: (record: T) => FillDate, fill: (dateText: string, record: undefined | T) => R): R[]
  • deprecated

    Type parameters

    • T

    • R

    Parameters

    • records: T[]
    • min: undefined | FillDate
    • max: undefined | FillDate
    • getDate: (record: T) => FillDate
    • fill: (dateText: string, record: undefined | T) => R
        • (dateText: string, record: undefined | T): R
        • Parameters

          • dateText: string
          • record: undefined | T

          Returns R

    Returns R[]

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Type parameters

  • T

  • R

Parameters

Returns R[]

  • smartDates<T, R>(records: T[], min: undefined | FillDate, max: undefined | FillDate, getDate: (record: T) => FillDate, fill: (dateText: string, record: undefined | T) => R): R[]
  • deprecated

    Type parameters

    • T

    • R

    Parameters

    • records: T[]
    • min: undefined | FillDate
    • max: undefined | FillDate
    • getDate: (record: T) => FillDate
    • fill: (dateText: string, record: undefined | T) => R
        • (dateText: string, record: undefined | T): R
        • Parameters

          • dateText: string
          • record: undefined | T

          Returns R

    Returns R[]

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react-utils/interfaces/DropDownOption.html b/docs/typedoc/flowerbi-react-utils/interfaces/DropDownOption.html index 075ca3f4..d2fae1f2 100644 --- a/docs/typedoc/flowerbi-react-utils/interfaces/DropDownOption.html +++ b/docs/typedoc/flowerbi-react-utils/interfaces/DropDownOption.html @@ -1 +1 @@ -DropDownOption | flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DropDownOption<T>

Type parameters

  • T

Hierarchy

  • DropDownOption

Index

Properties

Properties

label: string
value: T

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +DropDownOption | flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DropDownOption<T>

Type parameters

  • T

Hierarchy

  • DropDownOption

Index

Properties

Properties

label: string
value: T

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react-utils/interfaces/DropDownProps.html b/docs/typedoc/flowerbi-react-utils/interfaces/DropDownProps.html index 3a795f06..67f2b3d7 100644 --- a/docs/typedoc/flowerbi-react-utils/interfaces/DropDownProps.html +++ b/docs/typedoc/flowerbi-react-utils/interfaces/DropDownProps.html @@ -1 +1 @@ -DropDownProps | flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DropDownProps

Hierarchy

  • DropDownProps

Index

Properties

Methods

Properties

options: string[]
value: string

Methods

  • onChange(e: ChangeEvent<HTMLSelectElement>): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +DropDownProps | flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DropDownProps

Hierarchy

  • DropDownProps

Index

Properties

Methods

Properties

options: string[]
value: string

Methods

  • onChange(e: ChangeEvent<HTMLSelectElement>): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIChartBox.html b/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIChartBox.html index f8225379..dbe00751 100644 --- a/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIChartBox.html +++ b/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIChartBox.html @@ -124,10 +124,10 @@
see

aria-valuetext.

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

-
autoCapitalize?: string
autoCorrect?: string
autoSave?: string
children?: ReactNode | ReactNode[]
className?: string
color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
draggable?: Booleanish
hidden?: boolean
id?: string
inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"
+
autoCapitalize?: string
autoCorrect?: string
autoSave?: string
children?: ReactNode | ReactNode[]
className?: string
color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
draggable?: Booleanish
hidden?: boolean
id?: string
inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

see

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

see

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

-
itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
lang?: string
onAbort?: ReactEventHandler<HTMLDivElement>
onAbortCapture?: ReactEventHandler<HTMLDivElement>
onAnimationEnd?: AnimationEventHandler<HTMLDivElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>
onAnimationIteration?: AnimationEventHandler<HTMLDivElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>
onAnimationStart?: AnimationEventHandler<HTMLDivElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>
onAuxClick?: MouseEventHandler<HTMLDivElement>
onAuxClickCapture?: MouseEventHandler<HTMLDivElement>
onBeforeInput?: FormEventHandler<HTMLDivElement>
onBeforeInputCapture?: FormEventHandler<HTMLDivElement>
onBlur?: FocusEventHandler<HTMLDivElement>
onBlurCapture?: FocusEventHandler<HTMLDivElement>
onCanPlay?: ReactEventHandler<HTMLDivElement>
onCanPlayCapture?: ReactEventHandler<HTMLDivElement>
onCanPlayThrough?: ReactEventHandler<HTMLDivElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>
onChange?: FormEventHandler<HTMLDivElement>
onChangeCapture?: FormEventHandler<HTMLDivElement>
onClick?: MouseEventHandler<HTMLDivElement>
onClickCapture?: MouseEventHandler<HTMLDivElement>
onCompositionEnd?: CompositionEventHandler<HTMLDivElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>
onCompositionStart?: CompositionEventHandler<HTMLDivElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>
onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>
onContextMenu?: MouseEventHandler<HTMLDivElement>
onContextMenuCapture?: MouseEventHandler<HTMLDivElement>
onCopy?: ClipboardEventHandler<HTMLDivElement>
onCopyCapture?: ClipboardEventHandler<HTMLDivElement>
onCut?: ClipboardEventHandler<HTMLDivElement>
onCutCapture?: ClipboardEventHandler<HTMLDivElement>
onDoubleClick?: MouseEventHandler<HTMLDivElement>
onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>
onDrag?: DragEventHandler<HTMLDivElement>
onDragCapture?: DragEventHandler<HTMLDivElement>
onDragEnd?: DragEventHandler<HTMLDivElement>
onDragEndCapture?: DragEventHandler<HTMLDivElement>
onDragEnter?: DragEventHandler<HTMLDivElement>
onDragEnterCapture?: DragEventHandler<HTMLDivElement>
onDragExit?: DragEventHandler<HTMLDivElement>
onDragExitCapture?: DragEventHandler<HTMLDivElement>
onDragLeave?: DragEventHandler<HTMLDivElement>
onDragLeaveCapture?: DragEventHandler<HTMLDivElement>
onDragOver?: DragEventHandler<HTMLDivElement>
onDragOverCapture?: DragEventHandler<HTMLDivElement>
onDragStart?: DragEventHandler<HTMLDivElement>
onDragStartCapture?: DragEventHandler<HTMLDivElement>
onDrop?: DragEventHandler<HTMLDivElement>
onDropCapture?: DragEventHandler<HTMLDivElement>
onDurationChange?: ReactEventHandler<HTMLDivElement>
onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>
onEmptied?: ReactEventHandler<HTMLDivElement>
onEmptiedCapture?: ReactEventHandler<HTMLDivElement>
onEncrypted?: ReactEventHandler<HTMLDivElement>
onEncryptedCapture?: ReactEventHandler<HTMLDivElement>
onEnded?: ReactEventHandler<HTMLDivElement>
onEndedCapture?: ReactEventHandler<HTMLDivElement>
onError?: ReactEventHandler<HTMLDivElement>
onErrorCapture?: ReactEventHandler<HTMLDivElement>
onFocus?: FocusEventHandler<HTMLDivElement>
onFocusCapture?: FocusEventHandler<HTMLDivElement>
onGotPointerCapture?: PointerEventHandler<HTMLDivElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
onInput?: FormEventHandler<HTMLDivElement>
onInputCapture?: FormEventHandler<HTMLDivElement>
onInvalid?: FormEventHandler<HTMLDivElement>
onInvalidCapture?: FormEventHandler<HTMLDivElement>
onKeyDown?: KeyboardEventHandler<HTMLDivElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>
onKeyPress?: KeyboardEventHandler<HTMLDivElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>
onKeyUp?: KeyboardEventHandler<HTMLDivElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>
onLoad?: ReactEventHandler<HTMLDivElement>
onLoadCapture?: ReactEventHandler<HTMLDivElement>
onLoadStart?: ReactEventHandler<HTMLDivElement>
onLoadStartCapture?: ReactEventHandler<HTMLDivElement>
onLoadedData?: ReactEventHandler<HTMLDivElement>
onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>
onLoadedMetadata?: ReactEventHandler<HTMLDivElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>
onLostPointerCapture?: PointerEventHandler<HTMLDivElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
onMouseDown?: MouseEventHandler<HTMLDivElement>
onMouseDownCapture?: MouseEventHandler<HTMLDivElement>
onMouseEnter?: MouseEventHandler<HTMLDivElement>
onMouseLeave?: MouseEventHandler<HTMLDivElement>
onMouseMove?: MouseEventHandler<HTMLDivElement>
onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>
onMouseOut?: MouseEventHandler<HTMLDivElement>
onMouseOutCapture?: MouseEventHandler<HTMLDivElement>
onMouseOver?: MouseEventHandler<HTMLDivElement>
onMouseOverCapture?: MouseEventHandler<HTMLDivElement>
onMouseUp?: MouseEventHandler<HTMLDivElement>
onMouseUpCapture?: MouseEventHandler<HTMLDivElement>
onPaste?: ClipboardEventHandler<HTMLDivElement>
onPasteCapture?: ClipboardEventHandler<HTMLDivElement>
onPause?: ReactEventHandler<HTMLDivElement>
onPauseCapture?: ReactEventHandler<HTMLDivElement>
onPlay?: ReactEventHandler<HTMLDivElement>
onPlayCapture?: ReactEventHandler<HTMLDivElement>
onPlaying?: ReactEventHandler<HTMLDivElement>
onPlayingCapture?: ReactEventHandler<HTMLDivElement>
onPointerCancel?: PointerEventHandler<HTMLDivElement>
onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>
onPointerDown?: PointerEventHandler<HTMLDivElement>
onPointerDownCapture?: PointerEventHandler<HTMLDivElement>
onPointerEnter?: PointerEventHandler<HTMLDivElement>
onPointerEnterCapture?: PointerEventHandler<HTMLDivElement>
onPointerLeave?: PointerEventHandler<HTMLDivElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLDivElement>
onPointerMove?: PointerEventHandler<HTMLDivElement>
onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>
onPointerOut?: PointerEventHandler<HTMLDivElement>
onPointerOutCapture?: PointerEventHandler<HTMLDivElement>
onPointerOver?: PointerEventHandler<HTMLDivElement>
onPointerOverCapture?: PointerEventHandler<HTMLDivElement>
onPointerUp?: PointerEventHandler<HTMLDivElement>
onPointerUpCapture?: PointerEventHandler<HTMLDivElement>
onProgress?: ReactEventHandler<HTMLDivElement>
onProgressCapture?: ReactEventHandler<HTMLDivElement>
onRateChange?: ReactEventHandler<HTMLDivElement>
onRateChangeCapture?: ReactEventHandler<HTMLDivElement>
onReset?: FormEventHandler<HTMLDivElement>
onResetCapture?: FormEventHandler<HTMLDivElement>
onScroll?: UIEventHandler<HTMLDivElement>
onScrollCapture?: UIEventHandler<HTMLDivElement>
onSeeked?: ReactEventHandler<HTMLDivElement>
onSeekedCapture?: ReactEventHandler<HTMLDivElement>
onSeeking?: ReactEventHandler<HTMLDivElement>
onSeekingCapture?: ReactEventHandler<HTMLDivElement>
onSelect?: ReactEventHandler<HTMLDivElement>
onSelectCapture?: ReactEventHandler<HTMLDivElement>
onStalled?: ReactEventHandler<HTMLDivElement>
onStalledCapture?: ReactEventHandler<HTMLDivElement>
onSubmit?: FormEventHandler<HTMLDivElement>
onSubmitCapture?: FormEventHandler<HTMLDivElement>
onSuspend?: ReactEventHandler<HTMLDivElement>
onSuspendCapture?: ReactEventHandler<HTMLDivElement>
onTimeUpdate?: ReactEventHandler<HTMLDivElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>
onTouchCancel?: TouchEventHandler<HTMLDivElement>
onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>
onTouchEnd?: TouchEventHandler<HTMLDivElement>
onTouchEndCapture?: TouchEventHandler<HTMLDivElement>
onTouchMove?: TouchEventHandler<HTMLDivElement>
onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>
onTouchStart?: TouchEventHandler<HTMLDivElement>
onTouchStartCapture?: TouchEventHandler<HTMLDivElement>
onTransitionEnd?: TransitionEventHandler<HTMLDivElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>
onVolumeChange?: ReactEventHandler<HTMLDivElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>
onWaiting?: ReactEventHandler<HTMLDivElement>
onWaitingCapture?: ReactEventHandler<HTMLDivElement>
onWheel?: WheelEventHandler<HTMLDivElement>
onWheelCapture?: WheelEventHandler<HTMLDivElement>
placeholder?: string
prefix?: string
property?: string
radioGroup?: string
resource?: string
results?: number
role?: AriaRole
security?: string
slot?: string
spellCheck?: Booleanish
state?: string
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
title?: string
translate?: "yes" | "no"
typeof?: string
unselectable?: "on" | "off"
vocab?: string

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
lang?: string
onAbort?: ReactEventHandler<HTMLDivElement>
onAbortCapture?: ReactEventHandler<HTMLDivElement>
onAnimationEnd?: AnimationEventHandler<HTMLDivElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>
onAnimationIteration?: AnimationEventHandler<HTMLDivElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>
onAnimationStart?: AnimationEventHandler<HTMLDivElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>
onAuxClick?: MouseEventHandler<HTMLDivElement>
onAuxClickCapture?: MouseEventHandler<HTMLDivElement>
onBeforeInput?: FormEventHandler<HTMLDivElement>
onBeforeInputCapture?: FormEventHandler<HTMLDivElement>
onBlur?: FocusEventHandler<HTMLDivElement>
onBlurCapture?: FocusEventHandler<HTMLDivElement>
onCanPlay?: ReactEventHandler<HTMLDivElement>
onCanPlayCapture?: ReactEventHandler<HTMLDivElement>
onCanPlayThrough?: ReactEventHandler<HTMLDivElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>
onChange?: FormEventHandler<HTMLDivElement>
onChangeCapture?: FormEventHandler<HTMLDivElement>
onClick?: MouseEventHandler<HTMLDivElement>
onClickCapture?: MouseEventHandler<HTMLDivElement>
onCompositionEnd?: CompositionEventHandler<HTMLDivElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>
onCompositionStart?: CompositionEventHandler<HTMLDivElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>
onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>
onContextMenu?: MouseEventHandler<HTMLDivElement>
onContextMenuCapture?: MouseEventHandler<HTMLDivElement>
onCopy?: ClipboardEventHandler<HTMLDivElement>
onCopyCapture?: ClipboardEventHandler<HTMLDivElement>
onCut?: ClipboardEventHandler<HTMLDivElement>
onCutCapture?: ClipboardEventHandler<HTMLDivElement>
onDoubleClick?: MouseEventHandler<HTMLDivElement>
onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>
onDrag?: DragEventHandler<HTMLDivElement>
onDragCapture?: DragEventHandler<HTMLDivElement>
onDragEnd?: DragEventHandler<HTMLDivElement>
onDragEndCapture?: DragEventHandler<HTMLDivElement>
onDragEnter?: DragEventHandler<HTMLDivElement>
onDragEnterCapture?: DragEventHandler<HTMLDivElement>
onDragExit?: DragEventHandler<HTMLDivElement>
onDragExitCapture?: DragEventHandler<HTMLDivElement>
onDragLeave?: DragEventHandler<HTMLDivElement>
onDragLeaveCapture?: DragEventHandler<HTMLDivElement>
onDragOver?: DragEventHandler<HTMLDivElement>
onDragOverCapture?: DragEventHandler<HTMLDivElement>
onDragStart?: DragEventHandler<HTMLDivElement>
onDragStartCapture?: DragEventHandler<HTMLDivElement>
onDrop?: DragEventHandler<HTMLDivElement>
onDropCapture?: DragEventHandler<HTMLDivElement>
onDurationChange?: ReactEventHandler<HTMLDivElement>
onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>
onEmptied?: ReactEventHandler<HTMLDivElement>
onEmptiedCapture?: ReactEventHandler<HTMLDivElement>
onEncrypted?: ReactEventHandler<HTMLDivElement>
onEncryptedCapture?: ReactEventHandler<HTMLDivElement>
onEnded?: ReactEventHandler<HTMLDivElement>
onEndedCapture?: ReactEventHandler<HTMLDivElement>
onError?: ReactEventHandler<HTMLDivElement>
onErrorCapture?: ReactEventHandler<HTMLDivElement>
onFocus?: FocusEventHandler<HTMLDivElement>
onFocusCapture?: FocusEventHandler<HTMLDivElement>
onGotPointerCapture?: PointerEventHandler<HTMLDivElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
onInput?: FormEventHandler<HTMLDivElement>
onInputCapture?: FormEventHandler<HTMLDivElement>
onInvalid?: FormEventHandler<HTMLDivElement>
onInvalidCapture?: FormEventHandler<HTMLDivElement>
onKeyDown?: KeyboardEventHandler<HTMLDivElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>
onKeyPress?: KeyboardEventHandler<HTMLDivElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>
onKeyUp?: KeyboardEventHandler<HTMLDivElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>
onLoad?: ReactEventHandler<HTMLDivElement>
onLoadCapture?: ReactEventHandler<HTMLDivElement>
onLoadStart?: ReactEventHandler<HTMLDivElement>
onLoadStartCapture?: ReactEventHandler<HTMLDivElement>
onLoadedData?: ReactEventHandler<HTMLDivElement>
onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>
onLoadedMetadata?: ReactEventHandler<HTMLDivElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>
onLostPointerCapture?: PointerEventHandler<HTMLDivElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>
onMouseDown?: MouseEventHandler<HTMLDivElement>
onMouseDownCapture?: MouseEventHandler<HTMLDivElement>
onMouseEnter?: MouseEventHandler<HTMLDivElement>
onMouseLeave?: MouseEventHandler<HTMLDivElement>
onMouseMove?: MouseEventHandler<HTMLDivElement>
onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>
onMouseOut?: MouseEventHandler<HTMLDivElement>
onMouseOutCapture?: MouseEventHandler<HTMLDivElement>
onMouseOver?: MouseEventHandler<HTMLDivElement>
onMouseOverCapture?: MouseEventHandler<HTMLDivElement>
onMouseUp?: MouseEventHandler<HTMLDivElement>
onMouseUpCapture?: MouseEventHandler<HTMLDivElement>
onPaste?: ClipboardEventHandler<HTMLDivElement>
onPasteCapture?: ClipboardEventHandler<HTMLDivElement>
onPause?: ReactEventHandler<HTMLDivElement>
onPauseCapture?: ReactEventHandler<HTMLDivElement>
onPlay?: ReactEventHandler<HTMLDivElement>
onPlayCapture?: ReactEventHandler<HTMLDivElement>
onPlaying?: ReactEventHandler<HTMLDivElement>
onPlayingCapture?: ReactEventHandler<HTMLDivElement>
onPointerCancel?: PointerEventHandler<HTMLDivElement>
onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>
onPointerDown?: PointerEventHandler<HTMLDivElement>
onPointerDownCapture?: PointerEventHandler<HTMLDivElement>
onPointerEnter?: PointerEventHandler<HTMLDivElement>
onPointerEnterCapture?: PointerEventHandler<HTMLDivElement>
onPointerLeave?: PointerEventHandler<HTMLDivElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLDivElement>
onPointerMove?: PointerEventHandler<HTMLDivElement>
onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>
onPointerOut?: PointerEventHandler<HTMLDivElement>
onPointerOutCapture?: PointerEventHandler<HTMLDivElement>
onPointerOver?: PointerEventHandler<HTMLDivElement>
onPointerOverCapture?: PointerEventHandler<HTMLDivElement>
onPointerUp?: PointerEventHandler<HTMLDivElement>
onPointerUpCapture?: PointerEventHandler<HTMLDivElement>
onProgress?: ReactEventHandler<HTMLDivElement>
onProgressCapture?: ReactEventHandler<HTMLDivElement>
onRateChange?: ReactEventHandler<HTMLDivElement>
onRateChangeCapture?: ReactEventHandler<HTMLDivElement>
onReset?: FormEventHandler<HTMLDivElement>
onResetCapture?: FormEventHandler<HTMLDivElement>
onScroll?: UIEventHandler<HTMLDivElement>
onScrollCapture?: UIEventHandler<HTMLDivElement>
onSeeked?: ReactEventHandler<HTMLDivElement>
onSeekedCapture?: ReactEventHandler<HTMLDivElement>
onSeeking?: ReactEventHandler<HTMLDivElement>
onSeekingCapture?: ReactEventHandler<HTMLDivElement>
onSelect?: ReactEventHandler<HTMLDivElement>
onSelectCapture?: ReactEventHandler<HTMLDivElement>
onStalled?: ReactEventHandler<HTMLDivElement>
onStalledCapture?: ReactEventHandler<HTMLDivElement>
onSubmit?: FormEventHandler<HTMLDivElement>
onSubmitCapture?: FormEventHandler<HTMLDivElement>
onSuspend?: ReactEventHandler<HTMLDivElement>
onSuspendCapture?: ReactEventHandler<HTMLDivElement>
onTimeUpdate?: ReactEventHandler<HTMLDivElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>
onTouchCancel?: TouchEventHandler<HTMLDivElement>
onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>
onTouchEnd?: TouchEventHandler<HTMLDivElement>
onTouchEndCapture?: TouchEventHandler<HTMLDivElement>
onTouchMove?: TouchEventHandler<HTMLDivElement>
onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>
onTouchStart?: TouchEventHandler<HTMLDivElement>
onTouchStartCapture?: TouchEventHandler<HTMLDivElement>
onTransitionEnd?: TransitionEventHandler<HTMLDivElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>
onVolumeChange?: ReactEventHandler<HTMLDivElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>
onWaiting?: ReactEventHandler<HTMLDivElement>
onWaitingCapture?: ReactEventHandler<HTMLDivElement>
onWheel?: WheelEventHandler<HTMLDivElement>
onWheelCapture?: WheelEventHandler<HTMLDivElement>
placeholder?: string
prefix?: string
property?: string
radioGroup?: string
resource?: string
results?: number
role?: AriaRole
security?: string
slot?: string
spellCheck?: Booleanish
state?: string
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
title?: string
translate?: "yes" | "no"
typeof?: string
unselectable?: "on" | "off"
vocab?: string

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIValueBoxProps.html b/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIValueBoxProps.html index 128b6c16..f8c9c914 100644 --- a/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIValueBoxProps.html +++ b/docs/typedoc/flowerbi-react-utils/interfaces/FlowerBIValueBoxProps.html @@ -1 +1 @@ -FlowerBIValueBoxProps | flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FlowerBIValueBoxProps

Hierarchy

  • FlowerBIValueBoxProps

Index

Properties

id?: string
label?: string
title?: string
value?: string | number

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +FlowerBIValueBoxProps | flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FlowerBIValueBoxProps

Hierarchy

  • FlowerBIValueBoxProps

Index

Properties

id?: string
label?: string
title?: string
value?: string | number

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react-utils/interfaces/LayoutProps.html b/docs/typedoc/flowerbi-react-utils/interfaces/LayoutProps.html index 83c7301a..b1808ffe 100644 --- a/docs/typedoc/flowerbi-react-utils/interfaces/LayoutProps.html +++ b/docs/typedoc/flowerbi-react-utils/interfaces/LayoutProps.html @@ -124,7 +124,7 @@
see

aria-valuetext.

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

-
autoCapitalize?: string
autoCorrect?: string
autoSave?: string
children: ReactNode | ReactNode[]
className?: string
color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
draggable?: Booleanish
hidden?: boolean
id?: string
inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"
+
autoCapitalize?: string
autoCorrect?: string
autoSave?: string
children: ReactNode | ReactNode[]
className?: string
color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
draggable?: Booleanish
hidden?: boolean
id?: string
inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

see

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

is?: string
diff --git a/docs/typedoc/flowerbi-react-utils/modules.html b/docs/typedoc/flowerbi-react-utils/modules.html index 20748cd5..761132a4 100644 --- a/docs/typedoc/flowerbi-react-utils/modules.html +++ b/docs/typedoc/flowerbi-react-utils/modules.html @@ -1 +1 @@ -flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

flowerbi-react-utils

Index

Functions

  • Column(props: LayoutElementCoreProps): Element
  • Row(props: LayoutElementCoreProps): Element
  • useDropDown<T>(options: DropDownOption<T>[]): { options: string[]; value: string; get selected(): T; onChange: any }

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +flowerbi-react-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

flowerbi-react-utils

Index

Functions

  • Column(props: LayoutElementCoreProps): Element
  • Row(props: LayoutElementCoreProps): Element
  • useDropDown<T>(options: DropDownOption<T>[]): { options: string[]; value: string; get selected(): T; onChange: any }

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react/interfaces/PageFilters.html b/docs/typedoc/flowerbi-react/interfaces/PageFilters.html index a2f0132a..6d61ebed 100644 --- a/docs/typedoc/flowerbi-react/interfaces/PageFilters.html +++ b/docs/typedoc/flowerbi-react/interfaces/PageFilters.html @@ -1 +1 @@ -PageFilters | flowerbi-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PageFilters

Hierarchy

Index

Properties

global: FilterJson[]
interactionKey: string
interactions: FilterJson[]

Methods

  • clearAll(): void
  • clearGlobal(): void
  • clearInteraction(): void
  • getFilters(key: string): FilterJson[]
  • setGlobal(filters: FilterJson[]): void
  • setInteraction(key: string, filters: FilterJson[]): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +PageFilters | flowerbi-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PageFilters

Hierarchy

Index

Properties

global: FilterJson[]
interactionKey: string
interactions: FilterJson[]

Methods

  • clearAll(): void
  • clearGlobal(): void
  • clearInteraction(): void
  • getFilters(key: string): FilterJson[]
  • setGlobal(filters: FilterJson[]): void
  • setInteraction(key: string, filters: FilterJson[]): void

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react/interfaces/PageFiltersProp.html b/docs/typedoc/flowerbi-react/interfaces/PageFiltersProp.html index 3146aa89..ebc80ec6 100644 --- a/docs/typedoc/flowerbi-react/interfaces/PageFiltersProp.html +++ b/docs/typedoc/flowerbi-react/interfaces/PageFiltersProp.html @@ -1 +1 @@ -PageFiltersProp | flowerbi-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PageFiltersProp

Hierarchy

  • PageFiltersProp

Index

Properties

Properties

pageFilters: PageFilters

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +PageFiltersProp | flowerbi-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PageFiltersProp

Hierarchy

  • PageFiltersProp

Index

Properties

Properties

pageFilters: PageFilters

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react/interfaces/PageFiltersState.html b/docs/typedoc/flowerbi-react/interfaces/PageFiltersState.html index 44a68599..0a211f59 100644 --- a/docs/typedoc/flowerbi-react/interfaces/PageFiltersState.html +++ b/docs/typedoc/flowerbi-react/interfaces/PageFiltersState.html @@ -1 +1 @@ -PageFiltersState | flowerbi-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PageFiltersState

Hierarchy

Index

Properties

global: FilterJson[]
interactionKey: string
interactions: FilterJson[]

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +PageFiltersState | flowerbi-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PageFiltersState

Hierarchy

Index

Properties

global: FilterJson[]
interactionKey: string
interactions: FilterJson[]

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi-react/interfaces/UseQueryResult.html b/docs/typedoc/flowerbi-react/interfaces/UseQueryResult.html index 7a29a98d..58792661 100644 --- a/docs/typedoc/flowerbi-react/interfaces/UseQueryResult.html +++ b/docs/typedoc/flowerbi-react/interfaces/UseQueryResult.html @@ -2,7 +2,7 @@

The set of records returned, each having named properties corresponding to the plain and aggregated columns selected in the query.

-
+

The state of the query operation:

UseQueryState: "init" | "ready" | "refresh" | "error"

Functions

UseQueryState: "init" | "ready" | "refresh" | "error"

Functions

  • A custom React hook that evaluates to the result of a Query, making it easy to perform a query from within a component.

    @@ -23,6 +23,6 @@

    Optionally, a list of one or more other queries whose results are used to build this query, so we wait for them before executing, and optionally short-circuit to an empty result if the dependency is empty.

    -

Returns UseQueryResult<S, C>

Returns UseQueryResult<S, C>

Legend

  • Property
  • Method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/classes/IntegerQueryColumn.html b/docs/typedoc/flowerbi/classes/IntegerQueryColumn.html index aff40833..3c560165 100644 --- a/docs/typedoc/flowerbi/classes/IntegerQueryColumn.html +++ b/docs/typedoc/flowerbi/classes/IntegerQueryColumn.html @@ -1,51 +1,51 @@ -IntegerQueryColumn | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IntegerQueryColumn<T>

Type parameters

  • T: number | null = number

Hierarchy

Index

Constructors

Properties

name: string

Methods

  • bitsIn(mask: number, value: NonNullable<T>[]): FilterJson

Returns AggregationJson

  • bitsIn(mask: number, value: NonNullable<T>[]): FilterJson

Returns AggregationJson

Returns AggregationJson

  • in(value: T extends string | number ? T[] : never): FilterJson
  • in(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to appear in the list. Only supported for number or string columns.

    -

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

Returns AggregationJson

Returns AggregationJson

  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to not appear in the list. Only supported for number or string columns.

    -

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

Returns AggregationJson

Returns AggregationJson

  • in(value: T extends string | number ? T[] : never): FilterJson
  • in(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to appear in the list. Only supported for number or string columns.

    -

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

Returns AggregationJson

Returns AggregationJson

  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to not appear in the list. Only supported for number or string columns.

    -

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

Returns AggregationJson

  • Produces a filter that requires this column to be equal to some value.

    -

    Parameters

    • value: T

    Returns FilterJson

  • Produces a filter that requires this column to be greater than to some value.

    -

    Parameters

    • value: T

    Returns FilterJson

  • Produces a filter that requires this column to be greater than or equal to some value.

    -

    Parameters

    • value: T

    Returns FilterJson

  • in(value: T extends string | number ? T[] : never): FilterJson
  • in(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to appear in the list. Only supported for number or string columns.

    -

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

  • Produces a filter that requires this column to be less than to some value.

    -

    Parameters

    • value: T

    Returns FilterJson

  • Produces a filter that requires this column to be less than or equal to some value.

    -

    Parameters

    • value: T

    Returns FilterJson

Returns AggregationJson

Returns AggregationJson

  • Produces a filter that requires this column to be not equal to some value.

    -

    Parameters

    • value: T

    Returns FilterJson

  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to not appear in the list. Only supported for number or string columns.

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/classes/QueryColumnRuntimeType.html b/docs/typedoc/flowerbi/classes/QueryColumnRuntimeType.html index 633d8e70..5b43d94b 100644 --- a/docs/typedoc/flowerbi/classes/QueryColumnRuntimeType.html +++ b/docs/typedoc/flowerbi/classes/QueryColumnRuntimeType.html @@ -1 +1 @@ -QueryColumnRuntimeType | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryColumnRuntimeType

Hierarchy

  • QueryColumnRuntimeType

Index

Constructors

Properties

Constructors

Properties

targetColumn: string

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +QueryColumnRuntimeType | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryColumnRuntimeType

Hierarchy

  • QueryColumnRuntimeType

Index

Constructors

Properties

Constructors

Properties

targetColumn: string

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/classes/QueryValuesRow.html b/docs/typedoc/flowerbi/classes/QueryValuesRow.html index eec87d42..14a07756 100644 --- a/docs/typedoc/flowerbi/classes/QueryValuesRow.html +++ b/docs/typedoc/flowerbi/classes/QueryValuesRow.html @@ -1,4 +1,4 @@ -QueryValuesRow | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryValuesRow<S, C>

Type parameters

Hierarchy

  • QueryValuesRow

Implements

Index

Constructors

Properties

Methods

Constructors

Properties

totals: undefined | (AggregateValuesOnly<S> & CalculationValues<C>)
values: ExpandedQueryRecord<S, C>
+QueryValuesRow | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryValuesRow<S, C>

Type parameters

Hierarchy

  • QueryValuesRow

Implements

Index

Constructors

Properties

Methods

Constructors

Properties

totals: undefined | (AggregateValuesOnly<S> & CalculationValues<C>)
values: ExpandedQueryRecord<S, C>

The plain values of columns, which may be undefined if this refers to the ExpandedQueryResult.totals record.

-

Methods

  • percentage<K>(key: K): number

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Methods

  • percentage<K>(key: K): number

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/classes/QueryValuesTotal.html b/docs/typedoc/flowerbi/classes/QueryValuesTotal.html index 14608a85..f7a6eae9 100644 --- a/docs/typedoc/flowerbi/classes/QueryValuesTotal.html +++ b/docs/typedoc/flowerbi/classes/QueryValuesTotal.html @@ -1,4 +1,4 @@ -QueryValuesTotal | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryValuesTotal<S, C>

Type parameters

Hierarchy

  • QueryValuesTotal

Implements

Index

Constructors

Properties

Methods

Constructors

Properties

+QueryValuesTotal | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryValuesTotal<S, C>

Type parameters

Hierarchy

  • QueryValuesTotal

Implements

Index

Constructors

Properties

Methods

Constructors

Properties

The plain values of columns, which may be undefined if this refers to the ExpandedQueryResult.totals record.

-

Methods

  • percentage(): number

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Methods

  • percentage(): number

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/classes/StringQueryColumn.html b/docs/typedoc/flowerbi/classes/StringQueryColumn.html index 7402ef9e..36d50289 100644 --- a/docs/typedoc/flowerbi/classes/StringQueryColumn.html +++ b/docs/typedoc/flowerbi/classes/StringQueryColumn.html @@ -1,46 +1,46 @@ -StringQueryColumn | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StringQueryColumn<T>

Type parameters

  • T: string | null = string

Hierarchy

Index

Constructors

Properties

name: string

Methods

Returns AggregationJson

Returns AggregationJson

  • in(value: T extends string | number ? T[] : never): FilterJson
  • in(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to appear in the list. Only supported for number or string columns.

    -

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

Returns AggregationJson

Returns AggregationJson

  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • notIn(value: T extends string | number ? T[] : never): FilterJson
  • Produces a filter that requires this column's value to not appear in the list. Only supported for number or string columns.

    Parameters

    • value: T extends string | number ? T[] : never

    Returns FilterJson

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/enums/QueryColumnDataType.html b/docs/typedoc/flowerbi/enums/QueryColumnDataType.html index d1e5d3fa..85debd21 100644 --- a/docs/typedoc/flowerbi/enums/QueryColumnDataType.html +++ b/docs/typedoc/flowerbi/enums/QueryColumnDataType.html @@ -1,4 +1,4 @@ QueryColumnDataType | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration QueryColumnDataType

A column from the schema, with a name and a data type. A whole schema of such declared columns can be auto-generated using the CLI.

-

Index

Enumeration members

Bool = "Bool"
Byte = "Byte"
DateTime = "DateTime"
Decimal = "Decimal"
Double = "Double"
Float = "Float"
Int = "Int"
Long = "Long"
None = "None"
Short = "Short"
String = "String"

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration members

Bool = "Bool"
Byte = "Byte"
DateTime = "DateTime"
Decimal = "Decimal"
Double = "Double"
Float = "Float"
Int = "Int"
Long = "Long"
None = "None"
Short = "Short"
String = "String"

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/interfaces/AggregationJson.html b/docs/typedoc/flowerbi/interfaces/AggregationJson.html index 7f63743b..911d6d62 100644 --- a/docs/typedoc/flowerbi/interfaces/AggregationJson.html +++ b/docs/typedoc/flowerbi/interfaces/AggregationJson.html @@ -3,4 +3,4 @@ a function applied to it. Filters can optionally be supplied to limit the set of rows included in the aggregation. The column is specified by a string of the form table.column.

-

Hierarchy

  • AggregationJson

Index

Properties

column: string
filters?: FilterJson[]
function: AggregationType

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • AggregationJson

Index

Properties

column: string
filters?: FilterJson[]
function: AggregationType

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/interfaces/ExpandedQueryResult.html b/docs/typedoc/flowerbi/interfaces/ExpandedQueryResult.html index 84859667..df24412d 100644 --- a/docs/typedoc/flowerbi/interfaces/ExpandedQueryResult.html +++ b/docs/typedoc/flowerbi/interfaces/ExpandedQueryResult.html @@ -1,10 +1,10 @@ ExpandedQueryResult | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ExpandedQueryResult<S, C>

The statically-typed result of a Query.

-

Type parameters

Hierarchy

  • ExpandedQueryResult

Index

Properties

Properties

records: ExpandedQueryRecord<S, C>[]
+

Type parameters

Hierarchy

  • ExpandedQueryResult

Index

Properties

Properties

records: ExpandedQueryRecord<S, C>[]

The set of records returned, each having named properties corresponding to the plain and aggregated columns selected in the query.

-
+

Optional extra record, only available if QueryJson.totals was specified as true in the query, containing the aggregation totals.

diff --git a/docs/typedoc/flowerbi/interfaces/FilterJson.html b/docs/typedoc/flowerbi/interfaces/FilterJson.html index 76854a58..75b2fd12 100644 --- a/docs/typedoc/flowerbi/interfaces/FilterJson.html +++ b/docs/typedoc/flowerbi/interfaces/FilterJson.html @@ -1,4 +1,4 @@ FilterJson | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FilterJson

Specifies a filter criterion. The column is specified by a string of the form table.column.

-

Hierarchy

  • FilterJson

Index

Properties

column: string
constant?: unknown
operator: FilterOperator
value: unknown

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • FilterJson

Index

Properties

column: string
constant?: unknown
operator: FilterOperator
value: unknown

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/interfaces/Query.html b/docs/typedoc/flowerbi/interfaces/Query.html index 20c7fb27..080fccfb 100644 --- a/docs/typedoc/flowerbi/interfaces/Query.html +++ b/docs/typedoc/flowerbi/interfaces/Query.html @@ -1,25 +1,25 @@ Query | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Query<S, C>

Strongly-typed query definition: use jsonifyQuery to convert to the JSON format and expandQueryResult to generate corresponding output records.

-

Type parameters

Hierarchy

  • Query

Index

Properties

allowDuplicates?: boolean
+

Type parameters

Hierarchy

  • Query

Index

Properties

allowDuplicates?: boolean

Only applicable if the query specifies only ordinary columns, no aggregations. If true, no GROUP BY clause is added to the SQL, so if multiple results have the same values they will appear repeatedly in the output. This can greatly reduce the work required by the SQL engine, and so should be specified if duplicate rows are tolerable or are known to be impossible.

-
calculations?: C
comment?: string
+
calculations?: C
comment?: string

A string to insert in a comment at the start of the generated SQL.

This will be aggressively processed to remove the danger of injection attacks, so anything other than alpha, numeric, new line or CR characters will be replaced with space.

-
filters?: FilterJson[]
orderBy?: (OrderingJson | Ordering<S, C>)[]
+
filters?: FilterJson[]
orderBy?: (OrderingJson | Ordering<S, C>)[]

Ordering criteria to apply.

-
select: S
skip?: number
+
select: S
skip?: number

Number of result records to skip before the first record returned.

-
take?: number
+
take?: number

Number of result records to return.

-
totals?: boolean
+
totals?: boolean

Specifies whether to return a totals property containing the aggregation values across the whole dataset, e.g. if the select object is:

diff --git a/docs/typedoc/flowerbi/interfaces/QueryJson.html b/docs/typedoc/flowerbi/interfaces/QueryJson.html index 99e7229d..d733faf3 100644 --- a/docs/typedoc/flowerbi/interfaces/QueryJson.html +++ b/docs/typedoc/flowerbi/interfaces/QueryJson.html @@ -1,23 +1,23 @@ QueryJson | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryJson

Specifies an entire query.

-

Hierarchy

  • QueryJson

Index

Properties

aggregations: AggregationJson[]
+

Hierarchy

  • QueryJson

Index

Properties

aggregations: AggregationJson[]

The aggregated values to fetch.

-
allowDuplicates?: boolean
+
allowDuplicates?: boolean
calculations?: CalculationJson[]
+
calculations?: CalculationJson[]

The calculations to perform.

-
comment?: string
+
comment?: string
filters?: FilterJson[]
+
filters?: FilterJson[]

Filters to apply. They are always combined with AND.

-
orderBy?: OrderingJson[]
+
orderBy?: OrderingJson[]

Ordering criteria to apply.

-
select?: string[]
+
select?: string[]

The plain columns to fetch, each specified by a string of the form table.column.

-
skip?: number
+
skip?: number

See Query.skip.

-
take?: number
+
take?: number

See Query.take.

-
totals?: boolean
+
totals?: boolean

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/interfaces/QueryRecordJson.html b/docs/typedoc/flowerbi/interfaces/QueryRecordJson.html index d3480a39..eec18f27 100644 --- a/docs/typedoc/flowerbi/interfaces/QueryRecordJson.html +++ b/docs/typedoc/flowerbi/interfaces/QueryRecordJson.html @@ -1,7 +1,7 @@ QueryRecordJson | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryRecordJson

The JSON format of a record returned from the API when executing a query.

-

Hierarchy

  • QueryRecordJson

Index

Properties

aggregated: number[]
+

Hierarchy

  • QueryRecordJson

Index

Properties

aggregated: number[]

The aggregated column values.

-
selected: QuerySelectValue[]
+
selected: QuerySelectValue[]

The plain column values.

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/interfaces/QueryResultJson.html b/docs/typedoc/flowerbi/interfaces/QueryResultJson.html index 57023b99..8d89ad5b 100644 --- a/docs/typedoc/flowerbi/interfaces/QueryResultJson.html +++ b/docs/typedoc/flowerbi/interfaces/QueryResultJson.html @@ -1,9 +1,9 @@ QueryResultJson | flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryResultJson

The JSON format of the whole payload returned from the API when executing a query.

-

Hierarchy

  • QueryResultJson

Index

Properties

Properties

records: QueryRecordJson[]
+

Hierarchy

  • QueryResultJson

Index

Properties

Properties

records: QueryRecordJson[]

The records of the query result.

-
+

Optional extra record, only available if QueryJson.totals was specified as true in the query, containing the aggregation totals.

diff --git a/docs/typedoc/flowerbi/interfaces/QueryValues.html b/docs/typedoc/flowerbi/interfaces/QueryValues.html index 50295eea..4b14c807 100644 --- a/docs/typedoc/flowerbi/interfaces/QueryValues.html +++ b/docs/typedoc/flowerbi/interfaces/QueryValues.html @@ -2,7 +2,7 @@

An abstract interface representing either a row from a dataset or the ExpandedQueryResult.totals row, so that generic code can format either of them in a consistent way.

-

Type parameters

Hierarchy

  • QueryValues

Implemented by

Index

Properties

Methods

Properties

+

Type parameters

Hierarchy

  • QueryValues

Implemented by

Index

Properties

Methods

Properties

The plain values of columns, which may be undefined if this refers to the ExpandedQueryResult.totals record.

-

Methods

  • percentage<K>(key: K): number
  • Type parameters

    • K: string | number | symbol

    Parameters

    • key: K

    Returns number

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Methods

  • percentage<K>(key: K): number
  • Type parameters

    • K: string | number | symbol

    Parameters

    • key: K

    Returns number

Legend

  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Property
  • Protected method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/typedoc/flowerbi/modules.html b/docs/typedoc/flowerbi/modules.html index 76a82320..8433780f 100644 --- a/docs/typedoc/flowerbi/modules.html +++ b/docs/typedoc/flowerbi/modules.html @@ -1,70 +1,70 @@ -flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

flowerbi

Index

Type aliases

AggregatePropsOnly<T>: AggregatePropsOnlyHelper<T>[keyof AggregatePropsOnlyHelper<T>]
+flowerbi
Options
All
  • Public
  • Public/Protected
  • All
Menu

flowerbi

Index

Type aliases

AggregatePropsOnly<T>: AggregatePropsOnlyHelper<T>[keyof AggregatePropsOnlyHelper<T>]

The names of properties from a select object that refer to aggregated values. Compare with ColumnPropsOnly.

-

Type parameters

AggregatePropsOnlyHelper<T>: { [ K in keyof T]: T[K] extends QueryColumn<any> ? never : K }
+

Type parameters

AggregatePropsOnlyHelper<T>: { [ K in keyof T]: T[K] extends QueryColumn<any> ? never : K }

A helper type used in the definition of AggregatePropsOnly.

-

Type parameters

AggregateValuesOnly<T>: { [ K in AggregatePropsOnly<T>]: number }
+

Type parameters

AggregateValuesOnly<T>: { [ K in AggregatePropsOnly<T>]: number }

An object that contains a subset of the the named properties from a query's select object, those that refer to aggregated values (hence all are of type number.)

-

Type parameters

AggregationType: "Count" | "Sum" | "Avg" | "Min" | "Max" | "CountDistinct"
+

Type parameters

AggregationType: "Count" | "Sum" | "Avg" | "Min" | "Max" | "CountDistinct"

The allowed aggregation function names.

-
Calculation<S>: number | AggregatePropsOnly<S> | [Calculation<S>, "+" | "-" | "*" | "/" | "??", Calculation<S>]

Type parameters

CalculationJson: { value: number } | { aggregation: number } | { first: CalculationJson; operator: "+" | "-" | "*" | "/" | "??"; second: CalculationJson }
+
Calculation<S>: number | AggregatePropsOnly<S> | [Calculation<S>, "+" | "-" | "*" | "/" | "??", Calculation<S>]

Type parameters

CalculationJson: { value: number } | { aggregation: number } | { first: CalculationJson; operator: "+" | "-" | "*" | "/" | "??"; second: CalculationJson }

Specifies an expression for calculating a derived value based on the values of aggregations, specified by zero-based position.

-
CalculationValues<C>: { [ K in keyof C]: number }

Type parameters

ColumnPropsOnly<T>: ColumnPropsOnlyHelper<T>[keyof ColumnPropsOnlyHelper<T>]
+
CalculationValues<C>: { [ K in keyof C]: number }

Type parameters

ColumnPropsOnly<T>: ColumnPropsOnlyHelper<T>[keyof ColumnPropsOnlyHelper<T>]

The names of properties from a select object that refer to plain columns. Compare with AggregatePropsOnly.

-

Type parameters

ColumnPropsOnlyHelper<T>: { [ K in keyof T]: T[K] extends QueryColumn<any> ? K : never }
+

Type parameters

ColumnPropsOnlyHelper<T>: { [ K in keyof T]: T[K] extends QueryColumn<any> ? K : never }

A helper type used in the definition of ColumnPropsOnly.

-

Type parameters

ExpandedQueryRecord<S, C>: { [ P in keyof S]: S[P] extends QueryColumn<any> ? QueryColumnType<S[P]> : number } & { [ P in keyof C]: number }
+

Type parameters

ExpandedQueryRecord<S, C>: { [ P in keyof S]: S[P] extends QueryColumn<any> ? QueryColumnType<S[P]> : number } & { [ P in keyof C]: number }

Defines the shape of a record returned from a query, based on its select object. Each selected property appears as a property in the record with the same name. For plain columns the data type depends on the column definition, but for aggregations and calculations the data type is always number.

-

Type parameters

ExpandedQueryRecordWithOptionalColumns<S, C>: { [ P in keyof S]: S[P] extends QueryColumn<any> ? QueryColumnType<S[P]> | undefined : number } & { [ P in keyof C]: number }
+

Type parameters

ExpandedQueryRecordWithOptionalColumns<S, C>: { [ P in keyof S]: S[P] extends QueryColumn<any> ? QueryColumnType<S[P]> | undefined : number } & { [ P in keyof C]: number }

Similar to ExpandedQueryRecord but the plain columns are optional, so they may be undefined. Aggregations/calculations are not optional.

-

Type parameters

FilterOperator: "=" | "<>" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "BITS IN" | "LIKE"
+

Type parameters

FilterOperator: "=" | "<>" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN" | "BITS IN" | "LIKE"

The allowed filter comparison operators.

-
FilterValue: string | number | boolean | Date | unknown | string[] | number[]
+
FilterValue: string | number | boolean | Date | unknown | string[] | number[]

The allowed value types for a filter.

-
Ordering<S, C>: { descending?: boolean } & ({ select: keyof S } | { calculation: keyof C })

Type parameters

OrderingJson: { descending?: boolean } & ({ column: string } | { index: number; type: "Select" | "Value" | "Calculation" })
+
Ordering<S, C>: { descending?: boolean } & ({ select: keyof S } | { calculation: keyof C })

Type parameters

OrderingJson: { descending?: boolean } & ({ column: string } | { index: number; type: "Select" | "Value" | "Calculation" })

Specifies an ordering criteria: which column to sort by, and optionally whether it is descending (the default is ascending). The column can be specified by a string of the form table.column, though this can only target one of the columns specified in select. More flexibly, specify a type of column (the type 'Value' refers to aggregations) and its zero-based position.

-
QueryCalculations<S>: Record<string, Calculation<S>>
+
QueryCalculations<S>: Record<string, Calculation<S>>

The select object of a query has named properties of type SelectMember.

-

Type parameters

QueryColumnType<T>: T extends QueryColumn<infer C> ? C : never
+

Type parameters

QueryColumnType<T>: T extends QueryColumn<infer C> ? C : never

Extracts the data type from a column. So QueryColumnType<QueryColumn<boolean>> is boolean.

-

Type parameters

  • T

QueryFetch: (queryJson: QueryJson) => Promise<QueryResultJson>

Type declaration

QueryFetch: (queryJson: QueryJson) => Promise<QueryResultJson>

Type declaration

    • The function you need to implement to pass QueryJson payloads to your API and get them executed. This will typically be a wrapper around the fetch browser API, or something more high-level, and can make use of whatever authentication method you prefer.

      -

      Parameters

      Returns Promise<QueryResultJson>

QuerySelect: Record<string, SelectMember>
+

Parameters

Returns Promise<QueryResultJson>

QuerySelect: Record<string, SelectMember>

The select object of a query has named properties of type SelectMember.

-
QuerySelectValue: number | string | Date | boolean
+
QuerySelectValue: number | string | Date | boolean

The allowed data types for plain columns.

-
SelectMember: QueryColumn<any> | AggregationJson
+
SelectMember: QueryColumn<any> | AggregationJson

Defines the kinds of member that can appear in the select object of a query. Queries can select plain columns, or aggregation functions on columns.

-

Functions

  • distinct<T>(arr: T[]): T[]

Functions

  • distinct<T>(arr: T[]): T[]
  • Returns the distinct (unique) values from an array. The comparison method is very simplistic: all values are converted to strings before comparison.

    Type parameters

    • T

    Parameters

    • arr: T[]
      -

    Returns T[]

Returns T[]

  • Converts the QueryRecordJson for a single record into a strongly-typed record with named properties, using the Query.select from the query to perform the necessary mapping.

    @@ -72,21 +72,21 @@

    The Query.select property from the query.

  • record: QueryRecordJson

    The record returned from your API.

    -
  • Optional calcs: C

Returns ExpandedQueryRecord<S, C>

Returns ExpandedQueryRecord<S, C>

Returns ExpandedQueryResult<S, C>

  • Returns the names of properties in a query that refer to aggregated columns. The result is an array of strings, but type-constrained to string literal types:

    getAggregatePropsOnly({
    customer: Customer.Name,
    spend: Invoice.Amount.sum()
    }) // ["spend"]

    Type parameters

    Parameters

    • select: T

      the select object from a query

      -

    Returns AggregatePropsOnly<T>[]

Returns AggregatePropsOnly<T>[]

Returns AggregateValuesOnly<S> & CalculationValues<C>

Returns AggregateValuesOnly<S> & CalculationValues<C>

  • Returns the names of properties in a query that refer to plain columns. The result is an array of strings, but type-constrained to string literal types:

    getColumnPropsOnly({
    customer: Customer.Name,
    spend: Invoice.Amount.sum()
    }) // ["customer"]

    Type parameters

    Parameters

    • select: T

      the select object from a query

      -

    Returns ColumnPropsOnly<T>[]

Returns ColumnPropsOnly<T>[]

  • Returns the plain column objects referred to in a query, ignoring aggregated columns.

    Parameters

    Returns QueryColumn<any>[]

Returns QueryColumn<any>[]

  • keysOf<T>(obj: T): keyof T[]

Returns QueryJson

  • keysOf<T>(obj: T): keyof T[]
  • Returns the names of properties (i.e. the keys) in an object, statically typed so each has the string literal type of one of the properties. This is not always correct, because the type will include properties inherited diff --git a/server/dotnet/Demo/FlowerBI.DemoSchema/DemoSchema.cs b/server/dotnet/Demo/FlowerBI.DemoSchema/DemoSchema.cs index 916e7a01..fb820800 100644 --- a/server/dotnet/Demo/FlowerBI.DemoSchema/DemoSchema.cs +++ b/server/dotnet/Demo/FlowerBI.DemoSchema/DemoSchema.cs @@ -4,7 +4,7 @@ namespace FlowerBI.DemoSchema; using FlowerBI; -// Important: this file is auto-generated by flowerbi on dotnet. +// Important: this file is auto-generated by flowerbi. [DbSchema("main")] public static class BugSchema diff --git a/server/dotnet/Directory.Build.props b/server/dotnet/Directory.Build.props index ac10ae73..237b3330 100644 --- a/server/dotnet/Directory.Build.props +++ b/server/dotnet/Directory.Build.props @@ -1,6 +1,6 @@ - 5.2.0 + 5.2.1 Daniel Earwicker ./nupkg MIT