@web-core/web-sdk
    Preparing search index...

    Interface IDefinitionsController

    foreks definiton controller you can manage all definition action in this class all you need first you must call set methods for storing definitons in this class then you can manage all definitions from here..

    interface IDefinitionsController {
        getAll(): Definition[];
        getByCode(code: string): Definition;
        getByDomain(domain: DefinitionDomain): Definition[];
        getByExchange(exchange: DefinitionExchange): Definition[];
        getById(id: string): Definition;
        getByLegacyCode(code: string): Definition;
        getByLocalCode(code: string): Definition;
        getDefinitionAvailabilities(
            definition: Definition,
        ): DefinitionAvailabilities;
        getDefinitionByQuery(query: any[]): Definition[];
        getDefinitionsForSelector(query: any[], group: string): Definition[];
        searchDefinition(search: string): Definition[];
        setAllDefinition(definitionLocale: DefinitionLocale): Promise<void>;
        setDefinition(
            definitionId: string,
            definitionLocale: DefinitionLocale,
        ): void;
        setDefinitionByDomain(
            domain: string,
            definitionLocale: DefinitionLocale,
        ): Promise<void>;
        setDefinitionByQuery(
            definitionQuery: any[],
            definitionLocale: DefinitionLocale,
        ): Promise<void>;
        setDefinitionByQueryWithFilter(
            definitionQuery: any[],
            definitionLocale: DefinitionLocale,
            fieldFilter?: string[],
        ): Promise<void>;
        setDefinitionByStaticData(definitions: Definition[]): void;
        setDefinitions(
            definitionsIds: string[],
            definitionLocale: DefinitionLocale,
        ): Promise<void>;
        tradingViewSearch(params: any, locale?: string): any[];
        tradingViewSymbolInfo(params: any, locale?: string): any[];
    }
    Index

    Methods

    getAll getByCode getByDomain getByExchange getById getByLegacyCode getByLocalCode getDefinitionAvailabilities getDefinitionByQuery getDefinitionsForSelector searchDefinition setAllDefinition setDefinition setDefinitionByDomain setDefinitionByQuery setDefinitionByQueryWithFilter setDefinitionByStaticData setDefinitions tradingViewSearch tradingViewSymbolInfo

    Methods

    • Returns Definition[]

      definitions

      get all definitions This method returns all definitions if you want to get all definitions you must call setDefinitions method

    • Parameters

      • code: string

        definition code

      Returns Definition

      definition

      get definition by code

    • Parameters

      • id: string

        : definition id

      Returns Definition

      get definition by id

    • Parameters

      • code: string

        definition legacyCode

      Returns Definition

      definition

      get definition by legacyCode

    • Parameters

      • code: string

        definition code

      Returns Definition

      definition

      get definition by local code

    • Parameters

      Returns DefinitionAvailabilities

      definition availabilities

      get definition availabilities definition availabilities is a object that contains hasDepth, hasTransactions, hasLevelAnalysis properties

      will be removed in next version

    • Parameters

      • query: any[]

        query example

      Returns Definition[]

      definition

      get definition by query

    • Parameters

      • query: any[]

        query

      • group: string

        group

      Returns Definition[]

      definition

      get definitions for selectors

    • Parameters

      • search: string

        : search

      Returns Definition[]

      definition

      search definition

    • Parameters

      Returns Promise<void>

      set all definition

    • Parameters

      • definitionId: string

        definition id

      • definitionLocale: DefinitionLocale

        definitionLocale

      Returns void

      set definition by id

    • Parameters

      Returns Promise<void>

      set definition by domain

    • Parameters

      • definitionQuery: any[]

        definitionQuery example [{exchange: 'BIST', type: 'E'}]

      • definitionLocale: DefinitionLocale

        definitionLocale

      Returns Promise<void>

      set definition by query

    • Parameters

      • definitionQuery: any[]

        definitionQuery example [{exchange: 'BIST', type: 'E'}]

      • definitionLocale: DefinitionLocale

        definitionLocale

      • OptionalfieldFilter: string[]

        fieldFilter example ['_id', 'code']

      Returns Promise<void>

      set definition by query with field filter

    • Parameters

      Returns void

      set definition by static

    • Parameters

      • definitionsIds: string[]

        definitionsIds

      • definitionLocale: DefinitionLocale

        definitionLocale

      Returns Promise<void>

      set definitions with definition ids

    • Parameters

      • params: any

        {exchange: string, limit: number, query: string, type: string}

      • Optionallocale: string

      Returns any[]

      result list of definitions

      search definition for tradingview

    • Parameters

      • params: any

        {exchange: string, limit: number, query: string, type: string}

      • Optionallocale: string

      Returns any[]

      result list of definitions

      get all definition by exchange for tradingview

    Settings

    Member Visibility

    On This Page

    Methods