Cesium API - TimeIntervalCollection 中文文档

new Cesium.TimeIntervalCollection(intervals)

按开始时间排序的TimeInterval实例的非重叠集合。

Name	Type	Description
`intervals`	Array.<TimeInterval>	optional 要添加到集合中的区间数组。

成员变量

readonlychangedEvent : Event

Core/TimeIntervalCollection.js 50

获取每当区间集合发生更改时引发的事件。

readonlyisEmpty : Boolean

Core/TimeIntervalCollection.js 128

获取集合是否为空。

readonlyisStartIncluded : Boolean

Core/TimeIntervalCollection.js 75

获取开始时间是否包含在集合中。

readonlyisStopIncluded : Boolean

Core/TimeIntervalCollection.js 102

获取集合中是否包含停止时间。

readonlylength : Number

Core/TimeIntervalCollection.js 116

获取集合中的区间数。

readonlystart : JulianDate

Core/TimeIntervalCollection.js 62

获取集合的开始时间。

readonlystop : JulianDate

Core/TimeIntervalCollection.js 88

获取集合的停止时间。

内置方法

staticCesium.TimeIntervalCollection.fromIso8601(options, result) → TimeIntervalCollection

Core/TimeIntervalCollection.js 971

从一个ISO 8601时间区间（开始/结束/持续时间）创建一个新实例。

Name Type Description

options

Object

对象，具有以下属性：

Name	Type	Default	Description
`iso8601`	String		ISO 8601区间。
`isStartIncluded`	Boolean	`true`	optional 如果开始时间包含在区间内，则为`true`；否则`false`。
`isStopIncluded`	Boolean	`true`	optional 如果结束时间包含在区间内，则为`true`；否则`false`。
`leadingInterval`	Boolean	`false`	optional 如果您想添加一个从Iso8601.MINIMUM_VALUE到开始时间的区间，则为`true`；否则`false`。
`trailingInterval`	Boolean	`false`	optional 如果你想添加一个从停止时间到Iso8601.MAXIMUM_VALUE的时间区间，则为`true`；否则`false`。
`dataCallback`	function		optional 函数的作用是：在将数据添加到集合之前，返回每个区间调用的数据。如果未指定，数据将是集合中的索引。

result TimeIntervalCollection optional 要用于结果的现有实例。

返回值：

修改后的结果参数或新实例（如果没有提供）。

staticCesium.TimeIntervalCollection.fromIso8601DateArray(options, result) → TimeIntervalCollection

Core/TimeIntervalCollection.js 1038

从ISO 8601日期数组中创建一个新实例。

Name Type Description

options

Object

对象，具有以下属性：

Name	Type	Default	Description
`iso8601Dates`	Array.<String>		ISO 8601日期数组。
`isStartIncluded`	Boolean	`true`	optional 如果开始时间包含在区间内，则为`true`；否则`false`。
`isStopIncluded`	Boolean	`true`	optional 如果结束时间包含在区间内，则为`true`；否则`false`。
`leadingInterval`	Boolean	`false`	optional 如果您想添加一个从Iso8601.MINIMUM_VALUE到开始时间的区间，则为`true`；否则`false`。
`trailingInterval`	Boolean	`false`	optional 如果你想添加一个从停止时间到Iso8601.MAXIMUM_VALUE的时间区间，则为`true`；否则`false`。
`dataCallback`	function		optional 函数的作用是：在将数据添加到集合之前，返回每个区间调用的数据。如果未指定，数据将是集合中的索引。

result TimeIntervalCollection optional 要用于结果的现有实例。

返回值：

修改后的结果参数或新实例（如果没有提供）。

staticCesium.TimeIntervalCollection.fromIso8601DurationArray(options, result) → TimeIntervalCollection

Core/TimeIntervalCollection.js 1090

从ISO 8601持续时间数组中创建一个新实例。

Name Type Description

options

Object

对象，具有以下属性：

Name	Type	Default	Description
`epoch`	JulianDate		持续时间相对的日期。
`iso8601Durations`	String		ISO 8601持续时间数组。
`relativeToPrevious`	Boolean	`false`	optional 如果持续时间是相对于之前的日期，则为`true`；如果总是相对于epoch，则为`false`。
`isStartIncluded`	Boolean	`true`	optional 如果开始时间包含在区间内，则为`true`；否则`false`。
`isStopIncluded`	Boolean	`true`	optional 如果结束时间包含在区间内，则为`true`；否则`false`。
`leadingInterval`	Boolean	`false`	optional 如果您想添加一个从Iso8601.MINIMUM_VALUE到开始时间的区间，则为`true`；否则`false`。
`trailingInterval`	Boolean	`false`	optional 如果你想添加一个从停止时间到Iso8601.MAXIMUM_VALUE的时间区间，则为`true`；否则`false`。
`dataCallback`	function		optional 函数的作用是：在将数据添加到集合之前，返回每个区间调用的数据。如果未指定，数据将是集合中的索引。

result TimeIntervalCollection optional 要用于结果的现有实例。

返回值：

修改后的结果参数或新实例（如果没有提供）。

staticCesium.TimeIntervalCollection.fromJulianDateArray(options, result) → TimeIntervalCollection

Core/TimeIntervalCollection.js 722

从JulianDate数组创建一个新实例。

Name Type Description

options

Object

对象，具有以下属性：

Name	Type	Default	Description
`julianDates`	Array.<JulianDate>		ISO 8601日期数组。
`isStartIncluded`	Boolean	`true`	optional 如果开始时间包含在区间内，则为`true`；否则`false`。
`isStopIncluded`	Boolean	`true`	optional 如果结束时间包含在区间内，则为`true`；否则`false`。
`leadingInterval`	Boolean	`false`	optional 如果您想添加一个从Iso8601.MINIMUM_VALUE到开始时间的区间，则为`true`；否则`false`。
`trailingInterval`	Boolean	`false`	optional 如果你想添加一个从停止时间到Iso8601.MAXIMUM_VALUE的时间区间，则为`true`；否则`false`。
`dataCallback`	function		optional 函数的作用是：在将数据添加到集合之前，返回每个区间调用的数据。如果未指定，数据将是集合中的索引。

result TimeIntervalCollection optional 要用于结果的现有实例。

返回值：

修改后的结果参数或新实例（如果没有提供）。

addInterval(interval, dataComparer)

Core/TimeIntervalCollection.js 339

将区间添加到集合中，合并包含相同数据的区间，并根据需要分割不同数据的区间，以维护不重叠的集合。新区间中的数据优先于集合中任何现有的区间。

Name	Type	Description
`interval`	TimeInterval	要添加的区间。
`dataComparer`	TimeInterval~DataComparer	optional 一个比较两个区间的数据的函数。如果省略，则使用引用相等。

contains(julianDate) → Boolean

Core/TimeIntervalCollection.js 231

检查指定的日期是否在此集合中。

Name	Type	Description
`julianDate`	JulianDate	要检查的日期。

返回值：

如果集合包含指定的日期则为true，否则false。

equals(right, dataComparer) → Boolean

Core/TimeIntervalCollection.js 150

将此实例与提供的实例分量比较，如果相等，则返回true，否则返回false。

Name	Type	Description
`right`	TimeIntervalCollection	optional 要比较的集合实例。
`dataComparer`	TimeInterval~DataComparer	optional 一个比较两个区间的数据的函数。如果省略，则使用引用相等。

返回值：

如果它们相等，则为true，否则false。

findDataForIntervalContainingDate(date) → Object

Core/TimeIntervalCollection.js 220

查找并返回包含指定日期的时间区间的数据。

Name	Type	Description
`date`	JulianDate	要搜索的日期。

返回值：

包含指定日期的区间的数据，或undefined（如果不存在这样的区间）。

findInterval(options) → TimeInterval

Core/TimeIntervalCollection.js 304

返回集合中与指定参数匹配的第一个区间。所有参数都是可选的，undefined参数被视为不关心条件。

Name Type Description

options

Object

optional 对象，具有以下属性：

Name	Type	Description
`start`	JulianDate	optional 区间的开始时间。
`stop`	JulianDate	optional 区间的结束时间。
`isStartIncluded`	Boolean	optional 如果开始时间包含在区间内，则为`true`；否则`false`。
`isStopIncluded`	Boolean	optional 如果结束时间包含在区间内，则为`true`；否则`false`。

返回值：

集合中与指定参数匹配的第一个区间。

findIntervalContainingDate(date) → TimeInterval|undefined

Core/TimeIntervalCollection.js 209

查找并返回包含指定日期的区间。

Name	Type	Description
`date`	JulianDate	要搜索的日期。

返回值：

包含指定日期的区间，如果不存在这样的区间则为undefined。

get(index) → TimeInterval

Core/TimeIntervalCollection.js 183

获取指定索引处的区间。

Name	Type	Description
`index`	Number	要检索的区间的索引。

返回值：

指定索引处的区间，或者undefined（如果不存在该索引的区间）。

indexOf(date) → Number

Core/TimeIntervalCollection.js 253

查找并返回集合中包含指定日期的时间区间的索引。

Name	Type	Description
`date`	JulianDate	要搜索的日期。

返回值：

区间的索引包含的指定的日期，如果没有这样的区间存在，它返回一个负数，即在日期之后开始的下一个区间的索引的按位补数，或者如果在指定日期之后没有区间，则按位补全集合的长度。

intersect(other, dataComparer, mergeCallback) → TimeIntervalCollection

Core/TimeIntervalCollection.js 650

创建此集合与提供的集合的交集的新实例。

Name	Type	Description
`other`	TimeIntervalCollection	要与之相交的集合。
`dataComparer`	TimeInterval~DataComparer	optional 一个比较两个区间的数据的函数。如果省略，则使用引用相等。
`mergeCallback`	TimeInterval~MergeCallback	optional 将两个区间的数据合并在一起的函数。如果省略，则使用左区间的数据。