HashHishtory | kdayun 界面引擎API

使用 URL 中的 hash 部分（即 # 符号后的内容）来管理路由 url: http://www.example.com/index.html#location1 通过 # 后面的参数来切换页面

Hierarchy

HashHishtory

Implements

IHistory

Index

Constructors

constructor

Properties

Constructors

constructor

new HashHishtory(): HashHishtory

- Defined in YH-Designer/src/base/router/History.ts:331
Returns HashHishtory

Properties

Methods

addPage

addPage(page: DesignerPageBase): void

- Defined in YH-Designer/src/base/router/History.ts:610
Parameters
- page: DesignerPageBase
Returns void

Private closePage

closePage(page: DesignerPageBase): void

- Defined in YH-Designer/src/base/router/History.ts:451
Parameters
- page: DesignerPageBase
Returns void

Protected doShow

doShow(type: "id" | "code" | "path", pageParam: string | IRouterItem, paramsObj?: {}, pageConfig?: ISPAPageConfig, isPush?: boolean, isHashChange?: boolean): void

- Defined in YH-Designer/src/base/router/History.ts:535
显示页面

Parameters
- type: "id" | "code" | "path"
  
  类型
- pageParam: string | IRouterItem
  
  页面参数可以是页面id/页面编码
- paramsObj: {} = ...
  
  传递的参数
- pageConfig: ISPAPageConfig = ...
  
  页面配置
- isPush: boolean = true
  
  是否要push记录到history内
- isHashChange: boolean = false
  
  是否修改hash变化引起的页面显示
Returns void

findRouterItem

findRouterItem(path: string): IRouterItem

- Defined in YH-Designer/src/base/router/History.ts:602
Parameters
- path: string
Returns IRouterItem

getCurrent

getCurrent(): DesignerPageBase

Implementation of IHistory.getCurrent
- Defined in YH-Designer/src/base/router/History.ts:518
获取当前的表单

Returns DesignerPageBase

返回当前表单实例

getCurrentLocation

getCurrentLocation(): string

- Defined in YH-Designer/src/base/router/History.ts:622
得到当前的hash值

Returns string

go

go(n: number): void

Implementation of IHistory.go
- Defined in YH-Designer/src/base/router/History.ts:522
在当前历史中跳转的位置 go(-1): 后退+刷新；原页面表单中的内容会丢失. go(0)：刷新； go(1)：前进+刷新；

Parameters
- n: number
Returns void

goToByCode

goToByCode(pageModelCode: string, paramsObj?: {}, pageConfig?: ISPAPageConfig, isNew?: boolean): void

- Defined in YH-Designer/src/base/router/History.ts:462
通过页面代码跳转到指定的url

Parameters
- pageModelCode: string
  
  页面模型
- paramsObj: {} = ...
  
  可选参数参数对象
- pageConfig: ISPAPageConfig = ...
  
  可选参数页面配置项
- isNew: boolean = true
  
  可选参数是否新创建
Returns void

goToById

goToById(pageModelId: string, paramsObj?: {}, pageConfig?: ISPAPageConfig, isNew?: boolean): void

- Defined in YH-Designer/src/base/router/History.ts:473
通过页面代码跳转到指定的url

Parameters
- pageModelId: string
  
  页面模型
- paramsObj: {} = ...
  
  可选参数参数对象
- pageConfig: ISPAPageConfig = ...
  
  可选参数页面配置项
- isNew: boolean = true
  
  可选参数是否新创建
Returns void

init

init(): void

- Defined in YH-Designer/src/base/router/History.ts:335
Returns void

Private innerGoToByCode

innerGoToByCode(fnGetPage: openPageHandle, pageModelCode: string, paramsObj?: {}, pageConfig?: ISPAPageConfig, isNew?: boolean): void

- Defined in YH-Designer/src/base/router/History.ts:476
Parameters
- fnGetPage: openPageHandle
- pageModelCode: string
- paramsObj: {} = ...
- pageConfig: ISPAPageConfig = ...
- isNew: boolean = true
Returns void

pushCode

pushCode(pageCode: string, paramsObj?: {}, pageConfig?: ISPAPageConfig): void

- Defined in YH-Designer/src/base/router/History.ts:579
Parameters
- pageCode: string
- paramsObj: {} = ...
- Optional pageConfig: ISPAPageConfig
Returns void

pushId

pushId(pageCode: string, paramsObj?: {}, pageConfig?: ISPAPageConfig): void

- Defined in YH-Designer/src/base/router/History.ts:583
Parameters
- pageCode: string
- paramsObj: {} = ...
- Optional pageConfig: ISPAPageConfig
Returns void

pushPath

pushPath(path: string, paramsObj?: object, pageConfig?: ISPAPageConfig): void

Implementation of IHistory.pushPath
- Defined in YH-Designer/src/base/router/History.ts:593
跳转到指定的path的页面将新的路由添加到导航历史记录中。在导航过程中，会向应用程序的历史记录中添加新的路由，从而可以通过后退按钮回到之前的路由。新的路由将成为历史记录中的当前活动路由

Parameters
- path: string
- Optional paramsObj: object
- Optional pageConfig: ISPAPageConfig
Returns void

renderByPageCode

renderByPageCode(fnGetPage: openPageHandle, elem: string | JQuery<HTMLElement>, pageModelCode: string, paramsObj?: {}, callback?: (page: DesignerPageBase, err?: any) => void, pageConfig?: ISPAPageConfig): void

- Defined in YH-Designer/src/base/router/History.ts:397
在html元素内渲染页面

Parameters
- fnGetPage: openPageHandle
  
  页面数据获取函数一般是 DesignerPageBase.getPageByCode ,DesignerPageBase.getPageById
- elem: string | JQuery<HTMLElement>
  
  element Id string | JQuery | HTMLElement
- pageModelCode: string
  
  页面唯一编号
- paramsObj: {} = ...
  
  可选参数传入的页面参数
- Optional callback: (page: DesignerPageBase, err?: any) => void
  - - (page: DesignerPageBase, err?: any): void
    - Parameters
      - page: DesignerPageBase
      - Optional err: any
      Returns void
- pageConfig: ISPAPageConfig = ...
Returns void

replaceCode

replaceCode(pageCode: string, paramsObj?: {}, pageConfig?: ISPAPageConfig): void

- Defined in YH-Designer/src/base/router/History.ts:587
Parameters
- pageCode: string
- paramsObj: {} = ...
- Optional pageConfig: ISPAPageConfig
Returns void

replaceId

replaceId(pageId: string, paramsObj?: {}, pageConfig?: ISPAPageConfig): void

- Defined in YH-Designer/src/base/router/History.ts:590
Parameters
- pageId: string
- paramsObj: {} = ...
- Optional pageConfig: ISPAPageConfig
Returns void

replacePath

replacePath(path: string, paramsObj?: object, pageConfig?: ISPAPageConfig): void

Implementation of IHistory.replacePath
- Defined in YH-Designer/src/base/router/History.ts:597
跳转到指定的path的页面在导航过程中，会将当前的活动路由替换为新的路由，并且不会在历史记录中创建额外的记录。这意味着无法通过后退按钮返回到之前的路由。

Parameters
- path: string
- Optional paramsObj: object
- Optional pageConfig: ISPAPageConfig
Returns void

setCurrent

setCurrent(page: DesignerPageBase): void

- Defined in YH-Designer/src/base/router/History.ts:607
Parameters
- page: DesignerPageBase
Returns void

setRoot

setRoot(rootPage: DesignerPageBase): void

Implementation of IHistory.setRoot
- Defined in YH-Designer/src/base/router/History.ts:513
设置根表单

Parameters
- rootPage: DesignerPageBase
Returns void

Private showPage

showPage(page: DesignerPageBase, forceUpdate?: boolean, forceEmptyChild?: boolean): void

- Defined in YH-Designer/src/base/router/History.ts:432
Parameters
- page: DesignerPageBase
- forceUpdate: boolean = true
- forceEmptyChild: boolean = false
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HashHishtory

Properties

_pages

current

rootPage

Methods

addPage

Parameters

page: DesignerPageBase

Returns void

Private closePage

Parameters

page: DesignerPageBase

Returns void

Protected doShow

Parameters

type: "id" | "code" | "path"

pageParam: string | IRouterItem

paramsObj: {} = ...

pageConfig: ISPAPageConfig = ...

isPush: boolean = true

isHashChange: boolean = false

Returns void

findRouterItem

Parameters

path: string

Returns IRouterItem

getCurrent

Returns DesignerPageBase

getCurrentLocation

Returns string

go

Parameters

n: number

Returns void

goToByCode

Parameters

pageModelCode: string

paramsObj: {} = ...

pageConfig: ISPAPageConfig = ...

isNew: boolean = true

Returns void

goToById

Parameters

pageModelId: string

paramsObj: {} = ...

pageConfig: ISPAPageConfig = ...

isNew: boolean = true

Returns void

init

Returns void

Private innerGoToByCode

Parameters

fnGetPage: openPageHandle

pageModelCode: string

paramsObj: {} = ...

pageConfig: ISPAPageConfig = ...

isNew: boolean = true

Returns void

pushCode

Parameters

pageCode: string

paramsObj: {} = ...

Optional pageConfig: ISPAPageConfig

Returns void

pushId

Parameters

pageCode: string

paramsObj: {} = ...

Optional pageConfig: ISPAPageConfig

Returns void

pushPath