Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Draw on Canvas using Views
Kanva is a canvas framework for Node.js & browser web apps, inspired by structures present in Android ecosystem.
Kanva is broken down into several packages, allowing you to pick what's really needed.
Most important yarn
scripts during development:
start
- runs builds for all packages in watch mode
verify
- runs lint & tests
Package
Description
Core of Kanva
React bindings for Kanva core.
Chart views in Kanva
@kanva/charts-react
React bindings for chart views in Kanva
@kanva/example
Storybook showcase of Kanva's possibilities
↳ AreaSelectGestureDetector
+ new AreaSelectGestureDetector(options
: AreaSelectGestureDetectorOptions): AreaSelectGestureDetector
Parameters:
Returns: AreaSelectGestureDetector
â–¸ onGestureEvent(event
: CanvasPointerEvent): boolean
Overrides GestureDetector.onGestureEvent
Parameters:
Returns: boolean
â–¸ onPointerEvent(event
: CanvasPointerEvent): boolean
Inherited from GestureDetector.onPointerEvent
Parameters:
Returns: boolean
CanvasPointerEvent
+ new CanvasPointerEvent(): CanvasPointerEvent
Returns: CanvasPointerEvent
• action: PointerAction
• offset: Offset
• pointerCount: number = 0
• pointers: CanvasPointer[] = new Array(10).fill(null).map(() => ({}) as any)
• scrollX: number = 0
• scrollY: number = 0
• scrollZ: number = 0
• target: View
• get primaryPointer(): CanvasPointer
Returns: CanvasPointer
â–¸ clone(): CanvasPointerEvent
Returns: CanvasPointerEvent
â–¸ cloneTo(event
: CanvasPointerEvent): CanvasPointerEvent
Parameters:
Returns: CanvasPointerEvent
â–¸ offsetPointers(offsetX
: number, offsetY
: number): void
Parameters:
Returns: void
↳ DragGestureDetector
+ new DragGestureDetector(options
: DragGestureDetectorOptions): DragGestureDetector
Parameters:
Returns: DragGestureDetector
â–¸ onGestureEvent(event
: CanvasPointerEvent): boolean
Overrides GestureDetector.onGestureEvent
Parameters:
Returns: boolean
â–¸ onPointerEvent(event
: CanvasPointerEvent): boolean
Inherited from GestureDetector.onPointerEvent
Parameters:
Returns: boolean
Context
+ new Context(options
: ContextOptions): Context
Parameters:
Returns: Context
Readonly
canvasCreator• canvasCreator: CanvasCreator
• debugEnabled: boolean = false
Readonly
imageClass• imageClass: ImageClass
â–¸ deregisterView(id
: number): void
Parameters:
Returns: void
â–¸ getId(id
: string | number | undefined): undefined | string | number
Implementation of ContextLike
Parameters:
Returns: undefined | string | number
â–¸ registerView(idName
: string): number
Implementation of ContextLike
Parameters:
Returns: number
â–¸ resolve(id
: string | number | undefined): number | undefined
Implementation of ContextLike
Parameters:
Returns: number | undefined
Ƭ CanvasCreator: function
â–¸ (options
: CanvasCreatorOptions): Canvas
Parameters:
Ƭ DeepReadonly: T extends Primitive ? T : DeepReadonlyObject‹T›
Ƭ DeepReadonlyObject: object
Ƭ DimensionInput: string | number | undefined | null
Ƭ FontStyle: "normal" | "italic" | "oblique"
Ƭ FontVariant: "normal" | "small-caps"
Ƭ FontWeight: "normal" | "bold" | "bolder" | "lighter" | 100 | "100" | 200 | "200" | 300 | "300" | 400 | "400" | 500 | "500" | 600 | "600" | 700 | "700" | 800 | "800" | 900 | "900"
Ƭ Id: number | string
Ƭ ImageClass: object
Ƭ OnAreaSelectListener: function
â–¸ (areaSelectEvent
: AreaSelectEvent): boolean
Parameters:
Ƭ OnDragListener: function
â–¸ (dragEvent
: DragEvent): boolean
Parameters:
Ƭ OnScaleListener: function
â–¸ (scaleEvent
: ScaleEvent): boolean
Parameters:
Ƭ Primitive: string | number | boolean | undefined | null
Ƭ RadiusInput: number | Partial‹Radius› | null | undefined
Ƭ RectInput: RectObjectInput | number
Ƭ SupportedDomPointerEvent: MouseEvent | WheelEvent | TouchEvent
Const
DEBUG_POINTER_EVENTS• DEBUG_POINTER_EVENTS: false = false
Const
DEFAULT_POINTER_COUNT• DEFAULT_POINTER_COUNT: 1 = 1
Const
MATCH_PARENT• MATCH_PARENT: -1 = -1
Const
PARENT_ID• PARENT_ID: -1 = -1
Const
WHEEL_SCROLL_SPAN• WHEEL_SCROLL_SPAN: 100 = 100
Const
WRAP_CONTENT• WRAP_CONTENT: -2 = -2
Const
colorRegex• colorRegex: RegExp‹› = /^(?:#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2}))|(?:#([0-9a-f])([0-9a-f])([0-9a-f]))|(?:rgb((\d+),\s*(\d+),\s*(\d+)))|(?:rgba((\d+),\s*(\d+),\s*(\d+),\s*(\d*.?\d+)))$/i
Const
defaultImageClass• defaultImageClass: undefined | object = (() => { try { // Browsers default return Image; } catch { return undefined; } })()
Const
defaultLayoutProps• defaultLayoutProps: LayoutProps = new LayoutParams().asProps()
Const
isBrowser• isBrowser: false | requestAnimationFrame & requestAnimationFrame = typeof window !== 'undefined' && window.requestAnimationFrame
Const
supportedDomPointerEvents• supportedDomPointerEvents: ("touchmove" | "mousemove" | "mousedown" | "touchstart" | "mouseover" | "mouseenter" | "touchcancel" | "mouseout" | "mouseup" | "touchend" | "wheel")[] = [ 'touchmove', 'mousemove', 'mousedown', 'touchstart', 'mouseover', 'mouseenter', 'touchcancel', 'mouseout', 'mouseup', 'touchend', 'wheel', ]
Const
calcDimensionâ–¸ calcDimension(dimension
: Dimension, parentDimension
: number): undefined | number
Parameters:
Returns: undefined | number
Const
createEventDispatcherâ–¸ createEventDispatcher(view
: View): EventListener
Parameters:
Returns: EventListener
▸ createLayoutMap‹K›(t
: Record‹K, LayoutProps›): object
Type parameters:
â–ª K: string
Parameters:
Returns: object
Const
deepFreeze▸ deepFreeze‹T›(object
: T): DeepReadonly‹T›
Type parameters:
â–ª T
Parameters:
Returns: DeepReadonly‹T›
Const
defaultCanvasCreatorâ–¸ defaultCanvasCreator(__namedParameters
: object): HTMLCanvasElement
Parameters:
â–ª __namedParameters: object
Returns: HTMLCanvasElement
Const
domEventToPointerActionâ–¸ domEventToPointerAction(event
: Event): PointerAction | undefined
Parameters:
Returns: PointerAction | undefined
Const
existingNonParentDependencyâ–¸ existingNonParentDependency(id
: undefined | Id): id is number
Parameters:
Returns: id is number
Const
fillPointerEventDataâ–¸ fillPointerEventData(pointerEvent
: CanvasPointerEvent, view
: View, event
: Event): void
Parameters:
Returns: void
Const
getBoxâ–¸ getBox(width
: number, height
: number, scale
: number): object
Parameters:
Returns: object
str: string = +
style: string = font-size: 1px; padding: ${isSafari() ? height * scale / 2 : 0}px ${Math.floor(width * scale / 2)}px; color: transparent; line-height: ${height * scale}px;
Const
getElementOffsetâ–¸ getElementOffset(element
: HTMLElement, offset
: Offset): Offset
Parameters:
Returns: Offset
Const
horizontalLayoutDependenciesâ–¸ horizontalLayoutDependencies(lp
: LayoutParams): number[]
Parameters:
Returns: number[]
Const
isBrightâ–¸ isBright(color
: Color): boolean
Parameters:
Returns: boolean
Const
isChromeâ–¸ isChrome(): boolean
Returns: boolean
Const
isMouseEventâ–¸ isMouseEvent(event
: Event): event is MouseEvent
Parameters:
Returns: event is MouseEvent
Const
isSafariâ–¸ isSafari(): boolean
Returns: boolean
Const
isTouchEventâ–¸ isTouchEvent(event
: Event): event is TouchEvent
Parameters:
Returns: event is TouchEvent
Const
isWheelEventâ–¸ isWheelEvent(event
: Event): event is WheelEvent
Parameters:
Returns: event is WheelEvent
Const
logPointerEventâ–¸ logPointerEvent(pointerEvent
: CanvasPointerEvent): void
Parameters:
Returns: void
Const
logScreenshotâ–¸ logScreenshot(view
: View, scale
: number): void
Parameters:
Returns: void
Const
luminanceâ–¸ luminance(c
: Color): number
Parameters:
Returns: number
Const
mouseToPointerâ–¸ mouseToPointer(event
: MouseEvent, offset
: Offset, canvasPointer
: CanvasPointer): void
Parameters:
Returns: void
Const
noContextErrorâ–¸ noContextError(): Error
Returns: Error
Const
normalizeRadiusâ–¸ normalizeRadius(radius
: RadiusInput): Radius
Parameters:
Returns: Radius
Const
parseColorâ–¸ parseColor(colorString
: string | undefined): typeof colorString extends undefined ? undefined : Color | undefined
Parameters:
Returns: typeof colorString extends undefined ? undefined : Color | undefined
Const
parseDimensionâ–¸ parseDimension(value
: DimensionInput): Dimension
Parameters:
Returns: Dimension
Const
parseFontâ–¸ parseFont(__namedParameters
: object): string
Parameters:
â–ª __namedParameters: object
Returns: string
Const
registerEventDispatcherâ–¸ registerEventDispatcher(element
: Element, dispatcher
: EventListener): (Anonymous function)
Parameters:
Returns: (Anonymous function)
Const
removeDefaultPropsâ–¸ removeDefaultProps(props
: LayoutProps): any
Parameters:
Returns: any
Const
removeEqualPropsâ–¸ removeEqualProps(object
: any, defaultObject
: any): any
Parameters:
Returns: any
Const
removeUndefinedPropsâ–¸ removeUndefinedProps(object
: any): any
Parameters:
Returns: any
Const
resolveDimensionDependencies▸ resolveDimensionDependencies‹T›(children
: T[], dependencySelector
: function, context
: Context): T[]
Type parameters:
â–ª T: ViewLike
Parameters:
â–ª children: T[]
â–ª dependencySelector: function
â–¸ (lp
: LayoutParams): number[]
Parameters:
â–ª context: Context
Returns: T[]
Const
resolveLayoutParamsIdsâ–¸ resolveLayoutParamsIds(layoutParams
: LayoutParams, context
: Context): void
Parameters:
Returns: void
Const
rgbaâ–¸ rgba(color
: string, alpha
: number): string
Parameters:
Returns: string
Const
roundCoordinateâ–¸ roundCoordinate(coordinate
: number): number
Parameters:
Returns: number
Const
scaleImageâ–¸ scaleImage(scaleType
: ImageScaleType, imageWidth
: number, imageHeight
: number, innerWidth
: number, innerHeight
: number, rect
: Rect): Rect
Parameters:
Returns: Rect
Const
touchToPointerâ–¸ touchToPointer(touch
: Touch | null, offset
: Offset, canvasPointer
: CanvasPointer): void
Parameters:
Returns: void
Const
verticalLayoutDependenciesâ–¸ verticalLayoutDependencies(lp
: LayoutParams): number[]
Parameters:
Returns: number[]
Const
xorâ–¸ xor(a
: boolean, b
: boolean): boolean
Parameters:
Returns: boolean
Const
DefaultProps• ABOVE: undefined = undefined
• ALIGN_BOTTOM: undefined = undefined
• ALIGN_END: undefined = undefined
• ALIGN_START: undefined = undefined
• ALIGN_TOP: undefined = undefined
• BELOW: undefined = undefined
• CENTER_HORIZONTAL: boolean = false
• CENTER_VERTICAL: boolean = false
• HEIGHT: number = WRAP_CONTENT
• IS_ABSOLUTE: boolean = false
• IS_ANIMATED: boolean = false
• MARGIN: Rect‹› = new Rect(0)
• MAX_HEIGHT: number = Number.MAX_SAFE_INTEGER
• MAX_WIDTH: number = Number.MAX_SAFE_INTEGER
• MIN_HEIGHT: number = 0
• MIN_WIDTH: number = 0
• PADDING: Rect‹› = new Rect(0)
• TO_END_OF: undefined = undefined
• TO_START_OF: undefined = undefined
• WIDTH: number = WRAP_CONTENT
• X: number = 0
• Y: number = 0
Const
defaultFont• fontFamily: string = "Arial"
• fontSize: number = 12
Const
defaultPaintOptions• font: string = parseFont(defaultFont)
• lineDash: never[] = []
• lineRounding: boolean = false
• lineWidth: number = 0
• textAlign: TextAlign = 'left' as TextAlign
• textBaseline: TextBaseline = 'bottom' as TextBaseline
• textDirection: CanvasDirection = 'ltr' as CanvasDirection
Const
zeroRadius• bl: number = 0
• br: number = 0
• tl: number = 0
• tr: number = 0
Line
Parameters:
• endX: number
• endY: number
• startX: number
• startY: number
Parameters:
Returns: this
â–¸ add(x
: number, y
: number): this
Parameters:
Returns: this
Returns a copy of Line that can be mutated separately.
Copies all of this Line's properties to a Line specified in an argument. Returns the line passed as argument.
Parameters:
â–¸ extend(distance
: number): this
Extends this line by a specified distance. Starting point remains the same, ending point changes it's place by the distance. If current line has the length of 0, it's extended horizontally. Resulting Line is the same, mutated Line.
Parameters:
Returns: this
â–¸ length(): number
Returns: number
â–¸ move(distance
: number): this
Moves this line by a specified distance on the same angle. Acting similarly to {@link Line#extend}, but modifies both starting and ending points by a specified distance. If current line has the length of 0, it's moved horizontally. Resulting Line is the same, mutated Line.
Parameters:
Returns: this
Parameters:
Returns: this
â–¸ offset(x
: number, y
: number): this
Parameters:
Returns: this
Returns a point on this line, at specified position (ranged from 0 to 1). I.e. to get the center of line, pass 0.5. Creates a new Point, but in order to reuse the existing one, you can pass it as a second argument.
Parameters:
â–¸ toString(): string
Returns: string
LayoutParams
Optional
aboveIdOptional
belowIdOptional
bottomId• centerH: boolean = DefaultProps.CENTER_HORIZONTAL
• centerV: boolean = DefaultProps.CENTER_VERTICAL
• dependenciesModified: boolean = false
Optional
endId• isAbsolute: boolean = DefaultProps.IS_ABSOLUTE
• isAnimated: boolean = DefaultProps.IS_ANIMATED
• maxH: number = DefaultProps.MAX_HEIGHT
• maxW: number = DefaultProps.MAX_WIDTH
• minH: number = DefaultProps.MIN_HEIGHT
• minW: number = DefaultProps.MIN_WIDTH
Optional
startIdOptional
toEndOfIdOptional
toStartOfIdOptional
topIdParameters:
Returns: this
â–¸ absolute(absolute?
: undefined | false | true): this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
â–¸ alignParentBottom(): this
Returns: this
â–¸ alignParentEnd(): this
Returns: this
â–¸ alignParentStart(): this
Returns: this
â–¸ alignParentTop(): this
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
â–¸ animate(animate?
: undefined | false | true): this
Parameters:
Returns: this
Parameters:
Returns: this
â–¸ center(center?
: undefined | false | true): this
Parameters:
Returns: this
â–¸ centerHorizontal(center?
: undefined | false | true): this
Parameters:
Returns: this
â–¸ centerVertical(center?
: undefined | false | true): this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
â–¸ maxHeight(maxHeight
: number): this
Parameters:
Returns: this
â–¸ maxWidth(maxWidth
: number): this
Parameters:
Returns: this
â–¸ minHeight(minHeight
: number): this
Parameters:
Returns: this
â–¸ minWidth(minWidth
: number): this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
Parameters:
Returns: this
â–¸ updateWithProps(__namedParameters
: object): boolean
Parameters:
â–ªDefault value
__namedParameters: object= {}
Returns: boolean
Parameters:
Returns: this
↳ ImageView
Parameters:
Protected
Optional
backgroundColor• backgroundColor? : undefined | string
Protected
Optional
borderColor• borderColor? : undefined | string
Protected
Optional
borderRectReadonly
contextProtected
height• height: number = 0
Optional
id• id? : undefined | number
Protected
innerRectThis are the bounds of view including padding.
Protected
lpReadonly
name• name: string
This are the bounds of view absolute offset.
Protected
Optional
onMount• onMount? : undefined | function
Protected
rectThis are bounds of a view including margin and padding
Protected
visibilityProtected
width• width: number = 0
• get innerHeight(): number
Returns: number
• get innerWidth(): number
Returns: number
Parameters:
Returns: void
â–¸ destroy(): void
Returns: void
Parameters:
Returns: boolean
Parameters:
Returns: void
â–¸ getBackgroundColor(): undefined | string
Returns: undefined | string
â–¸ getBorder(): undefined | string
Returns: undefined | string
â–¸ getBorderColor(): undefined | string
Returns: undefined | string
â–¸ getId(): undefined | string | number
Returns: undefined | string | number
â–¸ getInternalWrappedHeight(): number
Returns: number
â–¸ getInternalWrappedWidth(): number
Returns: number
â–¸ getMatchParentHeight(): number
Returns: number
â–¸ getMatchParentWidth(): number
Returns: number
â–¸ getOnMount(): undefined | function
Returns: undefined | function
â–¸ getSource(): undefined | string
Returns: undefined | string
â–¸ hasParent(): boolean
Returns: boolean
â–¸ layout(force?
: undefined | false | true): void
Prepares the layout for all children
Parameters:
Returns: void
Measures the component and adjusts it's dimensions to min/max width and height values.
Parameters:
Returns: void
true if width or height changed, false otherwise
â–¸ mount(): void
Returns: void
â–¸ onDestroy(): void
Returns: void
Parameters:
Returns: void
â–¸ onLayout(): void
Returns: void
â–¸ onMeasure(width
: number, height
: number): object
Parameters:
Returns: object
height: number
width: number
Parameters:
Returns: boolean
â–¸ onSizeChanged(_width
: number, _height
: number, _oldWidth
: number, _oldHeight
: number): void
Parameters:
Returns: void
â–¸ onSnapshot(): object
Returns: object
source: undefined | string = this.source
Parameters:
Returns: void
â–¸ removeChildAt(startIndex
: number, endIndex
: number): void
Parameters:
Returns: void
Parameters:
Returns: void
Parameters:
Returns: boolean
Parameters:
Returns: boolean
â–¸ resolvePositionDependencies(): void
Prepare arrays of children ordered horizontally and vertically, so that they could be measured in a single pass, without waiting for their dependencies to be resolved.
This has to be called before measure whenever child's layoutParams change or views are added/removed.
throws
an error in case of unresolvable dependency (circular or lack of required view)
Returns: void
â–¸ screenshot(): string | undefined
Returns: string | undefined
â–¸ setBackgroundColor(backgroundColor
: string | undefined): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setBorderColor(borderColor
: string | undefined): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setId(id?
: undefined | string): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setOnMount(callback
: function): void
Parameters:
â–ª callback: function
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setSource(source
: string): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ snapshot(): object
Returns: object
Name | Type | Default |
---|---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type | Default |
---|---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
↳
↳
↳
â–¸ onGestureEvent(event
: , previousEvent
: ): boolean
â–¸ onPointerEvent(event
: ): boolean
+ new Line():
Returns:
+ new Line(startX
: number, startY
: number, endX
: number, endY
: number):
Returns:
â–¸ add(line
: | ): this
▸ clone(): ‹›
Returns: ‹›
â–¸ cloneTo(line
: ): ‹›
Returns: ‹›
â–¸ offset(line
: | ): this
â–¸ pointAt(position
: number, result
: ):
Returns:
• aboveId? : = DefaultProps.ABOVE
• belowId? : = DefaultProps.BELOW
• bottomId? : = DefaultProps.ALIGN_BOTTOM
• endId? : = DefaultProps.ALIGN_END
• h: = DefaultProps.HEIGHT
• hDimension: = parseDimension(DefaultProps.HEIGHT)
• marginRect: ‹› = DefaultProps.MARGIN
• paddingRect: ‹› = DefaultProps.PADDING
• startId? : = DefaultProps.ALIGN_START
• toEndOfId? : = DefaultProps.TO_END_OF
• toStartOfId? : = DefaultProps.TO_START_OF
• topId? : = DefaultProps.ALIGN_TOP
• w: = DefaultProps.WIDTH
• wDimension: = parseDimension(DefaultProps.WIDTH)
• x: = DefaultProps.X
• xDimension: = parseDimension(DefaultProps.X)
• y: = DefaultProps.Y
• yDimension: = parseDimension(DefaultProps.Y)
â–¸ above(id?
: ): this
Name | Type |
---|
Name | Type |
---|
â–¸ alignBottom(id?
: ): this
Name | Type |
---|
â–¸ alignEnd(id?
: ): this
Name | Type |
---|
â–¸ alignStart(id?
: ): this
Name | Type |
---|
â–¸ alignTop(id?
: ): this
Name | Type |
---|
Name | Type |
---|
â–¸ asProps():
Returns:
â–¸ below(id?
: ): this
Name | Type |
---|
Name | Type |
---|
Name | Type |
---|
Name | Type |
---|
â–¸ height(height
: ): this
Name | Type |
---|
â–¸ margin(margin?
: ): this
Name | Type |
---|
Name | Type |
---|
Name | Type |
---|
Name | Type |
---|
Name | Type |
---|
â–¸ padding(padding?
: ): this
Name | Type |
---|
â–¸ posX(x
: ): this
Name | Type |
---|
â–¸ posY(y
: ): this
Name | Type |
---|
â–¸ toEndOf(id?
: ): this
Name | Type |
---|
â–¸ toLeftOf(id?
: ): this
Name | Type |
---|
â–¸ toRightOf(id?
: ): this
Name | Type |
---|
â–¸ toStartOf(id?
: ): this
Name | Type |
---|
Name | Type | Default |
---|
â–¸ width(width
: ): this
Name | Type |
---|
‹›
+ new ImageView(context
: ):
Overrides .
Name | Type |
---|
Returns:
Inherited from .
Inherited from .
• borderRect? :
Inherited from .
• context:
Inherited from .
Inherited from .
Inherited from .
• innerRect: = new Rect(0)
Inherited from .
• lp: = new LayoutParams()
Inherited from .
Inherited from .
• offsetRect: = new Rect(0)
Inherited from .
Inherited from .
• rect: = new Rect(0)
Inherited from .
• visibility: = Visibility.VISIBLE
Inherited from .
Inherited from .
Inherited from .
Inherited from .
â–¸ addChild(child
: , position
: number): void
Inherited from .
Name | Type | Default |
---|
Inherited from .
â–¸ dispatchPointerEvent(event
: ): boolean
Inherited from .
Name | Type |
---|
â–¸ draw(canvas
: , force
: boolean): void
Inherited from .
Name | Type | Default |
---|
Inherited from .
Inherited from .
Inherited from .
Inherited from .
Overrides .
Overrides .
▸ getLayoutParams(): ‹›
Inherited from .
Returns: ‹›
Inherited from .
Inherited from .
Inherited from .
▸ getParent(): null | ‹›
Inherited from .
Returns: null | ‹›
▸ getRootView(): ‹›
Inherited from .
Returns: ‹›
â–¸ getScaleType():
Returns:
â–¸ getVisibility():
Inherited from .
Returns:
Inherited from .
Inherited from .
Name | Type |
---|
â–¸ measure(canvas
: , force?
: undefined | false | true): void
Inherited from .
Name | Type |
---|
Inherited from .
Inherited from .
â–¸ onDraw(canvas
: ): void
Overrides .
Name | Type |
---|
Inherited from .
Inherited from .
Name | Type |
---|
â–¸ onPointerEvent(_event
: ): boolean
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type |
---|
Overrides .
â–¸ removeChild(child
: | number): void
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type | Default |
---|
â–¸ require(requiredChanges
: ): void
Inherited from .
Name | Type |
---|
â–¸ requireGuard(requiredChanges
: ): boolean
Inherited from .
Name | Type |
---|
â–¸ requireGuardAndTake(requiredChanges
: , force?
: undefined | false | true): boolean
Inherited from .
Name | Type |
---|
Inherited from .
Inherited from .
Inherited from .
Name | Type |
---|
â–¸ setBorder(borderRect
: | undefined): void
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type |
---|
â–¸ setChildAt(child
: , position
: number): void
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type |
---|
â–¸ setLayoutParams(lp
: ): void
Inherited from .
Name | Type |
---|
Inherited from .
â–¸ (view
: ‹any›): void
Name | Type |
---|
â–¸ setScaleType(scaleType
: ): void
Name | Type |
---|
Name | Type |
---|
â–¸ setVisibility(visibility
: ): void
Inherited from .
Name | Type | Default |
---|
Inherited from .
Name
Type
options
AreaSelectGestureDetectorOptions
Name
Type
event
Name
Type
event
Name
Type
event
Name
Type
offsetX
number
offsetY
number
Name
Type
options
DragGestureDetectorOptions
Name
Type
event
Name
Type
event
options
{}
id
number
id
string | number | undefined
idName
string
id
string | number | undefined
options
areaSelectEvent
dragEvent
scaleEvent
dimension
parentDimension
number
view
t
Record‹K, LayoutProps›
object
T
height
number
width
number
event
Event
id
undefined | Id
pointerEvent
view
event
Event
width
number
height
number
scale
number
element
HTMLElement
offset
lp
color
event
Event
event
Event
event
Event
pointerEvent
view
-
scale
number
1
c
event
MouseEvent
offset
canvasPointer
radius
colorString
string | undefined
value
fontFamily
string
fontSize
number
fontStyle
undefined | "normal" | "italic" | "oblique"
fontVariant
undefined | "normal" | "small-caps"
fontWeight
undefined | "normal" | "bold" | "bolder" | "lighter" | 100 | "100" | 200 | "200" | 300 | "300" | 400 | "400" | 500 | "500" | 600 | "600" | 700 | "700" | 800 | "800" | 900 | "900"
element
Element
dispatcher
EventListener
props
object
any
defaultObject
any
object
any
lp
layoutParams
context
color
string
alpha
number
coordinate
number
scaleType
imageWidth
number
imageHeight
number
innerWidth
number
innerHeight
number
rect
touch
Touch | null
offset
canvasPointer
lp
a
boolean
b
boolean
Name | Type |
| number |
| number |
| number |
| number |
Name | Type |
| number |
| number |
Name | Type |
| number |
Name | Type |
| number |
Name | Type |
| number |
| number |
| undefined | false | true |
| undefined | false | true |
| undefined | false | true |
| undefined | false | true |
| undefined | false | true |
| number |
| number |
| number |
| number |
| undefined | false | true |
| number |
| number |
| number |
| number |
| number |
| number |
| number | - |
| number | startIndex + 1 |
| string | undefined |
| string | undefined |
| undefined | string |
| string |
Name | Type |
|
|
Name | Type |
|
Name | Type |
|
Name | Type |
|
Name | Type |
|
Name | Type | Default |
| number | - |
| new Point() |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| undefined | string | number | DefaultProps.ABOVE |
| undefined | string | number | DefaultProps.ALIGN_BOTTOM |
| undefined | string | number | DefaultProps.ALIGN_END |
| undefined | string | number | DefaultProps.ALIGN_START |
| undefined | string | number | DefaultProps.ALIGN_TOP |
| undefined | string | number | DefaultProps.BELOW |
| boolean | DefaultProps.CENTER_HORIZONTAL |
| boolean | DefaultProps.CENTER_VERTICAL |
| null | string | number | DefaultProps.HEIGHT |
| boolean | DefaultProps.IS_ABSOLUTE |
| boolean | DefaultProps.IS_ANIMATED |
| DefaultProps.MARGIN |
| number | DefaultProps.MAX_HEIGHT |
| number | DefaultProps.MAX_WIDTH |
| number | DefaultProps.MIN_HEIGHT |
| number | DefaultProps.MIN_WIDTH |
| DefaultProps.PADDING |
| null | string | number | DefaultProps.X |
| null | string | number | DefaultProps.Y |
| undefined | string | number | DefaultProps.TO_END_OF |
| undefined | string | number | DefaultProps.TO_START_OF |
| null | string | number | DefaultProps.WIDTH |
|
|
| - |
| number | -1 |
|
| - |
| boolean | false |
|
| undefined | false | true |
|
|
|
|
|
|
| undefined | false | true |
|
|
| number |
|
|
|
| Visibility.VISIBLE |
NoContext
ContextLike
â–¸ deregisterView(_id
: number): void
Parameters:
Returns: void
â–¸ getId(_id
: string | number): string | number
Parameters:
Returns: string | number
â–¸ registerView(_idName
: string): number
Implementation of ContextLike
Parameters:
Returns: number
â–¸ resolve(_id
: string | number | undefined): number | undefined
Implementation of ContextLike
Parameters:
Returns: number | undefined
Point
+ new Point(x
: number, y
: number): Point
Parameters:
Returns: Point
• x: number
• y: number
▸ clone(): Point‹›
Returns a copy of Point that can be mutated separately.
Returns: Point‹›
â–¸ cloneTo(point
: Point): Point‹›
Copies all of this Point's properties to a Point specified in an argument. Returns the point passed as argument.
Parameters:
Returns: Point‹›
â–¸ toString(): string
Returns: string
Rect
+ new Rect(value
: RectInput): Rect
Parameters:
Returns: Rect
• b: number
• l: number
• r: number
• t: number
• get height(): number
Returns: number
• get width(): number
Returns: number
▸ clone(): Rect‹›
Returns a copy of Rect that can be mutated separately.
Returns: Rect‹›
â–¸ cloneTo(rect
: Rect): Rect‹›
Copies all of this Rect's properties to a Rect specified in an argument. Returns the line passed as argument.
Parameters:
Returns: Rect‹›
â–¸ contains(x
: number, y
: number): boolean
Parameters:
Returns: boolean
â–¸ expand(expansion
: Rect | number): this
Expands this Rect by other Rect's dimensions (i.e. to reduce padding) or by a constant numeric value from each side. Resulting Rect is the same, mutated Rect.
Parameters:
Returns: this
â–¸ inset(shrink
: Rect | number): this
Shrinks this Rect by other Rect's dimensions (i.e. to apply padding) or by a constant numeric value from each side. Resulting Rect is the same, mutated Rect.
Parameters:
Returns: this
â–¸ intersects(rect
: Rect): boolean
Parameters:
Returns: boolean
â–¸ offset(offset
: Rect | Point): this
Moves this Rect by left top position of passed rect or by XY coordinates of a Point. Resulting Rect is the same, mutated Rect.
Parameters:
Returns: this
â–¸ offset(x
: number, y
: number): this
Moves this Rect by passed x and y coordinates. Resulting Rect is the same, mutated Rect.
Parameters:
Returns: this
â–¸ toString(): string
Returns: string
Static
fromâ–¸ from(rectLike
: RectLike): Rect
Parameters:
Returns: Rect
↳ RootCanvasView
+ new RootCanvasView(context
: Context, canvas
: Canvas): RootCanvasView
Overrides View.constructor
Parameters:
Returns: RootCanvasView
Protected
Optional
backgroundColor• backgroundColor? : undefined | string
Inherited from RootCanvasView.backgroundColor
Protected
Optional
borderColor• borderColor? : undefined | string
Inherited from RootCanvasView.borderColor
Protected
Optional
borderRect• borderRect? : Rect
Inherited from RootCanvasView.borderRect
Readonly
context• context: Context
Inherited from RootCanvasView.context
Protected
height• height: number = 0
Inherited from RootCanvasView.height
Optional
id• id? : undefined | number
Inherited from RootCanvasView.id
Protected
innerRect• innerRect: Rect = new Rect(0)
Inherited from RootCanvasView.innerRect
This are the bounds of view including padding.
Protected
lp• lp: LayoutParams = new LayoutParams()
Inherited from RootCanvasView.lp
Readonly
name• name: string
Inherited from RootCanvasView.name
• offsetRect: Rect = new Rect(0)
Inherited from RootCanvasView.offsetRect
This are the bounds of view absolute offset.
Protected
Optional
onMount• onMount? : undefined | function
Inherited from RootCanvasView.onMount
Protected
rect• rect: Rect = new Rect(0)
Inherited from RootCanvasView.rect
This are bounds of a view including margin and padding
Protected
visibility• visibility: Visibility = Visibility.VISIBLE
Inherited from RootCanvasView.visibility
Protected
width• width: number = 0
Inherited from RootCanvasView.width
• get innerHeight(): number
Inherited from RootCanvasView.innerHeight
Returns: number
• get innerWidth(): number
Inherited from RootCanvasView.innerWidth
Returns: number
â–¸ addChild(child
: View, position
: number): void
Inherited from RootCanvasView.addChild
Parameters:
Returns: void
â–¸ destroy(): void
Inherited from RootCanvasView.destroy
Returns: void
â–¸ dispatchPointerEvent(event
: CanvasPointerEvent): boolean
Inherited from RootCanvasView.dispatchPointerEvent
Parameters:
Returns: boolean
â–¸ draw(canvas
: ViewCanvas): void
Parameters:
Returns: void
â–¸ getBackgroundColor(): undefined | string
Inherited from RootCanvasView.getBackgroundColor
Returns: undefined | string
â–¸ getBorder(): undefined | string
Inherited from RootCanvasView.getBorder
Returns: undefined | string
â–¸ getBorderColor(): undefined | string
Inherited from RootCanvasView.getBorderColor
Returns: undefined | string
â–¸ getCanvas(): HTMLCanvasElement
Returns: HTMLCanvasElement
â–¸ getId(): undefined | string | number
Inherited from RootCanvasView.getId
Returns: undefined | string | number
â–¸ getInternalWrappedHeight(_canvas
: ViewCanvas): number | undefined
Inherited from RootCanvasView.getInternalWrappedHeight
Parameters:
Returns: number | undefined
â–¸ getInternalWrappedWidth(_canvas
: ViewCanvas): number | undefined
Inherited from RootCanvasView.getInternalWrappedWidth
Parameters:
Returns: number | undefined
▸ getLayoutParams(): LayoutParams‹›
Inherited from RootCanvasView.getLayoutParams
Returns: LayoutParams‹›
â–¸ getMatchParentHeight(): number
Inherited from RootCanvasView.getMatchParentHeight
Returns: number
â–¸ getMatchParentWidth(): number
Inherited from RootCanvasView.getMatchParentWidth
Returns: number
â–¸ getOnMount(): undefined | function
Inherited from RootCanvasView.getOnMount
Returns: undefined | function
▸ getParent(): null | View‹ViewProps›
Inherited from RootCanvasView.getParent
Returns: null | View‹ViewProps›
▸ getRootView(): View‹ViewProps›
Inherited from RootCanvasView.getRootView
â–¸ getScale(): number
Returns: number
â–¸ getVisibility(): Visibility
Inherited from RootCanvasView.getVisibility
Returns: Visibility
â–¸ hasParent(): boolean
Inherited from RootCanvasView.hasParent
Returns: boolean
â–¸ layout(force?
: undefined | false | true): void
Inherited from RootCanvasView.layout
Prepares the layout for all children
Parameters:
Returns: void
â–¸ measure(canvas
: ViewCanvas, force?
: undefined | false | true): void
Inherited from RootCanvasView.measure
Measures the component and adjusts it's dimensions to min/max width and height values.
Parameters:
Returns: void
true if width or height changed, false otherwise
â–¸ mount(): void
Inherited from RootCanvasView.mount
Returns: void
â–¸ onDestroy(): void
Returns: void
â–¸ onDraw(_canvas
: ViewCanvas): void
Inherited from RootCanvasView.onDraw
Parameters:
Returns: void
â–¸ onLayout(): void
Inherited from RootCanvasView.onLayout
Returns: void
â–¸ onMeasure(width
: number, height
: number): object
Inherited from RootCanvasView.onMeasure
Parameters:
Returns: object
height: number
width: number
â–¸ onPointerEvent(_event
: CanvasPointerEvent): boolean
Inherited from RootCanvasView.onPointerEvent
Parameters:
Returns: boolean
â–¸ onSizeChanged(): void
Overrides TextView.onSizeChanged
Returns: void
â–¸ onSnapshot(): object
Overrides View.onSnapshot
Returns: object
dpr: number = this.dpr
â–¸ removeChild(child
: View | number): void
Inherited from RootCanvasView.removeChild
Parameters:
Returns: void
â–¸ removeChildAt(startIndex
: number, endIndex
: number): void
Inherited from RootCanvasView.removeChildAt
Parameters:
Returns: void
â–¸ require(requiredChanges
: RequiredViewChanges): void
Parameters:
Returns: void
â–¸ requireGuard(requiredChanges
: RequiredViewChanges): boolean
Inherited from RootCanvasView.requireGuard
Parameters:
Returns: boolean
â–¸ requireGuardAndTake(requiredChanges
: RequiredViewChanges, force?
: undefined | false | true): boolean
Inherited from RootCanvasView.requireGuardAndTake
Parameters:
Returns: boolean
â–¸ resolvePositionDependencies(): void
Inherited from RootCanvasView.resolvePositionDependencies
Prepare arrays of children ordered horizontally and vertically, so that they could be measured in a single pass, without waiting for their dependencies to be resolved.
This has to be called before measure whenever child's layoutParams change or views are added/removed.
throws
an error in case of unresolvable dependency (circular or lack of required view)
Returns: void
â–¸ run(): void
Returns: void
â–¸ screenshot(): string | undefined
Inherited from RootCanvasView.screenshot
Returns: string | undefined
â–¸ setBackgroundColor(backgroundColor
: string | undefined): void
Inherited from RootCanvasView.setBackgroundColor
Parameters:
Returns: void
â–¸ setBorder(borderRect
: RectLike | undefined): void
Inherited from RootCanvasView.setBorder
Parameters:
Returns: void
â–¸ setBorderColor(borderColor
: string | undefined): void
Inherited from RootCanvasView.setBorderColor
Parameters:
Returns: void
â–¸ setChildAt(child
: View, position
: number): void
Inherited from RootCanvasView.setChildAt
Parameters:
Returns: void
â–¸ setDebugEnabled(enabled
: boolean): void
Parameters:
Returns: void
â–¸ setId(id?
: undefined | string): void
Inherited from RootCanvasView.setId
Parameters:
Returns: void
â–¸ setLayoutParams(lp
: LayoutParams): void
Inherited from RootCanvasView.setLayoutParams
Parameters:
Returns: void
â–¸ setOnMount(callback
: function): void
Inherited from RootCanvasView.setOnMount
Parameters:
â–ª callback: function
â–¸ (view
: View‹any›): void
Parameters:
Returns: void
â–¸ setVisibility(visibility
: Visibility): void
Inherited from RootCanvasView.setVisibility
Parameters:
Returns: void
â–¸ setupPointerEvents(): void
Returns: void
â–¸ snapshot(): object
Inherited from RootCanvasView.snapshot
Returns: object
▪ _Props: Record‹string, any›
View
Parameters:
Protected
Optional
backgroundColor• backgroundColor? : undefined | string
Protected
Optional
borderColor• borderColor? : undefined | string
Protected
Optional
borderRectReadonly
contextProtected
height• height: number = 0
Optional
id• id? : undefined | number
Protected
innerRectThis are the bounds of view including padding.
Protected
lpReadonly
name• name: string
This are the bounds of view absolute offset.
Protected
Optional
onMount• onMount? : undefined | function
Protected
rectThis are bounds of a view including margin and padding
Protected
visibilityProtected
width• width: number = 0
• get innerHeight(): number
Returns: number
• get innerWidth(): number
Returns: number
Parameters:
Returns: void
â–¸ destroy(): void
Returns: void
Parameters:
Returns: boolean
Parameters:
Returns: void
â–¸ getBackgroundColor(): undefined | string
Returns: undefined | string
â–¸ getBorder(): undefined | string
Returns: undefined | string
â–¸ getBorderColor(): undefined | string
Returns: undefined | string
â–¸ getId(): undefined | string | number
Returns: undefined | string | number
Parameters:
Returns: number | undefined
Parameters:
Returns: number | undefined
â–¸ getMatchParentHeight(): number
Returns: number
â–¸ getMatchParentWidth(): number
Returns: number
â–¸ getOnMount(): undefined | function
Returns: undefined | function
â–¸ hasParent(): boolean
Returns: boolean
â–¸ layout(force?
: undefined | false | true): void
Prepares the layout for all children
Parameters:
Returns: void
Measures the component and adjusts it's dimensions to min/max width and height values.
Parameters:
Returns: void
true if width or height changed, false otherwise
â–¸ mount(): void
Returns: void
â–¸ onDestroy(): void
Returns: void
Parameters:
Returns: void
â–¸ onLayout(): void
Returns: void
â–¸ onMeasure(width
: number, height
: number): object
Parameters:
Returns: object
height: number
width: number
Parameters:
Returns: boolean
â–¸ onSizeChanged(_width
: number, _height
: number, _oldWidth
: number, _oldHeight
: number): void
Parameters:
Returns: void
â–¸ onSnapshot(): object
Returns: object
Parameters:
Returns: void
â–¸ removeChildAt(startIndex
: number, endIndex
: number): void
Parameters:
Returns: void
Parameters:
Returns: void
Parameters:
Returns: boolean
Parameters:
Returns: boolean
â–¸ resolvePositionDependencies(): void
Prepare arrays of children ordered horizontally and vertically, so that they could be measured in a single pass, without waiting for their dependencies to be resolved.
This has to be called before measure whenever child's layoutParams change or views are added/removed.
throws
an error in case of unresolvable dependency (circular or lack of required view)
Returns: void
â–¸ screenshot(): string | undefined
Returns: string | undefined
â–¸ setBackgroundColor(backgroundColor
: string | undefined): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setBorderColor(borderColor
: string | undefined): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setId(id?
: undefined | string): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setOnMount(callback
: function): void
Parameters:
â–ª callback: function
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ snapshot(): object
Returns: object
↳ TextView
Parameters:
Protected
Optional
backgroundColor• backgroundColor? : undefined | string
Protected
Optional
borderColor• borderColor? : undefined | string
Protected
Optional
borderRectReadonly
contextProtected
height• height: number = 0
Optional
id• id? : undefined | number
Protected
innerRectThis are the bounds of view including padding.
Protected
lpReadonly
name• name: string
This are the bounds of view absolute offset.
Protected
Optional
onMount• onMount? : undefined | function
Protected
rectThis are bounds of a view including margin and padding
Protected
visibilityProtected
width• width: number = 0
• get innerHeight(): number
Returns: number
• get innerWidth(): number
Returns: number
Parameters:
Returns: void
â–¸ destroy(): void
Returns: void
Parameters:
Returns: boolean
Parameters:
Returns: void
â–¸ getBackgroundColor(): undefined | string
Returns: undefined | string
â–¸ getBorder(): undefined | string
Returns: undefined | string
â–¸ getBorderColor(): undefined | string
Returns: undefined | string
â–¸ getId(): undefined | string | number
Returns: undefined | string | number
â–¸ getInternalWrappedHeight(): number
Returns: number
Parameters:
Returns: undefined | number
â–¸ getMatchParentHeight(): number
Returns: number
â–¸ getMatchParentWidth(): number
Returns: number
â–¸ getOnMount(): undefined | function
Returns: undefined | function
â–¸ getText(): string
Returns: string
Parameters:
Returns: number
â–¸ hasParent(): boolean
Returns: boolean
â–¸ layout(force?
: undefined | false | true): void
Prepares the layout for all children
Parameters:
Returns: void
Measures the component and adjusts it's dimensions to min/max width and height values.
Parameters:
Returns: void
true if width or height changed, false otherwise
â–¸ mount(): void
Returns: void
â–¸ onDestroy(): void
Returns: void
Parameters:
Returns: void
â–¸ onLayout(): void
Returns: void
â–¸ onMeasure(width
: number, height
: number): object
Parameters:
Returns: object
height: number
width: number
Parameters:
Returns: boolean
â–¸ onSizeChanged(_width
: number, _height
: number, _oldWidth
: number, _oldHeight
: number): void
Parameters:
Returns: void
â–¸ onSnapshot(): object
Returns: object
text: string = this.textString
textPaint: object = this.textPaint.snapshot()
Parameters:
Returns: void
â–¸ removeChildAt(startIndex
: number, endIndex
: number): void
Parameters:
Returns: void
Parameters:
Returns: void
Parameters:
Returns: boolean
Parameters:
Returns: boolean
â–¸ resolvePositionDependencies(): void
Prepare arrays of children ordered horizontally and vertically, so that they could be measured in a single pass, without waiting for their dependencies to be resolved.
This has to be called before measure whenever child's layoutParams change or views are added/removed.
throws
an error in case of unresolvable dependency (circular or lack of required view)
Returns: void
â–¸ screenshot(): string | undefined
Returns: string | undefined
â–¸ setBackgroundColor(backgroundColor
: string | undefined): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setBorderColor(borderColor
: string | undefined): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setId(id?
: undefined | string): void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ setOnMount(callback
: function): void
Parameters:
â–ª callback: function
Parameters:
Returns: void
â–¸ setText(text
: string): void
Parameters:
Returns: void
Parameters:
Returns: void
Parameters:
Returns: void
â–¸ snapshot(): object
Returns: object
|
|
| number
| undefined
‹any›
Name | Type |
---|---|
Name | Type | Default |
---|---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type | Default |
---|---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type | Default |
---|---|---|
+ new ScaleGestureDetector(options
: ):
Returns:
â–¸ onGestureEvent(event
: ): boolean
Overrides .
â–¸ onPointerEvent(event
: ): boolean
Inherited from .
↳
↳
↳
+ new View(context
: , name
: string):
Name | Type | Default |
---|
Returns:
• borderRect? :
• context:
• innerRect: = new Rect(0)
• lp: = new LayoutParams()
• offsetRect: = new Rect(0)
• rect: = new Rect(0)
• visibility: = Visibility.VISIBLE
â–¸ addChild(child
: , position
: number): void
Name | Type | Default |
---|
â–¸ dispatchPointerEvent(event
: ): boolean
Name | Type |
---|
â–¸ draw(canvas
: , force
: boolean): void
Name | Type | Default |
---|
â–¸ getInternalWrappedHeight(_canvas
: ): number | undefined
Name | Type |
---|
â–¸ getInternalWrappedWidth(_canvas
: ): number | undefined
Name | Type |
---|
▸ getLayoutParams(): ‹›
Returns: ‹›
▸ getParent(): null | ‹›
Returns: null | ‹›
▸ getRootView(): ‹›
Returns: ‹›
â–¸ getVisibility():
Returns:
Name | Type |
---|
â–¸ measure(canvas
: , force?
: undefined | false | true): void
Name | Type |
---|
â–¸ onDraw(_canvas
: ): void
Name | Type |
---|
Name | Type |
---|
â–¸ onPointerEvent(_event
: ): boolean
Name | Type |
---|
Name | Type |
---|
â–¸ removeChild(child
: | number): void
Name | Type |
---|
Name | Type | Default |
---|
â–¸ require(requiredChanges
: ): void
Name | Type |
---|
â–¸ requireGuard(requiredChanges
: ): boolean
Name | Type |
---|
â–¸ requireGuardAndTake(requiredChanges
: , force?
: undefined | false | true): boolean
Name | Type |
---|
Name | Type |
---|
â–¸ setBorder(borderRect
: | undefined): void
Name | Type |
---|
Name | Type |
---|
â–¸ setChildAt(child
: , position
: number): void
Name | Type |
---|
Name | Type |
---|
â–¸ setLayoutParams(lp
: ): void
Name | Type |
---|
â–¸ (view
: ‹any›): void
Name | Type |
---|
â–¸ setVisibility(visibility
: ): void
Name | Type | Default |
---|
‹›
+ new TextView(context
: ):
Overrides .
Name | Type |
---|
Returns:
Inherited from .
Inherited from .
• borderRect? :
Inherited from .
• context:
Inherited from .
Inherited from .
Inherited from .
• innerRect: = new Rect(0)
Inherited from .
• lp: = new LayoutParams()
Inherited from .
Inherited from .
• offsetRect: = new Rect(0)
Inherited from .
Inherited from .
• rect: = new Rect(0)
Inherited from .
• visibility: = Visibility.VISIBLE
Inherited from .
Inherited from .
Inherited from .
Inherited from .
â–¸ addChild(child
: , position
: number): void
Inherited from .
Name | Type | Default |
---|
Inherited from .
â–¸ dispatchPointerEvent(event
: ): boolean
Inherited from .
Name | Type |
---|
â–¸ draw(canvas
: , force
: boolean): void
Inherited from .
Name | Type | Default |
---|
Inherited from .
Inherited from .
Inherited from .
Inherited from .
Overrides .
â–¸ getInternalWrappedWidth(canvas
: ): undefined | number
Overrides .
Name | Type |
---|
▸ getLayoutParams(): ‹›
Inherited from .
Returns: ‹›
Inherited from .
Inherited from .
Inherited from .
▸ getParent(): null | ‹›
Inherited from .
Returns: null | ‹›
▸ getRootView(): ‹›
Inherited from .
Returns: ‹›
â–¸ getTextPaint():
Returns:
â–¸ getVisibility():
Inherited from .
Returns:
â–¸ getY(textBaseline
: ): number
Name | Type |
---|
Inherited from .
Inherited from .
Name | Type |
---|
â–¸ measure(canvas
: , force?
: undefined | false | true): void
Inherited from .
Name | Type |
---|
Inherited from .
Inherited from .
â–¸ onDraw(canvas
: ): void
Overrides .
Name | Type |
---|
Inherited from .
Inherited from .
Name | Type |
---|
â–¸ onPointerEvent(_event
: ): boolean
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type |
---|
Overrides .
â–¸ removeChild(child
: | number): void
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type | Default |
---|
â–¸ require(requiredChanges
: ): void
Inherited from .
Name | Type |
---|
â–¸ requireGuard(requiredChanges
: ): boolean
Inherited from .
Name | Type |
---|
â–¸ requireGuardAndTake(requiredChanges
: , force?
: undefined | false | true): boolean
Inherited from .
Name | Type |
---|
Inherited from .
Inherited from .
Inherited from .
Name | Type |
---|
â–¸ setBorder(borderRect
: | undefined): void
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type |
---|
â–¸ setChildAt(child
: , position
: number): void
Inherited from .
Name | Type |
---|
Inherited from .
Name | Type |
---|
â–¸ setLayoutParams(lp
: ): void
Inherited from .
Name | Type |
---|
Inherited from .
â–¸ (view
: ‹any›): void
Name | Type |
---|
Name | Type |
---|
â–¸ setTextPaint(paint
: ): void
Name | Type |
---|
â–¸ setVisibility(visibility
: ): void
Inherited from .
Name | Type | Default |
---|
Inherited from .
Name
Type
_id
number
Name
Type
_id
string | number
Name
Type
_idName
string
Name
Type
_id
string | number | undefined
Name
Type
Default
x
number
0
y
number
0
Name
Type
point
Name
Type
value
Name
Type
rect
Name
Type
x
number
y
number
Name
Type
expansion
Rect | number
Name
Type
shrink
Rect | number
Name
Type
rect
Name
Type
offset
Name
Type
x
number
y
number
Name
Type
rectLike
context
canvas
child
-
position
number
-1
event
canvas
_canvas
_canvas
force?
undefined | false | true
canvas
force?
undefined | false | true
_canvas
width
number
height
number
_event
child
View | number
startIndex
number
-
endIndex
number
startIndex + 1
requiredChanges
requiredChanges
requiredChanges
force?
undefined | false | true
backgroundColor
string | undefined
borderRect
RectLike | undefined
borderColor
string | undefined
child
position
number
enabled
boolean
id?
undefined | string
lp
view
View‹any›
visibility
Visibility.VISIBLE
| undefined | false | true |
| number |
| number |
| number |
| number |
| number |
| number |
| number | - |
| number | startIndex + 1 |
| string | undefined |
| string | undefined |
| undefined | string |
| undefined | false | true |
| number |
| number |
| number |
| number |
| number |
| number |
| number | - |
| number | startIndex + 1 |
| string | undefined |
| string | undefined |
| undefined | string |
| string |
Name | Type |
|
Name | Type |
|
Name | Type |
|
| - |
| string | "View" |
| - |
| number | -1 |
|
| - |
| boolean | false |
|
|
|
| undefined | false | true |
|
|
|
|
|
|
| undefined | false | true |
|
|
| number |
|
|
| Visibility.VISIBLE |
|
| - |
| number | -1 |
|
| - |
| boolean | false |
|
|
|
| undefined | false | true |
|
|
|
|
|
|
| undefined | false | true |
|
|
| number |
|
|
|
| Visibility.VISIBLE |
ViewCanvas
+ new ViewCanvas(canvas
: Canvas): ViewCanvas
Parameters:
Returns: ViewCanvas
Protected
Readonly
canvas• canvas: Canvas
Readonly
context• context: CanvasRenderingContext2D
â–¸ drawPath(paint
: Paint): void
Parameters:
Returns: void
â–¸ drawRect(rect
: Rect, paint
: Paint, borders?
: Rect): void
Parameters:
Returns: void
â–¸ drawText(x
: number, y
: number, text
: string, paint
: Paint, paintOverrides?
: PaintOverrides, maxWidth
: number): void
Parameters:
Returns: void
â–¸ line(line
: Line): void
Parameters:
Returns: void
â–¸ measureText(text
: string, paint
: Paint): TextMetrics
Parameters:
Returns: TextMetrics
â–¸ roundRect(x
: number, y
: number, w
: number, h
: number, r
: Radius): void
Parameters:
Returns: void
â–¸ setPaint(paint
: Paint, paintOverrides?
: PaintOverrides): void
Parameters:
Returns: void
Paint
Optional
fillStyle• fillStyle? : undefined | string
Implementation of PaintOverrides.fillStyle
• font: Font = defaultFont
• fontString: string = defaultPaintOptions.font
• lineDash: number[] = defaultPaintOptions.lineDash
• lineRounding: boolean = defaultPaintOptions.lineRounding
Implementation of PaintOverrides.lineRounding
• lineWidth: number = defaultPaintOptions.lineWidth
Optional
strokeStyle• strokeStyle? : undefined | string
• textAlign: TextAlign = defaultPaintOptions.textAlign
Implementation of PaintOverrides.textAlign
• textBaseline: TextBaseline = defaultPaintOptions.textBaseline
Implementation of PaintOverrides.textBaseline
• textDirection: CanvasDirection = defaultPaintOptions.textDirection
Implementation of PaintOverrides.textDirection
Static
Readonly
DEFAULT▪ DEFAULT: DeepReadonly‹Paint› = new Paint()
â–¸ canDrawFill(): boolean
Returns: boolean
â–¸ canDrawStroke(): boolean
Returns: boolean
â–¸ canDrawText(): boolean
Returns: boolean
▸ clone(): Paint‹›
Returns: Paint‹›
â–¸ getLineHeight(): number
Returns: number
â–¸ isBright(): boolean
Returns: boolean
â–¸ setFillStyle(fill
: string): this
Parameters:
Returns: this
â–¸ setFont(font
: Font): this
Parameters:
Returns: this
â–¸ setLineDash(lineDash
: number[]): this
Parameters:
Returns: this
â–¸ setLineRounding(lineRounding
: boolean): this
Parameters:
Returns: this
â–¸ setLineWidth(lineWidth
: number): this
Parameters:
Returns: this
â–¸ setStrokeStyle(stroke
: string): this
Parameters:
Returns: this
â–¸ setTextAlign(textAlign
: TextAlign): this
Parameters:
Returns: this
â–¸ setTextBaseline(textBaseline
: TextBaseline): this
Parameters:
Returns: this
â–¸ setTextDirection(textDirection
: CanvasDirection): this
Parameters:
Returns: this
â–¸ snapshot(): object
Returns: object
| number
| undefined
‹any›
| number
| undefined
‹any›
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type | Default |
---|---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
Name | Type |
---|---|
canvas
paint
rect
paint
borders?
x
number
-
y
number
-
text
string
-
paint
-
paintOverrides?
-
maxWidth
number
0
line
text
string
paint
x
number
y
number
w
number
h
number
r
paint
paintOverrides?
fill
string
font
lineDash
number[]
lineRounding
boolean
lineWidth
number
stroke
string
textAlign
textBaseline
textDirection
CanvasDirection