Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISettingDescriptor<T>

The setting descriptor

Type parameters

  • T

Hierarchy

Index

Properties

Optional category

category: string

The category of the setting

default

"General"

Optional compose

A helper to convert the setting value into a powerbi value

Optional config

config: DataViewObjectPropertyDescriptor

Additional configuration options

Optional defaultValue

defaultValue: any

The default value for this setting

Optional description

description: string

The settings description

Optional displayName

displayName: string

The display name of the setting

Optional enumerable

enumerable: boolean | IHiddenFn<T>

If enumerable is false, then it will not show up in the formatting pane

default

true

Optional hidden

hidden: boolean | IHiddenFn<T>

If hidden, the setting will not show up in powerbi's formatting pane

default

false

deprecated

Optional max

max: number

The maximum value for this setting

Optional min

min: number

The minimum value for this setting

Optional name

name: string

The name of the setting

Optional parse

A helper to parse the powerbi value into a setting value

Optional persist

persist: boolean

Whether or not this setting should be persisted to powerbi

default

true

Generated using TypeDoc