ResourceService | quickearth

资源管理器，提供了资源的加载、更新和删除操作，支持从配置文件或者构造参数构建资源，提供了资源ID级别的事件监听具有复用价值的资源才需要使用管理器管理

Hierarchy

Evented
- ResourceService

Constructors

constructor

new ResourceService(): ResourceService

Inherited from Evented.constructor
Returns ResourceService

Properties

registerCreator

registerCreator: ((resourceType: string, creator: ResourceCreator) => void) = ResourceService.registerCreator

Type declaration

- (resourceType: string, creator: ResourceCreator): void
- 注册资源的构建器
  
  static
  memberof
  ResourceService
  
  Parameters
  - resourceType: string
    
    支持的资源类型
  - creator: ResourceCreator
    
    构建函数
  Returns void

Static EventTypes

EventTypes: { resAdd: string; resLoaded: string; resRemoved: string; resUpdated: string } = ...

资源的事件基类型，监听某个具体资源的事件，可以使用基类型+":"+资源ID 进行监听，如： res:add:style1（即ResourceService.EventTypes.resAdd+":"+"style1" ），表示对style1这个资源的增删改进行监听

static
memberof: ResourceService

Type declaration

resAdd: string

当资源第一次被加载之后触发
resLoaded: string

当资源被加载之后触发（第一次加载或者更新都会触发）
resRemoved: string

当资源被移出之后触发
resUpdated: string

当资源被更新后触发

Methods

addEventParent

addEventParent(obj: any): ResourceService

Inherited from Evented.addEventParent
- Defined in src/core/evented.ts:299
Parameters
- obj: any
Returns ResourceService

addResource

addResource(key: string, resourceObj: IResourceObject, updateIfExists?: boolean): void

- Defined in src/services/resource.service.ts:396
添加一个资源实例

memberof
ResourceService

Parameters
- key: string
  
  资源ID
- resourceObj: IResourceObject
  
  实例对象
- updateIfExists: boolean = false
  
  资源存在的时候是否进行更新，默认为否
Returns void

fire

fire(type: any, data: IEventData, propagate?: any): ResourceService

Inherited from Evented.fire
- Defined in src/core/evented.ts:220
Parameters
- type: any
- data: IEventData
- Optional propagate: any
Returns ResourceService

getResource

getResource(key: string): IResourceObject

- Defined in src/services/resource.service.ts:624
获取一个资源实例

memberof
ResourceService

Parameters
- key: string
  
  要获取的key
Returns IResourceObject
{*} 资源实例

hasResource

hasResource(key: string): boolean

- Defined in src/services/resource.service.ts:655
检查是否存在指定key的资源实例

memberof
ResourceService

Parameters
- key: string
Returns boolean
{boolean} 返回是否存在

listens

listens(type: any, propagate?: any): boolean

Inherited from Evented.listens
- Defined in src/core/evented.ts:261
Parameters
- type: any
- Optional propagate: any
Returns boolean

loadResource

loadResource(resourceInfo: IResourceInfo, updateIfExists?: boolean): Promise<IResourceObject>

- Defined in src/services/resource.service.ts:437
加载一个资源实例

memberof
ResourceService

Parameters
- resourceInfo: IResourceInfo
  
  资源描述信息。
- updateIfExists: boolean = false
  
  如果当前资源已经存在，则更新。默认为否
Returns Promise<IResourceObject>
{Promise} 返回一个Promise对象，当资源加载完成后进行回调

loadResourceFromConfig

loadResourceFromConfig(resourceConfig: any, updateIfExists?: boolean): Promise<IResourceObject[]>

- Defined in src/services/resource.service.ts:510
从资源配置对象信息加载资源

memberof
ResourceService

Parameters
- resourceConfig: any
  资源配置对象。预定义的资源集合配置对象。如果希望增加自定义的资源支持，可以注册creator用于创建自定义类型的资源实例该对象中的key就是资源的类型每一个二级对象中的key表示具体资源的唯一ID，如下所示
```
//这里是资源的类型
featureStyles:{
     //这里是资源的ID
     style1:{
     },
     style2:{
     }
},
images:{
     img1:"",
     img2:""
}
```
- updateIfExists: boolean = false
  
  如果资源存在的时候，是否重新加载。默认为false，表示不重新加载。注意如果是相同的资源应该只在一个地方加载
Returns Promise<IResourceObject[]>
{Promise<IResourceObject[]>} 返回一个Promise对象，当所有资源全部加载完成后回调

loadResourceFromConfigPath

loadResourceFromConfigPath(requestInfo: RequestInfo, init?: RequestInit, updateIfExists?: boolean): Promise<IResourceObject[]>

- Defined in src/services/resource.service.ts:603
从一个配置地址请求资源。该配置文件返回的信息为预定义的资源集合配置对象。如果希望增加自定义的资源支持，可以注册creator用于创建自定义类型的资源实例该对象中的key就是资源的类型每一个二级对象中的key表示具体资源的唯一ID，如下所示
```
//这里是资源的类型
featureStyles:{
     //这里是资源的ID
     style1:{
     },
     style2:{
     }
},
images:{
     img1:"",
     img2:""
}
```
memberof
ResourceService
Parameters
- requestInfo: RequestInfo
  
  请求信息绝对路径请以/开头，否则认为是相对于静态资源目录下的目录（consts.resourcePath中配置静态资源目录，默认是public）
- Optional init: RequestInit
- updateIfExists: boolean = false
  
  如果资源存在的时候，是否重新加载。默认为false，表示不重新加载。注意如果是相同的资源应该只在一个地方加载
Returns Promise<IResourceObject[]>
{Promise<IResourceObject[]>}

loadResources

loadResources(infos: IResourceInfo[]): Promise<IResourceObject[]>

- Defined in src/services/resource.service.ts:471
加载一组资源

memberof
ResourceService

Parameters
- infos: IResourceInfo[]
  
  资源描述信息
Returns Promise<IResourceObject[]>
{Promise<IResourceObject[]>} 返回一个Promise对象，当所有资源加载完成后回调，当有一个资源出现失败即加载失败

lock

lock(): ResourceService

Inherited from Evented.lock
- Defined in src/core/evented.ts:119
Returns ResourceService

off

off(types: any, fn: any, context?: any): ResourceService

Inherited from Evented.off
- Defined in src/core/evented.ts:97
Parameters
- types: any
- fn: any
- Optional context: any
Returns ResourceService

on

on(types: any, fn: ((event: IEventData) => void), context?: any): ResourceService

Inherited from Evented.on
- Defined in src/core/evented.ts:64
Parameters
- types: any
- fn: ((event: IEventData) => void)
  - - (event: IEventData): void
    - Parameters
      - event: IEventData
      Returns void
- Optional context: any
Returns ResourceService

once

once(types: any, fn: ((event: IEventData) => void), context?: any): ResourceService

Inherited from Evented.once
- Defined in src/core/evented.ts:276
Parameters
- types: any
- fn: ((event: IEventData) => void)
  - - (event: IEventData): void
    - Parameters
      - event: IEventData
      Returns void
- Optional context: any
Returns ResourceService

removeEventParent

removeEventParent(obj: any): ResourceService

Inherited from Evented.removeEventParent
- Defined in src/core/evented.ts:307
Parameters
- obj: any
Returns ResourceService

removeResource

removeResource(key: string): boolean

- Defined in src/services/resource.service.ts:639
移除一个资源实例

memberof
ResourceService

Parameters
- key: string
  
  要移除的key
Returns boolean
{boolean} 返回是否成功移除

unlock

unlock(fireLocked?: boolean): void

Inherited from Evented.unlock
- Defined in src/core/evented.ts:124
Parameters
- fireLocked: boolean = true
Returns void

whenResourceAdded

whenResourceAdded(key: string, added: ((resource: IResourceObject) => void)): Promise<IResourceObject>

- Defined in src/services/resource.service.ts:666
添加指定资源第一次增加的监听（删除后再添加也算第一次增加）

memberof
ResourceService

Parameters
- key: string
  
  要监听的资源ID
- added: ((resource: IResourceObject) => void)
  
  回调函数
  - - (resource: IResourceObject): void
    - Parameters
      - resource: IResourceObject
      Returns void
Returns Promise<IResourceObject>

whenResourceLoaded

whenResourceLoaded(key: string, loaded: ((resource: IResourceObject) => void)): void

- Defined in src/services/resource.service.ts:696
添加指定资源被加载后的回调

memberof
ResourceService

Parameters
- key: string
  
  要监听的资源ID
- loaded: ((resource: IResourceObject) => void)
  
  回调函数
  - - (resource: IResourceObject): void
    - Parameters
      - resource: IResourceObject
      Returns void
Returns void

whenResourceRemoved

whenResourceRemoved(key: string, removed: ((resource: IResourceObject) => void)): void

- Defined in src/services/resource.service.ts:709
添加指定资源被移出后的回调

memberof
ResourceService

Parameters
- key: string
  
  要监听的资源ID
- removed: ((resource: IResourceObject) => void)
  
  回调函数
  - - (resource: IResourceObject): void
    - Parameters
      - resource: IResourceObject
      Returns void
Returns void

whenResourceUpdated

whenResourceUpdated(key: string, updated: ((oldResource: IResourceObject, newResource: IResourceObject) => void)): void

- Defined in src/services/resource.service.ts:683
添加指定资源被更新后的回调

memberof
ResourceService

Parameters
- key: string
  
  要监听的资源ID
- updated: ((oldResource: IResourceObject, newResource: IResourceObject) => void)
  
  回调函数
  - - (oldResource: IResourceObject, newResource: IResourceObject): void
    - Parameters
      - oldResource: IResourceObject
      - newResource: IResourceObject
      Returns void
Returns void

Static registerCreator

registerCreator(resourceType: string, creator: ResourceCreator): void

- Defined in src/services/resource.service.ts:346
注册资源的构建器

static
memberof
ResourceService

Parameters
- resourceType: string
  
  支持的资源类型
- creator: ResourceCreator
  
  构建函数
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ResourceService

Properties

registerCreator

Type declaration

Parameters

resourceType: string

creator: ResourceCreator

Returns void

Static EventTypes

Type declaration

resAdd: string

resLoaded: string

resRemoved: string

resUpdated: string

Methods

addEventParent

Parameters

obj: any

Returns ResourceService

addResource

Parameters

key: string

resourceObj: IResourceObject

updateIfExists: boolean = false

Returns void

fire

Parameters

type: any

data: IEventData

Optional propagate: any

Returns ResourceService

getResource

Parameters

key: string

Returns IResourceObject

hasResource

Parameters

key: string

Returns boolean

listens

Parameters

type: any

Optional propagate: any

Returns boolean

loadResource

Parameters

resourceInfo: IResourceInfo

updateIfExists: boolean = false

Returns Promise<IResourceObject>

loadResourceFromConfig

Parameters

resourceConfig: any

updateIfExists: boolean = false

Returns Promise<IResourceObject[]>

loadResourceFromConfigPath

Parameters

requestInfo: RequestInfo

Optional init: RequestInit

updateIfExists: boolean = false

Returns Promise<IResourceObject[]>

loadResources

Parameters

infos: IResourceInfo[]

Returns Promise<IResourceObject[]>

lock

Returns ResourceService

off

Parameters

types: any

fn: any

Optional context: any

Returns ResourceService

on