命名空间: data

Table of contents

枚举

• AnalysisMode

接口

• BackendServer
• EventsOptionBase
• GrapeCity
• InitOption
• InitOptionBase
• Parameters
• Window

Type Aliases

• AnalysisDesignerInit
• AnalysisDesignerInitOption
• AnalysisDesignerInitOptionCore
• DatasetDesignerInit
• DatasetDesignerInitOption
• DatasetDesignerInitOptionCore
• DatasetPreviewInitOption
• DatasetPreviewInitOptionCore
• DatasourceDesignerInit
• DatasourceDesignerInitOption
• DatasourceDesignerInitOptionCore
• DatasourcePreviewInit
• DatasourcePreviewInitOption
• DestroyInstance
• ModelTypeSelectorOption
• PreviewDatasetInit
• SemanticModelDesignerInit
• SemanticModelDesignerInitOption
• SemanticModelDesignerInitOptionCore
• SemanticModelSelectorInit

Type Aliases

AnalysisDesignerInit

Ƭ AnalysisDesignerInit: (option: AnalysisDesignerInitOption) => Element

Type declaration

▸ (option): Element

数据模型设计器的初始化操作.

示例

const designer = GrapeCity.wyn.analysis.designer.init(option);

Parameters

名称	类型	描述
option	AnalysisDesignerInitOption	数据模型设计器初始化参数配置

Returns

Element

---

AnalysisDesignerInitOption

Ƭ AnalysisDesignerInitOption: InitOption & AnalysisDesignerInitOptionCore & { mode: AnalysisMode ; name?: string }

数据模型设计器的初始化参数配置

---

AnalysisDesignerInitOptionCore

Ƭ AnalysisDesignerInitOptionCore: Object

Type declaration

名称	类型
documentId?	string
events?	EventsOptionBase
integrationTokenName?	string
showCloseButton?	boolean

documentId?: string

数据模型 id

示例

documentId: '1f183c3f-64f9-4b4c-ac92-cd37580bde21'

---

events?: EventsOptionBase

-

---

integrationTokenName?: string

url 集成 token 时使用的 token 参数名称 (默认为 token )

---

showCloseButton?: boolean

控制是否显示 关闭按钮 的标志位

示例

showCloseButton: true

---

---

DatasetDesignerInit

Ƭ DatasetDesignerInit: (option: DatasetDesignerInitOption) => Element

Type declaration

▸ (option): Element

数据集设计器的初始化操作

示例

const designer = GrapeCity.wyn.dataset.designer.init(option);

Parameters

名称	类型	描述
option	DatasetDesignerInitOption	数据集设计器初始化配置

Returns

Element

---

DatasetDesignerInitOption

Ƭ DatasetDesignerInitOption: InitOption & DatasetDesignerInitOptionCore

数据集设计器的初始化参数配置

---

DatasetDesignerInitOptionCore

Ƭ DatasetDesignerInitOptionCore: Object

Type declaration

名称	类型
documentId?	string
events?	EventsOptionBase
integrationTokenName?	string
showCloseButton?	boolean
type?	"report" | "dashboard"

documentId?: string

数据集 id

示例

documentId: '1f183c3f-64f9-4b4c-ac92-cd37580bde21'

---

events?: EventsOptionBase

-

---

integrationTokenName?: string

-

---

showCloseButton?: boolean

控制是否显示 关闭按钮 的标志位

示例

showCloseButton: true

---

type?: "report" | "dashboard"

数据集使用方式类型

示例

type: 'dashboard'

---

---

DatasetPreviewInitOption

Ƭ DatasetPreviewInitOption: InitOption & DatasetPreviewInitOptionCore

数据集预览实例的初始化参数配置

---

DatasetPreviewInitOptionCore

Ƭ DatasetPreviewInitOptionCore: Object

Type declaration

名称	类型
documentId	string
integrationTokenName?	string
parameters?	Parameters[]

documentId: string

数据集 id

示例

documentId: '1f183c3f-64f9-4b4c-ac92-cd37580bde21'

---

integrationTokenName?: string

url 集成 token 时使用的 token 参数名称 (默认为 token )

---

parameters?: Parameters[]

数据集参数

---

---

DatasourceDesignerInit

Ƭ DatasourceDesignerInit: (option: DatasourceDesignerInitOption) => Element

Type declaration

▸ (option): Element

数据源设计器的初始化操作

示例

const designer = GrapeCity.wyn.datasource.designer.init(option);

Parameters

名称	类型	描述
option	DatasourceDesignerInitOption	数据源设计器初始化参数配置

Returns

Element

---

DatasourceDesignerInitOption

Ƭ DatasourceDesignerInitOption: InitOption & DatasourceDesignerInitOptionCore

数据源设计器的初始化配置

---

DatasourceDesignerInitOptionCore

Ƭ DatasourceDesignerInitOptionCore: Object

Type declaration

名称	类型
afterClose?	(document: any) => void
documentId?	string
events?	EventsOptionBase
inDataset?	boolean
integrationTokenName?	string
showCloseButton?	boolean

afterClose?: (document: any) => void

关闭设计器后的回调函数

示例

afterDocumentSave: () => {}

---

documentId?: string

数据源id

示例

documentId: '1f183c3f-64f9-4b4c-ac92-cd37580bde21'

---

events?: EventsOptionBase

-

---

inDataset?: boolean

控制是否能够在数据集设计器页面中打开数据源设计器的标志位

示例

inDataset: false

---

integrationTokenName?: string

url 集成 token 时使用的 token 参数名称 (默认为 token )

---

showCloseButton?: boolean

控制是否显示 关闭按钮 的标志位

示例

showCloseButton: true

---

---

DatasourcePreviewInit

Ƭ DatasourcePreviewInit: (option: DatasourcePreviewInitOption) => Element

Type declaration

▸ (option): Element

数据源预览实例的初始化操作

示例

const previewInstance = GrapeCity.wyn.datasource.designer.preview(option);

Parameters

名称	类型	描述
option	DatasourcePreviewInitOption	数据源预览初始化参数配置

Returns

Element

---

DatasourcePreviewInitOption

Ƭ DatasourcePreviewInitOption: InitOption & { documentId: string ; integrationTokenName?: string }

数据源预览实例的初始化参数配置

---

DestroyInstance

Ƭ DestroyInstance: (element: Element) => void

Type declaration

▸ (element): void

释放设计器实例的占用资源

示例

GrapeCity.wyn.dataset.designer.destroy(element);
GrapeCity.wyn.dataset.preview.destroy(element);
GrapeCity.wyn.datasource.designer.destroy(element);
GrapeCity.wyn.datasource.preview.destroy(element);
GrapeCity.wyn.semanticModel.designer.destroy(element);
GrapeCity.wyn.semanticModel.selector.destroy(element);
GrapeCity.wyn.streamingDataset.designer.destroy(element);
GrapeCity.wyn.streamingDataset.preview.destroy(element);
GrapeCity.wyn.pushDataset.designer.destroy(element);
GrapeCity.wyn.pushDataset.preview.destroy(element);
GrapeCity.wyn.nativeQueryDataset.designer.destroy(element);
GrapeCity.wyn.nativeQueryDataset.preview.destroy(element);
GrapeCity.wyn.analysis.designer.destroy(element);

Parameters

名称	类型	描述
element	Element	Resource instance

Returns

void

---

ModelTypeSelectorOption

Ƭ ModelTypeSelectorOption: InitOption & { initAnalysis: () => void ; initSemantic: () => void ; integrationTokenName?: string ; showCloseButton?: boolean }

数据模型选择器的初始化参数配置

---

PreviewDatasetInit

Ƭ PreviewDatasetInit: (option: DatasetPreviewInitOption) => Element

Type declaration

▸ (option): Element

数据集预览实例的初始化操作

示例

const previewInstance = GrapeCity.wyn.dataset.designer.preview(option);

Parameters

名称	类型	描述
option	DatasetPreviewInitOption	数据集预览初始化参数配置

Returns

Element

---

SemanticModelDesignerInit

Ƭ SemanticModelDesignerInit: (option: SemanticModelDesignerInitOption) => Element

Type declaration

▸ (option): Element

语义模型设计器的初始化操作

示例

const designer = GrapeCity.wyn.semanticModel.designer.init(option);

Parameters

名称	类型	描述
option	SemanticModelDesignerInitOption	语义模型设计器初始化参数配置

Returns

Element

---

SemanticModelDesignerInitOption

Ƭ SemanticModelDesignerInitOption: InitOption & SemanticModelDesignerInitOptionCore

语义模型设计器的初始化参数配置

---

SemanticModelDesignerInitOptionCore

Ƭ SemanticModelDesignerInitOptionCore: Object

Type declaration

名称	类型
documentId?	string
events?	EventsOptionBase
integrationTokenName?	string
showCloseButton?	boolean

documentId?: string

语义模型 id

示例

documentId: '1f183c3f-64f9-4b4c-ac92-cd37580bde21'

---

events?: EventsOptionBase

-

---

integrationTokenName?: string

url 集成 token 时使用的 token 参数名称 (默认为 token )

---

showCloseButton?: boolean

控制是否显示 关闭按钮 的标志位

示例

showCloseButton: true

---

---

SemanticModelSelectorInit

Ƭ SemanticModelSelectorInit: (option: ModelTypeSelectorOption) => Element

Type declaration

▸ (option): Element

语义模型选择器的初始化操作

示例

const selector = GrapeCity.wyn.semanticModel.selector.init(option);

Parameters

名称	类型	描述
option	ModelTypeSelectorOption	语义模型选择器初始化参数配置

Returns

Element