尺寸设置

用于设置组件的宽高、边距。

说明

从API Version 7开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

width

width(value: Length)

设置组件自身的宽度,缺省时使用元素自身内容需要的宽度。若子组件的宽大于父组件的宽,则会画出父组件的范围。

从API version 10开始,该接口支持calc计算特性。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Length

要设置的组件宽度。

单位:vp

说明
  • TextInput组件中,width设置auto表示自适应文本宽度。

  • AlphabetIndexer组件中,width设置auto表示自适应宽度最大索引项的宽度。

height

height(value: Length)

设置组件自身的高度,缺省时使用元素自身内容需要的高度。若子组件的高大于父组件的高,则会画出父组件的范围。

从API version 10开始,该接口支持calc计算特性。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Length

要设置的组件高度。

单位:vp

说明

RowColumnRelativeContainer组件中,width、height设置auto表示自适应子组件。

size

size(value: SizeOptions)

设置高宽尺寸。

从API version 10开始,该接口支持calc计算特性。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value SizeOptions

设置高宽尺寸。

单位:vp

padding

padding(value: Padding | Length | LocalizedPadding)

设置内边距属性。

从API version 10开始,该接口支持calc计算特性。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Padding | Length | LocalizedPadding12+

设置组件的内边距。

参数为Length类型时,四个方向内边距同时生效。

默认值:0

单位:vp

padding设置百分比时,上下左右内边距均以父容器的width作为基础值。

margin

margin(value: Margin | Length | LocalizedMargin)

设置外边距属性。

从API version 10开始,该接口支持calc计算特性。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value Margin | Length | LocalizedMargin12+

设置组件的外边距。

参数为Length类型时,四个方向外边距同时生效。

默认值:0

单位:vp

margin设置百分比时,上下左右外边距均以父容器的width作为基础值。在RowColumnFlex交叉轴上布局时,子组件交叉轴的大小与margin的和为整体。

例如Column容器宽100,其中子组件宽50,margin left为10,right为20,子组件水平方向偏移10。

layoutWeight

layoutWeight(value: number | string)

设置组件的布局权重,使用该属性的组件在父容器(Row/Column/Flex)的主轴方向按照权重分配尺寸。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value number | string

父容器尺寸确定时,设置了layoutWeight属性的子元素与兄弟元素占主轴尺寸按照权重进行分配,忽略元素本身尺寸设置,表示自适应占满剩余空间。

默认值:0

说明:

仅在Row/Column/Flex布局中生效。

可选值为大于等于0的数字,或者可以转换为数字的字符串。

如果容器中有子元素设置了layoutWeight属性,且设置的属性值大于0,则所有子元素不会再基于flexShrink和flexGrow布局。

constraintSize

constraintSize(value: ConstraintSizeOptions)

设置约束尺寸,组件布局时,进行尺寸范围限制。

从API version 10开始,该接口支持calc计算特性。

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

系统能力: SystemCapability.ArkUI.ArkUI.Full

参数:

参数名 类型 必填 说明
value ConstraintSizeOptions

设置约束尺寸。constraintSize的优先级高于Width和Height。取值结果参考constraintSize取值对width/height影响。

默认值:

{

minWidth: 0,

maxWidth: Infinity,

minHeight: 0,

maxHeight: Infinity

}

单位:vp

constraintSize(minWidth/maxWidth/minHeight/maxHeight)取值对width/height影响

缺省值 结果
\

width=MAX(minWidth,MIN(maxWidth,width))

height=MAX(minHeight,MIN(maxHeight,height))

maxWidth、maxHeight

width=MAX(minWidth,width)

height=MAX(minHeight,height)

minWidth、minHeight

width=MIN(maxWidth,width)

height=MIN(maxHeight,height)

width、height

若minWidth<maxWidth,组件自身布局逻辑生效,width取值范围为[minWidth,maxWidth];否则,width=MAX(minWidth,maxWidth)。

若minHeight<maxHeight,组件自身布局逻辑生效,height取值范围为[minHeight,maxHeight];否则,height=MAX(minHeight,maxHeight)。

width与maxWidth、height与maxHeight

width=minWidth

height=minHeight

width与minWidth、height与minHeight

组件自身布局逻辑生效,width取值约束为不大于maxWidth。

组件自身布局逻辑生效,height取值约束为不大于maxHeight。

minWidth与maxWidth、minHeight与maxHeight

width以所设值为基础,根据其他布局属性发生可能的拉伸或者压缩。

height以所设值为基础,根据其他布局属性发生可能的拉伸或者压缩。

width与minWidth与maxWidth 使用父容器传递的布局限制进行布局。
height与minHeight与maxHeight 使用父容器传递的布局限制进行布局。

SizeOptions对象说明

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

参数名 类型 必填 说明
width Length 设置组件宽度。
height Length 设置组件高度。

ConstraintSizeOptions对象说明

卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。

元服务API: 从API version 11开始,该接口支持在元服务中使用。

参数名 类型 必填 说明
minWidth Length 设置组件最小宽度。
maxWidth Length 设置组件最大宽度。
minHeight Length 设置组件最小高度。
maxHeight Length 设置组件最大高度。
说明

RowColumnRelativeContainer组件中,width、height设置auto表示自适应子组件。在TextInput组件中,width设置auto表示自适应文本宽度。

示例

示例1(设置组件的宽高和边距)

设置组件的宽度和高度,以及内边距和外边距。

// xxx.ets
@Entry
@Component
struct SizeExample {
  build() {
    Column({ space: 10 }) {
      Text('margin and padding:').fontSize(12).fontColor(0xCCCCCC).width('90%')
      Row() {
        // 宽度80 ,高度80 ,外边距20(蓝色区域),上下左右的内边距分别为5、15、10、20(白色区域)
        Row() {
          Row().size({ width: '100%', height: '100%' }).backgroundColor(Color.Yellow)
        }
        .width(80)
        .height(80)
        .padding({ top: 5, left: 10, bottom: 15, right: 20 })
        .margin(20)
        .backgroundColor(Color.White)
      }.backgroundColor(Color.Blue)

      Text('constraintSize').fontSize(12).fontColor(0xCCCCCC).width('90%')
      Text('this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text.this is a Text')
        .width('90%')
        .constraintSize({ maxWidth: 200 })

      Text('layoutWeight').fontSize(12).fontColor(0xCCCCCC).width('90%')
      // 父容器尺寸确定时,设置了layoutWeight的子元素在主轴布局尺寸按照权重进行分配,忽略本身尺寸设置。
      Row() {
        // 权重1,占主轴剩余空间1/3
        Text('layoutWeight(1)')
          .size({ width: '30%', height: 110 }).backgroundColor(0xFFEFD5).textAlign(TextAlign.Center)
          .layoutWeight(1)
        // 权重2,占主轴剩余空间2/3
        Text('layoutWeight(2)')
          .size({ width: '30%', height: 110 }).backgroundColor(0xF5DEB3).textAlign(TextAlign.Center)
          .layoutWeight(2)
        // 未设置layoutWeight属性,组件按照自身尺寸渲染
        Text('no layoutWeight')
          .size({ width: '30%', height: 110 }).backgroundColor(0xD2B48C).textAlign(TextAlign.Center)
      }.size({ width: '90%', height: 140 }).backgroundColor(0xAFEEEE)
      // calc计算特性
      Text('calc:').fontSize(12).fontColor(0xCCCCCC).width('90%')
      Text('calc test')
        .fontSize(50)
        .fontWeight(FontWeight.Bold)
        .backgroundColor(0xFFFAF0)
        .textAlign(TextAlign.Center)
        .margin('calc(25vp*2)')
        // width和height设置百分比时,以父容器的width和height作为基础值。
        .size({ width: 'calc(90%)', height: 'calc(50vp + 10%)' })
    }.width('100%').margin({ top: 5 })
  }
}

示例2(LocalizedPadding和LocalizedMargin类型的使用)

padding和margin属性使用LocalizedPadding类型和LocalizedMargin类型。

// xxx.ets
// padding和margin属性使用LocalizedPadding类型和LocalizedMargin类型

import { LengthMetrics } from '@kit.ArkUI'

@Entry
@Component
struct SizeExample {
  build() {
    Column({ space: 10 }) {
      Text('margin and padding:').fontSize(12).fontColor(0xCCCCCC).width('90%')
      Row() {
        // 宽度80 ,高度80 ,上下开始结束的外边距40、20、30、10(蓝色区域),上下开始结束的内边距分别为5、15、10、20(白色区域)
        Row() {
          Row().size({ width: '100%', height: '100%' }).backgroundColor(Color.Yellow)
        }
        .width(80)
        .height(80)
        .padding({
          top: LengthMetrics.vp(5),
          bottom: LengthMetrics.vp(15),
          start: LengthMetrics.vp(10),
          end: LengthMetrics.vp(20)
        })
        .margin({
          top: LengthMetrics.vp(40),
          bottom: LengthMetrics.vp(20),
          start: LengthMetrics.vp(30),
          end: LengthMetrics.vp(10)
        })
        .backgroundColor(Color.White)
      }.backgroundColor(Color.Blue)
    }.width('100%').margin({ top: 5 })
  }
}

从左至右显示语言示例图

从右至左显示语言示例图

搜索
请输入您想要搜索的关键词