Interface GridCanvasHelperAPI
Methods
buildCheckBoxInline
Parameters
check: boolean
option: { animElapsedTime?: number; borderColor?: ColorPropertyDefine; checkBgColor?: ColorPropertyDefine; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; uncheckBgColor?: ColorPropertyDefine }
Optional animElapsedTime?: number
Optional textAlign?: CanvasTextAlign
Optional textBaseline?: CanvasTextBaseline
button
- button(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 }): void
Parameters
caption: string
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 }
Optional icons?: SimpleColumnIconOption[]
Optional offset?: number
Optional padding?: string | number | (string | number)[]
Optional shadow?: { blur?: number; color?: string; offset?: { x?: number; y?: number }; offsetX?: number; offsetY?: number }
Optional blur?: number
Optional color?: string
Optional offset?: { x?: number; y?: number }
Optional x?: number
Optional y?: number
Optional offsetX?: number
Optional offsetY?: number
Optional textAlign?: CanvasTextAlign
Optional textBaseline?: CanvasTextBaseline
Optional textOverflow?: string
Returns void
checkbox
Parameters
check: boolean
option: { animElapsedTime?: number; borderColor?: ColorPropertyDefine; checkBgColor?: ColorPropertyDefine; offset?: number; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; uncheckBgColor?: ColorPropertyDefine }
Optional animElapsedTime?: number
Optional offset?: number
Optional textAlign?: CanvasTextAlign
Optional textBaseline?: CanvasTextBaseline
Returns void
drawBorderWithClip
- drawBorderWithClip(context: CellContext, draw: (ctx: CanvasRenderingContext2D) => void): void
Parameters
draw: (ctx: CanvasRenderingContext2D) => void
- (ctx: CanvasRenderingContext2D): void
Parameters
ctx: CanvasRenderingContext2D
Returns void
Returns void
drawWithClip
- drawWithClip(context: CellContext, draw: (ctx: CanvasRenderingContext2D) => void): void
Parameters
draw: (ctx: CanvasRenderingContext2D) => void
- (ctx: CanvasRenderingContext2D): void
Parameters
ctx: CanvasRenderingContext2D
Returns void
Returns void
getColor
- getColor(color: ColorPropertyDefine, col: number, row: number, ctx: CanvasRenderingContext2D): string | CanvasGradient | CanvasPattern
- getColor(color: ColorsPropertyDefine, col: number, row: number, ctx: CanvasRenderingContext2D): ColorsDef
Parameters
col: number
row: number
ctx: CanvasRenderingContext2D
Returns string | CanvasGradient | CanvasPattern
Parameters
col: number
row: number
ctx: CanvasRenderingContext2D
Returns ColorsDef
multilineText
- multilineText(multilines: 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 }): void
Parameters
multilines: string[]
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 }
Optional autoWrapText?: boolean
Optional icons?: SimpleColumnIconOption[]
Optional lineClamp?: LineClamp
Optional lineHeight?: string | number
Optional offset?: number
Optional padding?: string | number | (string | number)[]
Optional textAlign?: CanvasTextAlign
Optional textBaseline?: CanvasTextBaseline
Optional textOverflow?: string
Returns void
testFontLoad
- testFontLoad(font: undefined | string, value: string, context: CellContext): boolean
Parameters
font: undefined | string
value: string
Returns boolean
text
- text(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 }): void
Parameters
text: string | (string | InlineAPI)[]
option: { color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; offset?: number; padding?: string | number | (string | number)[]; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: string }
Optional icons?: SimpleColumnIconOption[]
Optional offset?: number
Optional padding?: string | number | (string | number)[]
Optional textAlign?: CanvasTextAlign
Optional textBaseline?: CanvasTextBaseline
Optional textOverflow?: string
Returns void
toBoxPixelArray
- toBoxPixelArray(value: string | number | (string | number)[], context: CellContext, font: undefined | string): [number, number, number, number]
Parameters
value: string | number | (string | number)[]
font: undefined | string
Returns [number, number, number, number]