Skip to main content

TiledImageBackgroundComponent

const TiledImageBackgroundComponent: object

This is a headless component that adds a tiled background to the surface/paper it resides in.

Type Declaration​

mounted()​

mounted: () => void

Returns​

void

name​

name: string = COMPONENT_TILED_IMAGE_BACKGROUND

props​

props: object

props.height​

height: object

props.height.type​

type: NumberConstructor = Number

props.maxZoom​

maxZoom: object

props.maxZoom.type​

type: NumberConstructor = Number

props.panDebounceTimeout​

panDebounceTimeout: object

props.panDebounceTimeout.type​

type: NumberConstructor = Number

props.tileSize​

tileSize: object

props.tileSize.type​

type: PropType<Size>

props.tiling​

tiling: object

props.tiling.type​

type: StringConstructor = String

props.url​

url: object

props.url.type​

type: StringConstructor = String

props.urlGenerator​

urlGenerator: object

props.urlGenerator.type​

type: FunctionConstructor = Function

props.width​

width: object

props.width.type​

type: NumberConstructor = Number

props.zoomDebounceTimeout​

zoomDebounceTimeout: object

props.zoomDebounceTimeout.type​

type: NumberConstructor = Number

render()​

render: (_ctx) => any

Parameters​

_ctx​

any

Returns​

any

setup()​

setup(): object

Returns​

object

service​

service: unknown