The following sections describe the module: dataset/types.

Enumerations

• AnalysisMode

Interfaces

• Analysis

• BackendServer

• ColumnDefinition

• DataSource

• DataSourceConnectionString

• Dataset

• DesignerAPI

• Dictionary

• EventsOptionBase

• Field

• FilterCondition

• FilterExpression

• ISemanticMessageQueue

• InitOption

• InitOptionBase

• JSONDataSourceParameterData

• JSONDataSourceSchemaData

• JoinColumn

• JoinCondition

• JoinRelation

• NativeQueryDataset

• PushDataset

• Query

• QueryParameter

• RowData

• SchemaDefinition

• ScriptOption

• SemanticMessage

• SemanticModel

• StreamingDataset

• Table

• TableDefinition

• TableJoinQuery

• UpdateMessageData

• Window

• WrappedDataSourceConnectionInstance

• WynView

• WynViewOption

Type Aliases

• AnalysisDesignerInitOptionCore

• AnalysisDesignerInitOptionFull

• CacheAnalysisDesignerInitOption

• ColumnDataType

• ConditionType

• ConditionType_And

• ConditionType_Or

• ConditionType_Rule

• DataSourceProviderType

• DatasetDesignerInitOption

• DatasetDesignerInitOptionCore

• DatasetDesignerInitOptionFull

• DatasetPreviewInitOption

• DatasetPreviewInitOptionCore

• DatasetPreviewInitOptionFull

• DatasourceDesignerInitOption

• DatasourceDesignerInitOptionCore

• DatasourceDesignerInitOptionFull

• DatasourcePreviewInitOption

• DirectAnalysisDesignerInitOption

• DocumentMeta

• ModelTypeSelectorOption

• SemanticModelDesignerInitOption

• SemanticModelDesignerInitOptionCore

• SemanticModelDesignerInitOptionFull

• WynViewLoaderType

• WynViewType

• destroyAble

Enumerations

Enumeration: AnalysisMode

Enumeration Members

cacheMode

• cacheMode = "cacheMode"

directQuery

• directQuery = "directQuery"

Interfaces

Interface: Analysis

Properties

designer

• Optional designer: Object

Type declaration

destroy: (element: Element) => void

init: (option: AnalysisDesignerInitOptionFull) => Element

Interface: BackendServer

Properties

token

• token: string

The token needed to access the Wyn API.

Example

token: 'DA3CF35403BF9B0823A63CB2663D58E88B0B85FB588A1068753E0BDEF935B7C2'

url

• url: string

Wyn Server URL.

Example

url: 'http://localhost:51980/'

useTokenInHeader

• Optional useTokenInHeader: boolean

Set if the token is required to be sent in the request header instead of the query parameter. The default value is false.

Example

useTokenInHeader: true,

Interface: ColumnDefinition

Properties

dataType

• dataType: ColumnDataType

newColumnName

• newColumnName: string

originColumnName

• originColumnName: string

Interface: Dataset

Properties

designer

• Optional designer: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetDesignerInitOptionFull) => Element

preview

• Optional preview: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetDesignerInitOptionFull) => Element

Interface: DataSource

Properties

connectionString

• connectionString: string

fileName

• fileName: string

filter

• filter: FilterExpression[]

id

• id: string

isExtracted

• isExtracted: boolean

name

• name: string

provider

• provider: string

useAdvancedConfig

• useAdvancedConfig: boolean

useMultiTenant

• useMultiTenant: boolean

useUserContext

• useUserContext: boolean

Interface: DataSourceConnectionString

Properties

ConnectionString

• Optional ConnectionString: string

Name

• Optional Name: string

Provider

• Optional Provider: string

SourceType

• Optional SourceType: string

UseAdvancedConfig

• Optional UseAdvancedConfig: boolean

Interface: DesignerAPI

Properties

hasPaddingChanges

• Optional hasPaddingChanges: () => boolean | PromiseLike<any>

Type declaration

▸ (): boolean | PromiseLike<any>

Returns

boolean | PromiseLike<any>

Interface: Dictionary<T>

Type parameters

Indexable

▪ [key: string]: T

Interface: EventsOptionBase

Properties

afterDocumentSave

• Optional afterDocumentSave: (success: boolean, documentId?: string) => void

Type declaration

▸ (success, documentId?): void

The callback after save.

Parameters

Returns

void

Example

afterDocumentSave: () => {}

Interface: Field

Properties

aggregation

• aggregation: string

alias

• alias: string

column

• column: string

dataType

• dataType: string

description

• description: string

fieldType

• fieldType: string

format

• format: string

table

• table: string

Interface: FilterCondition

Hierarchy

• FilterExpression

  
  

  ↳ FilterCondition

Properties

column

• column: string

Inherited from

FilterExpression.column

conditionType

• conditionType: ConditionType

dataSourceId

• Optional dataSourceId: string

Inherited from

FilterExpression.dataSourceId

expression

• expression: string

Inherited from

FilterExpression.expression

index

• Optional index: number

Inherited from

FilterExpression.index

multivalue

• multivalue: boolean

Inherited from

FilterExpression.multivalue

operator

• operator: string

Inherited from

FilterExpression.operator

table

• table: string

Inherited from

FilterExpression.table

type

• type: "Datasource" | "Dataset" | "Table"

Inherited from

FilterExpression.type

value

• value: string | string[]

Inherited from

FilterExpression.value

valueType

• valueType: "Constant" | "Parameter"

Inherited from

FilterExpression.valueType

Interface: FilterExpression

Hierarchy

• FilterExpression

  
  

  ↳ FilterCondition

Properties

column

• column: string

dataSourceId

• Optional dataSourceId: string

expression

• expression: string

index

• Optional index: number

multivalue

• multivalue: boolean

operator

• operator: string

table

• table: string

type

• type: "Datasource" | "Dataset" | "Table"

value

• value: string | string[]

valueType

• valueType: "Constant" | "Parameter"

Interface: InitOption

Hierarchy

• InitOptionBase

  
  

  ↳ InitOption

Properties

backendServer

• backendServer: BackendServer

language

• language: string

The designer or viewer language

Example

language: 'zh'

Inherited from

InitOptionBase.language

parentSelector

• parentSelector: () => HTMLElement

Type declaration

▸ (): HTMLElement

The dom contain designer or viewer.

Returns

HTMLElement

Example

parentSelector: () => document.querySelector('#root')

siteTitle

• Optional siteTitle: string

The web tab title

Example

siteTitle: 'dataset'

Inherited from

InitOptionBase.siteTitle

theme

• Optional theme: string

The designer or viewer theme

Example

theme: 'red'

Inherited from

InitOptionBase.theme

version

• Optional version: string

The designer or viewer version

Example

version: '1.0.0'

Inherited from

InitOptionBase.version

Interface: InitOptionBase

Hierarchy

• InitOptionBase

  
  

  ↳ InitOption

Properties

language

• language: string

The designer or viewer language

Example

language: 'zh'

siteTitle

• Optional siteTitle: string

The web tab title

Example

siteTitle: 'dataset'

theme

• Optional theme: string

The designer or viewer theme

Example

theme: 'red'

version

• Optional version: string

The designer or viewer version

Example

version: '1.0.0'

Interface: ISemanticMessageQueue

Properties

dequeue

• dequeue: () => SemanticMessage

Type declaration

▸ (): SemanticMessage

Returns

SemanticMessage

enqueue

• enqueue: (message: SemanticMessage) => void

Type declaration

▸ (message): void

Parameters

Returns

void

isEmpty

• isEmpty: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

peek

• peek: (predicate: (message: SemanticMessage) => boolean) => SemanticMessage

Type declaration

▸ (predicate): SemanticMessage

Parameters

Returns

SemanticMessage

Interface: JoinColumn

Properties

columnName

• columnName: string

tableName

• tableName: string

Interface: JoinCondition

Properties

leftColumn

• leftColumn: JoinColumn

operator

• operator: string

rightColumn

• rightColumn: JoinColumn

Interface: JoinRelation

Properties

conditions

• conditions: JoinCondition[]

joinType

• joinType: string

table

• table: Table

Interface: JSONDataSourceParameterData

Properties

column

• column: string

defaultValue

• defaultValue: string

type

• type: string

Interface: JSONDataSourceSchemaData

Properties

column

• column: string

path

• path: string

tableName

• tableName: string

type

• type: string

Interface: NativeQueryDataset

Properties

designer

• Optional designer: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetDesignerInitOptionFull) => Element

preview

• Optional preview: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetPreviewInitOptionFull) => Element

Interface: PushDataset

Properties

designer

• Optional designer: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetDesignerInitOptionFull) => Element

preview

• Optional preview: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetDesignerInitOptionFull) => Element

Interface: Query

Properties

commandModel

• commandModel: TableJoinQuery

commandText

• commandText: string

commandType

• commandType: string

dataSources

• dataSources: DataSource[]

parameters

• parameters: QueryParameter[]

Interface: QueryParameter

Properties

dataType

• dataType: string

multivalue

• multivalue: boolean

name

• name: string

parameterType

• parameterType: string

parameterValue

• parameterValue: string

Interface: RowData

Properties

data

• data: string[]

Interface: SchemaDefinition

Properties

tables

• tables: TableDefinition[]

Interface: ScriptOption

Properties

content

• content: string

Interface: SemanticMessage

Properties

name

• name: string

process

• process: () => IterableIterator<any>

Type declaration

▸ (): IterableIterator<any>

Returns

IterableIterator<any>

Interface: SemanticModel

Properties

designer

• Optional designer: Object

Type declaration

destroy: (element: Element) => void

init: (option: SemanticModelDesignerInitOptionFull) => Element

selector

• Optional selector: Object

Type declaration

destroy: (element: Element) => void

init: (option: ModelTypeSelectorOption) => Element

Interface: StreamingDataset

Properties

designer

• Optional designer: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetDesignerInitOptionFull) => Element

preview

• Optional preview: Object

Type declaration

destroy: (element: Element) => void

init: (option: DatasetDesignerInitOptionFull) => Element

Interface: Table

Properties

dataSourceId

• dataSourceId: string

filters

• filters: FilterExpression[]

id

• id: string

sql

• sql: string

tableName

• tableName: string

tableType

• tableType: "NativeTable" | "CustomSqlTable" | "UnionTable"

tables

• tables: Table[]

unionMap

• unionMap: Dictionary<string>[]

unionType

• unionType: "None" | "unionAll" | "union"

Interface: TableDefinition

Properties

checked

• Optional checked: boolean

columns

• columns: ColumnDefinition[]

newTableName

• newTableName: string

originTableName

• originTableName: string

rows

• Optional rows: RowData[]

Interface: TableJoinQuery

Properties

firstTable

• firstTable: Table

joinRelations

• joinRelations: JoinRelation[]

Interface: UpdateMessageData

Properties

key

• key: string

value

• value: any

Interface: Window

Properties

PathBase

• Optional PathBase: string

SemanticMessageQueue

• SemanticMessageQueue: ISemanticMessageQueue

SemanticModelId

• SemanticModelId: string

WynView

• WynView: WynView

datasetDesigner

• datasetDesigner: any

hasDashboardLicense

• hasDashboardLicense: boolean

hasReportLicense

• hasReportLicense: boolean

inverted

• inverted: boolean

isDevMode

• isDevMode: boolean

token

• token: string

Interface: Window

Properties

PathBase

• Optional PathBase: string

SemanticMessageQueue

• SemanticMessageQueue: ISemanticMessageQueue

SemanticModelId

• SemanticModelId: string

WynView

• WynView: WynView

datasetDesigner

• datasetDesigner: any

hasDashboardLicense

• hasDashboardLicense: boolean

hasReportLicense

• hasReportLicense: boolean

inverted

• inverted: boolean

isDevMode

• isDevMode: boolean

token

• token: string

Interface: WrappedDataSourceConnectionInstance

Properties

createDataSourceConnection

• createDataSourceConnection: () => DataSourceConnectionString | PromiseLike<DataSourceConnectionString>

Type declaration

▸ (): DataSourceConnectionString | PromiseLike<DataSourceConnectionString>

Returns

DataSourceConnectionString | PromiseLike<DataSourceConnectionString>

onBack

• onBack: () => void

Type declaration

▸ (): void

Returns

void

onNext

• onNext: () => void

Type declaration

▸ (): void

Returns

void

Interface: WynView

Properties

create

• create: (option: WynViewOption) => void

Type declaration

▸ (option): void

Parameters

Returns

void

destroy

• destroy: (domId: string) => void

Type declaration

▸ (domId): void

Parameters

Returns

void

loader

• loader: Object

Type declaration

hide: () => void

show: (type: WynViewLoaderType) => void

Interface: WynViewOption

Properties

afterCreating

• Optional afterCreating: (option: WynViewOption, attachedDom: HTMLDivElement) => void

Type declaration

▸ (option, attachedDom): void

Parameters

Returns

void

document

• document: Object

Type declaration

title?: string

type: string

domId

• domId: string

manuallyOperateLoader

• Optional manuallyOperateLoader: boolean

onDestroy

• Optional onDestroy: (option: WynViewOption, attachedDom: HTMLDivElement) => void

Type declaration

▸ (option, attachedDom): void

Parameters

Returns

void

scripts

• scripts: (string | ScriptOption)[]

styles

• styles: string[]

transparent

• Optional transparent: boolean

type

• type: WynViewType

Type Aliases

AnalysisDesignerInitOptionCore

Ƭ AnalysisDesignerInitOptionCore: Object

Type declaration

documentId?: string

The data model id.

Example

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

events?: EventsOptionBase

showCloseButton?: boolean

A flag specifying whether to show the showCloseButton.

Example

showCloseButton: true

AnalysisDesignerInitOptionFull

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

CacheAnalysisDesignerInitOption

Ƭ CacheAnalysisDesignerInitOption: InitOptionBase & AnalysisDesignerInitOptionCore & { name?: string }

ColumnDataType

Ƭ ColumnDataType: "String" | "Boolean" | "Double" | "DateTime"

ConditionType

Ƭ ConditionType: ConditionType_And | ConditionType_Or | ConditionType_Rule

ConditionType_And

Ƭ ConditionType_And: 0

ConditionType_Or

Ƭ ConditionType_Or: 1

ConditionType_Rule

Ƭ ConditionType_Rule: 2

DataSourceProviderType

Ƭ DataSourceProviderType: "Csv" | "Excel" | "Json" | "MongoDB" | "MySql" | "OData" | "ODBC" | "Oracle" | "Postgres" | "Salesforce" | "SQLite" | "SqlServer" | "WebData" | "Xml"

DatasetDesignerInitOption

Ƭ DatasetDesignerInitOption: InitOptionBase & DatasetDesignerInitOptionCore

DatasetDesignerInitOptionCore

Ƭ DatasetDesignerInitOptionCore: Object

Type declaration

documentId?: string

The dataset id.

Example

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

events?: EventsOptionBase

showCloseButton?: boolean

A flag specifying whether to show the showCloseButton.

Example

showCloseButton: true

type?: "report" | "dashboard"

The dataset usage type.

Example

type: 'dashboard'

DatasetDesignerInitOptionFull

Ƭ DatasetDesignerInitOptionFull: InitOption & DatasetDesignerInitOptionCore

DatasetPreviewInitOption

Ƭ DatasetPreviewInitOption: InitOptionBase & DatasetPreviewInitOptionCore

DatasetPreviewInitOptionCore

Ƭ DatasetPreviewInitOptionCore: Object

Type declaration

documentId: string

The dataset id.

Example

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

DatasetPreviewInitOptionFull

Ƭ DatasetPreviewInitOptionFull: InitOption & DatasetPreviewInitOptionCore

DatasourceDesignerInitOption

Ƭ DatasourceDesignerInitOption: InitOptionBase & DatasourceDesignerInitOptionCore

DatasourceDesignerInitOptionCore

Ƭ DatasourceDesignerInitOptionCore: Object

Type declaration

afterClose?: (document: any) => void

The callback after close designer.

Example

afterDocumentSave: () => {}

documentId?: string

The datasource id.

Example

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

events?: EventsOptionBase

inDataset?: boolean

A flag specifying whether to open datasource designer in dataset designer.

Example

inDataset: false

showCloseButton?: boolean

A flag specifying whether to show the showCloseButton.

Example

showCloseButton: true

DatasourceDesignerInitOptionFull

Ƭ DatasourceDesignerInitOptionFull: InitOption & DatasourceDesignerInitOptionCore

DatasourcePreviewInitOption

Ƭ DatasourcePreviewInitOption: InitOption & { documentId: string }

DirectAnalysisDesignerInitOption

Ƭ DirectAnalysisDesignerInitOption: InitOptionBase & AnalysisDesignerInitOptionCore

DocumentMeta

Ƭ DocumentMeta: Object

Type declaration

DSC_ALLOW_APPEND_DATA?: "True" | "False"

DSC_PROVIDER?: DataSourceProviderType

ModelTypeSelectorOption

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

SemanticModelDesignerInitOption

Ƭ SemanticModelDesignerInitOption: InitOptionBase & SemanticModelDesignerInitOptionCore

SemanticModelDesignerInitOptionCore

Ƭ SemanticModelDesignerInitOptionCore: Object

Type declaration

documentId?: string

The data model id.

Example

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

events?: EventsOptionBase

showCloseButton?: boolean

A flag specifying whether to show the showCloseButton.

Example

showCloseButton: true

SemanticModelDesignerInitOptionFull

Ƭ SemanticModelDesignerInitOptionFull: InitOption & SemanticModelDesignerInitOptionCore

WynViewLoaderType

Ƭ WynViewLoaderType: WynViewType | "none"

WynViewType

Ƭ WynViewType: "designer" | "preview"

destroyAble

Ƭ destroyAble: Object

Type declaration

destroy: () => void