Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EntityRec

Represents a 'Record' or set of Prop (names and values). An EntityRec may also have DataAnnos (style annotations) that apply to the whole 'record'

Hierarchy

  • EntityRec

Implemented by

Index

Properties

annos

annos: Array<DataAnno>

backgroundColor

backgroundColor: string

foregroundColor

foregroundColor: string

imageName

imageName: string

imagePlacement

imagePlacement: string

isBoldText

isBoldText: boolean

isItalicText

isItalicText: boolean

isPlacementCenter

isPlacementCenter: boolean

isPlacementLeft

isPlacementLeft: boolean

isPlacementRight

isPlacementRight: boolean

isPlacementStretchUnder

isPlacementStretchUnder: boolean

isPlacementUnder

isPlacementUnder: boolean

isUnderline

isUnderline: boolean

objectId

objectId: string

overrideText

overrideText: string

propCount

propCount: number

propNames

propNames: Array<string>

propValues

propValues: Array<any>

props

props: Array<Prop>

tipText

tipText: string

Methods

afterEffects

annosAtName

  • annosAtName(propName: string): Array<DataAnno>
  • Parameters

    • propName: string

    Returns Array<DataAnno>

backgroundColorFor

  • backgroundColorFor(propName: string): string
  • Parameters

    • propName: string

    Returns string

foregroundColorFor

  • foregroundColorFor(propName: string): string
  • Parameters

    • propName: string

    Returns string

imageNameFor

  • imageNameFor(propName: string): string
  • Parameters

    • propName: string

    Returns string

imagePlacementFor

  • imagePlacementFor(propName: string): string
  • Parameters

    • propName: string

    Returns string

isBoldTextFor

  • isBoldTextFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

isItalicTextFor

  • isItalicTextFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

isPlacementCenterFor

  • isPlacementCenterFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

isPlacementLeftFor

  • isPlacementLeftFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

isPlacementRightFor

  • isPlacementRightFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

isPlacementStretchUnderFor

  • isPlacementStretchUnderFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

isPlacementUnderFor

  • isPlacementUnderFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

isUnderlineFor

  • isUnderlineFor(propName: string): boolean
  • Parameters

    • propName: string

    Returns boolean

overrideTextFor

  • overrideTextFor(propName: string): string
  • Parameters

    • propName: string

    Returns string

propAtIndex

  • propAtIndex(index: number): Prop
  • Parameters

    • index: number

    Returns Prop

propAtName

  • propAtName(propName: string): Prop
  • Parameters

    • propName: string

    Returns Prop

tipTextFor

  • tipTextFor(propName: string): string
  • Parameters

    • propName: string

    Returns string

toEntityRec

  • Returns EntityRec

toWS

toWSEditorRecord

valueAtName

  • valueAtName(propName: string): any
  • Parameters

    • propName: string

    Returns any

Generated using TypeDoc