Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "lib/settings/parsers"

Index

Variables

Functions

Variables

ldget

ldget: any = require("lodash/get")

Functions

basicParser

  • basicParser<T, J>(path: string, defaultValue?: IDefaultValue): function

  • Provides a basic parser for PBI settings

    Type parameters

    • T

    • J

    Parameters

    • path: string

      The path within the pbi object to look for the value

    • Optional defaultValue: IDefaultValue

      The default value to use if PBI doesn't have a value

    Returns function

colorCategoricalInstanceObjectParser

  • A parser which parses colors for each instance in a categorical dataset

    Type parameters

    • T

    Parameters

    • Default value defaultColor: IDefaultInstanceColor = "#ccc"

      The color to use if an instance doesn't have a color

    Returns function

colorParser

coloredInstanceObjectParser

  • coloredInstanceObjectParser<T>(defaultColor?: IDefaultInstanceColor, instancesGetter: function): function

  • A basic color object parser which parses colors per some instance, using the instancesGetter

    Type parameters

    • T

    Parameters

    • Default value defaultColor: IDefaultInstanceColor = "#ccc"

      The color to use if an instance doesn't have a color

    • instancesGetter: function

      A getter function which returns the set of instances to iterate

        • (dv: DataView): object[]

        • Parameters

          • dv: DataView

          Returns object[]

          • Optional identity?: any
          • Optional name?: any
          • Optional objects?: any

    Returns function

Generated using TypeDoc