Interface GridCanvasHelperAPI
Methods
buildCheckBoxInline
-
Parameters
-
check: boolean
-
-
option: { animElapsedTime?: undefined | number; borderColor?: ColorPropertyDefine; checkBgColor?: ColorPropertyDefine; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; uncheckBgColor?: ColorPropertyDefine }
-
Optional animElapsedTime?: undefined | number
-
-
-
Optional textAlign?: CanvasTextAlign
-
Optional textBaseline?: CanvasTextBaseline
-
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
-
-
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 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
-
Returns void
checkbox
-
Parameters
-
check: boolean
-
-
option: { animElapsedTime?: undefined | number; borderColor?: ColorPropertyDefine; checkBgColor?: ColorPropertyDefine; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; uncheckBgColor?: ColorPropertyDefine }
-
Optional animElapsedTime?: undefined | 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
-
Parameters
-
-
col: number
-
row: number
-
ctx: CanvasRenderingContext2D
-
Parameters
-
-
col: number
-
row: number
-
ctx: CanvasRenderingContext2D
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[]
-
-
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 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
-
Returns void
radioButton
-
Parameters
-
check: boolean
-
-
-
Optional animElapsedTime?: undefined | number
-
-
-
-
-
Optional textAlign?: CanvasTextAlign
-
Optional textBaseline?: CanvasTextBaseline
-
-
Returns void
testFontLoad
- testFontLoad(font: string | undefined, value: string, context: CellContext): boolean
-
Parameters
-
font: string | undefined
-
value: string
-
Returns boolean
text
-
Parameters
-
text: string | (string | InlineAPI)[]
-
-
option: { color?: ColorPropertyDefine; font?: FontPropertyDefine; icons?: SimpleColumnIconOption[]; offset?: undefined | number; padding?: number | string | (string | number)[]; textAlign?: CanvasTextAlign; textBaseline?: CanvasTextBaseline; textOverflow?: TextOverflow }
-
-
-
Optional icons?: SimpleColumnIconOption[]
-
Optional offset?: undefined | number
-
Optional padding?: number | string | (string | number)[]
-
Optional textAlign?: CanvasTextAlign
-
Optional textBaseline?: CanvasTextBaseline
-
Returns void
toBoxPixelArray
- toBoxPixelArray(value: number | string | (string | number)[], context: CellContext, font: string | undefined): [number, number, number, number]
-
Parameters
-
value: number | string | (string | number)[]
-
-
font: string | undefined
Returns [number, number, number, number]