Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GridCanvasHelperAPI

Hierarchy

  • GridCanvasHelperAPI

Index

Properties

theme

Methods

buildCheckBoxInline

button

  • button(caption: string, context: CellContext, option: { bgColor?: ColorPropertyDefine; color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; offset?: undefined | number; padding?: number | string | (string | number)[]; shadow?: undefined | { blur?: undefined | number; color?: undefined | string; offset?: undefined | { x?: undefined | number; y?: undefined | number }; offsetX?: undefined | number; offsetY?: undefined | number }; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: TextOverflow }): void
  • Parameters

    • caption: string
    • context: CellContext
    • option: { bgColor?: ColorPropertyDefine; color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; offset?: undefined | number; padding?: number | string | (string | number)[]; shadow?: undefined | { blur?: undefined | number; color?: undefined | string; offset?: undefined | { x?: undefined | number; y?: undefined | number }; offsetX?: undefined | number; offsetY?: undefined | number }; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: TextOverflow }
      • Optional bgColor?: ColorPropertyDefine
      • Optional color?: ColorPropertyDefine
      • Optional font?: FontPropertyDefine
      • Optional icons?: SimpleColumnIconOption[]
      • Optional offset?: undefined | number
      • Optional padding?: number | string | (string | number)[]
      • Optional shadow?: undefined | { blur?: undefined | number; color?: undefined | string; offset?: undefined | { x?: undefined | number; y?: undefined | number }; offsetX?: undefined | number; offsetY?: undefined | number }
      • Optional textAlign?: CanvasTextAlign
      • Optional textBaseline?: CanvasTextBaseline
      • Optional textOverflow?: TextOverflow

    Returns void

checkbox

drawBorderWithClip

  • drawBorderWithClip(context: CellContext, draw: (ctx: CanvasRenderingContext2D) => void): void
  • Parameters

    • context: CellContext
    • draw: (ctx: CanvasRenderingContext2D) => void
        • (ctx: CanvasRenderingContext2D): void
        • Parameters

          • ctx: CanvasRenderingContext2D

          Returns void

    Returns void

drawWithClip

  • drawWithClip(context: CellContext, draw: (ctx: CanvasRenderingContext2D) => void): void
  • Parameters

    • context: CellContext
    • draw: (ctx: CanvasRenderingContext2D) => void
        • (ctx: CanvasRenderingContext2D): void
        • Parameters

          • ctx: CanvasRenderingContext2D

          Returns void

    Returns void

fillRectWithState

getColor

multilineText

  • multilineText(multilines: string[], context: CellContext, option: { autoWrapText?: undefined | false | true; color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; lineClamp?: LineClamp; lineHeight?: string | number; offset?: undefined | number; padding?: number | string | (string | number)[]; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: TextOverflow }): void
  • Parameters

    • multilines: string[]
    • context: CellContext
    • option: { autoWrapText?: undefined | false | true; color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; lineClamp?: LineClamp; lineHeight?: string | number; offset?: undefined | number; padding?: number | string | (string | number)[]; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: TextOverflow }
      • Optional autoWrapText?: undefined | false | true
      • Optional color?: ColorPropertyDefine
      • Optional font?: FontPropertyDefine
      • Optional icons?: SimpleColumnIconOption[]
      • Optional lineClamp?: LineClamp
      • Optional lineHeight?: string | number
      • Optional offset?: undefined | number
      • Optional padding?: number | string | (string | number)[]
      • Optional textAlign?: CanvasTextAlign
      • Optional textBaseline?: CanvasTextBaseline
      • Optional textOverflow?: TextOverflow

    Returns void

radioButton

testFontLoad

  • testFontLoad(font: string | undefined, value: string, context: CellContext): boolean
  • Parameters

    • font: string | undefined
    • value: string
    • context: CellContext

    Returns boolean

text

  • text(text: string | (string | InlineAPI)[], context: CellContext, option: { color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; offset?: undefined | number; padding?: number | string | (string | number)[]; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: TextOverflow }): void
  • Parameters

    • text: string | (string | InlineAPI)[]
    • context: CellContext
    • option: { color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; offset?: undefined | number; padding?: number | string | (string | number)[]; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: TextOverflow }
      • Optional color?: ColorPropertyDefine
      • Optional font?: FontPropertyDefine
      • Optional icons?: SimpleColumnIconOption[]
      • Optional offset?: undefined | number
      • Optional padding?: number | string | (string | number)[]
      • Optional textAlign?: CanvasTextAlign
      • Optional textBaseline?: CanvasTextBaseline
      • Optional textOverflow?: TextOverflow

    Returns void

toBoxPixelArray

  • toBoxPixelArray(value: number | string | (string | number)[], context: CellContext, font: string | undefined): [number, number, number, number]
  • Parameters

    • value: number | string | (string | number)[]
    • context: CellContext
    • font: string | undefined

    Returns [number, number, number, number]

Generated using TypeDoc