Interface GridCanvasHelperAPI

theme

buildCheckBoxInline

• buildCheckBoxInline(check, context, option): InlineAPI

• Parameters

  • check: boolean
  • context: CellContext
  • option: {
        animElapsedTime?: number;
        borderColor?: ColorPropertyDefine;
        checkBgColor?: ColorPropertyDefine;
        textAlign?: CanvasTextAlign;
        textBaseline?: CanvasTextBaseline;
        uncheckBgColor?: ColorPropertyDefine;
    }

    • OptionalanimElapsedTime?: number

    • OptionalborderColor?: ColorPropertyDefine

    • OptionalcheckBgColor?: ColorPropertyDefine

    • OptionaltextAlign?: CanvasTextAlign

    • OptionaltextBaseline?: CanvasTextBaseline

    • OptionaluncheckBgColor?: ColorPropertyDefine

  Returns InlineAPI

button

• button(caption, context, option): void

• Parameters

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

    • OptionalbgColor?: ColorPropertyDefine

    • Optionalcolor?: ColorPropertyDefine

    • Optionalfont?: FontPropertyDefine

    • Optionalicons?: SimpleColumnIconOption[]

    • Optionaloffset?: number

    • Optionalpadding?: string | number | (string | number)[]

    • Optionalshadow?: {
          blur?: number;
          color?: string;
          offset?: {
              x?: number;
              y?: number;
          };
          offsetX?: number;
          offsetY?: number;
      }

      • Optionalblur?: number

      • Optionalcolor?: string

      • Optionaloffset?: {
            x?: number;
            y?: number;
        }

        • Optionalx?: number

        • Optionaly?: number

      • OptionaloffsetX?: number

      • OptionaloffsetY?: number

    • OptionaltextAlign?: CanvasTextAlign

    • OptionaltextBaseline?: CanvasTextBaseline

    • OptionaltextOverflow?: string

  Returns void

checkbox

• checkbox(check, context, option): void

• Parameters

  • check: boolean
  • context: CellContext
  • option: {
        animElapsedTime?: number;
        borderColor?: ColorPropertyDefine;
        checkBgColor?: ColorPropertyDefine;
        offset?: number;
        textAlign?: CanvasTextAlign;
        textBaseline?: CanvasTextBaseline;
        uncheckBgColor?: ColorPropertyDefine;
    }

    • OptionalanimElapsedTime?: number

    • OptionalborderColor?: ColorPropertyDefine

    • OptionalcheckBgColor?: ColorPropertyDefine

    • Optionaloffset?: number

    • OptionaltextAlign?: CanvasTextAlign

    • OptionaltextBaseline?: CanvasTextBaseline

    • OptionaluncheckBgColor?: ColorPropertyDefine

  Returns void

drawBorderWithClip

• drawBorderWithClip(context, draw): void

• Parameters

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

      • Parameters

        • ctx: CanvasRenderingContext2D

        Returns void

  Returns void

drawWithClip

• drawWithClip(context, draw): void

• Parameters

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

      • Parameters

        • ctx: CanvasRenderingContext2D

        Returns void

  Returns void

fillRectWithState

• fillRectWithState(rect, context, option): void

• Parameters

  • rect: RectProps
  • context: CellContext
  • option: {
        fillColor?: ColorPropertyDefine;
    }

    • OptionalfillColor?: ColorPropertyDefine

  Returns void

getColor

• getColor(color, col, row, ctx): string | CanvasGradient | CanvasPattern

• Parameters

  • color: ColorPropertyDefine
  • col: number
  • row: number
  • ctx: CanvasRenderingContext2D

  Returns string | CanvasGradient | CanvasPattern

• getColor(color, col, row, ctx): ColorsDef

• Parameters

  • color: ColorsPropertyDefine
  • col: number
  • row: number
  • ctx: CanvasRenderingContext2D

  Returns ColorsDef

getStyleProperty

• getStyleProperty<T>(style, col, row, ctx): T

• Type Parameters

  • T

  Parameters

  • style: T | ((args: StylePropertyFunctionArg) => T)
  • col: number
  • row: number
  • ctx: CanvasRenderingContext2D

  Returns T

multilineText

• multilineText(lines, context, option): void

• Parameters

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

    • OptionalautoWrapText?: boolean

    • Optionalcolor?: ColorPropertyDefine

    • Optionalfont?: FontPropertyDefine

    • Optionalicons?: SimpleColumnIconOption[]

    • OptionallineClamp?: LineClamp

    • OptionallineHeight?: string | number

    • Optionaloffset?: number

    • Optionalpadding?: string | number | (string | number)[]

    • OptionaltextAlign?: CanvasTextAlign

    • OptionaltextBaseline?: CanvasTextBaseline

    • OptionaltextOverflow?: string

  Returns void

radioButton

• radioButton(check, context, option): void

• Parameters

  • check: boolean
  • context: CellContext
  • option: {
        animElapsedTime?: number;
        checkBgColor?: ColorPropertyDefine;
        checkBorderColor?: ColorPropertyDefine;
        checkColor?: ColorPropertyDefine;
        offset?: number;
        textAlign?: CanvasTextAlign;
        textBaseline?: CanvasTextBaseline;
        uncheckBgColor?: ColorPropertyDefine;
        uncheckBorderColor?: ColorPropertyDefine;
    }

    • OptionalanimElapsedTime?: number

    • OptionalcheckBgColor?: ColorPropertyDefine

    • OptionalcheckBorderColor?: ColorPropertyDefine

    • OptionalcheckColor?: ColorPropertyDefine

    • Optionaloffset?: number

    • OptionaltextAlign?: CanvasTextAlign

    • OptionaltextBaseline?: CanvasTextBaseline

    • OptionaluncheckBgColor?: ColorPropertyDefine

    • OptionaluncheckBorderColor?: ColorPropertyDefine

  Returns void

testFontLoad

• testFontLoad(font, value, context): boolean

• Parameters

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

  Returns boolean

text

• text(text, context, option): void

• Parameters

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

    • Optionalcolor?: ColorPropertyDefine

    • Optionalfont?: FontPropertyDefine

    • Optionalicons?: SimpleColumnIconOption[]

    • Optionaloffset?: number

    • Optionalpadding?: string | number | (string | number)[]

    • OptionaltextAlign?: CanvasTextAlign

    • OptionaltextBaseline?: CanvasTextBaseline

    • OptionaltextOverflow?: string

  Returns void

toBoxPixelArray

• toBoxPixelArray(value, context, font): [number, number, number, number]

• Parameters

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

  Returns [number, number, number, number]