文档帮助

内容

术语、图标和标签访问级别成员类型成员语法成员标志类图标成员图标导航和功能类成员快速导航菜单 Getter 和 Setter 方法历史记录栏搜索和过滤器 API 文档类元数据展开和折叠示例和类成员桌面 -vs- 移动视图查看类源

术语、图标和标签

许多类在使用配置对象创建（实例化）类时具有使用的快捷名称。快捷名称称为别名（如果类扩展 Ext.Component，则称为xtype）。对于可应用的类，别名/xtype 会列在类名称旁边以供快速参考。

访问级别

框架类或其成员可以指定为private或protected。否则，类/成员为public。Public、protected和private是访问描述符，用于传达如何以及何时使用类或类成员。

Public类和类成员可供任何其他类或应用程序代码使用，并且可以依赖它们在主要产品版本中稳定且持久。Public 类和成员可以通过子类安全地进行扩展。
Protected类成员是稳定的public成员，旨在供拥有类或其子类使用。Protected 成员可以通过子类安全地进行扩展。
Private类和类成员由框架内部使用，不打算供应用程序开发人员使用。Private 类和成员可能会在任何时候在不通知的情况下更改或从框架中省略，并且不应在应用程序逻辑中依赖它们。

成员类型

Config - 类的配置选项。
Property - 在实例化类后设置一次。*请参见下面的只读。
Method - 类可以执行的操作。方法应作为实例方法读取，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边有一个static标签。*请参见下面的静态。
Event - 事件特定于框架事件系统，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但不会在 API 文档中具体描述。*对于 DOM 事件，请参阅 MDN 中的事件参考页面。
Theme Variable - 框架采用的视觉主题引擎使用的变量。
Theme Mixin - 框架采用的视觉主题引擎使用的函数，并且可以使用在各种主题变量中设置的值。

成员语法

下面是一个示例类成员，我们可以对其进行剖析以显示类成员的语法（在这种情况下，从 Ext.button.Button 类中查看的 lookupComponent 方法）。

Ext.container.Container

查看源

lookupComponent ( item ) : Ext.Component

protected

在初始化items配置期间将原始配置对象添加到此容器时，或者在添加新项目时added），或{@link #insert inserted时调用。

此方法将传递的对象转换为实例化子组件。

当需要对子创建应用特殊处理时，可以在子类中覆盖此方法。

参数

item : Object

正在添加的配置对象。

Ext.Component

要添加的组件。

让我们看看成员行的每个部分

展开/折叠 - 在成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（此示例中为 lookupComponent）
方法参数 - 方法（或传递给事件处理程序方法）使用的任何必需或可选参数将在括号中列在方法名称旁边（此示例中为 ( item )）
返回类型 - 方法或属性返回的类实例或 JavaScript 对象（此示例中为 Ext.Component）。对于不返回 undefined 以外任何内容的方法，可以省略此项，或者可能显示由正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，方法可能返回一个组件，如果失败则返回 false，将显示为 Ext.Component/Boolean）。
标志 - 适用于该成员的任何标志将显示在旁边（此示例中为 PROTECTED - 请参见下面的标志部分）
成员来源 - 在成员行的右侧是最初描述该成员的类（此示例中为 Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接；如果成员是从祖先或混合类继承的，则源类将显示为灰色。
成员源 - 在成员来源类的右侧下方是查看成员源的链接（示例中为 view source）
参数列表 - 类方法的每个参数将使用括号中上面找到的相同名称、预期的类或对象类型以及参数的描述（示例中为 item : Object）进行列出。
返回 - 如果类返回的值不是 undefined，则“返回”部分将注明返回的类或对象类型以及描述（示例中为 Ext.Component）
自（示例中未显示） - 某些成员将在成员描述之后显示该成员首次引入的产品版本（即 Available since 3.4.0 - 示例中未显示）
默认（示例中未显示） - 配置通常显示要应用于类实例的默认配置值（如果未覆盖）（即 Defaults to: false）

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

必需 - 实例化类时的必需配置
可绑定 - 配置具有允许通过 ViewModel 绑定设置此配置的设置器
只读 - 可以读取该属性，但不能用于在运行时配置/重新配置类实例
单例 - 单例类在定义后立即实例化，不能手动实例化
静态 - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
可链接 - 指在调用时返回类实例的方法。
这支持链接的方法调用，例如：classInstance.method1().method2().etc();
已弃用 - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将包含一条消息，指导你使用首选的类/方法。
已删除 - 仅在文档中作为框架版本之间升级的用户参考而存在的已删除类或成员
模板 - 在基类中定义的方法，旨在由子类覆盖
抽象 - 类或成员可以定义为抽象。抽象类和成员建立类结构并提供有限的代码（如果有）。类特定代码将通过子类中的覆盖来提供。
可预防 - 标记为可预防的事件如果从事件处理程序返回 false，则不会触发

类图标

- 表示框架类

- 单例框架类。*有关更多信息，请参见单例标志

- 组件类型框架类（Ext JS 框架中任何扩展 Ext.Component 的类）

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme mixin 的类成员

- 表示类、成员或指南在当前查看的版本中是新的

在 API 文档页面类名正下方是与当前类拥有的成员类型相对应的按钮行。每个按钮按类型显示成员数（此计数会在应用筛选器时更新）。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示所有该类型成员的弹出菜单，以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分，位于它们所使用的配置正下方。Getter 和 Setter 方法文档将位于配置行中，以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中，并显示在顶部标题栏正下方（使用可用空间）。默认情况下，仅显示与您当前正在查看的产品/版本匹配的页面搜索结果。您可以通过单击历史记录栏右侧的按钮并选择“全部”单选按钮来展开显示内容。这将在历史记录栏中显示所有产品/版本中的所有近期页面。

在历史记录配置菜单中，您还将看到最近访问的页面列表。结果按“当前产品/版本”和“全部”单选按钮进行筛选。单击按钮将清除历史记录栏以及保存在本地存储中的历史记录。

如果在历史记录配置菜单中选择了“全部”，则会启用“在历史记录栏中显示产品详细信息”复选框选项。选中后，每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和筛选器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上，还有一个筛选器输入字段，该字段使用筛选器字符串筛选成员行。除了按字符串筛选外，您还可以按访问级别、继承和只读筛选类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框筛选类列表，以包括或排除私有类。

单击空搜索字段将显示您最近的 10 次搜索，以便快速导航。

API 文档类元数据

每个 API 文档页面（除了 Javascript 基本类型页面）都有一个与该类相关的元数据的菜单视图。此元数据视图将具有以下一个或多个

备用名称 - 一个或多个其他类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类具有 Ext.Button 的备用类名）。备用类名通常用于向后兼容。
层次结构 - 层次结构视图列出了当前类的继承链，从其祖先类一直到根基类。
混合 - 混合到当前类的类列表
继承的混合 - 混合到当前类祖先的类列表
需要 - 实例化类所需的已定义的所有类
使用 - 在其生命周期的某个时刻类可能使用的类列表，但对于最初实例化类而言并非必需
子类 - 扩展当前类的类

展开和折叠示例和类成员

默认情况下，可运行示例（Fiddles）在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换全部状态将在页面加载之间记住。

默认情况下，类成员在页面上折叠。您可以使用成员行左侧的箭头图标展开和折叠成员，或使用右上角的展开/折叠全部切换按钮全局展开和折叠成员。

桌面 -vs- 移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小的外形尺寸进行优化的视图。桌面和“移动”视图之间的主要区别是

全局导航将位于左侧菜单中，可通过汉堡包菜单图标访问。该菜单包含以下内容（在大多数页面上）
- 当前产品名称（作为指向产品登陆页面的链接）
- 用于导航回文档主页的 Sencha 图标
- 产品菜单下拉按钮
- API 文档和指南的导航树选项卡
当前上下文导航和工具位于右侧，可通过齿轮图标访问。上下文菜单包含以下内容
- 全局搜索输入字段
- (API 文档) 带有成员筛选器、“展开/折叠所有示例”按钮、“展开/折叠所有成员行”按钮、访问级别筛选器复选框和每个成员计数的“筛选器”选项卡
- (API 文档) 包含与当前类相关的元数据菜单的“相关类”选项卡
- (指南) 指南目录

查看类源

可以通过单击 API 文档页面顶部的类名来查看类源。可以通过单击成员行右侧的“查看源”链接来查看类成员的源。

GXT 4.x

显示私有类

顶部

内容

Reference Configuration functions util.darkenGradient(gradientDetails, scale) Parameters Example util.lightenGradient(gradientDetails, scale) util.solidGradient(colorString) Parameters util.solidGradientString(colorString) Parameters util.darkenColor(colorString, scale) Parameters Example util.lightenColor(colorString, scale) Parameters Example util.mixColors(color1, color2, <ratio>) Parameters Example util.gradientString(gradientDetails) Parameters Example util.lastStopColor(gradientDetails) Parameters Example util.colorNameToHex(name) Parameters Example util.rgbToHex(red, green, blue) Parameters Example util.margin(top [, right [, bottom [, left]]]]) Parameters Examples Normal usage to simply express an otherwise longer set of values Skipping values to repeat the existing values util.padding(top [, right [, bottom [, left]]]]) Parameters Examples util.border(style, [, color [,top [, right [, bottom [, left]]]]]]) Parameters Examples util.abs(value) util.min(a, b) util.max(a, b) util.extend(originalObject, additionalProperties) Parameters Example util.fontStyle(family [, size [, color [, weight]]]) Parameters util.radiusMinusBorderWidth(borderObject, radius) Parameters util.glossyGradient(base [, scale]) Parameters Example util.bevelGradient(base [, scale]) Parameters Example util.recessedGradient(base [, scale]) Parameters Example util.matteGradient(base, [, scale]) Parameters Example util.reversedMatteGradient(base [, scale]) Parameters Example

Themebuilder 配置函数语法

主题配置语法参考。

参考

请参阅主题构建器语法概述了解更多信息。
请参阅渐变语法了解更多信息。

配置函数

主题配置的部分可能是配置中其他值的派生。为了避免手动计算这些值，util 包中提供了几个配置函数。util 包提供了便利函数，可以在主题构建期间预先计算主题中的值，而不是影响任何运行时性能。

util.darkenGradient(gradientDetails, scale)

按 scale 量加深给定的渐变数据结构

参数

名称	说明
gradientDetails	渐变结构，用于加深
scale	表示加深百分比的双精度浮点数。例如：0.2 将使颜色加深 20%

示例

  activeGradientDetails {
    stops = [
      "#1e5799 0%",
      "#2989d8 50%",
      "#207cca 51%",
      "#7db9e8 100%"
      ]
  }
  inactiveGradientDetails = util.darkenGradient(activeGradientDetails, 0.2)

上述示例将计算为以下内容

  activeGradientDetails {
    stops = [
      "#1e5799 0%",
      "#2989d8 50%",
      "#207cca 51%",
      "#7db9e8 100%"
      ]
  }
  inactiveGradientDetails {
    stops = [
      "#18457a 0%",
      "#206dac 50%",
      "#1963a1 51%",
      "#6494b9 100%"
      ]
  }

util.lightenGradient(gradientDetails, scale)

按 scale 量减淡渐变数据结构。有关如何使用它的详细信息，请参阅上面的 darkenGradient。

util.solidGradient(colorString)

从指定颜色创建单色渐变的便捷方法。返回渐变数据结构。

参数

名称	说明
colorString	用于构建纯色渐变对象的十六进制颜色

util.solidGradientString(colorString)

从指定颜色创建单色渐变的便捷方法。返回渐变字符串，适用于 CSS。

参数

名称	说明
colorString	用于构建纯色渐变字符串的十六进制颜色

util.darkenColor(colorString, scale)

按 scale 量加深十六进制值颜色字符串。

参数

名称	说明
colorString	要加深的十六进制颜色
scale	表示加深百分比的双精度浮点数。例如：0.2 将使颜色加深 20%。

示例

textColor = "#1e5799"
inactiveTextColor = util.darkenColor(textColor, 0.2)

上述示例将计算为以下内容

textColor = "#1e5799"
inactiveTextColor = "#6494b9"

util.lightenColor(colorString, scale)

按 scale 量减淡十六进制值颜色字符串。

参数

名称	说明
colorString	要减淡的十六进制颜色
scale	表示减淡百分比的双精度浮点数。例如：0.2 将使颜色减淡 20%。

示例

textColor = "#1e5799"
overTextColor = util.lightenColor(textColor, 0.2)

上述示例将计算为以下内容

textColor = "#1e5799"
overTextColor = "#4b78ad"

util.mixColors(color1, color2, <ratio>)

使用可选的 ratio 混合两种十六进制颜色。

参数

名称	说明	默认值
color1	要混合的第一个十六进制字符串颜色
color2	要混合的第二个十六进制字符串颜色
ratio	混合比率	`0.5`

示例

red = "#ff0000"
blue = "#0000ff"

eggplant = util.mixColors(red, blue)
lipstick = util.mixColors(red, blue, 0.3)
purple = util.mixColors(red, blue, 0.7)

上述示例将计算为以下内容

red = "#ff0000"
blue = "#0000ff"

eggplant = "#7f007f"
lipstick = "#b2004c"
purple = "#4c00b2"

util.gradientString(gradientDetails)

将渐变数据结构转换为 CSS 友好的字符串。

参数

名称	说明
gradientDetails	渐变数据结构

示例

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

activeGradient = util.gradientString(activeGradientDetails)

上述示例将计算为以下内容

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

activeGradient = "#1e5799 0%, #2989d8 50%, #207cca 51%, #7db9e8 100%"

util.lastStopColor(gradientDetails)

返回渐变数据结构的最后一个停止颜色。如果渐变需要融入背景，则很有用。

参数

名称	说明
gradientDetails	渐变数据结构

示例

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

panelBackgroundColor = util.lastStopColor(activeGradientDetails)

上述示例将计算为以下内容

activeGradientDetails {
  stops = [
    "#1e5799 0%",
    "#2989d8 50%",
    "#207cca 51%",
    "#7db9e8 100%"
  ]
}

panelBackgroundColor = "#7db9e8"

util.colorNameToHex(name)

将颜色名称转换为其十六进制表示形式。在样式中需要使用命名颜色时很有用。

参数

名称	说明
name	要转换为十六进制字符串的颜色名称

示例

red = util.colorNameToHex('red')
blue = util.colorNameToHex('blue')
aliceblue = util.colorNameToHex('aliceblue')

上述示例将计算为以下内容

red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"

util.rgbToHex(red, green, blue)

将 RGB 颜色值转换为十六进制字符串。

参数

名称	说明
red	颜色的红色值，范围为 0-255
green	颜色的绿色值，范围为 0-255
blue	颜色的蓝色值，范围为 0-255

示例

red = util.rgbToHex(255, 0, 0)
blue = util.rgbToHex(0, 0, 255)
aliceblue = util.rgbToHex(240, 248, 255)

上述示例将计算为以下内容

red = "#ff0000"
blue = "#0000ff"
aliceblue = "#f0f8ff"

util.margin(top [, right [, bottom [, left]]]])

帮助函数，用于在一行中分配所有边距详细信息。第一个参数之外的所有参数都是可选的，遵循边距值的 CSS 样式。所有值均以像素为单位。

参数

名称	说明	默认值
顶部	应用于元素/小部件顶部的像素边距
right	应用于元素/小部件右侧的像素边距	`顶部`
bottom	应用于元素/小部件底部的像素边距	`顶部`
left	应用于元素/小部件左侧的像素边距	`right`

示例

正常用法，仅表示一组较长的值

buttonMargin = util.margin(0, 3, 0, 2)

上述示例将计算为以下内容

buttonMargin {
  top = 0
  right = 3
  bottom = 0
  left = 2
}

跳过值以重复现有值

info {
  //...
  margin = util.margin(2, 0)
  //...
}

上述示例将计算为

info {
  //...
  margin {
    top = 2
    right = 0
    bottom = 2
    left = 0
  }
  //...
}

util.padding(top [, right [, bottom [, left]]]])

帮助函数，用于在一行中分配所有填充详细信息。第一个参数之外的所有参数都是可选的，遵循填充值的 CSS 样式。所有值均以像素为单位。

参数

名称	说明	默认值
顶部	应用于元素/小部件顶部的像素填充
right	应用于元素/小部件右侧的像素填充	`顶部`
bottom	应用于元素/小部件底部的像素填充	`顶部`
left	应用于元素/小部件左侧的像素填充	`right`

示例

与 util.margin 的用法相同

util.border(style, [, color [,top [, right [, bottom [, left]]]]]])

帮助函数，用于在一行中分配所有边框详细信息。第一个参数之外的所有参数都是可选的，但对于可见边框，至少应指定前三个参数。请注意，并非所有边框都使用此边框对象进行管理，因为在某些情况下，需要单独描述和管理不同的详细信息。边框厚度值是整数，视为像素。

参数

名称	说明	默认值
style	要使用的边框样式，使用边框样式的合法值，例如 `none`、`solid`、`dashed` 等
color	要使用的边框的 css 颜色	`"#000000"`
顶部	顶部边框的厚度。	`0`
right	右侧边框的厚度	`顶部`
bottom	底部边框的厚度	`顶部`
left	左侧边框的厚度	`right`

示例

无边框

border = util.border('none')

所有边均为实心蓝色边框

border = util.border('solid', '#0000ff', 1)

这将计算为

border {
  style = 'solid'
  color = '#0000ff'
  top = 1
  right = 1
  bottom = 1
  left = 1
}

util.abs(value)

返回给定数字的绝对值

util.min(a, b)

返回传入的两个数字中的较小者

util.max(a, b)

返回传入的两个数字中的较大者

util.extend(originalObject, additionalProperties)

创建一个新对象，其中包含第一个参数的所有值，并覆盖第二个参数中指定的任何属性。

参数

名称	说明
originalObject	要克隆并修改的对象。这通常是对已在配置中声明的现有对象的引用
additionalProperties	应在新创建的对象中覆盖的属性

示例

dayText = util.fontStyle('helvetica,arial,verdana,sans-serif', '13px', '#000000')
dayDisabledText = util.extend(dayText, {
  color = '#808080'
})

这将计算为

dayText {
  family = 'helvetica,arial,verdana,sans-serif'
  size = '13px'
  color = '#000000'
  weight = 'normal'
}
dayDisabledText {
  family = 'helvetica,arial,verdana,sans-serif'
  size = '13px'
  color = '#808080'
  weight = 'normal'
}

util.fontStyle(family [, size [, color [, weight]]])

辅助函数，用于在单行中声明文本样式。仅需要第一个参数。与主题使用者使用的其他大多数大小不同，字体大小被视为字符串，以支持广泛可能的 CSS font-size 值。

参数

名称	说明	默认值
family	要使用的字体系列。任何有效的 CSS `font-family` 值在此处都是合法的。
size	要使用的字体大小。任何有效的 CSS `font-size` 值在此处都是合法的。	`"medium"`
color	要使用的文本颜色。任何有效的 CSS 颜色在此处都是合法的。	`"#000000"`
weight	要使用的字体粗细。任何有效的 CSS `font-weight` 值在此处都是合法的	`"normal"`

util.radiusMinusBorderWidth(borderObject, radius)

实用方法，用于帮助协调 CSS3 和切片外观之间的布局差异。为了保持填充和边距值一致应用，此值使我们能够确保 CSS3 实现与切片版本具有相同的尺寸。

参数

名称	说明
borderObject	边框对象，例如 `util.border` 将返回的内容
radius	指定相关角上边框半径的整数

util.glossyGradient(base [, scale])

采用颜色和可选缩放值，并返回光泽渐变字符串。

参数

名称	说明	默认值
base	要开始使用的初始颜色。
scale	将基本颜色拉伸到渐变中时要使用的可选值	`0.15`

示例

util.glossyGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15

util.bevelGradient(base [, scale])

采用颜色和可选缩放值，并返回斜角渐变字符串。

参数

名称	说明	默认值
base	要开始使用的初始颜色。
scale	将基本颜色拉伸到渐变中时要使用的可选值	`0.15`

示例

util.bevelGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.15

util.recessedGradient(base [, scale])

采用颜色和可选缩放值，并返回凹陷渐变字符串。

参数

名称	说明	默认值
base	要开始使用的初始颜色。
scale	将基本颜色拉伸到渐变中时要使用的可选值	`0.5`

示例

util.recessedGradient('#157FCC')

util.matteGradient(base, [, scale])

采用颜色和可选缩放值，并返回哑光渐变字符串。

参数

名称	说明	默认值
base	要开始使用的初始颜色。
scale	将基本颜色拉伸到渐变中时要使用的可选值	`0.04`

示例

util.matteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.03

util.reversedMatteGradient(base [, scale])

采用颜色和可选缩放值，并返回反向哑光渐变字符串。

参数

名称	说明	默认值
base	要开始使用的初始颜色。
scale	将基本颜色拉伸到渐变中时要使用的可选值	`0.06`

示例

util.reversedMatteGradient('#157FCC', 0.2) // scale exagerated for effect, default is 0.06