Class (Lattice)

Lattice object. which is used to divide an image by lattice.

NOTE

The initial APIs of this module are supported since API version 11. Newly added APIs will be marked with a superscript to indicate their earliest API version.

The initial APIs of this class are supported since API version 12.

This module uses the physical pixel unit, px.

This module operates under a single-threaded model. The caller needs to manage thread safety and context state transitions.

Modules to Import

import { drawing } from '@kit.ArkGraphics2D';

createImageLattice¹²⁺

static createImageLattice(xDivs: Array<number>, yDivs: Array<number>, fXCount: number, fYCount: number, fBounds?: common2D.Rect|null, fRectTypes?: Array<RectType>|null, fColors?: Array<common2D.Color>|null): Lattice

Divides the image into lattices. The lattices on both even columns and even rows are fixed, and they are drawn at their original size if the target is large enough. If the target is too small to hold the fixed lattices, all the fixed lattices are scaled down to fit the target, and the lattices that are not on even columns and even rows are scaled to accommodate the remaining space.

System capability: SystemCapability.Graphics.Drawing

Parameters

Name	Type	Mandatory	Description
xDivs	Array<number>	Yes	Array of X coordinates used to divide the image. The value is an integer.
yDivs	Array<number>	Yes	Array of Y coordinates used to divide the image. The value is an integer.
fXCount	number	Yes	Size of the array that holds the X coordinates. The value range is [0, 5].
fYCount	number	Yes	Size of the array that holds the Y coordinates. The value range is [0, 5].
fBounds	common2D.Rect \|null	No	Source bounds to draw. The rectangle parameter must be an integer. The default value is the rectangle size of the original image. If the rectangle parameter is a decimal, the decimal part is discarded and converted into an integer.
fRectTypes	Array<RectType> \|null	No	Array that holds the rectangle types. The default value is null. If this parameter is specified, the array size must be (fXCount + 1) * (fYCount + 1).
fColors	Array<common2D.Color> \|null	No	Array that holds the colors used to fill the lattices. The default value is null. If this parameter is specified, the array size must be (fXCount + 1) * (fYCount + 1).

Returns

Type	Description
Lattice	Lattice object obtained.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error.Possible causes:1.Mandatory parameters are left unspecified;2.Incorrect parameter types;3.Parameter verification failed.

Example

import { RenderNode } from '@kit.ArkUI';
import { drawing } from '@kit.ArkGraphics2D';

class DrawingRenderNode extends RenderNode {
  draw(context : DrawContext) {
    let xDivs : Array<number> = [1, 2, 4];
    let yDivs : Array<number> = [1, 2, 4];
    let lattice = drawing.Lattice.createImageLattice(xDivs, yDivs, 3, 3); // The image is divided into lattices of (3 + 1) x (3 + 1). The blue rectangles in the figure below are fixed lattices.
  }
}

createImageLattice¹⁸⁺